com.amazonaws.services.workspaces.model

Class DescribeWorkspacesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workspaces.model.DescribeWorkspacesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeWorkspacesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeWorkspaces operation.

Obtains information about the specified WorkSpaces.

Only one of the filter parameters, such as BundleId , DirectoryId , or WorkspaceIds , can be specified at a time.

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.describeWorkspaces(DescribeWorkspacesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeWorkspacesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeWorkspacesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getBundleId() The identifier of a bundle to obtain the WorkSpaces for.
String	getDirectoryId() Specifies the directory identifier to which to limit the WorkSpaces.
Integer	getLimit() The maximum number of items to return.
String	getNextToken() The NextToken value from a previous call to this operation.
String	getUserName() Used with the DirectoryId parameter to specify the directory user for which to obtain the WorkSpace.
List<String>	getWorkspaceIds() An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information.
int	hashCode()
void	setBundleId(String bundleId) The identifier of a bundle to obtain the WorkSpaces for.
void	setDirectoryId(String directoryId) Specifies the directory identifier to which to limit the WorkSpaces.
void	setLimit(Integer limit) The maximum number of items to return.
void	setNextToken(String nextToken) The NextToken value from a previous call to this operation.
void	setUserName(String userName) Used with the DirectoryId parameter to specify the directory user for which to obtain the WorkSpace.
void	setWorkspaceIds(Collection<String> workspaceIds) An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeWorkspacesRequest	withBundleId(String bundleId) The identifier of a bundle to obtain the WorkSpaces for.
DescribeWorkspacesRequest	withDirectoryId(String directoryId) Specifies the directory identifier to which to limit the WorkSpaces.
DescribeWorkspacesRequest	withLimit(Integer limit) The maximum number of items to return.
DescribeWorkspacesRequest	withNextToken(String nextToken) The NextToken value from a previous call to this operation.
DescribeWorkspacesRequest	withUserName(String userName) Used with the DirectoryId parameter to specify the directory user for which to obtain the WorkSpace.
DescribeWorkspacesRequest	withWorkspaceIds(Collection<String> workspaceIds) An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information.
DescribeWorkspacesRequest	withWorkspaceIds(String... workspaceIds) An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

DescribeWorkspacesRequest

public DescribeWorkspacesRequest()

Method Detail

getWorkspaceIds

public List<String> getWorkspaceIds()

An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.

Because the CreateWorkspaces operation is asynchronous, the identifier returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.

Constraints:
Length: 1 - 25

Returns:

An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.

Because the CreateWorkspaces operation is asynchronous, the identifier returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.

setWorkspaceIds

public void setWorkspaceIds(Collection<String> workspaceIds)

An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.

Because the CreateWorkspaces operation is asynchronous, the identifier returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.

Constraints:
Length: 1 - 25

Parameters:

workspaceIds - An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.

Because the CreateWorkspaces operation is asynchronous, the identifier returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.

withWorkspaceIds

public DescribeWorkspacesRequest withWorkspaceIds(String... workspaceIds)

An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.

Because the CreateWorkspaces operation is asynchronous, the identifier returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.

NOTE: This method appends the values to the existing list (if any). Use setWorkspaceIds(java.util.Collection) or withWorkspaceIds(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:

workspaceIds - An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.

Because the CreateWorkspaces operation is asynchronous, the identifier returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.

Returns:

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

withWorkspaceIds

public DescribeWorkspacesRequest withWorkspaceIds(Collection<String> workspaceIds)

An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.

Because the CreateWorkspaces operation is asynchronous, the identifier returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.

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

Constraints:
Length: 1 - 25

Parameters:

workspaceIds - An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.

Because the CreateWorkspaces operation is asynchronous, the identifier returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.

Returns:

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

getDirectoryId

public String getDirectoryId()

Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the UserName parameter. This parameter cannot be combined with any other filter parameter.

Constraints:
Pattern: ^d-[0-9a-f]{8,63}$

Returns:

Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the UserName parameter. This parameter cannot be combined with any other filter parameter.

setDirectoryId

public void setDirectoryId(String directoryId)

Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the UserName parameter. This parameter cannot be combined with any other filter parameter.

Constraints:
Pattern: ^d-[0-9a-f]{8,63}$

Parameters:

directoryId - Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the UserName parameter. This parameter cannot be combined with any other filter parameter.

withDirectoryId

public DescribeWorkspacesRequest withDirectoryId(String directoryId)

Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the UserName parameter. This parameter cannot be combined with any other filter parameter.

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

Constraints:
Pattern: ^d-[0-9a-f]{8,63}$

Parameters:

directoryId - Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the UserName parameter. This parameter cannot be combined with any other filter parameter.

Returns:

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

getUserName

public String getUserName()

Used with the DirectoryId parameter to specify the directory user for which to obtain the WorkSpace.

Constraints:
Length: 1 - 63

Returns:

Used with the DirectoryId parameter to specify the directory user for which to obtain the WorkSpace.

setUserName

public void setUserName(String userName)

Used with the DirectoryId parameter to specify the directory user for which to obtain the WorkSpace.

Constraints:
Length: 1 - 63

Parameters:

userName - Used with the DirectoryId parameter to specify the directory user for which to obtain the WorkSpace.

withUserName

public DescribeWorkspacesRequest withUserName(String userName)

Used with the DirectoryId parameter to specify the directory user for which to obtain the WorkSpace.

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

Constraints:
Length: 1 - 63

Parameters:

userName - Used with the DirectoryId parameter to specify the directory user for which to obtain the WorkSpace.

Returns:

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

getBundleId

public String getBundleId()

The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.

Constraints:
Pattern: ^wsb-[0-9a-z]{8,63}$

Returns:

The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.

setBundleId

public void setBundleId(String bundleId)

The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.

Constraints:
Pattern: ^wsb-[0-9a-z]{8,63}$

Parameters:

bundleId - The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.

withBundleId

public DescribeWorkspacesRequest withBundleId(String bundleId)

The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.

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

Constraints:
Pattern: ^wsb-[0-9a-z]{8,63}$

Parameters:

bundleId - The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.

Returns:

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

getLimit

public Integer getLimit()

The maximum number of items to return.

Constraints:
Range: 1 - 25

Returns:

The maximum number of items to return.

setLimit

public void setLimit(Integer limit)

The maximum number of items to return.

Constraints:
Range: 1 - 25

Parameters:

limit - The maximum number of items to return.

withLimit

public DescribeWorkspacesRequest withLimit(Integer limit)

The maximum number of items to return.

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

Constraints:
Range: 1 - 25

Parameters:

limit - The maximum number of items to return.

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