@Generated(value="software.amazon.awssdk:codegen") public class DescribeWorkspacesRequest extends WorkSpacesRequest implements ToCopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>
Contains the inputs for the DescribeWorkspaces operation.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeWorkspacesRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeWorkspacesRequest.Builder |
builder() |
String |
bundleId()
The identifier of a bundle to obtain the WorkSpaces for.
|
String |
directoryId()
Specifies the directory identifier to which to limit the WorkSpaces.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
limit()
The maximum number of items to return.
|
String |
nextToken()
The
NextToken value from a previous call to this operation. |
static Class<? extends DescribeWorkspacesRequest.Builder> |
serializableBuilderClass() |
DescribeWorkspacesRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
userName()
Used with the
DirectoryId parameter to specify the directory user for whom to obtain the WorkSpace. |
List<String> |
workspaceIds()
An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information.
|
requestOverrideConfig
copy
public List<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 it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public 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.
UserName
parameter. This parameter cannot be combined with
any other filter parameter.public String userName()
Used with the DirectoryId
parameter to specify the directory user for whom to obtain the WorkSpace.
DirectoryId
parameter to specify the directory user for whom to obtain the
WorkSpace.public 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.
public Integer limit()
The maximum number of items to return.
public String nextToken()
The NextToken
value from a previous call to this operation. Pass null if this is the first call.
NextToken
value from a previous call to this operation. Pass null if this is the first
call.public DescribeWorkspacesRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>
toBuilder
in class WorkSpacesRequest
public static DescribeWorkspacesRequest.Builder builder()
public static Class<? extends DescribeWorkspacesRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.