software.amazon.awssdk.services.datasync.model

Class DescribeLocationS3Response

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.datasync.model.DataSyncResponse

software.amazon.awssdk.services.datasync.model.DescribeLocationS3Response

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeLocationS3Response.Builder,DescribeLocationS3Response>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeLocationS3Response
extends DataSyncResponse
implements ToCopyableBuilder<DescribeLocationS3Response.Builder,DescribeLocationS3Response>

DescribeLocationS3Response

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeLocationS3Response.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	agentArns() If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost.
static DescribeLocationS3Response.Builder	builder()
Instant	creationTime() The time that the Amazon S3 bucket location was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAgentArns() For responses, this returns true if the service returned a value for the AgentArns property.
int	hashCode()
String	locationArn() The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.
String	locationUri() The URL of the Amazon S3 location that was described.
S3Config	s3Config() Returns the value of the S3Config property for this object.
S3StorageClass	s3StorageClass() The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination.
String	s3StorageClassAsString() The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeLocationS3Response.Builder>	serializableBuilderClass()
DescribeLocationS3Response.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.datasync.model.DataSyncResponse

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

locationArn

public final String locationArn()

The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.

Returns:

The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.

locationUri

public final String locationUri()

The URL of the Amazon S3 location that was described.

Returns:

The URL of the Amazon S3 location that was described.

s3StorageClass

public final S3StorageClass s3StorageClass()

The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

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

Returns:

The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

See Also:

S3StorageClass

s3StorageClassAsString

public final String s3StorageClassAsString()

The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

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

Returns:

The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

See Also:

S3StorageClass

s3Config

public final S3Config s3Config()

Returns the value of the S3Config property for this object.

Returns:

The value of the S3Config property for this object.

hasAgentArns

public final boolean hasAgentArns()

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

agentArns

public final List<String> agentArns()

If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

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

Returns:

If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

creationTime

public final Instant creationTime()

The time that the Amazon S3 bucket location was created.

Returns:

The time that the Amazon S3 bucket location was created.

toBuilder

public DescribeLocationS3Response.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeLocationS3Response.Builder,DescribeLocationS3Response>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeLocationS3Response.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeLocationS3Response.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