KeyPhrasesDetectionJobProperties (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.comprehend.model.KeyPhrasesDetectionJobProperties

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Provides information about a key phrases detection job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KeyPhrasesDetectionJobProperties()

Constructors
Constructor and Description
`KeyPhrasesDetectionJobProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KeyPhrasesDetectionJobProperties`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDataAccessRoleArn()` The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
`Date`	`getEndTime()` The time that the key phrases detection job completed.
`InputDataConfig`	`getInputDataConfig()` The input data configuration that you supplied when you created the key phrases detection job.
`String`	`getJobId()` The identifier assigned to the key phrases detection job.
`String`	`getJobName()` The name that you assigned the key phrases detection job.
`String`	`getJobStatus()` The current status of the key phrases detection job.
`String`	`getLanguageCode()` The language code of the input documents.
`String`	`getMessage()` A description of the status of a job.
`OutputDataConfig`	`getOutputDataConfig()` The output data configuration that you supplied when you created the key phrases detection job.
`Date`	`getSubmitTime()` The time that the key phrases detection job was submitted for processing.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
`void`	`setEndTime(Date endTime)` The time that the key phrases detection job completed.
`void`	`setInputDataConfig(InputDataConfig inputDataConfig)` The input data configuration that you supplied when you created the key phrases detection job.
`void`	`setJobId(String jobId)` The identifier assigned to the key phrases detection job.
`void`	`setJobName(String jobName)` The name that you assigned the key phrases detection job.
`void`	`setJobStatus(String jobStatus)` The current status of the key phrases detection job.
`void`	`setLanguageCode(String languageCode)` The language code of the input documents.
`void`	`setMessage(String message)` A description of the status of a job.
`void`	`setOutputDataConfig(OutputDataConfig outputDataConfig)` The output data configuration that you supplied when you created the key phrases detection job.
`void`	`setSubmitTime(Date submitTime)` The time that the key phrases detection job was submitted for processing.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`KeyPhrasesDetectionJobProperties`	`withDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
`KeyPhrasesDetectionJobProperties`	`withEndTime(Date endTime)` The time that the key phrases detection job completed.
`KeyPhrasesDetectionJobProperties`	`withInputDataConfig(InputDataConfig inputDataConfig)` The input data configuration that you supplied when you created the key phrases detection job.
`KeyPhrasesDetectionJobProperties`	`withJobId(String jobId)` The identifier assigned to the key phrases detection job.
`KeyPhrasesDetectionJobProperties`	`withJobName(String jobName)` The name that you assigned the key phrases detection job.
`KeyPhrasesDetectionJobProperties`	`withJobStatus(JobStatus jobStatus)` The current status of the key phrases detection job.
`KeyPhrasesDetectionJobProperties`	`withJobStatus(String jobStatus)` The current status of the key phrases detection job.
`KeyPhrasesDetectionJobProperties`	`withLanguageCode(LanguageCode languageCode)` The language code of the input documents.
`KeyPhrasesDetectionJobProperties`	`withLanguageCode(String languageCode)` The language code of the input documents.
`KeyPhrasesDetectionJobProperties`	`withMessage(String message)` A description of the status of a job.
`KeyPhrasesDetectionJobProperties`	`withOutputDataConfig(OutputDataConfig outputDataConfig)` The output data configuration that you supplied when you created the key phrases detection job.
`KeyPhrasesDetectionJobProperties`	`withSubmitTime(Date submitTime)` The time that the key phrases detection job was submitted for processing.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KeyPhrasesDetectionJobProperties
```
public KeyPhrasesDetectionJobProperties()
```
- Method Detail
  - setJobId
```
public void setJobId(String jobId)
```
    The identifier assigned to the key phrases detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the key phrases detection job.
  - getJobId
```
public String getJobId()
```
    The identifier assigned to the key phrases detection job.
    
    Returns:
    
    The identifier assigned to the key phrases detection job.
  - withJobId
```
public KeyPhrasesDetectionJobProperties withJobId(String jobId)
```
    The identifier assigned to the key phrases detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the key phrases detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobName
```
public void setJobName(String jobName)
```
    The name that you assigned the key phrases detection job.
    
    Parameters:
    
    jobName - The name that you assigned the key phrases detection job.
  - getJobName
```
public String getJobName()
```
    The name that you assigned the key phrases detection job.
    
    Returns:
    
    The name that you assigned the key phrases detection job.
  - withJobName
```
public KeyPhrasesDetectionJobProperties withJobName(String jobName)
```
    The name that you assigned the key phrases detection job.
    
    Parameters:
    
    jobName - The name that you assigned the key phrases detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobStatus
```
public void setJobStatus(String jobStatus)
```
    The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    See Also:
    
    JobStatus
  - getJobStatus
```
public String getJobStatus()
```
    The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Returns:
    
    The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public KeyPhrasesDetectionJobProperties withJobStatus(String jobStatus)
```
    The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public KeyPhrasesDetectionJobProperties withJobStatus(JobStatus jobStatus)
```
    The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setMessage
```
public void setMessage(String message)
```
    A description of the status of a job.
    
    Parameters:
    
    message - A description of the status of a job.
  - getMessage
```
public String getMessage()
```
    A description of the status of a job.
    
    Returns:
    
    A description of the status of a job.
  - withMessage
```
public KeyPhrasesDetectionJobProperties withMessage(String message)
```
    A description of the status of a job.
    
    Parameters:
    
    message - A description of the status of a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubmitTime
```
public void setSubmitTime(Date submitTime)
```
    The time that the key phrases detection job was submitted for processing.
    
    Parameters:
    
    submitTime - The time that the key phrases detection job was submitted for processing.
  - getSubmitTime
```
public Date getSubmitTime()
```
    The time that the key phrases detection job was submitted for processing.
    
    Returns:
    
    The time that the key phrases detection job was submitted for processing.
  - withSubmitTime
```
public KeyPhrasesDetectionJobProperties withSubmitTime(Date submitTime)
```
    The time that the key phrases detection job was submitted for processing.
    
    Parameters:
    
    submitTime - The time that the key phrases detection job was submitted for processing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The time that the key phrases detection job completed.
    
    Parameters:
    
    endTime - The time that the key phrases detection job completed.
  - getEndTime
```
public Date getEndTime()
```
    The time that the key phrases detection job completed.
    
    Returns:
    
    The time that the key phrases detection job completed.
  - withEndTime
```
public KeyPhrasesDetectionJobProperties withEndTime(Date endTime)
```
    The time that the key phrases detection job completed.
    
    Parameters:
    
    endTime - The time that the key phrases detection job completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputDataConfig
```
public void setInputDataConfig(InputDataConfig inputDataConfig)
```
    The input data configuration that you supplied when you created the key phrases detection job.
    
    Parameters:
    
    inputDataConfig - The input data configuration that you supplied when you created the key phrases detection job.
  - getInputDataConfig
```
public InputDataConfig getInputDataConfig()
```
    The input data configuration that you supplied when you created the key phrases detection job.
    
    Returns:
    
    The input data configuration that you supplied when you created the key phrases detection job.
  - withInputDataConfig
```
public KeyPhrasesDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig)
```
    The input data configuration that you supplied when you created the key phrases detection job.
    
    Parameters:
    
    inputDataConfig - The input data configuration that you supplied when you created the key phrases detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputDataConfig
```
public void setOutputDataConfig(OutputDataConfig outputDataConfig)
```
    The output data configuration that you supplied when you created the key phrases detection job.
    
    Parameters:
    
    outputDataConfig - The output data configuration that you supplied when you created the key phrases detection job.
  - getOutputDataConfig
```
public OutputDataConfig getOutputDataConfig()
```
    The output data configuration that you supplied when you created the key phrases detection job.
    
    Returns:
    
    The output data configuration that you supplied when you created the key phrases detection job.
  - withOutputDataConfig
```
public KeyPhrasesDetectionJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig)
```
    The output data configuration that you supplied when you created the key phrases detection job.
    
    Parameters:
    
    outputDataConfig - The output data configuration that you supplied when you created the key phrases 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 KeyPhrasesDetectionJobProperties 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 KeyPhrasesDetectionJobProperties 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
  - setDataAccessRoleArn
```
public void setDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
  - getDataAccessRoleArn
```
public String getDataAccessRoleArn()
```
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    
    Returns:
    
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
  - withDataAccessRoleArn
```
public KeyPhrasesDetectionJobProperties withDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    
    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; useful for testing and debugging.
    
    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 KeyPhrasesDetectionJobProperties 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.

Did this page help you?

Class KeyPhrasesDetectionJobProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeyPhrasesDetectionJobProperties

Method Detail

setJobId

getJobId

withJobId

setJobName

getJobName

withJobName

setJobStatus

getJobStatus

withJobStatus

withJobStatus

setMessage

getMessage

withMessage

setSubmitTime

getSubmitTime

withSubmitTime

setEndTime

getEndTime

withEndTime

setInputDataConfig

getInputDataConfig

withInputDataConfig

setOutputDataConfig

getOutputDataConfig

withOutputDataConfig

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

setDataAccessRoleArn

getDataAccessRoleArn

withDataAccessRoleArn

toString

equals

hashCode

clone

marshall