com.amazonaws.services.textract.model

Class S3Object

java.lang.Object

com.amazonaws.services.textract.model.S3Object

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class S3Object
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
S3Object()

Method Summary

Modifier and Type	Method and Description
S3Object	clone()
boolean	equals(Object obj)
String	getBucket() The name of the S3 bucket.
String	getName() The file name of the input document.
String	getVersion() If the bucket has versioning enabled, you can specify the object version.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBucket(String bucket) The name of the S3 bucket.
void	setName(String name) The file name of the input document.
void	setVersion(String version) If the bucket has versioning enabled, you can specify the object version.
String	toString() Returns a string representation of this object.
S3Object	withBucket(String bucket) The name of the S3 bucket.
S3Object	withName(String name) The file name of the input document.
S3Object	withVersion(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

Constructor Detail

S3Object

public S3Object()

Method Detail

setBucket

public void setBucket(String bucket)

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

Parameters:

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

getBucket

public String getBucket()

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.

withBucket

public S3Object withBucket(String bucket)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(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.

Parameters:

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.

getName

public String getName()

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.

withName

public S3Object withName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setVersion

public void setVersion(String version)

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

Parameters:

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

getVersion

public String getVersion()

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.

withVersion

public S3Object withVersion(String version)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public S3Object clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.