@Generated(value="software.amazon.awssdk:codegen") public final class TopicsDetectionJobProperties extends Object implements StructuredPojo, ToCopyableBuilder<TopicsDetectionJobProperties.Builder,TopicsDetectionJobProperties>
Provides information about a topic detection job.
Modifier and Type | Class and Description |
---|---|
static interface |
TopicsDetectionJobProperties.Builder |
Modifier and Type | Method and Description |
---|---|
static TopicsDetectionJobProperties.Builder |
builder() |
Instant |
endTime()
The time that the topic detection job was completed.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
InputDataConfig |
inputDataConfig()
The input data configuration supplied when you created the topic detection job.
|
String |
jobId()
The identifier assigned to the topic detection job.
|
String |
jobName()
The name of the topic detection job.
|
JobStatus |
jobStatus()
The current status of the topic detection job.
|
String |
jobStatusAsString()
The current status of the topic detection job.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
message()
A description for the status of a job.
|
Integer |
numberOfTopics()
The number of topics to detect supplied when you created the topic detection job.
|
OutputDataConfig |
outputDataConfig()
The output data configuration supplied when you created the topic detection job.
|
static Class<? extends TopicsDetectionJobProperties.Builder> |
serializableBuilderClass() |
Instant |
submitTime()
The time that the topic detection job was submitted for processing.
|
TopicsDetectionJobProperties.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String jobId()
The identifier assigned to the topic detection job.
public String jobName()
The name of the topic detection job.
public 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.
If the service returns an enum value that is not available in the current SDK version, jobStatus
will
return JobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
jobStatusAsString()
.
Failed
, the reason for the
failure is shown in the Message
field.JobStatus
public String jobStatusAsString()
The current status of the topic detection job. If the status is Failed
, the reason for the failure
is shown in the Message
field.
If the service returns an enum value that is not available in the current SDK version, jobStatus
will
return JobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
jobStatusAsString()
.
Failed
, the reason for the
failure is shown in the Message
field.JobStatus
public String message()
A description for the status of a job.
public Instant submitTime()
The time that the topic detection job was submitted for processing.
public Instant endTime()
The time that the topic detection job was completed.
public InputDataConfig inputDataConfig()
The input data configuration supplied when you created the topic detection job.
public OutputDataConfig outputDataConfig()
The output data configuration supplied when you created the topic detection job.
public Integer numberOfTopics()
The number of topics to detect supplied when you created the topic detection job. The default is 10.
public TopicsDetectionJobProperties.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<TopicsDetectionJobProperties.Builder,TopicsDetectionJobProperties>
public static TopicsDetectionJobProperties.Builder builder()
public static Class<? extends TopicsDetectionJobProperties.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.