com.amazonaws.services.workspaces.model

Class DescribeWorkspaceDirectoriesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workspaces.model.DescribeWorkspaceDirectoriesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeWorkspaceDirectoriesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeWorkspaceDirectories operation.

Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

See Also:

AmazonWorkspaces.describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeWorkspaceDirectoriesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeWorkspaceDirectoriesRequest	clone()
boolean	equals(Object obj)
List<String>	getDirectoryIds() An array of strings that contains the directory identifiers to retrieve information for.
String	getNextToken() The NextToken value from a previous call to this operation.
int	hashCode()
void	setDirectoryIds(Collection<String> directoryIds) An array of strings that contains the directory identifiers to retrieve information for.
void	setNextToken(String nextToken) The NextToken value from a previous call to this operation.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeWorkspaceDirectoriesRequest	withDirectoryIds(Collection<String> directoryIds) An array of strings that contains the directory identifiers to retrieve information for.
DescribeWorkspaceDirectoriesRequest	withDirectoryIds(String... directoryIds) An array of strings that contains the directory identifiers to retrieve information for.
DescribeWorkspaceDirectoriesRequest	withNextToken(String nextToken) The NextToken value from a previous call to this operation.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeWorkspaceDirectoriesRequest

public DescribeWorkspaceDirectoriesRequest()

Method Detail

getDirectoryIds

public List<String> getDirectoryIds()

An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

Constraints:
Length: 1 - 25

Returns:

An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

setDirectoryIds

public void setDirectoryIds(Collection<String> directoryIds)

An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

Constraints:
Length: 1 - 25

Parameters:

directoryIds - An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

withDirectoryIds

public DescribeWorkspaceDirectoriesRequest withDirectoryIds(String... directoryIds)

An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

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

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

Constraints:
Length: 1 - 25

Parameters:

directoryIds - An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

Returns:

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

withDirectoryIds

public DescribeWorkspaceDirectoriesRequest withDirectoryIds(Collection<String> directoryIds)

An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

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

Constraints:
Length: 1 - 25

Parameters:

directoryIds - An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

Returns:

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

getNextToken

public String getNextToken()

The NextToken value from a previous call to this operation. Pass null if this is the first call.

Constraints:
Length: 1 - 63

Returns:

The NextToken value from a previous call to this operation. Pass null if this is the first call.

setNextToken

public void setNextToken(String nextToken)

The NextToken value from a previous call to this operation. Pass null if this is the first call.

Constraints:
Length: 1 - 63

Parameters:

nextToken - The NextToken value from a previous call to this operation. Pass null if this is the first call.

withNextToken

public DescribeWorkspaceDirectoriesRequest withNextToken(String nextToken)

The NextToken value from a previous call to this operation. Pass null if this is the first call.

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

Constraints:
Length: 1 - 63

Parameters:

nextToken - The NextToken value from a previous call to this operation. Pass null if this is the first call.

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

Overrides:

clone in class AmazonWebServiceRequest