Package software.amazon.awssdk.services.bedrockagent.model

Class S3DataSourceConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.S3DataSourceConfiguration

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class S3DataSourceConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<S3DataSourceConfiguration.Builder,S3DataSourceConfiguration>

The configuration information to connect to Amazon S3 as your data source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3DataSourceConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
String	bucketArn()	The Amazon Resource Name (ARN) of the S3 bucket that contains your data.
String	bucketOwnerAccountId()	The account ID for the owner of the S3 bucket.
static S3DataSourceConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInclusionPrefixes()	For responses, this returns true if the service returned a value for the InclusionPrefixes property.
List<String>	inclusionPrefixes()	A list of S3 prefixes to include certain files or content.
List<SdkField<?>>	sdkFields()
static Class<? extends S3DataSourceConfiguration.Builder>	serializableBuilderClass()
S3DataSourceConfiguration.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

bucketArn

public final String bucketArn()

The Amazon Resource Name (ARN) of the S3 bucket that contains your data.

Returns:

The Amazon Resource Name (ARN) of the S3 bucket that contains your data.

bucketOwnerAccountId

public final String bucketOwnerAccountId()

The account ID for the owner of the S3 bucket.

Returns:

The account ID for the owner of the S3 bucket.

hasInclusionPrefixes

public final boolean hasInclusionPrefixes()

For responses, this returns true if the service returned a value for the InclusionPrefixes 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.

inclusionPrefixes

public final List<String> inclusionPrefixes()

A list of S3 prefixes to include certain files or content. For more information, see Organizing objects using prefixes.

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

Returns:

A list of S3 prefixes to include certain files or content. For more information, see Organizing objects using prefixes.

toBuilder

public S3DataSourceConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3DataSourceConfiguration.Builder,S3DataSourceConfiguration>

builder

public static S3DataSourceConfiguration.Builder builder()

serializableBuilderClass

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