com.amazonaws.services.cloudhsmv2.model

Class DescribeBackupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudhsmv2.model.DescribeBackupsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeBackupsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeBackupsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeBackupsRequest	addFiltersEntry(String key, List<String> value) Add a single Filters entry
DescribeBackupsRequest	clearFiltersEntries() Removes all the entries added into Filters.
DescribeBackupsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Map<String,List<String>>	getFilters() One or more filters to limit the items returned in the response.
Integer	getMaxResults() The maximum number of backups to return in the response.
String	getNextToken() The NextToken value that you received in the previous response.
Boolean	getShared() Describe backups that are shared with you.
Boolean	getSortAscending() Designates whether or not to sort the return backups by ascending chronological order of generation.
int	hashCode()
Boolean	isShared() Describe backups that are shared with you.
Boolean	isSortAscending() Designates whether or not to sort the return backups by ascending chronological order of generation.
void	setFilters(Map<String,List<String>> filters) One or more filters to limit the items returned in the response.
void	setMaxResults(Integer maxResults) The maximum number of backups to return in the response.
void	setNextToken(String nextToken) The NextToken value that you received in the previous response.
void	setShared(Boolean shared) Describe backups that are shared with you.
void	setSortAscending(Boolean sortAscending) Designates whether or not to sort the return backups by ascending chronological order of generation.
String	toString() Returns a string representation of this object.
DescribeBackupsRequest	withFilters(Map<String,List<String>> filters) One or more filters to limit the items returned in the response.
DescribeBackupsRequest	withMaxResults(Integer maxResults) The maximum number of backups to return in the response.
DescribeBackupsRequest	withNextToken(String nextToken) The NextToken value that you received in the previous response.
DescribeBackupsRequest	withShared(Boolean shared) Describe backups that are shared with you.
DescribeBackupsRequest	withSortAscending(Boolean sortAscending) Designates whether or not to sort the return backups by ascending chronological order of generation.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeBackupsRequest

public DescribeBackupsRequest()

Method Detail

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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.

withNextToken

public DescribeBackupsRequest withNextToken(String nextToken)

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

Parameters:

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

Returns:

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

setMaxResults

public void setMaxResults(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.

Parameters:

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.

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public DescribeBackupsRequest withMaxResults(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.

Parameters:

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:

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

getFilters

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

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.

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.

setFilters

public void setFilters(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.

Parameters:

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.

withFilters

public DescribeBackupsRequest withFilters(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.

Parameters:

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.

Returns:

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

addFiltersEntry

public DescribeBackupsRequest addFiltersEntry(String key,
                                              List<String> value)

Add a single Filters entry

See Also:

withFilters(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)

clearFiltersEntries

public DescribeBackupsRequest clearFiltersEntries()

Removes all the entries added into Filters.

Returns:

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

setShared

public void setShared(Boolean shared)

Describe backups that are shared with you.

By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.

Parameters:

shared - Describe backups that are shared with you.

By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.

getShared

public Boolean getShared()

Describe backups that are shared with you.

By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.

Returns:

Describe backups that are shared with you.

By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.

withShared

public DescribeBackupsRequest withShared(Boolean shared)

Describe backups that are shared with you.

By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.

Parameters:

shared - Describe backups that are shared with you.

By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.

Returns:

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

isShared

public Boolean isShared()

Describe backups that are shared with you.

By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.

Returns:

Describe backups that are shared with you.

By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.

setSortAscending

public void setSortAscending(Boolean sortAscending)

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

Parameters:

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

getSortAscending

public Boolean getSortAscending()

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.

withSortAscending

public DescribeBackupsRequest withSortAscending(Boolean sortAscending)

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

Parameters:

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

Returns:

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

isSortAscending

public Boolean isSortAscending()

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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeBackupsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()