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

Class ListVaultsRequest

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.ListVaultsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListVaultsRequest.Builder,ListVaultsRequest>

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

Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListVaultsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accountId()	The AccountId value is the AWS account ID.
static ListVaultsRequest.Builder	builder()
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 vaults to be returned.
String	marker()	A string used for pagination.
List<SdkField<?>>	sdkFields()
static Class<? extends ListVaultsRequest.Builder>	serializableBuilderClass()
ListVaultsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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. This value must match the AWS account ID associated with the credentials used to sign the request. 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 specify your account ID, do not include any hyphens ('-') in the ID.

Returns:

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. 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 specify your account ID, do not include any hyphens ('-') in the ID.

marker

public final String marker()

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

Returns:

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

limit

public final String limit()

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

Returns:

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

toBuilder

public ListVaultsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListVaultsRequest.Builder,ListVaultsRequest>

Specified by:

toBuilder in class GlacierRequest

builder

public static ListVaultsRequest.Builder builder()

serializableBuilderClass

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