Class ListJobsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sagemaker.model.SageMakerRequest
software.amazon.awssdk.services.sagemaker.model.ListJobsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListJobsRequest extends SageMakerRequest implements ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

  • Method Details

    • jobCategory

      public final JobCategory jobCategory()

      The category of jobs to list.

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

      Returns:
      The category of jobs to list.
      See Also:

    • jobCategoryAsString

      public final String jobCategoryAsString()

      The category of jobs to list.

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

      Returns:
      The category of jobs to list.
      See Also:

    • nextToken

      public final String nextToken()

      If the previous response was truncated, this token retrieves the next set of results.

      Returns:
      If the previous response was truncated, this token retrieves the next set of results.

    • maxResults

      public final Integer maxResults()

      The maximum number of jobs to return in the response. The default value is 50.

      Returns:
      The maximum number of jobs to return in the response. The default value is 50.

    • creationTimeAfter

      public final Instant creationTimeAfter()

      A filter that returns only jobs created after the specified time.

      Returns:
      A filter that returns only jobs created after the specified time.

    • creationTimeBefore

      public final Instant creationTimeBefore()

      A filter that returns only jobs created before the specified time.

      Returns:
      A filter that returns only jobs created before the specified time.

    • lastModifiedTimeAfter

      public final Instant lastModifiedTimeAfter()

      A filter that returns only jobs modified after the specified time.

      Returns:
      A filter that returns only jobs modified after the specified time.

    • lastModifiedTimeBefore

      public final Instant lastModifiedTimeBefore()

      A filter that returns only jobs modified before the specified time.

      Returns:
      A filter that returns only jobs modified before the specified time.

    • nameContains

      public final String nameContains()

      A string in the job name to filter results. Only jobs whose name contains the specified string are returned.

      Returns:
      A string in the job name to filter results. Only jobs whose name contains the specified string are returned.

    • sortBy

      public final SortBy sortBy()

      The field to sort results by.

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

      Returns:
      The field to sort results by.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      The field to sort results by.

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

      Returns:
      The field to sort results by.
      See Also:

    • sortOrder

      public final SortOrder sortOrder()

      The sort order for results. Valid values are Ascending and Descending.

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

      Returns:
      The sort order for results. Valid values are Ascending and Descending.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The sort order for results. Valid values are Ascending and Descending.

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

      Returns:
      The sort order for results. Valid values are Ascending and Descending.
      See Also:

    • statusEquals

      public final JobStatus statusEquals()

      A filter that returns only jobs with the specified status.

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

      Returns:
      A filter that returns only jobs with the specified status.
      See Also:

    • statusEqualsAsString

      public final String statusEqualsAsString()

      A filter that returns only jobs with the specified status.

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

      Returns:
      A filter that returns only jobs with the specified status.
      See Also:

    • toBuilder

      public ListJobsRequest.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<ListJobsRequest.Builder,ListJobsRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • builder

      public static ListJobsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.