software.amazon.awssdk.services.cloudhsmv2.model

Class DescribeBackupsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudhsmv2.model.CloudHsmV2Request

software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest

All Implemented Interfaces:

ToCopyableBuilder<DescribeBackupsRequest.Builder,DescribeBackupsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeBackupsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeBackupsRequest.Builder	builder()
boolean	equals(Object obj)
Map<String,List<String>>	filters() One or more filters to limit the items returned in the response.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of backups to return in the response.
String	nextToken() The NextToken value that you received in the previous response.
static Class<? extends DescribeBackupsRequest.Builder>	serializableBuilderClass()
DescribeBackupsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

nextToken

public String nextToken()

The NextToken value that you received in the previous response. Use this value to get more backups.

Returns:

The NextToken value that you received in the previous response. Use this value to get more backups.

maxResults

public Integer maxResults()

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

Returns:

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

filters

public Map<String,List<String>> filters()

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

toBuilder

public DescribeBackupsRequest.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<DescribeBackupsRequest.Builder,DescribeBackupsRequest>

Specified by:

toBuilder in class CloudHsmV2Request

Returns:

a builder for type T

builder

public static DescribeBackupsRequest.Builder builder()

serializableBuilderClass

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value