Interface ListGroupsForEntityRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListGroupsForEntityRequest.Builder,ListGroupsForEntityRequest>, SdkBuilder<ListGroupsForEntityRequest.Builder,ListGroupsForEntityRequest>, SdkPojo, SdkRequest.Builder, WorkMailRequest.Builder

Enclosing class:

ListGroupsForEntityRequest

@Mutable
@NotThreadSafe
public static interface ListGroupsForEntityRequest.Builder
extends WorkMailRequest.Builder, SdkPojo, CopyableBuilder<ListGroupsForEntityRequest.Builder,ListGroupsForEntityRequest>

Method Summary

Modifier and Type	Method	Description
ListGroupsForEntityRequest.Builder	entityId(String entityId)	The identifier for the entity.
default ListGroupsForEntityRequest.Builder	filters(Consumer<ListGroupsForEntityFilters.Builder> filters)	Limit the search results based on the filter criteria.
ListGroupsForEntityRequest.Builder	filters(ListGroupsForEntityFilters filters)	Limit the search results based on the filter criteria.
ListGroupsForEntityRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in a single call.
ListGroupsForEntityRequest.Builder	nextToken(String nextToken)	The token to use to retrieve the next page of results.
ListGroupsForEntityRequest.Builder	organizationId(String organizationId)	The identifier for the organization under which the entity exists.
ListGroupsForEntityRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListGroupsForEntityRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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

overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.services.workmail.model.WorkMailRequest.Builder

build

Method Details

organizationId

ListGroupsForEntityRequest.Builder organizationId(String organizationId)

The identifier for the organization under which the entity exists.

Parameters:

organizationId - The identifier for the organization under which the entity exists.

Returns:

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

entityId

ListGroupsForEntityRequest.Builder entityId(String entityId)

The identifier for the entity.

The entity ID can accept UserId or GroupID, Username or Groupname, or email.

• Entity ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

• Email address: entity@domain.tld

• Entity name: entity

Parameters:

entityId - The identifier for the entity.

The entity ID can accept UserId or GroupID, Username or Groupname, or email.

• Entity ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

• Email address: entity@domain.tld

• Entity name: entity

Returns:

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

filters

ListGroupsForEntityRequest.Builder filters(ListGroupsForEntityFilters filters)

Limit the search results based on the filter criteria.

Parameters:

filters - Limit the search results based on the filter criteria.

Returns:

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

filters

default ListGroupsForEntityRequest.Builder filters(Consumer<ListGroupsForEntityFilters.Builder> filters)

Limit the search results based on the filter criteria.

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

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

Parameters:

filters - a consumer that will call methods on ListGroupsForEntityFilters.Builder

Returns:

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

See Also:

• filters(ListGroupsForEntityFilters)

nextToken

ListGroupsForEntityRequest.Builder nextToken(String nextToken)

The token to use to retrieve the next page of results. The first call does not contain any tokens.

Parameters:

nextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.

Returns:

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

maxResults

ListGroupsForEntityRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in a single call.

Parameters:

maxResults - The maximum number of results to return in a single call.

Returns:

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

overrideConfiguration

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

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