Class ListJobsRequest

    • Method Detail

      • maxResults

        public final Integer maxResults()
        Optional. Number of jobs, up to twenty, that will be returned at one time.
        Returns:
        Optional. Number of jobs, up to twenty, that will be returned at one time.
      • nextToken

        public final String nextToken()
        Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.
        Returns:
        Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.
      • order

        public final Order order()
        Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

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

        Returns:
        Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
        See Also:
        Order
      • orderAsString

        public final String orderAsString()
        Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

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

        Returns:
        Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
        See Also:
        Order
      • queue

        public final String queue()
        Optional. Provide a queue name to get back only jobs from that queue.
        Returns:
        Optional. Provide a queue name to get back only jobs from that queue.
      • status

        public final JobStatus status()
        Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

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

        Returns:
        Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
        See Also:
        JobStatus
      • statusAsString

        public final String statusAsString()
        Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

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

        Returns:
        Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
        See Also:
        JobStatus
      • 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