software.amazon.awssdk.services.mq.model.DescribeUserResponse Maven / Gradle / Ivy
Show all versions of mq Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.mq.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeUserResponse extends MqResponse implements
ToCopyableBuilder {
private static final SdkField BROKER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("BrokerId").getter(getter(DescribeUserResponse::brokerId)).setter(setter(Builder::brokerId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("brokerId").build()).build();
private static final SdkField CONSOLE_ACCESS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("ConsoleAccess").getter(getter(DescribeUserResponse::consoleAccess))
.setter(setter(Builder::consoleAccess))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("consoleAccess").build()).build();
private static final SdkField> GROUPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Groups")
.getter(getter(DescribeUserResponse::groups))
.setter(setter(Builder::groups))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("groups").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField PENDING_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Pending")
.getter(getter(DescribeUserResponse::pending)).setter(setter(Builder::pending))
.constructor(UserPendingChanges::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("pending").build()).build();
private static final SdkField USERNAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Username").getter(getter(DescribeUserResponse::username)).setter(setter(Builder::username))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("username").build()).build();
private static final SdkField REPLICATION_USER_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("ReplicationUser").getter(getter(DescribeUserResponse::replicationUser))
.setter(setter(Builder::replicationUser))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("replicationUser").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BROKER_ID_FIELD,
CONSOLE_ACCESS_FIELD, GROUPS_FIELD, PENDING_FIELD, USERNAME_FIELD, REPLICATION_USER_FIELD));
private final String brokerId;
private final Boolean consoleAccess;
private final List groups;
private final UserPendingChanges pending;
private final String username;
private final Boolean replicationUser;
private DescribeUserResponse(BuilderImpl builder) {
super(builder);
this.brokerId = builder.brokerId;
this.consoleAccess = builder.consoleAccess;
this.groups = builder.groups;
this.pending = builder.pending;
this.username = builder.username;
this.replicationUser = builder.replicationUser;
}
/**
*
* Required. The unique ID that Amazon MQ generates for the broker.
*
*
* @return Required. The unique ID that Amazon MQ generates for the broker.
*/
public final String brokerId() {
return brokerId;
}
/**
*
* Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
*
*
* @return Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
*/
public final Boolean consoleAccess() {
return consoleAccess;
}
/**
* 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 {@code 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.
*/
public final boolean hasGroups() {
return groups != null && !(groups instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasGroups} method.
*
*
* @return 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.
*/
public final List groups() {
return groups;
}
/**
*
* The status of the changes pending for the ActiveMQ user.
*
*
* @return The status of the changes pending for the ActiveMQ user.
*/
public final UserPendingChanges pending() {
return pending;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String username() {
return username;
}
/**
*
* Describes whether the user is intended for data replication
*
*
* @return Describes whether the user is intended for data replication
*/
public final Boolean replicationUser() {
return replicationUser;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(brokerId());
hashCode = 31 * hashCode + Objects.hashCode(consoleAccess());
hashCode = 31 * hashCode + Objects.hashCode(hasGroups() ? groups() : null);
hashCode = 31 * hashCode + Objects.hashCode(pending());
hashCode = 31 * hashCode + Objects.hashCode(username());
hashCode = 31 * hashCode + Objects.hashCode(replicationUser());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeUserResponse)) {
return false;
}
DescribeUserResponse other = (DescribeUserResponse) obj;
return Objects.equals(brokerId(), other.brokerId()) && Objects.equals(consoleAccess(), other.consoleAccess())
&& hasGroups() == other.hasGroups() && Objects.equals(groups(), other.groups())
&& Objects.equals(pending(), other.pending()) && Objects.equals(username(), other.username())
&& Objects.equals(replicationUser(), other.replicationUser());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeUserResponse").add("BrokerId", brokerId()).add("ConsoleAccess", consoleAccess())
.add("Groups", hasGroups() ? groups() : null).add("Pending", pending()).add("Username", username())
.add("ReplicationUser", replicationUser()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "BrokerId":
return Optional.ofNullable(clazz.cast(brokerId()));
case "ConsoleAccess":
return Optional.ofNullable(clazz.cast(consoleAccess()));
case "Groups":
return Optional.ofNullable(clazz.cast(groups()));
case "Pending":
return Optional.ofNullable(clazz.cast(pending()));
case "Username":
return Optional.ofNullable(clazz.cast(username()));
case "ReplicationUser":
return Optional.ofNullable(clazz.cast(replicationUser()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeUserResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends MqResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* Required. The unique ID that Amazon MQ generates for the broker.
*
*
* @param brokerId
* Required. The unique ID that Amazon MQ generates for the broker.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder brokerId(String brokerId);
/**
*
* Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
*
*
* @param consoleAccess
* Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder consoleAccess(Boolean consoleAccess);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groups(Collection 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groups(String... groups);
/**
*
* The status of the changes pending for the ActiveMQ user.
*
*
* @param pending
* The status of the changes pending for the ActiveMQ user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pending(UserPendingChanges pending);
/**
*
* The status of the changes pending for the ActiveMQ user.
*
* This is a convenience method that creates an instance of the {@link UserPendingChanges.Builder} avoiding the
* need to create one manually via {@link UserPendingChanges#builder()}.
*
*
* When the {@link Consumer} completes, {@link UserPendingChanges.Builder#build()} is called immediately and its
* result is passed to {@link #pending(UserPendingChanges)}.
*
* @param pending
* a consumer that will call methods on {@link UserPendingChanges.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #pending(UserPendingChanges)
*/
default Builder pending(Consumer pending) {
return pending(UserPendingChanges.builder().applyMutation(pending).build());
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder username(String username);
/**
*
* Describes whether the user is intended for data replication
*
*
* @param replicationUser
* Describes whether the user is intended for data replication
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder replicationUser(Boolean replicationUser);
}
static final class BuilderImpl extends MqResponse.BuilderImpl implements Builder {
private String brokerId;
private Boolean consoleAccess;
private List groups = DefaultSdkAutoConstructList.getInstance();
private UserPendingChanges pending;
private String username;
private Boolean replicationUser;
private BuilderImpl() {
}
private BuilderImpl(DescribeUserResponse model) {
super(model);
brokerId(model.brokerId);
consoleAccess(model.consoleAccess);
groups(model.groups);
pending(model.pending);
username(model.username);
replicationUser(model.replicationUser);
}
public final String getBrokerId() {
return brokerId;
}
public final void setBrokerId(String brokerId) {
this.brokerId = brokerId;
}
@Override
public final Builder brokerId(String brokerId) {
this.brokerId = brokerId;
return this;
}
public final Boolean getConsoleAccess() {
return consoleAccess;
}
public final void setConsoleAccess(Boolean consoleAccess) {
this.consoleAccess = consoleAccess;
}
@Override
public final Builder consoleAccess(Boolean consoleAccess) {
this.consoleAccess = consoleAccess;
return this;
}
public final Collection getGroups() {
if (groups instanceof SdkAutoConstructList) {
return null;
}
return groups;
}
public final void setGroups(Collection groups) {
this.groups = ___listOf__stringCopier.copy(groups);
}
@Override
public final Builder groups(Collection groups) {
this.groups = ___listOf__stringCopier.copy(groups);
return this;
}
@Override
@SafeVarargs
public final Builder groups(String... groups) {
groups(Arrays.asList(groups));
return this;
}
public final UserPendingChanges.Builder getPending() {
return pending != null ? pending.toBuilder() : null;
}
public final void setPending(UserPendingChanges.BuilderImpl pending) {
this.pending = pending != null ? pending.build() : null;
}
@Override
public final Builder pending(UserPendingChanges pending) {
this.pending = pending;
return this;
}
public final String getUsername() {
return username;
}
public final void setUsername(String username) {
this.username = username;
}
@Override
public final Builder username(String username) {
this.username = username;
return this;
}
public final Boolean getReplicationUser() {
return replicationUser;
}
public final void setReplicationUser(Boolean replicationUser) {
this.replicationUser = replicationUser;
}
@Override
public final Builder replicationUser(Boolean replicationUser) {
this.replicationUser = replicationUser;
return this;
}
@Override
public DescribeUserResponse build() {
return new DescribeUserResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}