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:

SdkPojo, ToCopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>

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

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 the bundle.
String	directoryId() The identifier of the directory.
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() If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
List<SdkField<?>>	sdkFields()
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() The name of the directory user.
List<String>	workspaceIds() The identifiers of the WorkSpaces.

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

overrideConfiguration

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

The identifiers of the WorkSpaces. You cannot combine this parameter 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The identifiers of the WorkSpaces. You cannot combine this parameter 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.

directoryId

public String directoryId()

The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.

Returns:

The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.

userName

public String userName()

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.

bundleId

public String bundleId()

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

Returns:

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

limit

public Integer limit()

The maximum number of items to return.

Returns:

The maximum number of items to return.

nextToken

public String nextToken()

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Returns:

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.