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:

SdkPojo, 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)
boolean	equalsBySdkFields(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)
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeBackupsRequest.Builder>	serializableBuilderClass()
Boolean	sortAscending() Designates whether or not to sort the return backups by ascending chronological order of generation.
DescribeBackupsRequest.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

nextToken

public final 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 final 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.

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

filters

public final 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 sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

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.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

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 sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

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.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

sortAscending

public final Boolean sortAscending()

Designates whether or not to sort the return backups by ascending chronological order of generation.

Returns:

Designates whether or not to sort the return backups by ascending chronological order of generation.

toBuilder

public DescribeBackupsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeBackupsRequest.Builder,DescribeBackupsRequest>

Specified by:

toBuilder in class CloudHsmV2Request

builder

public static DescribeBackupsRequest.Builder builder()

serializableBuilderClass

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