Package software.amazon.awssdk.services.s3control.model

Class ListJobsRequest

    • Method Detail

      • accountId

        public final String accountId()

        The Amazon Web Services account ID associated with the S3 Batch Operations job.

        Returns:
        The Amazon Web Services account ID associated with the S3 Batch Operations job.

      • jobStatuses

        public final List<JobStatus> jobStatuses()

        The List Jobs request returns jobs that match the statuses listed in this element.

        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 hasJobStatuses() method.

        Returns:
        The List Jobs request returns jobs that match the statuses listed in this element.

      • hasJobStatuses

        public final boolean hasJobStatuses()
        For responses, this returns true if the service returned a value for the JobStatuses 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.

      • jobStatusesAsStrings

        public final List<String> jobStatusesAsStrings()

        The List Jobs request returns jobs that match the statuses listed in this element.

        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 hasJobStatuses() method.

        Returns:
        The List Jobs request returns jobs that match the statuses listed in this element.

      • nextToken

        public final String nextToken()

        A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

        Returns:
        A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

      • maxResults

        public final Integer maxResults()

        The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

        Returns:
        The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

      • 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