com.amazonaws.services.textract.model

Class S3Object

java.lang.Object

com.amazonaws.services.textract.model.S3Object

All Implemented Interfaces:

Serializable

public class S3Object
extends Object
implements Serializable

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

Constructor Summary

Constructors

Constructor and Description
S3Object()

Method Summary

Modifier and Type	Method and Description
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	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; useful for testing and debugging.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

S3Object

public S3Object()

Method Detail

getBucket

public String getBucket()

The name of the S3 bucket.

Constraints:
Length: 3 - 255
Pattern: [0-9A-Za-z\.\-_]*

Returns:

The name of the S3 bucket.

setBucket

public void setBucket(String bucket)

The name of the S3 bucket.

Constraints:
Length: 3 - 255
Pattern: [0-9A-Za-z\.\-_]*

Parameters:

bucket -

The name of the S3 bucket.

withBucket

public S3Object withBucket(String bucket)

The name of the S3 bucket.

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

Constraints:
Length: 3 - 255
Pattern: [0-9A-Za-z\.\-_]*

Parameters:

bucket -

The name of the S3 bucket.

Returns:

A reference to this updated object so that method calls can be chained together.

getName

public String getName()

The file name of the input document. It must be an image file (.JPG or .PNG format). Asynchronous operations also support PDF files.

Constraints:
Length: 1 - 1024
Pattern: .*\S.*

Returns:

The file name of the input document. It must be an image file (.JPG or .PNG format). Asynchronous operations also support PDF files.

setName

public void setName(String name)

The file name of the input document. It must be an image file (.JPG or .PNG format). Asynchronous operations also support PDF files.

Constraints:
Length: 1 - 1024
Pattern: .*\S.*

Parameters:

name -

The file name of the input document. It must be an image file (.JPG or .PNG format). Asynchronous operations also support PDF files.

withName

public S3Object withName(String name)

The file name of the input document. It must be an image file (.JPG or .PNG format). Asynchronous operations also support PDF files.

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

Constraints:
Length: 1 - 1024
Pattern: .*\S.*

Parameters:

name -

The file name of the input document. It must be an image file (.JPG or .PNG format). Asynchronous operations also support PDF files.

Returns:

A reference to this updated object so that method calls can be chained together.

getVersion

public String getVersion()

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

Constraints:
Length: 1 - 1024
Pattern: .*\S.*

Returns:

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

setVersion

public void setVersion(String version)

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

Constraints:
Length: 1 - 1024
Pattern: .*\S.*

Parameters:

version -

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.

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

Constraints:
Length: 1 - 1024
Pattern: .*\S.*

Parameters:

version -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object