Package 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("software.amazon.awssdk:codegen")
public final class DescribeWorkspacesRequest
extends WorkSpacesRequest
implements ToCopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeWorkspacesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeWorkspacesRequest.Builder	builder()
String	bundleId()	The identifier of the bundle.
String	directoryId()	The identifier of the directory.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasWorkspaceIds()	For responses, this returns true if the service returned a value for the WorkspaceIds property.
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()
String	toString()	Returns a string representation of this object.
String	userName()	The name of the directory user.
List<String>	workspaceIds()	The identifiers of the WorkSpaces.
String	workspaceName()	The name of the user-decoupled WorkSpace.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasWorkspaceIds

public final boolean hasWorkspaceIds()

For responses, this returns true if the service returned a value for the WorkspaceIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

workspaceIds

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkspaceIds() method.

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 final 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 final 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 final 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 final Integer limit()

The maximum number of items to return.

Returns:

The maximum number of items to return.

nextToken

public final 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.

workspaceName

public final String workspaceName()

The name of the user-decoupled WorkSpace.

Returns:

The name of the user-decoupled WorkSpace.

toBuilder

public DescribeWorkspacesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>

Specified by:

toBuilder in class WorkSpacesRequest

builder

public static DescribeWorkspacesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo