Interface BatchCreateUserRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<BatchCreateUserRequest.Builder,BatchCreateUserRequest>, SdkBuilder<BatchCreateUserRequest.Builder,BatchCreateUserRequest>, SdkPojo, SdkRequest.Builder, WickrRequest.Builder

Enclosing class:

BatchCreateUserRequest

@Mutable
@NotThreadSafe
public static interface BatchCreateUserRequest.Builder
extends WickrRequest.Builder, SdkPojo, CopyableBuilder<BatchCreateUserRequest.Builder,BatchCreateUserRequest>

Method Summary

Modifier and Type	Method	Description
BatchCreateUserRequest.Builder	clientToken(String clientToken)	A unique identifier for this request to ensure idempotency.
BatchCreateUserRequest.Builder	networkId(String networkId)	The ID of the Wickr network where users will be created.
BatchCreateUserRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
BatchCreateUserRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
BatchCreateUserRequest.Builder	users(Collection<BatchCreateUserRequestItem> users)	A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes.
BatchCreateUserRequest.Builder	users(Consumer<BatchCreateUserRequestItem.Builder>... users)	A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes.
BatchCreateUserRequest.Builder	users(BatchCreateUserRequestItem... users)	A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes.

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.wickr.model.WickrRequest.Builder

build

Method Details

networkId

BatchCreateUserRequest.Builder networkId(String networkId)

The ID of the Wickr network where users will be created.

Parameters:

networkId - The ID of the Wickr network where users will be created.

Returns:

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

users

BatchCreateUserRequest.Builder users(Collection<BatchCreateUserRequestItem> users)

A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes. Maximum 50 users per batch request.

Parameters:

users - A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes. Maximum 50 users per batch request.

Returns:

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

users

BatchCreateUserRequest.Builder users(BatchCreateUserRequestItem... users)

A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes. Maximum 50 users per batch request.

Parameters:

users - A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes. Maximum 50 users per batch request.

Returns:

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

users

BatchCreateUserRequest.Builder users(Consumer<BatchCreateUserRequestItem.Builder>... users)

A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes. Maximum 50 users per batch request.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to users(List<BatchCreateUserRequestItem>).

Parameters:

users - a consumer that will call methods on BatchCreateUserRequestItem.Builder

Returns:

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

See Also:

• users(java.util.Collection<BatchCreateUserRequestItem>)

clientToken

BatchCreateUserRequest.Builder clientToken(String clientToken)

A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without creating duplicate users.

Parameters:

clientToken - A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without creating duplicate users.

Returns:

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

overrideConfiguration

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

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