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

Class DescribeUserResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeUserResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	brokerId()	Required.
static DescribeUserResponse.Builder	builder()
Boolean	consoleAccess()	Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<String>	groups()	The list of groups (20 maximum) to which the ActiveMQ user belongs.
boolean	hasGroups()	For responses, this returns true if the service returned a value for the Groups property.
int	hashCode()
UserPendingChanges	pending()	The status of the changes pending for the ActiveMQ user.
Boolean	replicationUser()	Describes whether the user is intended for data replication
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeUserResponse.Builder>	serializableBuilderClass()
DescribeUserResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	username()	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.

consoleAccess

public final Boolean consoleAccess()

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

Returns:

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

hasGroups

public final boolean hasGroups()

For responses, this returns true if the service returned a value for the Groups 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.

groups

public final List<String> groups()

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

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 hasGroups() method.

Returns:

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

pending

public final UserPendingChanges pending()

The status of the changes pending for the ActiveMQ user.

Returns:

The status of the changes pending for the ActiveMQ user.

username

public final String username()

Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Returns:

Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

replicationUser

public final Boolean replicationUser()

Describes whether the user is intended for data replication

Returns:

Describes whether the user is intended for data replication

toBuilder

public DescribeUserResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeUserResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeUserResponse.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