com.amazonaws.services.fsx.model

Class DescribeBackupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.fsx.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

The request object for the DescribeBackups operation.

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	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getBackupIds() The IDs of the backups that you want to retrieve.
List<Filter>	getFilters() The filters structure.
Integer	getMaxResults() Maximum number of backups to return in the response.
String	getNextToken() An opaque pagination token returned from a previous DescribeBackups operation.
int	hashCode()
void	setBackupIds(Collection<String> backupIds) The IDs of the backups that you want to retrieve.
void	setFilters(Collection<Filter> filters) The filters structure.
void	setMaxResults(Integer maxResults) Maximum number of backups to return in the response.
void	setNextToken(String nextToken) An opaque pagination token returned from a previous DescribeBackups operation.
String	toString() Returns a string representation of this object.
DescribeBackupsRequest	withBackupIds(Collection<String> backupIds) The IDs of the backups that you want to retrieve.
DescribeBackupsRequest	withBackupIds(String... backupIds) The IDs of the backups that you want to retrieve.
DescribeBackupsRequest	withFilters(Collection<Filter> filters) The filters structure.
DescribeBackupsRequest	withFilters(Filter... filters) The filters structure.
DescribeBackupsRequest	withMaxResults(Integer maxResults) Maximum number of backups to return in the response.
DescribeBackupsRequest	withNextToken(String nextToken) An opaque pagination token returned from a previous DescribeBackups operation.

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

getBackupIds

public List<String> getBackupIds()

The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

Returns:

The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

setBackupIds

public void setBackupIds(Collection<String> backupIds)

The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

Parameters:

backupIds - The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

withBackupIds

public DescribeBackupsRequest withBackupIds(String... backupIds)

The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

NOTE: This method appends the values to the existing list (if any). Use setBackupIds(java.util.Collection) or withBackupIds(java.util.Collection) if you want to override the existing values.

Parameters:

backupIds - The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

Returns:

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

withBackupIds

public DescribeBackupsRequest withBackupIds(Collection<String> backupIds)

The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

Parameters:

backupIds - The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

Returns:

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

getFilters

public List<Filter> getFilters()

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

Returns:

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

setFilters

public void setFilters(Collection<Filter> filters)

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

Parameters:

filters - The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

withFilters

public DescribeBackupsRequest withFilters(Filter... filters)

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

Returns:

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

withFilters

public DescribeBackupsRequest withFilters(Collection<Filter> filters)

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

Parameters:

filters - The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

Parameters:

maxResults - Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

getMaxResults

public Integer getMaxResults()

Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

Returns:

Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

withMaxResults

public DescribeBackupsRequest withMaxResults(Integer maxResults)

Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

Parameters:

maxResults - Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

Parameters:

nextToken - An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

getNextToken

public String getNextToken()

An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

Returns:

An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

withNextToken

public DescribeBackupsRequest withNextToken(String nextToken)

An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

Parameters:

nextToken - An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

Returns:

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

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