ListedServer (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transfer.model.ListedServer

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListedServer
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Returns properties of a file transfer protocol-enabled server that was specified.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ListedServer()

Constructors
Constructor and Description
`ListedServer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListedServer`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
`String`	`getEndpointType()` Specifies the type of VPC endpoint that your server is connected to.
`String`	`getIdentityProviderType()` Specifies the authentication method used to validate a user for a server that was specified.
`String`	`getLoggingRole()` Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
`String`	`getServerId()` Specifies the unique system assigned identifier for the servers that were listed.
`String`	`getState()` Specifies the condition of a server for the server that was described.
`Integer`	`getUserCount()` Specifies the number of users that are assigned to a server you specified with the `ServerId`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
`void`	`setEndpointType(String endpointType)` Specifies the type of VPC endpoint that your server is connected to.
`void`	`setIdentityProviderType(String identityProviderType)` Specifies the authentication method used to validate a user for a server that was specified.
`void`	`setLoggingRole(String loggingRole)` Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
`void`	`setServerId(String serverId)` Specifies the unique system assigned identifier for the servers that were listed.
`void`	`setState(String state)` Specifies the condition of a server for the server that was described.
`void`	`setUserCount(Integer userCount)` Specifies the number of users that are assigned to a server you specified with the `ServerId`.
`String`	`toString()` Returns a string representation of this object.
`ListedServer`	`withArn(String arn)` Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
`ListedServer`	`withEndpointType(EndpointType endpointType)` Specifies the type of VPC endpoint that your server is connected to.
`ListedServer`	`withEndpointType(String endpointType)` Specifies the type of VPC endpoint that your server is connected to.
`ListedServer`	`withIdentityProviderType(IdentityProviderType identityProviderType)` Specifies the authentication method used to validate a user for a server that was specified.
`ListedServer`	`withIdentityProviderType(String identityProviderType)` Specifies the authentication method used to validate a user for a server that was specified.
`ListedServer`	`withLoggingRole(String loggingRole)` Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
`ListedServer`	`withServerId(String serverId)` Specifies the unique system assigned identifier for the servers that were listed.
`ListedServer`	`withState(State state)` Specifies the condition of a server for the server that was described.
`ListedServer`	`withState(String state)` Specifies the condition of a server for the server that was described.
`ListedServer`	`withUserCount(Integer userCount)` Specifies the number of users that are assigned to a server you specified with the `ServerId`.

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

- Constructor Detail
  - ListedServer
```
public ListedServer()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
    
    Parameters:
    
    arn - Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
  - getArn
```
public String getArn()
```
    Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
    
    Returns:
    
    Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
  - withArn
```
public ListedServer withArn(String arn)
```
    Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
    
    Parameters:
    
    arn - Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentityProviderType
```
public void setIdentityProviderType(String identityProviderType)
```
    Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
    
    Parameters:
    
    identityProviderType - Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
    
    See Also:
    
    IdentityProviderType
  - getIdentityProviderType
```
public String getIdentityProviderType()
```
    Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
    
    Returns:
    
    Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
    
    See Also:
    
    IdentityProviderType
  - withIdentityProviderType
```
public ListedServer withIdentityProviderType(String identityProviderType)
```
    Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
    
    Parameters:
    
    identityProviderType - Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IdentityProviderType
  - withIdentityProviderType
```
public ListedServer withIdentityProviderType(IdentityProviderType identityProviderType)
```
    Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
    
    Parameters:
    
    identityProviderType - Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IdentityProviderType
  - setEndpointType
```
public void setEndpointType(String endpointType)
```
    Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    Parameters:
    
    endpointType - Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    See Also:
    
    EndpointType
  - getEndpointType
```
public String getEndpointType()
```
    Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    Returns:
    
    Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    See Also:
    
    EndpointType
  - withEndpointType
```
public ListedServer withEndpointType(String endpointType)
```
    Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    Parameters:
    
    endpointType - Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointType
  - withEndpointType
```
public ListedServer withEndpointType(EndpointType endpointType)
```
    Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    Parameters:
    
    endpointType - Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointType
  - setLoggingRole
```
public void setLoggingRole(String loggingRole)
```
    Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
    
    Parameters:
    
    loggingRole - Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
  - getLoggingRole
```
public String getLoggingRole()
```
    Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
    
    Returns:
    
    Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
  - withLoggingRole
```
public ListedServer withLoggingRole(String loggingRole)
```
    Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
    
    Parameters:
    
    loggingRole - Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServerId
```
public void setServerId(String serverId)
```
    Specifies the unique system assigned identifier for the servers that were listed.
    
    Parameters:
    
    serverId - Specifies the unique system assigned identifier for the servers that were listed.
  - getServerId
```
public String getServerId()
```
    Specifies the unique system assigned identifier for the servers that were listed.
    
    Returns:
    
    Specifies the unique system assigned identifier for the servers that were listed.
  - withServerId
```
public ListedServer withServerId(String serverId)
```
    Specifies the unique system assigned identifier for the servers that were listed.
    
    Parameters:
    
    serverId - Specifies the unique system assigned identifier for the servers that were listed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    Specifies the condition of a server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
    
    The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
    
    Parameters:
    
    state - Specifies the condition of a server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
    
    The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
    
    See Also:
    
    State
  - getState
```
public String getState()
```
    Specifies the condition of a server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
    
    The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
    
    Returns:
    
    Specifies the condition of a server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
    
    The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
    
    See Also:
    
    State
  - withState
```
public ListedServer withState(String state)
```
    Specifies the condition of a server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
    
    The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
    
    Parameters:
    
    state - Specifies the condition of a server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
    
    The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    State
  - withState
```
public ListedServer withState(State state)
```
    Specifies the condition of a server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
    
    The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
    
    Parameters:
    
    state - Specifies the condition of a server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
    
    The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    State
  - setUserCount
```
public void setUserCount(Integer userCount)
```
    Specifies the number of users that are assigned to a server you specified with the ServerId.
    
    Parameters:
    
    userCount - Specifies the number of users that are assigned to a server you specified with the ServerId.
  - getUserCount
```
public Integer getUserCount()
```
    Specifies the number of users that are assigned to a server you specified with the ServerId.
    
    Returns:
    
    Specifies the number of users that are assigned to a server you specified with the ServerId.
  - withUserCount
```
public ListedServer withUserCount(Integer userCount)
```
    Specifies the number of users that are assigned to a server you specified with the ServerId.
    
    Parameters:
    
    userCount - Specifies the number of users that are assigned to a server you specified with the ServerId.
    
    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 ListedServer clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ListedServer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListedServer

Method Detail

setArn

getArn

withArn

setIdentityProviderType

getIdentityProviderType

withIdentityProviderType

withIdentityProviderType

setEndpointType

getEndpointType

withEndpointType

withEndpointType

setLoggingRole

getLoggingRole

withLoggingRole

setServerId

getServerId

withServerId

setState

getState

withState

withState

setUserCount

getUserCount

withUserCount

toString

equals

hashCode

clone

marshall