com.amazonaws.services.comprehend.model

Class StartEventsDetectionJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.comprehend.model.StartEventsDetectionJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartEventsDetectionJobRequest()

Method Summary

Modifier and Type	Method and Description
StartEventsDetectionJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() An unique identifier for the request.
String	getDataAccessRoleArn() The Amazon Resource Name (ARN) of the 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.
String	getJobName() The identifier of the events detection job.
String	getLanguageCode() The language code of the input documents.
OutputDataConfig	getOutputDataConfig() Specifies where to send the output files.
List<Tag>	getTags() Tags to associate with the events detection job.
List<String>	getTargetEventTypes() The types of events to detect in the input documents.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) An unique identifier for the request.
void	setDataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the 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(String jobName) The identifier of the events detection job.
void	setLanguageCode(String languageCode) The language code of the input documents.
void	setOutputDataConfig(OutputDataConfig outputDataConfig) Specifies where to send the output files.
void	setTags(Collection<Tag> tags) Tags to associate with the events detection job.
void	setTargetEventTypes(Collection<String> targetEventTypes) The types of events to detect in the input documents.
String	toString() Returns a string representation of this object.
StartEventsDetectionJobRequest	withClientRequestToken(String clientRequestToken) An unique identifier for the request.
StartEventsDetectionJobRequest	withDataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the 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(String jobName) The identifier of the events detection job.
StartEventsDetectionJobRequest	withLanguageCode(LanguageCode languageCode) The language code of the input documents.
StartEventsDetectionJobRequest	withLanguageCode(String languageCode) The language code of the input documents.
StartEventsDetectionJobRequest	withOutputDataConfig(OutputDataConfig outputDataConfig) Specifies where to send the output files.
StartEventsDetectionJobRequest	withTags(Collection<Tag> tags) Tags to associate with the events detection job.
StartEventsDetectionJobRequest	withTags(Tag... tags) Tags to associate with the events detection job.
StartEventsDetectionJobRequest	withTargetEventTypes(Collection<String> targetEventTypes) The types of events to detect in the input documents.
StartEventsDetectionJobRequest	withTargetEventTypes(String... targetEventTypes) The types of events to detect in the input documents.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartEventsDetectionJobRequest

public StartEventsDetectionJobRequest()

Method Detail

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.

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.

withInputDataConfig

public StartEventsDetectionJobRequest withInputDataConfig(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.

Returns:

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

setOutputDataConfig

public void setOutputDataConfig(OutputDataConfig outputDataConfig)

Specifies where to send the output files.

Parameters:

outputDataConfig - Specifies where to send the output files.

getOutputDataConfig

public OutputDataConfig getOutputDataConfig()

Specifies where to send the output files.

Returns:

Specifies where to send the output files.

withOutputDataConfig

public StartEventsDetectionJobRequest withOutputDataConfig(OutputDataConfig outputDataConfig)

Specifies where to send the output files.

Parameters:

outputDataConfig - Specifies where to send the output files.

Returns:

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

setDataAccessRoleArn

public void setDataAccessRoleArn(String dataAccessRoleArn)

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

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

getDataAccessRoleArn

public String getDataAccessRoleArn()

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

Returns:

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

withDataAccessRoleArn

public StartEventsDetectionJobRequest withDataAccessRoleArn(String dataAccessRoleArn)

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

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Returns:

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

setJobName

public void setJobName(String jobName)

The identifier of the events detection job.

Parameters:

jobName - The identifier of the events detection job.

getJobName

public String getJobName()

The identifier of the events detection job.

Returns:

The identifier of the events detection job.

withJobName

public StartEventsDetectionJobRequest withJobName(String jobName)

The identifier of the events detection job.

Parameters:

jobName - The identifier of the events detection job.

Returns:

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

setLanguageCode

public void setLanguageCode(String languageCode)

The language code of the input documents.

Parameters:

languageCode - The language code of the input documents.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

The language code of the input documents.

Returns:

The language code of the input documents.

See Also:

LanguageCode

withLanguageCode

public StartEventsDetectionJobRequest withLanguageCode(String languageCode)

The language code of the input documents.

Parameters:

languageCode - The language code of the input documents.

Returns:

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

See Also:

LanguageCode

withLanguageCode

public StartEventsDetectionJobRequest withLanguageCode(LanguageCode languageCode)

The language code of the input documents.

Parameters:

languageCode - The language code of the input documents.

Returns:

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

See Also:

LanguageCode

setClientRequestToken

public void setClientRequestToken(String clientRequestToken)

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

Parameters:

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

getClientRequestToken

public String getClientRequestToken()

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

Returns:

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

withClientRequestToken

public StartEventsDetectionJobRequest withClientRequestToken(String clientRequestToken)

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

Parameters:

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

Returns:

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

getTargetEventTypes

public List<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(Collection<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(String... targetEventTypes)

The types of events to detect in the input documents.

NOTE: This method appends the values to the existing list (if any). Use setTargetEventTypes(java.util.Collection) or withTargetEventTypes(java.util.Collection) if you want to override the existing values.

Parameters:

targetEventTypes - The types of events to detect in the input documents.

Returns:

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

withTargetEventTypes

public StartEventsDetectionJobRequest withTargetEventTypes(Collection<String> targetEventTypes)

The types of events to detect in the input documents.

Parameters:

targetEventTypes - The types of events to detect in the input documents.

Returns:

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

getTags

public List<Tag> getTags()

Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns:

Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

setTags

public void setTags(Collection<Tag> tags)

Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Parameters:

tags - Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

withTags

public StartEventsDetectionJobRequest withTags(Tag... tags)

Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns:

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

withTags

public StartEventsDetectionJobRequest withTags(Collection<Tag> tags)

Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Parameters:

tags - Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

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 StartEventsDetectionJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()