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

Class ListUsersResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.mq.model.MqResponse

software.amazon.awssdk.services.mq.model.ListUsersResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>

@Generated("software.amazon.awssdk:codegen")
public final class ListUsersResponse
extends MqResponse
implements ToCopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListUsersResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	brokerId()	Required.
static ListUsersResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUsers()	For responses, this returns true if the service returned a value for the Users property.
Integer	maxResults()	Required.
String	nextToken()	The token that specifies the next page of results Amazon MQ should return.
List<SdkField<?>>	sdkFields()
static Class<? extends ListUsersResponse.Builder>	serializableBuilderClass()
ListUsersResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<UserSummary>	users()	Required.

Methods inherited from class software.amazon.awssdk.services.mq.model.MqResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

brokerId

public final String brokerId()

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

Returns:

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

maxResults

public final 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.

Returns:

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.

nextToken

public final String nextToken()

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

Returns:

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

hasUsers

public final boolean hasUsers()

For responses, this returns true if the service returned a value for the Users property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

users

public final List<UserSummary> users()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUsers() method.

Returns:

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

toBuilder

public ListUsersResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ListUsersResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ListUsersResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo