software.amazon.awssdk.services.glacier.model

Class ListJobsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.glacier.model.GlacierRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListJobsRequest.Builder

Method Summary

Modifier and Type	Method and 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	limit() The maximum number of jobs to be returned.
String	marker() An opaque string used for pagination.
List<SdkField<?>>	sdkFields()
static Class<? extends ListJobsRequest.Builder>	serializableBuilderClass()
String	statuscode() The type of job status to return.
ListJobsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vaultName() The name of the vault.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

accountId

public final 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 S3 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 S3 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 final String vaultName()

The name of the vault.

Returns:

The name of the vault.

limit

public final String limit()

The maximum number of jobs to be returned. The default limit is 50. 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 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

marker

public final 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 final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

Specified by:

toBuilder in class GlacierRequest

builder

public static ListJobsRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo