com.amazonaws.services.textract.model

Class NotificationChannel

java.lang.Object

com.amazonaws.services.textract.model.NotificationChannel

All Implemented Interfaces:

java.io.Serializable

public class NotificationChannel
extends java.lang.Object
implements java.io.Serializable

The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation, such as StartDocumentTextDetection.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NotificationChannel()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
java.lang.String	getSNSTopicArn() The Amazon SNS topic that Amazon Textract posts the completion status to.
int	hashCode()
void	setRoleArn(java.lang.String roleArn) The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
void	setSNSTopicArn(java.lang.String sNSTopicArn) The Amazon SNS topic that Amazon Textract posts the completion status to.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
NotificationChannel	withRoleArn(java.lang.String roleArn) The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
NotificationChannel	withSNSTopicArn(java.lang.String sNSTopicArn) The Amazon SNS topic that Amazon Textract posts the completion status to.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NotificationChannel

public NotificationChannel()

Method Detail

getSNSTopicArn

public java.lang.String getSNSTopicArn()

The Amazon SNS topic that Amazon Textract posts the completion status to.

Constraints:
Length: 20 - 1024
Pattern: (^arn:([a-z\d-]+):sns:[a-zA-Z\d-]{1,20}:\w{12}:.+$)

Returns:

The Amazon SNS topic that Amazon Textract posts the completion status to.

setSNSTopicArn

public void setSNSTopicArn(java.lang.String sNSTopicArn)

The Amazon SNS topic that Amazon Textract posts the completion status to.

Constraints:
Length: 20 - 1024
Pattern: (^arn:([a-z\d-]+):sns:[a-zA-Z\d-]{1,20}:\w{12}:.+$)

Parameters:

sNSTopicArn -

The Amazon SNS topic that Amazon Textract posts the completion status to.

withSNSTopicArn

public NotificationChannel withSNSTopicArn(java.lang.String sNSTopicArn)

The Amazon SNS topic that Amazon Textract posts the completion status to.

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

Constraints:
Length: 20 - 1024
Pattern: (^arn:([a-z\d-]+):sns:[a-zA-Z\d-]{1,20}:\w{12}:.+$)

Parameters:

sNSTopicArn -

The Amazon SNS topic that Amazon Textract posts the completion status to.

Returns:

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

getRoleArn

public java.lang.String getRoleArn()

The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

Constraints:
Length: 20 - 2048
Pattern: arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Returns:

The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

setRoleArn

public void setRoleArn(java.lang.String roleArn)

The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

Constraints:
Length: 20 - 2048
Pattern: arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Parameters:

roleArn -

The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

withRoleArn

public NotificationChannel withRoleArn(java.lang.String roleArn)

The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

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

Constraints:
Length: 20 - 2048
Pattern: arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Parameters:

roleArn -

The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object