TopicsDetectionJobProperties (AWS Java SDK for Amazon Comprehend 1.11.482 API)

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Provides information about a topic detection job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TopicsDetectionJobProperties()

Constructors
Constructor and Description
`TopicsDetectionJobProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TopicsDetectionJobProperties`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getEndTime()` The time that the topic detection job was completed.
`InputDataConfig`	`getInputDataConfig()` The input data configuration supplied when you created the topic detection job.
`String`	`getJobId()` The identifier assigned to the topic detection job.
`String`	`getJobName()` The name of the topic detection job.
`String`	`getJobStatus()` The current status of the topic detection job.
`String`	`getMessage()` A description for the status of a job.
`Integer`	`getNumberOfTopics()` The number of topics to detect supplied when you created the topic detection job.
`OutputDataConfig`	`getOutputDataConfig()` The output data configuration supplied when you created the topic detection job.
`Date`	`getSubmitTime()` The time that the topic detection job was submitted for processing.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setEndTime(Date endTime)` The time that the topic detection job was completed.
`void`	`setInputDataConfig(InputDataConfig inputDataConfig)` The input data configuration supplied when you created the topic detection job.
`void`	`setJobId(String jobId)` The identifier assigned to the topic detection job.
`void`	`setJobName(String jobName)` The name of the topic detection job.
`void`	`setJobStatus(String jobStatus)` The current status of the topic detection job.
`void`	`setMessage(String message)` A description for the status of a job.
`void`	`setNumberOfTopics(Integer numberOfTopics)` The number of topics to detect supplied when you created the topic detection job.
`void`	`setOutputDataConfig(OutputDataConfig outputDataConfig)` The output data configuration supplied when you created the topic detection job.
`void`	`setSubmitTime(Date submitTime)` The time that the topic detection job was submitted for processing.
`String`	`toString()` Returns a string representation of this object.
`TopicsDetectionJobProperties`	`withEndTime(Date endTime)` The time that the topic detection job was completed.
`TopicsDetectionJobProperties`	`withInputDataConfig(InputDataConfig inputDataConfig)` The input data configuration supplied when you created the topic detection job.
`TopicsDetectionJobProperties`	`withJobId(String jobId)` The identifier assigned to the topic detection job.
`TopicsDetectionJobProperties`	`withJobName(String jobName)` The name of the topic detection job.
`TopicsDetectionJobProperties`	`withJobStatus(JobStatus jobStatus)` The current status of the topic detection job.
`TopicsDetectionJobProperties`	`withJobStatus(String jobStatus)` The current status of the topic detection job.
`TopicsDetectionJobProperties`	`withMessage(String message)` A description for the status of a job.
`TopicsDetectionJobProperties`	`withNumberOfTopics(Integer numberOfTopics)` The number of topics to detect supplied when you created the topic detection job.
`TopicsDetectionJobProperties`	`withOutputDataConfig(OutputDataConfig outputDataConfig)` The output data configuration supplied when you created the topic detection job.
`TopicsDetectionJobProperties`	`withSubmitTime(Date submitTime)` The time that the topic detection job was submitted for processing.

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

- Constructor Detail
  - TopicsDetectionJobProperties
```
public TopicsDetectionJobProperties()
```
- Method Detail
  - setJobId
```
public void setJobId(String jobId)
```
    The identifier assigned to the topic detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the topic detection job.
  - getJobId
```
public String getJobId()
```
    The identifier assigned to the topic detection job.
    
    Returns:
    
    The identifier assigned to the topic detection job.
  - withJobId
```
public TopicsDetectionJobProperties withJobId(String jobId)
```
    The identifier assigned to the topic detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the topic 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 of the topic detection job.
    
    Parameters:
    
    jobName - The name of the topic detection job.
  - getJobName
```
public String getJobName()
```
    The name of the topic detection job.
    
    Returns:
    
    The name of the topic detection job.
  - withJobName
```
public TopicsDetectionJobProperties withJobName(String jobName)
```
    The name of the topic detection job.
    
    Parameters:
    
    jobName - The name of the topic 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 topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    Parameters:
    
    jobStatus - The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    See Also:
    
    JobStatus
  - getJobStatus
```
public String getJobStatus()
```
    The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    Returns:
    
    The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public TopicsDetectionJobProperties withJobStatus(String jobStatus)
```
    The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    Parameters:
    
    jobStatus - The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public TopicsDetectionJobProperties withJobStatus(JobStatus jobStatus)
```
    The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    Parameters:
    
    jobStatus - The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    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 for the status of a job.
    
    Parameters:
    
    message - A description for the status of a job.
  - getMessage
```
public String getMessage()
```
    A description for the status of a job.
    
    Returns:
    
    A description for the status of a job.
  - withMessage
```
public TopicsDetectionJobProperties withMessage(String message)
```
    A description for the status of a job.
    
    Parameters:
    
    message - A description for 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 topic detection job was submitted for processing.
    
    Parameters:
    
    submitTime - The time that the topic detection job was submitted for processing.
  - getSubmitTime
```
public Date getSubmitTime()
```
    The time that the topic detection job was submitted for processing.
    
    Returns:
    
    The time that the topic detection job was submitted for processing.
  - withSubmitTime
```
public TopicsDetectionJobProperties withSubmitTime(Date submitTime)
```
    The time that the topic detection job was submitted for processing.
    
    Parameters:
    
    submitTime - The time that the topic 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 topic detection job was completed.
    
    Parameters:
    
    endTime - The time that the topic detection job was completed.
  - getEndTime
```
public Date getEndTime()
```
    The time that the topic detection job was completed.
    
    Returns:
    
    The time that the topic detection job was completed.
  - withEndTime
```
public TopicsDetectionJobProperties withEndTime(Date endTime)
```
    The time that the topic detection job was completed.
    
    Parameters:
    
    endTime - The time that the topic detection job was 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 supplied when you created the topic detection job.
    
    Parameters:
    
    inputDataConfig - The input data configuration supplied when you created the topic detection job.
  - getInputDataConfig
```
public InputDataConfig getInputDataConfig()
```
    The input data configuration supplied when you created the topic detection job.
    
    Returns:
    
    The input data configuration supplied when you created the topic detection job.
  - withInputDataConfig
```
public TopicsDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig)
```
    The input data configuration supplied when you created the topic detection job.
    
    Parameters:
    
    inputDataConfig - The input data configuration supplied when you created the topic 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 supplied when you created the topic detection job.
    
    Parameters:
    
    outputDataConfig - The output data configuration supplied when you created the topic detection job.
  - getOutputDataConfig
```
public OutputDataConfig getOutputDataConfig()
```
    The output data configuration supplied when you created the topic detection job.
    
    Returns:
    
    The output data configuration supplied when you created the topic detection job.
  - withOutputDataConfig
```
public TopicsDetectionJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig)
```
    The output data configuration supplied when you created the topic detection job.
    
    Parameters:
    
    outputDataConfig - The output data configuration supplied when you created the topic detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumberOfTopics
```
public void setNumberOfTopics(Integer numberOfTopics)
```
    The number of topics to detect supplied when you created the topic detection job. The default is 10.
    
    Parameters:
    
    numberOfTopics - The number of topics to detect supplied when you created the topic detection job. The default is 10.
  - getNumberOfTopics
```
public Integer getNumberOfTopics()
```
    The number of topics to detect supplied when you created the topic detection job. The default is 10.
    
    Returns:
    
    The number of topics to detect supplied when you created the topic detection job. The default is 10.
  - withNumberOfTopics
```
public TopicsDetectionJobProperties withNumberOfTopics(Integer numberOfTopics)
```
    The number of topics to detect supplied when you created the topic detection job. The default is 10.
    
    Parameters:
    
    numberOfTopics - The number of topics to detect supplied when you created the topic detection job. The default is 10.
    
    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 TopicsDetectionJobProperties clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class TopicsDetectionJobProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TopicsDetectionJobProperties

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

setNumberOfTopics

getNumberOfTopics

withNumberOfTopics

toString

equals

hashCode

clone

marshall