@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.
Constructor and Description |
---|
ListedServer() |
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 |
getDomain() |
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 |
setDomain(String domain) |
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 |
withDomain(Domain domain) |
ListedServer |
withDomain(String domain) |
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 . |
public void setArn(String arn)
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
arn
- Specifies the unique Amazon Resource Name (ARN) for a server to be listed.public String getArn()
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
public ListedServer withArn(String arn)
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
arn
- Specifies the unique Amazon Resource Name (ARN) for a server to be listed.public ListedServer withDomain(String domain)
domain
- Domain
public ListedServer withDomain(Domain domain)
domain
- Domain
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
.
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
.IdentityProviderType
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
.
SERVICE_MANAGED
or API_GATEWAY
.IdentityProviderType
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
.
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
.IdentityProviderType
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
.
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
.IdentityProviderType
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.
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.EndpointType
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.
EndpointType
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.
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.EndpointType
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.
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.EndpointType
public void setLoggingRole(String loggingRole)
Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
loggingRole
- Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon
CloudWatch logging.public String getLoggingRole()
Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
public ListedServer withLoggingRole(String loggingRole)
Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
loggingRole
- Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon
CloudWatch logging.public void setServerId(String serverId)
Specifies the unique system assigned identifier for the servers that were listed.
serverId
- Specifies the unique system assigned identifier for the servers that were listed.public String getServerId()
Specifies the unique system assigned identifier for the servers that were listed.
public ListedServer withServerId(String serverId)
Specifies the unique system assigned identifier for the servers that were listed.
serverId
- Specifies the unique system assigned identifier for the servers that were listed.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.
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.
State
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.
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.
State
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.
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.
State
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.
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.
State
public void setUserCount(Integer userCount)
Specifies the number of users that are assigned to a server you specified with the ServerId
.
userCount
- Specifies the number of users that are assigned to a server you specified with the ServerId
.public Integer getUserCount()
Specifies the number of users that are assigned to a server you specified with the ServerId
.
ServerId
.public ListedServer withUserCount(Integer userCount)
Specifies the number of users that are assigned to a server you specified with the ServerId
.
userCount
- Specifies the number of users that are assigned to a server you specified with the ServerId
.public String toString()
toString
in class Object
Object.toString()
public ListedServer clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.