software.amazon.awssdk.services.comprehend.model

Class ListDocumentClassificationJobsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.comprehend.model.ComprehendRequest

software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListDocumentClassificationJobsRequest.Builder,ListDocumentClassificationJobsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListDocumentClassificationJobsRequest
extends ComprehendRequest
implements ToCopyableBuilder<ListDocumentClassificationJobsRequest.Builder,ListDocumentClassificationJobsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListDocumentClassificationJobsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListDocumentClassificationJobsRequest.Builder	builder()
boolean	equals(Object obj)
DocumentClassificationJobFilter	filter() Filters the jobs that are returned.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of results to return in each page.
String	nextToken() Identifies the next page of results to return.
List<SdkField<?>>	sdkFields()
static Class<? extends ListDocumentClassificationJobsRequest.Builder>	serializableBuilderClass()
ListDocumentClassificationJobsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

filter

public DocumentClassificationJobFilter filter()

Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

Returns:

Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

nextToken

public String nextToken()

Identifies the next page of results to return.

Returns:

Identifies the next page of results to return.

maxResults

public Integer maxResults()

The maximum number of results to return in each page. The default is 100.

Returns:

The maximum number of results to return in each page. The default is 100.

toBuilder

public ListDocumentClassificationJobsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListDocumentClassificationJobsRequest.Builder,ListDocumentClassificationJobsRequest>

Specified by:

toBuilder in class ComprehendRequest

Returns:

a builder for type T

builder

public static ListDocumentClassificationJobsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.