software.amazon.awssdk.services.ec2.model

Class Reservation

java.lang.Object

software.amazon.awssdk.services.ec2.model.Reservation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Reservation.Builder,Reservation>

@Generated(value="software.amazon.awssdk:codegen")
public final class Reservation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Reservation.Builder,Reservation>

Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Reservation.Builder

Method Summary

Modifier and Type	Method and Description
static Reservation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<GroupIdentifier>	groups() [EC2-Classic only] The security groups.
boolean	hasGroups() For responses, this returns true if the service returned a value for the Groups property.
int	hashCode()
boolean	hasInstances() For responses, this returns true if the service returned a value for the Instances property.
List<Instance>	instances() The instances.
String	ownerId() The ID of the Amazon Web Services account that owns the reservation.
String	requesterId() The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).
String	reservationId() The ID of the reservation.
List<SdkField<?>>	sdkFields()
static Class<? extends Reservation.Builder>	serializableBuilderClass()
Reservation.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasGroups

public final boolean hasGroups()

For responses, this returns true if the service returned a value for the Groups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

groups

public final List<GroupIdentifier> groups()

[EC2-Classic only] The security groups.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroups() method.

Returns:

[EC2-Classic only] The security groups.

hasInstances

public final boolean hasInstances()

For responses, this returns true if the service returned a value for the Instances property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

instances

public final List<Instance> instances()

The instances.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstances() method.

Returns:

The instances.

ownerId

public final String ownerId()

The ID of the Amazon Web Services account that owns the reservation.

Returns:

The ID of the Amazon Web Services account that owns the reservation.

requesterId

public final String requesterId()

The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).

Returns:

The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).

reservationId

public final String reservationId()

The ID of the reservation.

Returns:

The ID of the reservation.

toBuilder

public Reservation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Reservation.Builder,Reservation>

builder

public static Reservation.Builder builder()

serializableBuilderClass

public static Class<? extends Reservation.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo