software.amazon.awssdk.services.workspaces.model

Interface DescribeWorkspacesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>, SdkBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>, SdkPojo, SdkRequest.Builder, WorkSpacesRequest.Builder

Enclosing class:

DescribeWorkspacesRequest

public static interface DescribeWorkspacesRequest.Builder
extends WorkSpacesRequest.Builder, SdkPojo, CopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>

Method Summary

Modifier and Type	Method and Description
DescribeWorkspacesRequest.Builder	bundleId(String bundleId) The identifier of the bundle.
DescribeWorkspacesRequest.Builder	directoryId(String directoryId) The identifier of the directory.
DescribeWorkspacesRequest.Builder	limit(Integer limit) The maximum number of items to return.
DescribeWorkspacesRequest.Builder	nextToken(String nextToken) If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
DescribeWorkspacesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeWorkspacesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeWorkspacesRequest.Builder	userName(String userName) The name of the directory user.
DescribeWorkspacesRequest.Builder	workspaceIds(Collection<String> workspaceIds) The identifiers of the WorkSpaces.
DescribeWorkspacesRequest.Builder	workspaceIds(String... workspaceIds) The identifiers of the WorkSpaces.

Methods inherited from interface software.amazon.awssdk.services.workspaces.model.WorkSpacesRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

workspaceIds

DescribeWorkspacesRequest.Builder workspaceIds(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

workspaceIds

DescribeWorkspacesRequest.Builder workspaceIds(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

directoryId

DescribeWorkspacesRequest.Builder directoryId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

userName

DescribeWorkspacesRequest.Builder userName(String userName)

The name of the directory user. You must specify this parameter with DirectoryId.

Parameters:

userName - The name of the directory user. You must specify this parameter with DirectoryId.

Returns:

Returns a reference to this object so that method calls can be chained together.

bundleId

DescribeWorkspacesRequest.Builder bundleId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

limit

DescribeWorkspacesRequest.Builder limit(Integer limit)

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.

nextToken

DescribeWorkspacesRequest.Builder nextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

DescribeWorkspacesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeWorkspacesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder