com.amazonaws.services.textract.model

Class NotificationChannel

java.lang.Object

com.amazonaws.services.textract.model.NotificationChannel

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
NotificationChannel()

Method Summary

Modifier and Type	Method and Description
NotificationChannel	clone()
boolean	equals(Object obj)
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
String	getSNSTopicArn() The Amazon SNS topic that Amazon Textract posts the completion status to.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
void	setSNSTopicArn(String sNSTopicArn) The Amazon SNS topic that Amazon Textract posts the completion status to.
String	toString() Returns a string representation of this object.
NotificationChannel	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
NotificationChannel	withSNSTopicArn(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

setSNSTopicArn

public void setSNSTopicArn(String sNSTopicArn)

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

Parameters:

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

getSNSTopicArn

public String getSNSTopicArn()

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

Returns:

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

withSNSTopicArn

public NotificationChannel withSNSTopicArn(String sNSTopicArn)

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

Parameters:

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

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

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

Parameters:

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

getRoleArn

public String getRoleArn()

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

Returns:

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

withRoleArn

public NotificationChannel withRoleArn(String roleArn)

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

Parameters:

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

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 NotificationChannel 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.