Package software.amazon.awssdk.services.mq.model

Interface ListUsersResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>, MqResponse.Builder, SdkBuilder<ListUsersResponse.Builder,ListUsersResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ListUsersResponse

public static interface ListUsersResponse.Builder
extends MqResponse.Builder, SdkPojo, CopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>

Method Summary

Modifier and Type	Method	Description
ListUsersResponse.Builder	brokerId(String brokerId)	Required.
ListUsersResponse.Builder	maxResults(Integer maxResults)	Required.
ListUsersResponse.Builder	nextToken(String nextToken)	The token that specifies the next page of results Amazon MQ should return.
ListUsersResponse.Builder	users(Collection<UserSummary> users)	Required.
ListUsersResponse.Builder	users(Consumer<UserSummary.Builder>... users)	Required.
ListUsersResponse.Builder	users(UserSummary... users)	Required.

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

copy

Methods inherited from interface software.amazon.awssdk.services.mq.model.MqResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

brokerId

ListUsersResponse.Builder brokerId(String brokerId)

Required. The unique ID that Amazon MQ generates for the broker.

Parameters:

brokerId - Required. The unique ID that Amazon MQ generates for the broker.

Returns:

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

maxResults

ListUsersResponse.Builder maxResults(Integer maxResults)

Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.

Parameters:

maxResults - Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.

Returns:

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

nextToken

ListUsersResponse.Builder nextToken(String nextToken)

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Parameters:

nextToken - The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Returns:

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

users

ListUsersResponse.Builder users(Collection<UserSummary> users)

Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.

Parameters:

users - Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.

Returns:

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

users

ListUsersResponse.Builder users(UserSummary... users)

Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.

Parameters:

users - Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.

Returns:

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

users

ListUsersResponse.Builder users(Consumer<UserSummary.Builder>... users)

Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.

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

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

Parameters:

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

Returns:

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

See Also:

#users(java.util.Collection)