java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.datasync.model.DataSyncRequest
    - - software.amazon.awssdk.services.datasync.model.CreateLocationS3Request

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateLocationS3Request.Builder,CreateLocationS3Request>

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

CreateLocationS3Request

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateLocationS3Request.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`agentArns()`	(Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.
`static CreateLocationS3Request.Builder`	`builder()`
`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()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`s3BucketArn()`	Specifies the ARN of the S3 bucket that you want to use as a location.
`S3Config`	`s3Config()`	Returns the value of the S3Config property for this object.
`S3StorageClass`	`s3StorageClass()`	Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.
`String`	`s3StorageClassAsString()`	Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateLocationS3Request.Builder>`	`serializableBuilderClass()`
`String`	`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).
`List<TagListEntry>`	`tags()`	Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
`CreateLocationS3Request.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - subdirectory
```
public final String 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
```
public final String 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
```
public final S3StorageClass 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 to OUTPOSTS.
    
    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 return S3StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3StorageClassAsString().
    
    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 to OUTPOSTS.
    
    For more information, see Storage class considerations with Amazon S3 transfers.
    
    See Also:
    
    S3StorageClass
  - s3StorageClassAsString
```
public final String 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 to OUTPOSTS.
    
    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 return S3StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3StorageClassAsString().
    
    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 to OUTPOSTS.
    
    For more information, see Storage class considerations with Amazon S3 transfers.
    
    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()
```
    (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 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<TagListEntry> 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
```
public CreateLocationS3Request.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateLocationS3Request.Builder,CreateLocationS3Request>
    
    Specified by:
    
    toBuilder in class DataSyncRequest
  - builder
```
public static CreateLocationS3Request.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateLocationS3Request.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateLocationS3Request

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

subdirectory

s3BucketArn

s3StorageClass

s3StorageClassAsString

s3Config

hasAgentArns

agentArns

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields