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

Class DocumentClassifierFilter

java.lang.Object

software.amazon.awssdk.services.comprehend.model.DocumentClassifierFilter

All Implemented Interfaces:

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

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

Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the ListDocumentClassifiers operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentClassifierFilter.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentClassifierFilter.Builder	builder()
String	documentClassifierName()	The name that you assigned to the document classifier
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentClassifierFilter.Builder>	serializableBuilderClass()
ModelStatus	status()	Filters the list of classifiers based on status.
String	statusAsString()	Filters the list of classifiers based on status.
Instant	submitTimeAfter()	Filters the list of classifiers based on the time that the classifier was submitted for processing.
Instant	submitTimeBefore()	Filters the list of classifiers based on the time that the classifier was submitted for processing.
DocumentClassifierFilter.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

status

public final ModelStatus status()

Filters the list of classifiers based on status.

If the service returns an enum value that is not available in the current SDK version, status will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Filters the list of classifiers based on status.

See Also:

ModelStatus

statusAsString

public final String statusAsString()

Filters the list of classifiers based on status.

If the service returns an enum value that is not available in the current SDK version, status will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Filters the list of classifiers based on status.

See Also:

ModelStatus

documentClassifierName

public final String documentClassifierName()

The name that you assigned to the document classifier

Returns:

The name that you assigned to the document classifier

submitTimeBefore

public final Instant submitTimeBefore()

Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.

Returns:

Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.

submitTimeAfter

public final Instant submitTimeAfter()

Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.

Returns:

Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.

toBuilder

public DocumentClassifierFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentClassifierFilter.Builder,DocumentClassifierFilter>

builder

public static DocumentClassifierFilter.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentClassifierFilter.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