software.amazon.awssdk.services.textract.model

Class S3Object

java.lang.Object

software.amazon.awssdk.services.textract.model.S3Object

All Implemented Interfaces:

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

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

The S3 bucket name and file name that identifies the document.

The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.

For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	S3Object.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() The name of the S3 bucket.
static S3Object.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The file name of the input document.
List<SdkField<?>>	sdkFields()
static Class<? extends S3Object.Builder>	serializableBuilderClass()
S3Object.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	version() If the bucket has versioning enabled, you can specify the object version.

Methods inherited from class java.lang.Object

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 name of the S3 bucket. Note that the # character is not valid in the file name.

Returns:

The name of the S3 bucket. Note that the # character is not valid in the file name.

name

public final String name()

The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.

Returns:

The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.

version

public final String version()

If the bucket has versioning enabled, you can specify the object version.

Returns:

If the bucket has versioning enabled, you can specify the object version.

toBuilder

public S3Object.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<S3Object.Builder,S3Object>

Returns:

a builder for type T

builder

public static S3Object.Builder builder()

serializableBuilderClass

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