Package software.amazon.awssdk.services.workspaces.model

Interface DescribeWorkspacesRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>, SdkBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>

Enclosing class:

DescribeWorkspacesRequest

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

Method Summary

Modifier and Type	Method	Description
DescribeWorkspacesRequest.Builder	bundleId(String bundleId)	The identifier of a bundle to obtain the WorkSpaces for.
DescribeWorkspacesRequest.Builder	directoryId(String directoryId)	Specifies the directory identifier to which to limit the WorkSpaces.
DescribeWorkspacesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
DescribeWorkspacesRequest.Builder	nextToken(String nextToken)	The NextToken value from a previous call to this operation.
DescribeWorkspacesRequest.Builder	userName(String userName)	Used with the DirectoryId parameter to specify the directory user for whom to obtain the WorkSpace.
DescribeWorkspacesRequest.Builder	workspaceIds(String... workspaceIds)	An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information.
DescribeWorkspacesRequest.Builder	workspaceIds(Collection<String> workspaceIds)	An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information.

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

copy

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

apply, build

Method Detail

workspaceIds

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

Parameters:

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.

Returns:

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

workspaceIds

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

NOTE: This method appends the values to the existing list (if any). Use #setWorkspaceIds(java.util.Collection) or #withWorkspaceIds(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

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

directoryId

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

Parameters:

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:

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

userName

DescribeWorkspacesRequest.Builder userName(String userName)

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

Parameters:

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

Returns:

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

bundleId

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

Parameters:

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:

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)

The NextToken value from a previous call to this operation. Pass null if this is the first call.

Parameters:

nextToken - The NextToken value from a previous call to this operation. Pass null if this is the first call.

Returns:

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