com.amazonaws.services.transfer.model

Class DescribedServer

java.lang.Object

com.amazonaws.services.transfer.model.DescribedServer

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribedServer
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the properties of a file transfer protocol-enabled server that was specified.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribedServer()

Method Summary

Modifier and Type	Method and Description
DescribedServer	clone()
boolean	equals(Object obj)
String	getArn() Specifies the unique Amazon Resource Name (ARN) of the file transfer protocol-enabled server.
String	getCertificate() Specifies the ARN of the AWS Certificate Manager (ACM) certificate.
EndpointDetails	getEndpointDetails() Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.
String	getEndpointType() Defines the type of endpoint that your file transfer protocol-enabled server is connected to.
String	getHostKeyFingerprint() Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
IdentityProviderDetails	getIdentityProviderDetails() Specifies information to call a customer-supplied authentication API.
String	getIdentityProviderType() Specifies the mode of authentication method enabled for this service.
String	getLoggingRole() Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events.
List<String>	getProtocols() Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
String	getSecurityPolicyName() Specifies the name of the security policy that is attached to the server.
String	getServerId() Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.
String	getState() Specifies the condition of a file transfer protocol-enabled server for the server that was described.
List<Tag>	getTags() Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.
Integer	getUserCount() Specifies the number of users that are assigned to a file transfer protocol-enabled 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) of the file transfer protocol-enabled server.
void	setCertificate(String certificate) Specifies the ARN of the AWS Certificate Manager (ACM) certificate.
void	setEndpointDetails(EndpointDetails endpointDetails) Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.
void	setEndpointType(String endpointType) Defines the type of endpoint that your file transfer protocol-enabled server is connected to.
void	setHostKeyFingerprint(String hostKeyFingerprint) Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
void	setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails) Specifies information to call a customer-supplied authentication API.
void	setIdentityProviderType(String identityProviderType) Specifies the mode of authentication method enabled for this service.
void	setLoggingRole(String loggingRole) Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events.
void	setProtocols(Collection<String> protocols) Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
void	setSecurityPolicyName(String securityPolicyName) Specifies the name of the security policy that is attached to the server.
void	setServerId(String serverId) Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.
void	setState(String state) Specifies the condition of a file transfer protocol-enabled server for the server that was described.
void	setTags(Collection<Tag> tags) Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.
void	setUserCount(Integer userCount) Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.
String	toString() Returns a string representation of this object.
DescribedServer	withArn(String arn) Specifies the unique Amazon Resource Name (ARN) of the file transfer protocol-enabled server.
DescribedServer	withCertificate(String certificate) Specifies the ARN of the AWS Certificate Manager (ACM) certificate.
DescribedServer	withEndpointDetails(EndpointDetails endpointDetails) Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.
DescribedServer	withEndpointType(EndpointType endpointType) Defines the type of endpoint that your file transfer protocol-enabled server is connected to.
DescribedServer	withEndpointType(String endpointType) Defines the type of endpoint that your file transfer protocol-enabled server is connected to.
DescribedServer	withHostKeyFingerprint(String hostKeyFingerprint) Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
DescribedServer	withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails) Specifies information to call a customer-supplied authentication API.
DescribedServer	withIdentityProviderType(IdentityProviderType identityProviderType) Specifies the mode of authentication method enabled for this service.
DescribedServer	withIdentityProviderType(String identityProviderType) Specifies the mode of authentication method enabled for this service.
DescribedServer	withLoggingRole(String loggingRole) Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events.
DescribedServer	withProtocols(Collection<String> protocols) Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
DescribedServer	withProtocols(Protocol... protocols) Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
DescribedServer	withProtocols(String... protocols) Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
DescribedServer	withSecurityPolicyName(String securityPolicyName) Specifies the name of the security policy that is attached to the server.
DescribedServer	withServerId(String serverId) Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.
DescribedServer	withState(State state) Specifies the condition of a file transfer protocol-enabled server for the server that was described.
DescribedServer	withState(String state) Specifies the condition of a file transfer protocol-enabled server for the server that was described.
DescribedServer	withTags(Collection<Tag> tags) Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.
DescribedServer	withTags(Tag... tags) Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.
DescribedServer	withUserCount(Integer userCount) Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribedServer

public DescribedServer()

Method Detail

setArn

public void setArn(String arn)

Specifies the unique Amazon Resource Name (ARN) of the file transfer protocol-enabled server.

Parameters:

arn - Specifies the unique Amazon Resource Name (ARN) of the file transfer protocol-enabled server.

getArn

public String getArn()

Specifies the unique Amazon Resource Name (ARN) of the file transfer protocol-enabled server.

Returns:

Specifies the unique Amazon Resource Name (ARN) of the file transfer protocol-enabled server.

withArn

public DescribedServer withArn(String arn)

Specifies the unique Amazon Resource Name (ARN) of the file transfer protocol-enabled server.

Parameters:

arn - Specifies the unique Amazon Resource Name (ARN) of the file transfer protocol-enabled server.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCertificate

public void setCertificate(String certificate)

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

Parameters:

certificate - Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

getCertificate

public String getCertificate()

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

Returns:

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

withCertificate

public DescribedServer withCertificate(String certificate)

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

Parameters:

certificate - Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndpointDetails

public void setEndpointDetails(EndpointDetails endpointDetails)

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

Parameters:

endpointDetails - Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

getEndpointDetails

public EndpointDetails getEndpointDetails()

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

Returns:

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

withEndpointDetails

public DescribedServer withEndpointDetails(EndpointDetails endpointDetails)

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

Parameters:

endpointDetails - Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndpointType

public void setEndpointType(String endpointType)

Defines the type of endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

Parameters:

endpointType - Defines the type of endpoint that your file transfer protocol-enabled 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()

Defines the type of endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

Returns:

Defines the type of endpoint that your file transfer protocol-enabled 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 DescribedServer withEndpointType(String endpointType)

Defines the type of endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

Parameters:

endpointType - Defines the type of endpoint that your file transfer protocol-enabled 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 DescribedServer withEndpointType(EndpointType endpointType)

Defines the type of endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

Parameters:

endpointType - Defines the type of endpoint that your file transfer protocol-enabled 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

setHostKeyFingerprint

public void setHostKeyFingerprint(String hostKeyFingerprint)

Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

Parameters:

hostKeyFingerprint - Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

getHostKeyFingerprint

public String getHostKeyFingerprint()

Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

Returns:

Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

withHostKeyFingerprint

public DescribedServer withHostKeyFingerprint(String hostKeyFingerprint)

Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

Parameters:

hostKeyFingerprint - Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIdentityProviderDetails

public void setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED.

Parameters:

identityProviderDetails - Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED.

getIdentityProviderDetails

public IdentityProviderDetails getIdentityProviderDetails()

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED.

Returns:

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED.

withIdentityProviderDetails

public DescribedServer withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED.

Parameters:

identityProviderDetails - Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIdentityProviderType

public void setIdentityProviderType(String identityProviderType)

Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

Parameters:

identityProviderType - Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

See Also:

IdentityProviderType

getIdentityProviderType

public String getIdentityProviderType()

Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

Returns:

Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

See Also:

IdentityProviderType

withIdentityProviderType

public DescribedServer withIdentityProviderType(String identityProviderType)

Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

Parameters:

identityProviderType - Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IdentityProviderType

withIdentityProviderType

public DescribedServer withIdentityProviderType(IdentityProviderType identityProviderType)

Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

Parameters:

identityProviderType - Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IdentityProviderType

setLoggingRole

public void setLoggingRole(String loggingRole)

Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

Parameters:

loggingRole - Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

getLoggingRole

public String getLoggingRole()

Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

Returns:

Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

withLoggingRole

public DescribedServer withLoggingRole(String loggingRole)

Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

Parameters:

loggingRole - Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

Returns:

Returns a reference to this object so that method calls can be chained together.

getProtocols

public List<String> getProtocols()

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

• FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

• FTP (File Transfer Protocol): Unencrypted file transfer

Returns:

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

• FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

• FTP (File Transfer Protocol): Unencrypted file transfer

See Also:

Protocol

setProtocols

public void setProtocols(Collection<String> protocols)

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

• FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

• FTP (File Transfer Protocol): Unencrypted file transfer

Parameters:

protocols - Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

• FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

• FTP (File Transfer Protocol): Unencrypted file transfer

See Also:

Protocol

withProtocols

public DescribedServer withProtocols(String... protocols)

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

• FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

• FTP (File Transfer Protocol): Unencrypted file transfer

NOTE: This method appends the values to the existing list (if any). Use setProtocols(java.util.Collection) or withProtocols(java.util.Collection) if you want to override the existing values.

Parameters:

protocols - Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

• FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

• FTP (File Transfer Protocol): Unencrypted file transfer

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Protocol

withProtocols

public DescribedServer withProtocols(Collection<String> protocols)

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

• FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

• FTP (File Transfer Protocol): Unencrypted file transfer

Parameters:

protocols - Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

• FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

• FTP (File Transfer Protocol): Unencrypted file transfer

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Protocol

withProtocols

public DescribedServer withProtocols(Protocol... protocols)

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

• FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

• FTP (File Transfer Protocol): Unencrypted file transfer

Parameters:

protocols - Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

• FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

• FTP (File Transfer Protocol): Unencrypted file transfer

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Protocol

setSecurityPolicyName

public void setSecurityPolicyName(String securityPolicyName)

Specifies the name of the security policy that is attached to the server.

Parameters:

securityPolicyName - Specifies the name of the security policy that is attached to the server.

getSecurityPolicyName

public String getSecurityPolicyName()

Specifies the name of the security policy that is attached to the server.

Returns:

Specifies the name of the security policy that is attached to the server.

withSecurityPolicyName

public DescribedServer withSecurityPolicyName(String securityPolicyName)

Specifies the name of the security policy that is attached to the server.

Parameters:

securityPolicyName - Specifies the name of the security policy that is attached to the server.

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 a file transfer protocol-enabled server that you instantiate.

Parameters:

serverId - Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.

getServerId

public String getServerId()

Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.

Returns:

Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.

withServerId

public DescribedServer withServerId(String serverId)

Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.

Parameters:

serverId - Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.

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 file transfer protocol-enabled 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 file transfer protocol-enabled 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 file transfer protocol-enabled 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 file transfer protocol-enabled 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 DescribedServer withState(String state)

Specifies the condition of a file transfer protocol-enabled 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 file transfer protocol-enabled 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 DescribedServer withState(State state)

Specifies the condition of a file transfer protocol-enabled 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 file transfer protocol-enabled 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

getTags

public List<Tag> getTags()

Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

Returns:

Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

setTags

public void setTags(Collection<Tag> tags)

Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

Parameters:

tags - Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

withTags

public DescribedServer withTags(Tag... tags)

Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public DescribedServer withTags(Collection<Tag> tags)

Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

Parameters:

tags - Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserCount

public void setUserCount(Integer userCount)

Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

Parameters:

userCount - Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

getUserCount

public Integer getUserCount()

Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

Returns:

Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

withUserCount

public DescribedServer withUserCount(Integer userCount)

Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

Parameters:

userCount - Specifies the number of users that are assigned to a file transfer protocol-enabled 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 DescribedServer 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.