Package software.amazon.awssdk.services.b2bi.model

Class SampleDocuments

java.lang.Object

software.amazon.awssdk.services.b2bi.model.SampleDocuments

All Implemented Interfaces:

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

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

Describes a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SampleDocuments.Builder

Method Summary

Modifier and Type	Method	Description
String	bucketName()	Contains the Amazon S3 bucket that is used to hold your sample documents.
static SampleDocuments.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasKeys()	For responses, this returns true if the service returned a value for the Keys property.
List<SampleDocumentKeys>	keys()	Contains an array of the Amazon S3 keys used to identify the location for your sample documents.
List<SdkField<?>>	sdkFields()
static Class<? extends SampleDocuments.Builder>	serializableBuilderClass()
SampleDocuments.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

bucketName

public final String bucketName()

Contains the Amazon S3 bucket that is used to hold your sample documents.

Returns:

Contains the Amazon S3 bucket that is used to hold your sample documents.

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

Contains an array of the Amazon S3 keys used to identify the location for your sample documents.

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:

Contains an array of the Amazon S3 keys used to identify the location for your sample documents.

toBuilder

public SampleDocuments.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SampleDocuments.Builder,SampleDocuments>

builder

public static SampleDocuments.Builder builder()

serializableBuilderClass

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