Interface SearchWorkspacesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<SearchWorkspacesRequest.Builder,SearchWorkspacesRequest>, SdkBuilder<SearchWorkspacesRequest.Builder,SearchWorkspacesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchWorkspacesRequest

@Mutable
@NotThreadSafe
public static interface SearchWorkspacesRequest.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<SearchWorkspacesRequest.Builder,SearchWorkspacesRequest>

Method Summary

Modifier and Type	Method	Description
SearchWorkspacesRequest.Builder	instanceId(String instanceId)	The identifier of the Amazon Connect instance.
SearchWorkspacesRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
SearchWorkspacesRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchWorkspacesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchWorkspacesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SearchWorkspacesRequest.Builder	searchCriteria(Consumer<WorkspaceSearchCriteria.Builder> searchCriteria)	The search criteria, including field names and comparison types.
SearchWorkspacesRequest.Builder	searchCriteria(WorkspaceSearchCriteria searchCriteria)	The search criteria, including field names and comparison types.
default SearchWorkspacesRequest.Builder	searchFilter(Consumer<WorkspaceSearchFilter.Builder> searchFilter)	Filters to apply to the search, such as tag-based filters.
SearchWorkspacesRequest.Builder	searchFilter(WorkspaceSearchFilter searchFilter)	Filters to apply to the search, such as tag-based filters.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

build

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

instanceId

SearchWorkspacesRequest.Builder instanceId(String instanceId)

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

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

nextToken

SearchWorkspacesRequest.Builder nextToken(String nextToken)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Parameters:

nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

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

maxResults

SearchWorkspacesRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return per page.

Parameters:

maxResults - The maximum number of results to return per page.

Returns:

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

searchFilter

SearchWorkspacesRequest.Builder searchFilter(WorkspaceSearchFilter searchFilter)

Filters to apply to the search, such as tag-based filters.

Parameters:

searchFilter - Filters to apply to the search, such as tag-based filters.

Returns:

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

searchFilter

default SearchWorkspacesRequest.Builder searchFilter(Consumer<WorkspaceSearchFilter.Builder> searchFilter)

Filters to apply to the search, such as tag-based filters.

This is a convenience method that creates an instance of the WorkspaceSearchFilter.Builder avoiding the need to create one manually via WorkspaceSearchFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchFilter(WorkspaceSearchFilter).

Parameters:

searchFilter - a consumer that will call methods on WorkspaceSearchFilter.Builder

Returns:

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

See Also:

• searchFilter(WorkspaceSearchFilter)

searchCriteria

SearchWorkspacesRequest.Builder searchCriteria(WorkspaceSearchCriteria searchCriteria)

The search criteria, including field names and comparison types.

Parameters:

searchCriteria - The search criteria, including field names and comparison types.

Returns:

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

searchCriteria

default SearchWorkspacesRequest.Builder searchCriteria(Consumer<WorkspaceSearchCriteria.Builder> searchCriteria)

The search criteria, including field names and comparison types.

This is a convenience method that creates an instance of the WorkspaceSearchCriteria.Builder avoiding the need to create one manually via WorkspaceSearchCriteria.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchCriteria(WorkspaceSearchCriteria).

Parameters:

searchCriteria - a consumer that will call methods on WorkspaceSearchCriteria.Builder

Returns:

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

See Also:

• searchCriteria(WorkspaceSearchCriteria)

overrideConfiguration

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

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