ListUsersResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.transfer.model.ListUsersResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListUsersResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ListUsersResult()

Constructors
Constructor and Description
`ListUsersResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListUsersResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getNextToken()` When you can get additional results from the `ListUsers` call, a `NextToken` parameter is returned in the output.
`String`	`getServerId()` A system-assigned unique identifier for an SFTP server that the users are assigned to.
`List<ListedUser>`	`getUsers()` Returns the user accounts and their properties for the `ServerId` value that you specify.
`int`	`hashCode()`
`void`	`setNextToken(String nextToken)` When you can get additional results from the `ListUsers` call, a `NextToken` parameter is returned in the output.
`void`	`setServerId(String serverId)` A system-assigned unique identifier for an SFTP server that the users are assigned to.
`void`	`setUsers(Collection<ListedUser> users)` Returns the user accounts and their properties for the `ServerId` value that you specify.
`String`	`toString()` Returns a string representation of this object.
`ListUsersResult`	`withNextToken(String nextToken)` When you can get additional results from the `ListUsers` call, a `NextToken` parameter is returned in the output.
`ListUsersResult`	`withServerId(String serverId)` A system-assigned unique identifier for an SFTP server that the users are assigned to.
`ListUsersResult`	`withUsers(Collection<ListedUser> users)` Returns the user accounts and their properties for the `ServerId` value that you specify.
`ListUsersResult`	`withUsers(ListedUser... users)` Returns the user accounts and their properties for the `ServerId` value that you specify.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListUsersResult
```
public ListUsersResult()
```
- Method Detail
  - setNextToken
```
public void setNextToken(String 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 the NextToken parameter to continue listing additional users.
    
    Parameters:
    
    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 the NextToken parameter to continue listing additional users.
  - getNextToken
```
public String getNextToken()
```
    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 the NextToken parameter to continue listing additional users.
    
    Returns:
    
    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 the NextToken parameter to continue listing additional users.
  - withNextToken
```
public ListUsersResult withNextToken(String 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 the NextToken parameter to continue listing additional users.
    
    Parameters:
    
    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 the NextToken parameter to continue listing additional users.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServerId
```
public void setServerId(String serverId)
```
    A system-assigned unique identifier for an SFTP server that the users are assigned to.
    
    Parameters:
    
    serverId - A system-assigned unique identifier for an SFTP server that the users are assigned to.
  - getServerId
```
public String getServerId()
```
    A system-assigned unique identifier for an SFTP server that the users are assigned to.
    
    Returns:
    
    A system-assigned unique identifier for an SFTP server that the users are assigned to.
  - withServerId
```
public ListUsersResult withServerId(String serverId)
```
    A system-assigned unique identifier for an SFTP server that the users are assigned to.
    
    Parameters:
    
    serverId - A system-assigned unique identifier for an SFTP server that the users are assigned to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUsers
```
public List<ListedUser> getUsers()
```
    Returns the user accounts and their properties for the ServerId value that you specify.
    
    Returns:
    
    Returns the user accounts and their properties for the ServerId value that you specify.
  - setUsers
```
public void setUsers(Collection<ListedUser> users)
```
    Returns the user accounts and their properties for the ServerId value that you specify.
    
    Parameters:
    
    users - Returns the user accounts and their properties for the ServerId value that you specify.
  - withUsers
```
public ListUsersResult withUsers(ListedUser... users)
```
    Returns the user accounts and their properties for the ServerId value that you specify.
    
    NOTE: This method appends the values to the existing list (if any). Use setUsers(java.util.Collection) or withUsers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    users - Returns the user accounts and their properties for the ServerId value that you specify.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUsers
```
public ListUsersResult withUsers(Collection<ListedUser> users)
```
    Returns the user accounts and their properties for the ServerId value that you specify.
    
    Parameters:
    
    users - Returns the user accounts and their properties for the ServerId value that you specify.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ListUsersResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class ListUsersResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

ListUsersResult

Method Detail

setNextToken

getNextToken

withNextToken

setServerId

getServerId

withServerId

getUsers

setUsers

withUsers

withUsers

toString

equals

hashCode

clone