Class S3DataAccessAsset

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

The Amazon S3 data access that is the asset.

See Also:

  • Method Details

    • bucket

      public final String bucket()

      The Amazon S3 bucket hosting data to be shared in the S3 data access.

      Returns:
      The Amazon S3 bucket hosting data to be shared in the S3 data access.

    • hasKeyPrefixes

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

    • keyPrefixes

      public final List<String> keyPrefixes()

      The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.

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

      Returns:
      The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.

    • hasKeys

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

    • keys

      public final List<String> keys()

      S3 keys made available using this asset.

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

      Returns:
      S3 keys made available using this asset.

    • s3AccessPointAlias

      public final String s3AccessPointAlias()

      The automatically-generated bucket-style alias for your Amazon S3 Access Point. Customers can access their entitled data using the S3 Access Point alias.

      Returns:
      The automatically-generated bucket-style alias for your Amazon S3 Access Point. Customers can access their entitled data using the S3 Access Point alias.

    • s3AccessPointArn

      public final String s3AccessPointArn()

      The ARN for your Amazon S3 Access Point. Customers can also access their entitled data using the S3 Access Point ARN.

      Returns:
      The ARN for your Amazon S3 Access Point. Customers can also access their entitled data using the S3 Access Point ARN.

    • hasKmsKeysToGrant

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

    • kmsKeysToGrant

      public final List<KmsKeyToGrant> kmsKeysToGrant()

      List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to encrypt S3 objects being shared in this S3 Data Access asset. Providers must include all AWS KMS keys used to encrypt these shared S3 objects.

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

      Returns:
      List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to encrypt S3 objects being shared in this S3 Data Access asset. Providers must include all AWS KMS keys used to encrypt these shared S3 objects.

    • toBuilder

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

    • builder

      public static S3DataAccessAsset.Builder builder()

    • serializableBuilderClass

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