software.amazon.awssdk.services.transfer.model.ListUsersResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of transfer Show documentation
Show all versions of transfer Show documentation
The AWS Java SDK for Transfer module holds the client classes that are used for
communicating with Transfer.
/*
* 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.transfer.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 TransferResponse implements
ToCopyableBuilder {
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 SERVER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ServerId").getter(getter(ListUsersResponse::serverId)).setter(setter(Builder::serverId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServerId").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(ListedUser::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NEXT_TOKEN_FIELD,
SERVER_ID_FIELD, USERS_FIELD));
private final String nextToken;
private final String serverId;
private final List users;
private ListUsersResponse(BuilderImpl builder) {
super(builder);
this.nextToken = builder.nextToken;
this.serverId = builder.serverId;
this.users = builder.users;
}
/**
*
* When you can get additional results from the ListUsers call, a NextToken parameter is
* returned in the output. You can then pass in a subsequent command to the NextToken parameter to
* continue listing additional users.
*
*
* @return When you can get additional results from the ListUsers call, a NextToken
* parameter is returned in the output. You can then pass in a subsequent command to the
* NextToken parameter to continue listing additional users.
*/
public String nextToken() {
return nextToken;
}
/**
*
* A system-assigned unique identifier for a server that the users are assigned to.
*
*
* @return A system-assigned unique identifier for a server that the users are assigned to.
*/
public String serverId() {
return serverId;
}
/**
* Returns true if the Users property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasUsers() {
return users != null && !(users instanceof SdkAutoConstructList);
}
/**
*
* Returns the user accounts and their properties for the ServerId value that you specify.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasUsers()} to see if a value was sent in this field.
*
*
* @return Returns the user accounts and their properties for the ServerId value that you specify.
*/
public 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 int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(serverId());
hashCode = 31 * hashCode + Objects.hashCode(users());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public 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(nextToken(), other.nextToken()) && Objects.equals(serverId(), other.serverId())
&& 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 String toString() {
return ToString.builder("ListUsersResponse").add("NextToken", nextToken()).add("ServerId", serverId())
.add("Users", users()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "ServerId":
return Optional.ofNullable(clazz.cast(serverId()));
case "Users":
return Optional.ofNullable(clazz.cast(users()));
default:
return Optional.empty();
}
}
@Override
public 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 TransferResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* When you can get additional results from the ListUsers call, a NextToken parameter
* is returned in the output. You can then pass in a subsequent command to the NextToken parameter
* to continue listing additional users.
*
*
* @param nextToken
* When you can get additional results from the ListUsers call, a NextToken
* parameter is returned in the output. You can then pass in a subsequent command to the
* NextToken parameter to continue listing additional users.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* A system-assigned unique identifier for a server that the users are assigned to.
*
*
* @param serverId
* A system-assigned unique identifier for a server that the users are assigned to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder serverId(String serverId);
/**
*
* Returns the user accounts and their properties for the ServerId value that you specify.
*
*
* @param users
* Returns the user accounts and their properties for the ServerId value that you specify.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder users(Collection users);
/**
*
* Returns the user accounts and their properties for the ServerId value that you specify.
*
*
* @param users
* Returns the user accounts and their properties for the ServerId value that you specify.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder users(ListedUser... users);
/**
*
* Returns the user accounts and their properties for the ServerId value that you specify.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #users(List)}.
*
* @param users
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #users(List)
*/
Builder users(Consumer... users);
}
static final class BuilderImpl extends TransferResponse.BuilderImpl implements Builder {
private String nextToken;
private String serverId;
private List users = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ListUsersResponse model) {
super(model);
nextToken(model.nextToken);
serverId(model.serverId);
users(model.users);
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
public final String getServerId() {
return serverId;
}
@Override
public final Builder serverId(String serverId) {
this.serverId = serverId;
return this;
}
public final void setServerId(String serverId) {
this.serverId = serverId;
}
public final Collection getUsers() {
return users != null ? users.stream().map(ListedUser::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder users(Collection users) {
this.users = ListedUsersCopier.copy(users);
return this;
}
@Override
@SafeVarargs
public final Builder users(ListedUser... users) {
users(Arrays.asList(users));
return this;
}
@Override
@SafeVarargs
public final Builder users(Consumer... users) {
users(Stream.of(users).map(c -> ListedUser.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setUsers(Collection users) {
this.users = ListedUsersCopier.copyFromBuilder(users);
}
@Override
public ListUsersResponse build() {
return new ListUsersResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy