Class DescribeWorkspacesRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Contains the inputs for the DescribeWorkspaces operation.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The identifier of a bundle to obtain the WorkSpaces for.Specifies the directory identifier to which to limit the WorkSpaces.getLimit()
The maximum number of items to return.TheNextToken
value from a previous call to this operation.Used with theDirectoryId
parameter to specify the directory user for which to obtain the WorkSpace.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
The maximum number of items to return.void
setNextToken
(String nextToken) TheNextToken
value from a previous call to this operation.void
setUserName
(String userName) Used with theDirectoryId
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.toString()
Returns a string representation of this object; useful for testing and debugging.withBundleId
(String bundleId) The identifier of a bundle to obtain the WorkSpaces for.withDirectoryId
(String directoryId) Specifies the directory identifier to which to limit the WorkSpaces.The maximum number of items to return.withNextToken
(String nextToken) TheNextToken
value from a previous call to this operation.withUserName
(String userName) Used with theDirectoryId
parameter to specify the directory user for which to obtain the WorkSpace.withWorkspaceIds
(String... workspaceIds) An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information.withWorkspaceIds
(Collection<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, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
DescribeWorkspacesRequest
public DescribeWorkspacesRequest()
-
-
Method Details
-
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.
- 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
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.
- 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
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)
orwithWorkspaceIds(java.util.Collection)
if you want to override the existing values.- 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:
- Returns a reference to this object so that method calls can be chained together.
-
withWorkspaceIds
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setDirectoryId
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.- Parameters:
directoryId
- Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with theUserName
parameter. This parameter cannot be combined with any other filter parameter.
-
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.- 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.
-
withDirectoryId
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.- Parameters:
directoryId
- Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with theUserName
parameter. This parameter cannot be combined with any other filter parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUserName
Used with the
DirectoryId
parameter to specify the directory user for which to obtain the WorkSpace.- Parameters:
userName
- Used with theDirectoryId
parameter to specify the directory user for which to obtain the WorkSpace.
-
getUserName
Used with the
DirectoryId
parameter to specify the directory user for which to obtain the WorkSpace.- Returns:
- Used with the
DirectoryId
parameter to specify the directory user for which to obtain the WorkSpace.
-
withUserName
Used with the
DirectoryId
parameter to specify the directory user for which to obtain the WorkSpace.- Parameters:
userName
- Used with theDirectoryId
parameter to specify the directory user for which to obtain the WorkSpace.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setBundleId
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.
- 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.
-
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.
- 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.
-
withBundleId
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setLimit
The maximum number of items to return.
- Parameters:
limit
- The maximum number of items to return.
-
getLimit
The maximum number of items to return.
- Returns:
- The maximum number of items to return.
-
withLimit
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
The
NextToken
value from a previous call to this operation. Pass null if this is the first call.- Parameters:
nextToken
- TheNextToken
value from a previous call to this operation. Pass null if this is the first call.
-
getNextToken
The
NextToken
value from a previous call to this operation. Pass null if this is the first call.- Returns:
- The
NextToken
value from a previous call to this operation. Pass null if this is the first call.
-
withNextToken
The
NextToken
value from a previous call to this operation. Pass null if this is the first call.- Parameters:
nextToken
- TheNextToken
value from a previous call to this operation. Pass null if this is the first call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-