software.amazon.awssdk.services.mq.model.ListUsersResponse 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 java.util.stream.Collectors;
import java.util.stream.Stream;
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 ListUsersResponse extends MqResponse implements
ToCopyableBuilder {
private static final SdkField BROKER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("BrokerId").getter(getter(ListUsersResponse::brokerId)).setter(setter(Builder::brokerId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("brokerId").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListUsersResponse::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListUsersResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("nextToken").build()).build();
private static final SdkField> USERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Users")
.getter(getter(ListUsersResponse::users))
.setter(setter(Builder::users))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("users").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(UserSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BROKER_ID_FIELD,
MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD, USERS_FIELD));
private final String brokerId;
private final Integer maxResults;
private final String nextToken;
private final List users;
private ListUsersResponse(BuilderImpl builder) {
super(builder);
this.brokerId = builder.brokerId;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.users = builder.users;
}
/**
*
* 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;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
* nextToken empty.
*
*
* @return The token that specifies the next page of results Amazon MQ should return. To request the first page,
* leave nextToken empty.
*/
public final String nextToken() {
return nextToken;
}
/**
* 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 {@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 hasUsers() {
return users != null && !(users instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasUsers} method.
*
*
* @return Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ
* brokers.
*/
public final List users() {
return users;
}
@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(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(hasUsers() ? users() : null);
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 ListUsersResponse)) {
return false;
}
ListUsersResponse other = (ListUsersResponse) obj;
return Objects.equals(brokerId(), other.brokerId()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(nextToken(), other.nextToken()) && hasUsers() == other.hasUsers()
&& Objects.equals(users(), other.users());
}
/**
* 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("ListUsersResponse").add("BrokerId", brokerId()).add("MaxResults", maxResults())
.add("NextToken", nextToken()).add("Users", hasUsers() ? users() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "BrokerId":
return Optional.ofNullable(clazz.cast(brokerId()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "Users":
return Optional.ofNullable(clazz.cast(users()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListUsersResponse) 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);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
* nextToken empty.
*
*
* @param nextToken
* The token that specifies the next page of results Amazon MQ should return. To request the first page,
* leave nextToken empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.
*
*
* @param users
* Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ
* brokers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder users(Collection users);
/**
*
* Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.
*
*
* @param users
* Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ
* brokers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder users(UserSummary... 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
* {@link software.amazon.awssdk.services.mq.model.UserSummary.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.mq.model.UserSummary#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.mq.model.UserSummary.Builder#build()} is called immediately and its
* result is passed to {@link #users(List)}.
*
* @param users
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.mq.model.UserSummary.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #users(java.util.Collection)
*/
Builder users(Consumer... users);
}
static final class BuilderImpl extends MqResponse.BuilderImpl implements Builder {
private String brokerId;
private Integer maxResults;
private String nextToken;
private List users = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ListUsersResponse model) {
super(model);
brokerId(model.brokerId);
maxResults(model.maxResults);
nextToken(model.nextToken);
users(model.users);
}
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 Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final List getUsers() {
List result = ___listOfUserSummaryCopier.copyToBuilder(this.users);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setUsers(Collection users) {
this.users = ___listOfUserSummaryCopier.copyFromBuilder(users);
}
@Override
public final Builder users(Collection users) {
this.users = ___listOfUserSummaryCopier.copy(users);
return this;
}
@Override
@SafeVarargs
public final Builder users(UserSummary... users) {
users(Arrays.asList(users));
return this;
}
@Override
@SafeVarargs
public final Builder users(Consumer... users) {
users(Stream.of(users).map(c -> UserSummary.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public ListUsersResponse build() {
return new ListUsersResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}