Class CreateLocationS3Request
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateLocationS3Request.Builder,
CreateLocationS3Request>
CreateLocationS3Request
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescription(Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AgentArns property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
Specifies the ARN of the S3 bucket that you want to use as a location.final S3Config
s3Config()
Returns the value of the S3Config property for this object.final S3StorageClass
Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.final String
Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.static Class
<? extends CreateLocationS3Request.Builder> final String
Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).final List
<TagListEntry> tags()
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
subdirectory
Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).
DataSync can't transfer objects with a prefix that begins with a slash (
/
) or includes//
,/./
, or/../
patterns. For example:-
/photos
-
photos//2006/January
-
photos/./2006/February
-
photos/../2006/March
- Returns:
- Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the
bucket is a source or destination location).
DataSync can't transfer objects with a prefix that begins with a slash (
/
) or includes//
,/./
, or/../
patterns. For example:-
/photos
-
photos//2006/January
-
photos/./2006/February
-
photos/../2006/March
-
-
-
s3BucketArn
Specifies the ARN of the S3 bucket that you want to use as a location. (When creating your DataSync task later, you specify whether this location is a transfer source or destination.)
If your S3 bucket is located on an Outposts resource, you must specify an Amazon S3 access point. For more information, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.
- Returns:
- Specifies the ARN of the S3 bucket that you want to use as a location. (When creating your DataSync task
later, you specify whether this location is a transfer source or destination.)
If your S3 bucket is located on an Outposts resource, you must specify an Amazon S3 access point. For more information, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.
-
s3StorageClass
Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.
For buckets in Amazon Web Services Regions, the storage class defaults to
STANDARD
. For buckets on Outposts, the storage class defaults toOUTPOSTS
.For more information, see Storage class considerations with Amazon S3 transfers.
If the service returns an enum value that is not available in the current SDK version,
s3StorageClass
will returnS3StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3StorageClassAsString()
.- Returns:
- Specifies the storage class that you want your objects to use when Amazon S3 is a transfer
destination.
For buckets in Amazon Web Services Regions, the storage class defaults to
STANDARD
. For buckets on Outposts, the storage class defaults toOUTPOSTS
.For more information, see Storage class considerations with Amazon S3 transfers.
- See Also:
-
s3StorageClassAsString
Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.
For buckets in Amazon Web Services Regions, the storage class defaults to
STANDARD
. For buckets on Outposts, the storage class defaults toOUTPOSTS
.For more information, see Storage class considerations with Amazon S3 transfers.
If the service returns an enum value that is not available in the current SDK version,
s3StorageClass
will returnS3StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3StorageClassAsString()
.- Returns:
- Specifies the storage class that you want your objects to use when Amazon S3 is a transfer
destination.
For buckets in Amazon Web Services Regions, the storage class defaults to
STANDARD
. For buckets on Outposts, the storage class defaults toOUTPOSTS
.For more information, see Storage class considerations with Amazon S3 transfers.
- See Also:
-
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 theisEmpty()
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
(Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.
For more information, 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:
- (Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your
Outpost.
For more information, see Deploy your DataSync agent on Outposts.
-
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 theisEmpty()
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
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.
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:
- Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateLocationS3Request.Builder,
CreateLocationS3Request> - Specified by:
toBuilder
in classDataSyncRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-