Class S3Location

java.lang.Object
software.amazon.awssdk.services.s3.model.S3Location
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<S3Location.Builder,S3Location>
@Generated("software.amazon.awssdk:codegen") public final class S3Location extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3Location.Builder,S3Location>

Describes an Amazon S3 location that will receive the results of the restore request.

See Also:

  • Method Details

    • bucketName

      public final String bucketName()

      The name of the bucket where the restore results will be placed.

      Returns:
      The name of the bucket where the restore results will be placed.

    • prefix

      public final String prefix()

      The prefix that is prepended to the restore results for this request.

      Returns:
      The prefix that is prepended to the restore results for this request.

    • encryption

      public final Encryption encryption()
      Returns the value of the Encryption property for this object.
      Returns:
      The value of the Encryption property for this object.

    • cannedACL

      public final ObjectCannedACL cannedACL()

      The canned ACL to apply to the restore results.

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

      Returns:
      The canned ACL to apply to the restore results.
      See Also:

    • cannedACLAsString

      public final String cannedACLAsString()

      The canned ACL to apply to the restore results.

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

      Returns:
      The canned ACL to apply to the restore results.
      See Also:

    • hasAccessControlList

      public final boolean hasAccessControlList()
      For responses, this returns true if the service returned a value for the AccessControlList 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.

    • accessControlList

      public final List<Grant> accessControlList()

      A list of grants that control access to the staged results.

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

      Returns:
      A list of grants that control access to the staged results.

    • tagging

      public final Tagging tagging()

      The tag-set that is applied to the restore results.

      Returns:
      The tag-set that is applied to the restore results.

    • hasUserMetadata

      public final boolean hasUserMetadata()
      For responses, this returns true if the service returned a value for the UserMetadata 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.

    • userMetadata

      public final List<MetadataEntry> userMetadata()

      A list of metadata to store with the restore results in S3.

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

      Returns:
      A list of metadata to store with the restore results in S3.

    • storageClass

      public final StorageClass storageClass()

      The class of storage used to store the restore results.

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

      Returns:
      The class of storage used to store the restore results.
      See Also:

    • storageClassAsString

      public final String storageClassAsString()

      The class of storage used to store the restore results.

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

      Returns:
      The class of storage used to store the restore results.
      See Also:

    • toBuilder

      public S3Location.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<S3Location.Builder,S3Location>
      Returns:
      a builder for type T

    • builder

      public static S3Location.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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