com.amazonaws.services.fsx.model

Class DescribeSnapshotsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.fsx.model.DescribeSnapshotsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSnapshotsRequest
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
DescribeSnapshotsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeSnapshotsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<SnapshotFilter>	getFilters() The filters structure.
Boolean	getIncludeShared() Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account.
Integer	getMaxResults()
String	getNextToken()
List<String>	getSnapshotIds() The IDs of the snapshots that you want to retrieve.
int	hashCode()
Boolean	isIncludeShared() Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account.
void	setFilters(Collection<SnapshotFilter> filters) The filters structure.
void	setIncludeShared(Boolean includeShared) Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account.
void	setMaxResults(Integer maxResults)
void	setNextToken(String nextToken)
void	setSnapshotIds(Collection<String> snapshotIds) The IDs of the snapshots that you want to retrieve.
String	toString() Returns a string representation of this object.
DescribeSnapshotsRequest	withFilters(Collection<SnapshotFilter> filters) The filters structure.
DescribeSnapshotsRequest	withFilters(SnapshotFilter... filters) The filters structure.
DescribeSnapshotsRequest	withIncludeShared(Boolean includeShared) Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account.
DescribeSnapshotsRequest	withMaxResults(Integer maxResults)
DescribeSnapshotsRequest	withNextToken(String nextToken)
DescribeSnapshotsRequest	withSnapshotIds(Collection<String> snapshotIds) The IDs of the snapshots that you want to retrieve.
DescribeSnapshotsRequest	withSnapshotIds(String... snapshotIds) The IDs of the snapshots that you want to retrieve.

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

DescribeSnapshotsRequest

public DescribeSnapshotsRequest()

Method Detail

getSnapshotIds

public List<String> getSnapshotIds()

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

Returns:

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

setSnapshotIds

public void setSnapshotIds(Collection<String> snapshotIds)

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

Parameters:

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

withSnapshotIds

public DescribeSnapshotsRequest withSnapshotIds(String... snapshotIds)

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

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

Parameters:

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

Returns:

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

withSnapshotIds

public DescribeSnapshotsRequest withSnapshotIds(Collection<String> snapshotIds)

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

Parameters:

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

Returns:

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

getFilters

public List<SnapshotFilter> getFilters()

The filters structure. The supported names are file-system-id or volume-id.

Returns:

The filters structure. The supported names are file-system-id or volume-id.

setFilters

public void setFilters(Collection<SnapshotFilter> filters)

The filters structure. The supported names are file-system-id or volume-id.

Parameters:

filters - The filters structure. The supported names are file-system-id or volume-id.

withFilters

public DescribeSnapshotsRequest withFilters(SnapshotFilter... filters)

The filters structure. The supported names are file-system-id or 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 or volume-id.

Returns:

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

withFilters

public DescribeSnapshotsRequest withFilters(Collection<SnapshotFilter> filters)

The filters structure. The supported names are file-system-id or volume-id.

Parameters:

filters - The filters structure. The supported names are file-system-id or volume-id.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

Parameters:

maxResults -

getMaxResults

public Integer getMaxResults()

Returns:

withMaxResults

public DescribeSnapshotsRequest withMaxResults(Integer maxResults)

Parameters:

maxResults -

Returns:

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

setNextToken

public void setNextToken(String nextToken)

Parameters:

nextToken -

getNextToken

public String getNextToken()

Returns:

withNextToken

public DescribeSnapshotsRequest withNextToken(String nextToken)

Parameters:

nextToken -

Returns:

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

setIncludeShared

public void setIncludeShared(Boolean includeShared)

Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.

Parameters:

includeShared - Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.

getIncludeShared

public Boolean getIncludeShared()

Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.

Returns:

Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.

withIncludeShared

public DescribeSnapshotsRequest withIncludeShared(Boolean includeShared)

Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.

Parameters:

includeShared - Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.

Returns:

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

isIncludeShared

public Boolean isIncludeShared()

Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.

Returns:

Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.

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