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

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeBackupsRequest

public DescribeBackupsRequest()

Method Detail

getBackupIds

public List<String> getBackupIds()

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Returns:

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

setBackupIds

public void setBackupIds(Collection<String> backupIds)

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Parameters:

backupIds - IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

withBackupIds

public DescribeBackupsRequest withBackupIds(String... backupIds)

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

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 - IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Returns:

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

withBackupIds

public DescribeBackupsRequest withBackupIds(Collection<String> backupIds)

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Parameters:

backupIds - IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Returns:

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

getFilters

public List<Filter> getFilters()

Filters structure. Supported names are file-system-id and backup-type.

Returns:

Filters structure. Supported names are file-system-id and backup-type.

setFilters

public void setFilters(Collection<Filter> filters)

Filters structure. Supported names are file-system-id and backup-type.

Parameters:

filters - Filters structure. Supported names are file-system-id and backup-type.

withFilters

public DescribeBackupsRequest withFilters(Filter... filters)

Filters structure. Supported names are file-system-id and backup-type.

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 - Filters structure. Supported names are file-system-id and backup-type.

Returns:

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

withFilters

public DescribeBackupsRequest withFilters(Collection<Filter> filters)

Filters structure. Supported names are file-system-id and backup-type.

Parameters:

filters - Filters structure. Supported names are file-system-id and backup-type.

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

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Parameters:

nextToken - Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

getNextToken

public String getNextToken()

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Returns:

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

withNextToken

public DescribeBackupsRequest withNextToken(String nextToken)

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Parameters:

nextToken - Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action 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()

Overrides:

clone in class AmazonWebServiceRequest