com.amazonaws.services.elasticfilesystem.model

Class DescribeFileSystemsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticfilesystem.model.DescribeFileSystemsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeFileSystemsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeFileSystems operation.

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided; otherwise, returns descriptions of all file systems owned by the caller's AWS account in the AWS region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon EFS returns a NextMarker , an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker .

So to retrieve a list of your file system descriptions, the expected usage of this API is an iterative process of first calling DescribeFileSystems without the Marker and then continuing to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker .

Note that the implementation may return fewer than MaxItems file system descriptions while still including a NextMarker value.

The order of file systems returned in the response of one DescribeFileSystems call, and the order of file systems returned across the responses of a multi-call iteration, is unspecified.

This operation requires permission for the elasticfilesystem:DescribeFileSystems action.

See Also:

AmazonElasticFileSystem.describeFileSystems(DescribeFileSystemsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeFileSystemsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeFileSystemsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getCreationToken() Optional string.
String	getFileSystemId() Optional string.
String	getMarker() Optional string.
Integer	getMaxItems() Optional integer.
int	hashCode()
void	setCreationToken(String creationToken) Optional string.
void	setFileSystemId(String fileSystemId) Optional string.
void	setMarker(String marker) Optional string.
void	setMaxItems(Integer maxItems) Optional integer.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeFileSystemsRequest	withCreationToken(String creationToken) Optional string.
DescribeFileSystemsRequest	withFileSystemId(String fileSystemId) Optional string.
DescribeFileSystemsRequest	withMarker(String marker) Optional string.
DescribeFileSystemsRequest	withMaxItems(Integer maxItems) Optional integer.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeFileSystemsRequest

public DescribeFileSystemsRequest()

Method Detail

getMaxItems

public Integer getMaxItems()

Optional integer. Specifies the maximum number of file systems to return in the response. This parameter value must be greater than 0. The number of items Amazon EFS returns will be the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.

Constraints:
Range: 1 -

Returns:

Optional integer. Specifies the maximum number of file systems to return in the response. This parameter value must be greater than 0. The number of items Amazon EFS returns will be the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.

setMaxItems

public void setMaxItems(Integer maxItems)

Optional integer. Specifies the maximum number of file systems to return in the response. This parameter value must be greater than 0. The number of items Amazon EFS returns will be the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.

Constraints:
Range: 1 -

Parameters:

maxItems - Optional integer. Specifies the maximum number of file systems to return in the response. This parameter value must be greater than 0. The number of items Amazon EFS returns will be the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.

withMaxItems

public DescribeFileSystemsRequest withMaxItems(Integer maxItems)

Optional integer. Specifies the maximum number of file systems to return in the response. This parameter value must be greater than 0. The number of items Amazon EFS returns will be the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.

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

Constraints:
Range: 1 -

Parameters:

maxItems - Optional integer. Specifies the maximum number of file systems to return in the response. This parameter value must be greater than 0. The number of items Amazon EFS returns will be the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()

Optional string. Opaque pagination token returned from a previous DescribeFileSystems operation. If present, specifies to continue the list from where the returning call had left off.

Returns:

Optional string. Opaque pagination token returned from a previous DescribeFileSystems operation. If present, specifies to continue the list from where the returning call had left off.

setMarker

public void setMarker(String marker)

Optional string. Opaque pagination token returned from a previous DescribeFileSystems operation. If present, specifies to continue the list from where the returning call had left off.

Parameters:

marker - Optional string. Opaque pagination token returned from a previous DescribeFileSystems operation. If present, specifies to continue the list from where the returning call had left off.

withMarker

public DescribeFileSystemsRequest withMarker(String marker)

Optional string. Opaque pagination token returned from a previous DescribeFileSystems operation. If present, specifies to continue the list from where the returning call had left off.

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

Parameters:

marker - Optional string. Opaque pagination token returned from a previous DescribeFileSystems operation. If present, specifies to continue the list from where the returning call had left off.

Returns:

A reference to this updated object so that method calls can be chained together.

getCreationToken

public String getCreationToken()

Optional string. Restricts the list to the file system with this creation token (you specify a creation token at the time of creating an Amazon EFS file system).

Constraints:
Length: 1 - 64

Returns:

Optional string. Restricts the list to the file system with this creation token (you specify a creation token at the time of creating an Amazon EFS file system).

setCreationToken

public void setCreationToken(String creationToken)

Optional string. Restricts the list to the file system with this creation token (you specify a creation token at the time of creating an Amazon EFS file system).

Constraints:
Length: 1 - 64

Parameters:

creationToken - Optional string. Restricts the list to the file system with this creation token (you specify a creation token at the time of creating an Amazon EFS file system).

withCreationToken

public DescribeFileSystemsRequest withCreationToken(String creationToken)

Optional string. Restricts the list to the file system with this creation token (you specify a creation token at the time of creating an Amazon EFS file system).

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

Constraints:
Length: 1 - 64

Parameters:

creationToken - Optional string. Restricts the list to the file system with this creation token (you specify a creation token at the time of creating an Amazon EFS file system).

Returns:

A reference to this updated object so that method calls can be chained together.

getFileSystemId

public String getFileSystemId()

Optional string. File system ID whose description you want to retrieve.

Constraints:
Pattern: fs-[0-9a-f]{8}

Returns:

Optional string. File system ID whose description you want to retrieve.

setFileSystemId

public void setFileSystemId(String fileSystemId)

Optional string. File system ID whose description you want to retrieve.

Constraints:
Pattern: fs-[0-9a-f]{8}

Parameters:

fileSystemId - Optional string. File system ID whose description you want to retrieve.

withFileSystemId

public DescribeFileSystemsRequest withFileSystemId(String fileSystemId)

Optional string. File system ID whose description you want to retrieve.

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

Constraints:
Pattern: fs-[0-9a-f]{8}

Parameters:

fileSystemId - Optional string. File system ID whose description you want to retrieve.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeFileSystemsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()