software.amazon.awssdk.services.transfer.model

Class ListedServer

java.lang.Object

software.amazon.awssdk.services.transfer.model.ListedServer

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ListedServer.Builder,ListedServer>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListedServer
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ListedServer.Builder,ListedServer>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListedServer.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
static ListedServer.Builder	builder()
EndpointType	endpointType() Specifies the type of VPC endpoint that your server is connected to.
String	endpointTypeAsString() Specifies the type of VPC endpoint that your server is connected to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IdentityProviderType	identityProviderType() Specifies the authentication method used to validate a user for a server that was specified.
String	identityProviderTypeAsString() Specifies the authentication method used to validate a user for a server that was specified.
String	loggingRole() Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
List<SdkField<?>>	sdkFields()
static Class<? extends ListedServer.Builder>	serializableBuilderClass()
String	serverId() Specifies the unique system assigned identifier for the servers that were listed.
State	state() Specifies the condition of a server for the server that was described.
String	stateAsString() Specifies the condition of a server for the server that was described.
ListedServer.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public String arn()

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.

identityProviderType

public 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.

If the service returns an enum value that is not available in the current SDK version, identityProviderType will return IdentityProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityProviderTypeAsString().

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

identityProviderTypeAsString

public String identityProviderTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, identityProviderType will return IdentityProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityProviderTypeAsString().

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

endpointType

public 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.

If the service returns an enum value that is not available in the current SDK version, endpointType will return EndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().

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

endpointTypeAsString

public String endpointTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, endpointType will return EndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().

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

loggingRole

public String loggingRole()

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.

serverId

public String serverId()

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.

state

public 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.

If the service returns an enum value that is not available in the current SDK version, state will return State.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

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

stateAsString

public String stateAsString()

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.

If the service returns an enum value that is not available in the current SDK version, state will return State.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

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

userCount

public Integer userCount()

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.

toBuilder

public ListedServer.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListedServer.Builder,ListedServer>

builder

public static ListedServer.Builder builder()

serializableBuilderClass

public static Class<? extends ListedServer.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo