com.amazonaws.services.transfer.model.ListUsersResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-transfer Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.transfer.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListUsersResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private String nextToken;
/**
*
* A system-assigned unique identifier for a server that the users are assigned to.
*
*/
private String serverId;
/**
*
* Returns the Transfer Family users and their properties for the ServerId value that you specify.
*
*/
private java.util.List 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.
*
*
* @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.
*/
public void setNextToken(String nextToken) {
this.nextToken = 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 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 getNextToken() {
return this.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.
*
*
* @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.
*/
public ListUsersResult withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* 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.
*/
public void setServerId(String serverId) {
this.serverId = serverId;
}
/**
*
* 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 getServerId() {
return this.serverId;
}
/**
*
* 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.
*/
public ListUsersResult withServerId(String serverId) {
setServerId(serverId);
return this;
}
/**
*
* Returns the Transfer Family users and their properties for the ServerId value that you specify.
*
*
* @return Returns the Transfer Family users and their properties for the ServerId value that you
* specify.
*/
public java.util.List getUsers() {
return users;
}
/**
*
* Returns the Transfer Family users and their properties for the ServerId value that you specify.
*
*
* @param users
* Returns the Transfer Family users and their properties for the ServerId value that you
* specify.
*/
public void setUsers(java.util.Collection users) {
if (users == null) {
this.users = null;
return;
}
this.users = new java.util.ArrayList(users);
}
/**
*
* Returns the Transfer Family users and their properties for the ServerId value that you specify.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setUsers(java.util.Collection)} or {@link #withUsers(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param users
* Returns the Transfer Family users 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.
*/
public ListUsersResult withUsers(ListedUser... users) {
if (this.users == null) {
setUsers(new java.util.ArrayList(users.length));
}
for (ListedUser ele : users) {
this.users.add(ele);
}
return this;
}
/**
*
* Returns the Transfer Family users and their properties for the ServerId value that you specify.
*
*
* @param users
* Returns the Transfer Family users 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.
*/
public ListUsersResult withUsers(java.util.Collection users) {
setUsers(users);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getServerId() != null)
sb.append("ServerId: ").append(getServerId()).append(",");
if (getUsers() != null)
sb.append("Users: ").append(getUsers());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListUsersResult == false)
return false;
ListUsersResult other = (ListUsersResult) obj;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getServerId() == null ^ this.getServerId() == null)
return false;
if (other.getServerId() != null && other.getServerId().equals(this.getServerId()) == false)
return false;
if (other.getUsers() == null ^ this.getUsers() == null)
return false;
if (other.getUsers() != null && other.getUsers().equals(this.getUsers()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getServerId() == null) ? 0 : getServerId().hashCode());
hashCode = prime * hashCode + ((getUsers() == null) ? 0 : getUsers().hashCode());
return hashCode;
}
@Override
public ListUsersResult clone() {
try {
return (ListUsersResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}