com.amazonaws.services.comprehend.model

Class StartEventsDetectionJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.comprehend.model.StartEventsDetectionJobRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StartEventsDetectionJobRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Starts an asynchronous event detection job for a collection of documents.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartEventsDetectionJobRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getClientRequestToken() An unique identifier for the request.
java.lang.String	getDataAccessRoleArn() The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
InputDataConfig	getInputDataConfig() Specifies the format and location of the input data for the job.
java.lang.String	getJobName() The identifier of the events detection job.
java.lang.String	getLanguageCode() The language code of the input documents.
OutputDataConfig	getOutputDataConfig() Specifies where to send the output files.
java.util.List<java.lang.String>	getTargetEventTypes() The types of events to detect in the input documents.
int	hashCode()
void	setClientRequestToken(java.lang.String clientRequestToken) An unique identifier for the request.
void	setDataAccessRoleArn(java.lang.String dataAccessRoleArn) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
void	setInputDataConfig(InputDataConfig inputDataConfig) Specifies the format and location of the input data for the job.
void	setJobName(java.lang.String jobName) The identifier of the events detection job.
void	setLanguageCode(LanguageCode languageCode) The language code of the input documents.
void	setLanguageCode(java.lang.String languageCode) The language code of the input documents.
void	setOutputDataConfig(OutputDataConfig outputDataConfig) Specifies where to send the output files.
void	setTargetEventTypes(java.util.Collection<java.lang.String> targetEventTypes) The types of events to detect in the input documents.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StartEventsDetectionJobRequest	withClientRequestToken(java.lang.String clientRequestToken) An unique identifier for the request.
StartEventsDetectionJobRequest	withDataAccessRoleArn(java.lang.String dataAccessRoleArn) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
StartEventsDetectionJobRequest	withInputDataConfig(InputDataConfig inputDataConfig) Specifies the format and location of the input data for the job.
StartEventsDetectionJobRequest	withJobName(java.lang.String jobName) The identifier of the events detection job.
StartEventsDetectionJobRequest	withLanguageCode(LanguageCode languageCode) The language code of the input documents.
StartEventsDetectionJobRequest	withLanguageCode(java.lang.String languageCode) The language code of the input documents.
StartEventsDetectionJobRequest	withOutputDataConfig(OutputDataConfig outputDataConfig) Specifies where to send the output files.
StartEventsDetectionJobRequest	withTargetEventTypes(java.util.Collection<java.lang.String> targetEventTypes) The types of events to detect in the input documents.
StartEventsDetectionJobRequest	withTargetEventTypes(java.lang.String... targetEventTypes) The types of events to detect in the input documents.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartEventsDetectionJobRequest

public StartEventsDetectionJobRequest()

Method Detail

getInputDataConfig

public InputDataConfig getInputDataConfig()

Specifies the format and location of the input data for the job.

Returns:

Specifies the format and location of the input data for the job.

setInputDataConfig

public void setInputDataConfig(InputDataConfig inputDataConfig)

Specifies the format and location of the input data for the job.

Parameters:

inputDataConfig -

Specifies the format and location of the input data for the job.

withInputDataConfig

public StartEventsDetectionJobRequest withInputDataConfig(InputDataConfig inputDataConfig)

Specifies the format and location of the input data for the job.

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

Parameters:

inputDataConfig -

Specifies the format and location of the input data for the job.

Returns:

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

getOutputDataConfig

public OutputDataConfig getOutputDataConfig()

Specifies where to send the output files.

Returns:

Specifies where to send the output files.

setOutputDataConfig

public void setOutputDataConfig(OutputDataConfig outputDataConfig)

Specifies where to send the output files.

Parameters:

outputDataConfig -

Specifies where to send the output files.

withOutputDataConfig

public StartEventsDetectionJobRequest withOutputDataConfig(OutputDataConfig outputDataConfig)

Specifies where to send the output files.

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

Parameters:

outputDataConfig -

Specifies where to send the output files.

Returns:

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

getDataAccessRoleArn

public java.lang.String getDataAccessRoleArn()

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Returns:

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

setDataAccessRoleArn

public void setDataAccessRoleArn(java.lang.String dataAccessRoleArn)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Parameters:

dataAccessRoleArn -

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

withDataAccessRoleArn

public StartEventsDetectionJobRequest withDataAccessRoleArn(java.lang.String dataAccessRoleArn)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

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

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Parameters:

dataAccessRoleArn -

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Returns:

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

getJobName

public java.lang.String getJobName()

The identifier of the events detection job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Returns:

The identifier of the events detection job.

setJobName

public void setJobName(java.lang.String jobName)

The identifier of the events detection job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Parameters:

jobName -

The identifier of the events detection job.

withJobName

public StartEventsDetectionJobRequest withJobName(java.lang.String jobName)

The identifier of the events detection job.

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

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Parameters:

jobName -

The identifier of the events detection job.

Returns:

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

getLanguageCode

public java.lang.String getLanguageCode()

The language code of the input documents.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Returns:

The language code of the input documents.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(java.lang.String languageCode)

The language code of the input documents.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Parameters:

languageCode -

The language code of the input documents.

See Also:

LanguageCode

withLanguageCode

public StartEventsDetectionJobRequest withLanguageCode(java.lang.String languageCode)

The language code of the input documents.

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

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Parameters:

languageCode -

The language code of the input documents.

Returns:

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

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(LanguageCode languageCode)

The language code of the input documents.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Parameters:

languageCode -

The language code of the input documents.

See Also:

LanguageCode

withLanguageCode

public StartEventsDetectionJobRequest withLanguageCode(LanguageCode languageCode)

The language code of the input documents.

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

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Parameters:

languageCode -

The language code of the input documents.

Returns:

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

See Also:

LanguageCode

getClientRequestToken

public java.lang.String getClientRequestToken()

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

Returns:

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

setClientRequestToken

public void setClientRequestToken(java.lang.String clientRequestToken)

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

Parameters:

clientRequestToken -

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

withClientRequestToken

public StartEventsDetectionJobRequest withClientRequestToken(java.lang.String clientRequestToken)

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

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

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

Parameters:

clientRequestToken -

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Returns:

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

getTargetEventTypes

public java.util.List<java.lang.String> getTargetEventTypes()

The types of events to detect in the input documents.

Returns:

The types of events to detect in the input documents.

setTargetEventTypes

public void setTargetEventTypes(java.util.Collection<java.lang.String> targetEventTypes)

The types of events to detect in the input documents.

Parameters:

targetEventTypes -

The types of events to detect in the input documents.

withTargetEventTypes

public StartEventsDetectionJobRequest withTargetEventTypes(java.lang.String... targetEventTypes)

The types of events to detect in the input documents.

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

Parameters:

targetEventTypes -

The types of events to detect in the input documents.

Returns:

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

withTargetEventTypes

public StartEventsDetectionJobRequest withTargetEventTypes(java.util.Collection<java.lang.String> targetEventTypes)

The types of events to detect in the input documents.

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

Parameters:

targetEventTypes -

The types of events to detect in the input documents.

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