com.amazonaws.services.workspaces.model

Class DescribeWorkspacesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workspaces.model.DescribeWorkspacesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
DescribeWorkspacesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getBundleId() The ID of the bundle.
String	getDirectoryId() The ID of the directory.
Integer	getLimit() The maximum number of items to return.
String	getNextToken() The token for the next set of results.
String	getUserName() The name of the directory user.
List<String>	getWorkspaceIds() The IDs of the WorkSpaces.
int	hashCode()
void	setBundleId(String bundleId) The ID of the bundle.
void	setDirectoryId(String directoryId) The ID of the directory.
void	setLimit(Integer limit) The maximum number of items to return.
void	setNextToken(String nextToken) The token for the next set of results.
void	setUserName(String userName) The name of the directory user.
void	setWorkspaceIds(Collection<String> workspaceIds) The IDs of the WorkSpaces.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeWorkspacesRequest	withBundleId(String bundleId) The ID of the bundle.
DescribeWorkspacesRequest	withDirectoryId(String directoryId) The ID of the directory.
DescribeWorkspacesRequest	withLimit(Integer limit) The maximum number of items to return.
DescribeWorkspacesRequest	withNextToken(String nextToken) The token for the next set of results.
DescribeWorkspacesRequest	withUserName(String userName) The name of the directory user.
DescribeWorkspacesRequest	withWorkspaceIds(Collection<String> workspaceIds) The IDs of the WorkSpaces.
DescribeWorkspacesRequest	withWorkspaceIds(String... workspaceIds) The IDs of the WorkSpaces.

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

DescribeWorkspacesRequest

public DescribeWorkspacesRequest()

Method Detail

getWorkspaceIds

public List<String> getWorkspaceIds()

The IDs of the WorkSpaces. This parameter cannot be combined with any other filter.

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

Returns:

The IDs of the WorkSpaces. This parameter cannot be combined with any other filter.

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

setWorkspaceIds

public void setWorkspaceIds(Collection<String> workspaceIds)

The IDs of the WorkSpaces. This parameter cannot be combined with any other filter.

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

Parameters:

workspaceIds - The IDs of the WorkSpaces. This parameter cannot be combined with any other filter.

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

withWorkspaceIds

public DescribeWorkspacesRequest withWorkspaceIds(String... workspaceIds)

The IDs of the WorkSpaces. This parameter cannot be combined with any other filter.

Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is 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.

Parameters:

workspaceIds - The IDs of the WorkSpaces. This parameter cannot be combined with any other filter.

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

Returns:

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

withWorkspaceIds

public DescribeWorkspacesRequest withWorkspaceIds(Collection<String> workspaceIds)

The IDs of the WorkSpaces. This parameter cannot be combined with any other filter.

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

Parameters:

workspaceIds - The IDs of the WorkSpaces. This parameter cannot be combined with any other filter.

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

Returns:

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

setDirectoryId

public void setDirectoryId(String directoryId)

The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName). This parameter cannot be combined with any other filter.

Parameters:

directoryId - The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName). This parameter cannot be combined with any other filter.

getDirectoryId

public String getDirectoryId()

The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName). This parameter cannot be combined with any other filter.

Returns:

The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName). This parameter cannot be combined with any other filter.

withDirectoryId

public DescribeWorkspacesRequest withDirectoryId(String directoryId)

The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName). This parameter cannot be combined with any other filter.

Parameters:

directoryId - The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName). This parameter cannot be combined with any other filter.

Returns:

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

setUserName

public void setUserName(String userName)

The name of the directory user. You must specify this parameter with DirectoryId.

Parameters:

userName - The name of the directory user. You must specify this parameter with DirectoryId.

getUserName

public String getUserName()

The name of the directory user. You must specify this parameter with DirectoryId.

Returns:

The name of the directory user. You must specify this parameter with DirectoryId.

withUserName

public DescribeWorkspacesRequest withUserName(String userName)

The name of the directory user. You must specify this parameter with DirectoryId.

Parameters:

userName - The name of the directory user. You must specify this parameter with DirectoryId.

Returns:

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

setBundleId

public void setBundleId(String bundleId)

The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.

Parameters:

bundleId - The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.

getBundleId

public String getBundleId()

The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.

Returns:

The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.

withBundleId

public DescribeWorkspacesRequest withBundleId(String bundleId)

The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.

Parameters:

bundleId - The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.

Returns:

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

setLimit

public void setLimit(Integer limit)

The maximum number of items to return.

Parameters:

limit - The maximum number of items to return.

getLimit

public Integer getLimit()

The maximum number of items to return.

Returns:

The maximum number of items to return.

withLimit

public DescribeWorkspacesRequest withLimit(Integer limit)

The maximum number of items to return.

Parameters:

limit - The maximum number of items to return.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The token for the next set of results. (You received this token from a previous call.)

Parameters:

nextToken - The token for the next set of results. (You received this token from a previous call.)

getNextToken

public String getNextToken()

The token for the next set of results. (You received this token from a previous call.)

Returns:

The token for the next set of results. (You received this token from a previous call.)

withNextToken

public DescribeWorkspacesRequest withNextToken(String nextToken)

The token for the next set of results. (You received this token from a previous call.)

Parameters:

nextToken - The token for the next set of results. (You received this token from a previous call.)

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; useful for testing and debugging.

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