Package 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 Details

    • 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.

    • workspaceName

      DescribeWorkspacesRequest.Builder workspaceName(String workspaceName)

      The name of the user-decoupled WorkSpace.

      Parameters:
      workspaceName - The name of the user-decoupled WorkSpace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeWorkspacesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeWorkspacesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.