Package software.amazon.awssdk.services.ebs.model

Class StartSnapshotResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.ebs.model.EbsResponse

software.amazon.awssdk.services.ebs.model.StartSnapshotResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartSnapshotResponse.Builder,StartSnapshotResponse>

@Generated("software.amazon.awssdk:codegen")
public final class StartSnapshotResponse
extends EbsResponse
implements ToCopyableBuilder<StartSnapshotResponse.Builder,StartSnapshotResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartSnapshotResponse.Builder

Method Summary

Modifier and Type	Method	Description
Integer	blockSize()	The size of the blocks in the snapshot, in bytes.
static StartSnapshotResponse.Builder	builder()
String	description()	The description of the snapshot.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	kmsKeyArn()	The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.
String	ownerId()	The Amazon Web Services account ID of the snapshot owner.
String	parentSnapshotId()	The ID of the parent snapshot.
List<SdkField<?>>	sdkFields()
static Class<? extends StartSnapshotResponse.Builder>	serializableBuilderClass()
String	snapshotId()	The ID of the snapshot.
SSEType	sseType()	Reserved for future use.
String	sseTypeAsString()	Reserved for future use.
Instant	startTime()	The timestamp when the snapshot was created.
Status	status()	The status of the snapshot.
String	statusAsString()	The status of the snapshot.
List<Tag>	tags()	The tags applied to the snapshot.
StartSnapshotResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Long	volumeSize()	The size of the volume, in GiB.

Methods inherited from class software.amazon.awssdk.services.ebs.model.EbsResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

description

public final String description()

The description of the snapshot.

Returns:

The description of the snapshot.

snapshotId

public final String snapshotId()

The ID of the snapshot.

Returns:

The ID of the snapshot.

ownerId

public final String ownerId()

The Amazon Web Services account ID of the snapshot owner.

Returns:

The Amazon Web Services account ID of the snapshot owner.

status

public final Status status()

The status of the snapshot.

If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the snapshot.

See Also:

Status

statusAsString

public final String statusAsString()

The status of the snapshot.

If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the snapshot.

See Also:

Status

startTime

public final Instant startTime()

The timestamp when the snapshot was created.

Returns:

The timestamp when the snapshot was created.

volumeSize

public final Long volumeSize()

The size of the volume, in GiB.

Returns:

The size of the volume, in GiB.

blockSize

public final Integer blockSize()

The size of the blocks in the snapshot, in bytes.

Returns:

The size of the blocks in the snapshot, in bytes.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

The tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

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 hasTags() method.

Returns:

The tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

parentSnapshotId

public final String parentSnapshotId()

The ID of the parent snapshot.

Returns:

The ID of the parent snapshot.

kmsKeyArn

public final String kmsKeyArn()

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.

Returns:

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.

sseType

public final SSEType sseType()

Reserved for future use.

If the service returns an enum value that is not available in the current SDK version, sseType will return SSEType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sseTypeAsString().

Returns:

Reserved for future use.

See Also:

SSEType

sseTypeAsString

public final String sseTypeAsString()

Reserved for future use.

If the service returns an enum value that is not available in the current SDK version, sseType will return SSEType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sseTypeAsString().

Returns:

Reserved for future use.

See Also:

SSEType

toBuilder

public StartSnapshotResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartSnapshotResponse.Builder,StartSnapshotResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static StartSnapshotResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo