Class ListServiceJobsRequest

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

  • Method Details

    • jobQueue

      public final String jobQueue()

      The name or ARN of the job queue with which to list service jobs.

      Returns:
      The name or ARN of the job queue with which to list service jobs.

    • jobStatus

      public final ServiceJobStatus jobStatus()

      The job status with which to filter service jobs.

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

      Returns:
      The job status with which to filter service jobs.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The job status with which to filter service jobs.

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

      Returns:
      The job status with which to filter service jobs.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of results returned by ListServiceJobs in paginated output. When this parameter is used, ListServiceJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListServiceJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceJobs returns up to 100 results and a nextToken value if applicable.

      Returns:
      The maximum number of results returned by ListServiceJobs in paginated output. When this parameter is used, ListServiceJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListServiceJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceJobs returns up to 100 results and a nextToken value if applicable.

    • nextToken

      public final String nextToken()

      The nextToken value returned from a previous paginated ListServiceJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

      Returns:
      The nextToken value returned from a previous paginated ListServiceJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

    • hasFilters

      public final boolean hasFilters()
      For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • filters

      public final List<KeyValuesPair> filters()

      The filters to apply to the service job list query. The filter names and values can be:

      • name: JOB_STATUS

        values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED | SCHEDULED

      • name: JOB_NAME

        values: case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

      Returns:
      The filters to apply to the service job list query. The filter names and values can be:

      • name: JOB_STATUS

        values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED | SCHEDULED

      • name: JOB_NAME

        values: case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.

    • toBuilder

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

    • builder

      public static ListServiceJobsRequest.Builder builder()

    • serializableBuilderClass

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