@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.
Modifier and Type | Class and Description |
---|---|
static interface |
S3Object.Builder |
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.
|
copy
public final String bucket()
The name of the S3 bucket.
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 format files.
public final String version()
If the bucket has versioning enabled, you can specify the object version.
public S3Object.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<S3Object.Builder,S3Object>
public static S3Object.Builder builder()
public static Class<? extends S3Object.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.