Package software.amazon.awssdk.services.comprehend.model

Class TopicsDetectionJobFilter

java.lang.Object

software.amazon.awssdk.services.comprehend.model.TopicsDetectionJobFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TopicsDetectionJobFilter.Builder,TopicsDetectionJobFilter>

@Generated("software.amazon.awssdk:codegen")
public final class TopicsDetectionJobFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TopicsDetectionJobFilter.Builder,TopicsDetectionJobFilter>

Provides information for filtering topic detection jobs. For more information, see .

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TopicsDetectionJobFilter.Builder

Method Summary

Modifier and Type	Method	Description
static TopicsDetectionJobFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobName()
JobStatus	jobStatus()	Filters the list of topic detection jobs based on job status.
String	jobStatusAsString()	Filters the list of topic detection jobs based on job status.
List<SdkField<?>>	sdkFields()
static Class<? extends TopicsDetectionJobFilter.Builder>	serializableBuilderClass()
Instant	submitTimeAfter()	Filters the list of jobs based on the time that the job was submitted for processing.
Instant	submitTimeBefore()	Filters the list of jobs based on the time that the job was submitted for processing.
TopicsDetectionJobFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

jobName

public final String jobName()

Returns:

jobStatus

public final JobStatus jobStatus()

Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.

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

Returns:

Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.

See Also:

JobStatus

jobStatusAsString

public final String jobStatusAsString()

Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.

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

Returns:

Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.

See Also:

JobStatus

submitTimeBefore

public final Instant submitTimeBefore()

Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

Returns:

Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

submitTimeAfter

public final Instant submitTimeAfter()

Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

Returns:

Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

toBuilder

public TopicsDetectionJobFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TopicsDetectionJobFilter.Builder,TopicsDetectionJobFilter>

builder

public static TopicsDetectionJobFilter.Builder builder()

serializableBuilderClass

public static Class<? extends TopicsDetectionJobFilter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo