software.amazon.awssdk.services.workspaces.model

Class DescribeWorkspacesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workspaces.model.WorkSpacesRequest

software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest

All Implemented Interfaces:

ToCopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class DescribeWorkspacesRequest
extends WorkSpacesRequest
implements ToCopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>

Contains the inputs for the DescribeWorkspaces operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeWorkspacesRequest.Builder

Method Summary

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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

workspaceIds

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.

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

directoryId

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.

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.

userName

public String userName()

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

Returns:

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

bundleId

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.

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.

limit

public Integer limit()

The maximum number of items to return.

Returns:

The maximum number of items to return.

nextToken

public String nextToken()

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.

toBuilder

public DescribeWorkspacesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>

Specified by:

toBuilder in class WorkSpacesRequest

Returns:

a builder for type T

builder

public static DescribeWorkspacesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeWorkspacesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value