software.amazon.awssdk.services.glacier.model

Interface ListJobsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>, GlacierRequest.Builder, SdkBuilder<ListJobsRequest.Builder,ListJobsRequest>, SdkRequest.Builder

Enclosing class:

ListJobsRequest

public static interface ListJobsRequest.Builder
extends GlacierRequest.Builder, CopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

Method Summary

Modifier and Type	Method and Description
ListJobsRequest.Builder	accountId(String accountId) The AccountId value is the AWS account ID of the account that owns the vault.
ListJobsRequest.Builder	completed(String completed) The state of the jobs to return.
ListJobsRequest.Builder	limit(String limit) The maximum number of jobs to be returned.
ListJobsRequest.Builder	marker(String marker) An opaque string used for pagination.
ListJobsRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
ListJobsRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
ListJobsRequest.Builder	statuscode(String statuscode) The type of job status to return.
ListJobsRequest.Builder	vaultName(String vaultName) The name of the vault.

Methods inherited from interface software.amazon.awssdk.services.glacier.model.GlacierRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

accountId

ListJobsRequest.Builder accountId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

vaultName

ListJobsRequest.Builder vaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

Returns:

Returns a reference to this object so that method calls can be chained together.

limit

ListJobsRequest.Builder limit(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

marker

ListJobsRequest.Builder marker(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

statuscode

ListJobsRequest.Builder statuscode(String statuscode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

completed

ListJobsRequest.Builder completed(String completed)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

requestOverrideConfig

ListJobsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

ListJobsRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.