software.amazon.awssdk.services.dataexchange.model

Class S3DataAccessAsset

java.lang.Object

software.amazon.awssdk.services.dataexchange.model.S3DataAccessAsset

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<S3DataAccessAsset.Builder,S3DataAccessAsset>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	S3DataAccessAsset.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() The Amazon S3 bucket hosting data to be shared in the S3 data access.
static S3DataAccessAsset.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasKeyPrefixes() For responses, this returns true if the service returned a value for the KeyPrefixes property.
boolean	hasKeys() For responses, this returns true if the service returned a value for the Keys property.
boolean	hasKmsKeysToGrant() For responses, this returns true if the service returned a value for the KmsKeysToGrant property.
List<String>	keyPrefixes() The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.
List<String>	keys() S3 keys made available using this asset.
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.
String	s3AccessPointAlias() The automatically-generated bucket-style alias for your Amazon S3 Access Point.
String	s3AccessPointArn() The ARN for your Amazon S3 Access Point.
List<SdkField<?>>	sdkFields()
static Class<? extends S3DataAccessAsset.Builder>	serializableBuilderClass()
S3DataAccessAsset.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

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

Specified by:

toBuilder in interface ToCopyableBuilder<S3DataAccessAsset.Builder,S3DataAccessAsset>

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)

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo