Class UpdateLocationS3Request

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.UpdateLocationS3Request
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateLocationS3Request.Builder,UpdateLocationS3Request>
@Generated("software.amazon.awssdk:codegen") public final class UpdateLocationS3Request extends DataSyncRequest implements ToCopyableBuilder<UpdateLocationS3Request.Builder,UpdateLocationS3Request>

  • Method Details

    • locationArn

      public final String locationArn()

      Specifies the Amazon Resource Name (ARN) of the Amazon S3 transfer location that you're updating.

      Returns:
      Specifies the Amazon Resource Name (ARN) of the Amazon S3 transfer location that you're updating.

    • 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

    • 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:

    • 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:

    • 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.

    • toBuilder

      public UpdateLocationS3Request.Builder 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 interface ToCopyableBuilder<UpdateLocationS3Request.Builder,UpdateLocationS3Request>
      Specified by:
      toBuilder in class DataSyncRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateLocationS3Request.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateLocationS3Request.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.