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

Class DocumentClassificationJobFilter

java.lang.Object
software.amazon.awssdk.services.comprehend.model.DocumentClassificationJobFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DocumentClassificationJobFilter.Builder,DocumentClassificationJobFilter>
@Generated("software.amazon.awssdk:codegen") public final class DocumentClassificationJobFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocumentClassificationJobFilter.Builder,DocumentClassificationJobFilter>

Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

See Also:

  • Method Details

    • jobName

      public final String jobName()

      Filters on the name of the job.

      Returns:
      Filters on the name of the job.

    • jobStatus

      public final JobStatus jobStatus()

      Filters the list 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 based on job status. Returns only jobs with the specified status.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      Filters the list 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 based on job status. Returns only jobs with the specified status.
      See Also:

    • submitTimeBefore

      public final Instant submitTimeBefore()

      Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before 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. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

    • submitTimeAfter

      public final Instant submitTimeAfter()

      Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after 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. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

    • toBuilder

      public DocumentClassificationJobFilter.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<DocumentClassificationJobFilter.Builder,DocumentClassificationJobFilter>
      Returns:
      a builder for type T

    • builder

      public static DocumentClassificationJobFilter.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DocumentClassificationJobFilter.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.