Package software.amazon.awssdk.services.glacier.model

Class ListJobsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.glacier.model.ListJobsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

@Generated("software.amazon.awssdk:codegen")
public class ListJobsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

Provides options for retrieving a job list for an Amazon Glacier vault.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListJobsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	accountId()	The AccountId value is the AWS account ID of the account that owns the vault.
static ListJobsRequest.Builder	builder()
String	completed()	The state of the jobs to return.
boolean	equals(Object obj)
int	hashCode()
String	limit()	The maximum number of jobs to be returned.
String	marker()	An opaque string used for pagination.
static Class<? extends ListJobsRequest.Builder>	serializableBuilderClass()
String	statuscode()	The type of job status to return.
ListJobsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	vaultName()	The name of the vault.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

accountId

public String accountId()

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Returns:

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

vaultName

public String vaultName()

The name of the vault.

Returns:

The name of the vault.

limit

public String limit()

The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

Returns:

The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

marker

public String marker()

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Returns:

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

statuscode

public String statuscode()

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

Returns:

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

completed

public String completed()

The state of the jobs to return. You can specify true or false.

Returns:

The state of the jobs to return. You can specify true or false.

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>

Returns:

a builder for type T

builder

public static ListJobsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object