All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartDocumentClassificationJobRequest
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
  StartDocumentClassificationJobRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  StartDocumentClassificationJobRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getClientRequestToken () A 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.
  String	getDocumentClassifierArn () The Amazon Resource Name (ARN) of the document classifier to use to process the job.
  String	getFlywheelArn () The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
  InputDataConfig	getInputDataConfig () Specifies the format and location of the input data for the job.
  String	getJobName () The identifier of the job.
  OutputDataConfig	getOutputDataConfig () Specifies where to send the output files.
  List<Tag>	getTags () Tags to associate with the document classification job.
  String	getVolumeKmsKeyId () ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
  VpcConfig	getVpcConfig () Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job.
  int	hashCode ()
  void	setClientRequestToken (String clientRequestToken) A 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	setDocumentClassifierArn (String documentClassifierArn) The Amazon Resource Name (ARN) of the document classifier to use to process the job.
  void	setFlywheelArn (String flywheelArn) The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
  void	setInputDataConfig (InputDataConfig inputDataConfig) Specifies the format and location of the input data for the job.
  void	setJobName (String jobName) The identifier of the job.
  void	setOutputDataConfig (OutputDataConfig outputDataConfig) Specifies where to send the output files.
  void	setTags (Collection<Tag> tags) Tags to associate with the document classification job.
  void	setVolumeKmsKeyId (String volumeKmsKeyId) ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
  void	setVpcConfig (VpcConfig vpcConfig) Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job.
  String	toString () Returns a string representation of this object.
  StartDocumentClassificationJobRequest	withClientRequestToken (String clientRequestToken) A unique identifier for the request.
  StartDocumentClassificationJobRequest	withDataAccessRoleArn (String dataAccessRoleArn) The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  StartDocumentClassificationJobRequest	withDocumentClassifierArn (String documentClassifierArn) The Amazon Resource Name (ARN) of the document classifier to use to process the job.
  StartDocumentClassificationJobRequest	withFlywheelArn (String flywheelArn) The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
  StartDocumentClassificationJobRequest	withInputDataConfig (InputDataConfig inputDataConfig) Specifies the format and location of the input data for the job.
  StartDocumentClassificationJobRequest	withJobName (String jobName) The identifier of the job.
  StartDocumentClassificationJobRequest	withOutputDataConfig (OutputDataConfig outputDataConfig) Specifies where to send the output files.
  StartDocumentClassificationJobRequest	withTags (Collection<Tag> tags) Tags to associate with the document classification job.
  StartDocumentClassificationJobRequest	withTags (Tag... tags) Tags to associate with the document classification job.
  StartDocumentClassificationJobRequest	withVolumeKmsKeyId (String volumeKmsKeyId) ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
  StartDocumentClassificationJobRequest	withVpcConfig (VpcConfig vpcConfig) Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job.

  • 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

  • StartDocumentClassificationJobRequest

    public StartDocumentClassificationJobRequest()

• Method Detail

  • setJobName

    public void setJobName(String jobName)

    The identifier of the job.

    Parameters:

    jobName - The identifier of the job.

  • getJobName

    public String getJobName()

    The identifier of the job.

    Returns:

    The identifier of the job.

  • withJobName

    public StartDocumentClassificationJobRequest withJobName(String jobName)

    The identifier of the job.

    Parameters:

    jobName - The identifier of the job.

    Returns:

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

  • setDocumentClassifierArn

    public void setDocumentClassifierArn(String documentClassifierArn)

    The Amazon Resource Name (ARN) of the document classifier to use to process the job.

    Parameters:

    documentClassifierArn - The Amazon Resource Name (ARN) of the document classifier to use to process the job.

  • getDocumentClassifierArn

    public String getDocumentClassifierArn()

    The Amazon Resource Name (ARN) of the document classifier to use to process the job.

    Returns:

    The Amazon Resource Name (ARN) of the document classifier to use to process the job.

  • withDocumentClassifierArn

    public StartDocumentClassificationJobRequest withDocumentClassifierArn(String documentClassifierArn)

    The Amazon Resource Name (ARN) of the document classifier to use to process the job.

    Parameters:

    documentClassifierArn - The Amazon Resource Name (ARN) of the document classifier to use to process the job.

    Returns:

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

  • 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 StartDocumentClassificationJobRequest 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 StartDocumentClassificationJobRequest 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 StartDocumentClassificationJobRequest 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.

  • setClientRequestToken

    public void setClientRequestToken(String clientRequestToken)

    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

    Parameters:

    clientRequestToken - A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

  • getClientRequestToken

    public String getClientRequestToken()

    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

    Returns:

    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

  • withClientRequestToken

    public StartDocumentClassificationJobRequest withClientRequestToken(String clientRequestToken)

    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

    Parameters:

    clientRequestToken - A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

    Returns:

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

  • setVolumeKmsKeyId

    public void setVolumeKmsKeyId(String volumeKmsKeyId)

    ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

    • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

    • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

    Parameters:

    volumeKmsKeyId - ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

    • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

    • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • getVolumeKmsKeyId

    public String getVolumeKmsKeyId()

    ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

    • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

    • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

    Returns:

    ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

    • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

    • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • withVolumeKmsKeyId

    public StartDocumentClassificationJobRequest withVolumeKmsKeyId(String volumeKmsKeyId)

    ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

    • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

    • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

    Parameters:

    volumeKmsKeyId - ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

    • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

    • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

    Returns:

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

  • setVpcConfig

    public void setVpcConfig(VpcConfig vpcConfig)

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

    Parameters:

    vpcConfig - Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

  • getVpcConfig

    public VpcConfig getVpcConfig()

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

    Returns:

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

  • withVpcConfig

    public StartDocumentClassificationJobRequest withVpcConfig(VpcConfig vpcConfig)

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

    Parameters:

    vpcConfig - Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

    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 document classification 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 document classification 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 document classification 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 document classification 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 StartDocumentClassificationJobRequest withTags(Tag... tags)

    Tags to associate with the document classification 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 document classification 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 StartDocumentClassificationJobRequest withTags(Collection<Tag> tags)

    Tags to associate with the document classification 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 document classification 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.

  • setFlywheelArn

    public void setFlywheelArn(String flywheelArn)

    The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

    Parameters:

    flywheelArn - The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

  • getFlywheelArn

    public String getFlywheelArn()

    The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

    Returns:

    The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

  • withFlywheelArn

    public StartDocumentClassificationJobRequest withFlywheelArn(String flywheelArn)

    The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

    Parameters:

    flywheelArn - The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

    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 StartDocumentClassificationJobRequest 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()