DescribedServer (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.transfer.model.DescribedServer

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DescribedServer.Builder,DescribedServer>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class DescribedServer
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DescribedServer.Builder,DescribedServer>
```
Describe the properties of the server that was specified. Information returned includes: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, server Id and state, and assigned tags or metadata.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribedServer.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribedServer.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` Specifies the unique Amazon Resource Name (ARN) for the server to be described.
`static DescribedServer.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`IdentityProviderDetails`	`identityProviderDetails()` Specifies information to call a customer-supplied authentication API.
`IdentityProviderType`	`identityProviderType()` This property defines the mode of authentication method enabled for this service.
`String`	`identityProviderTypeAsString()` This property defines the mode of authentication method enabled for this service.
`String`	`loggingRole()` This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribedServer.Builder>`	`serializableBuilderClass()`
`String`	`serverId()` This property is a unique system assigned identifier for the SFTP server that you instantiate.
`State`	`state()` The condition of the SFTP server for the server that was described.
`String`	`stateAsString()` The condition of the SFTP server for the server that was described.
`List<Tag>`	`tags()` This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
`DescribedServer.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Integer`	`userCount()` The number of users that are assigned to the SFTP server you specified with the `ServerId`.

Methods inherited from class java.lang.Object
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 the server to be described.
    
    Returns:
    
    Specifies the unique Amazon Resource Name (ARN) for the server to be described.
  - identityProviderDetails
```
public IdentityProviderDetails identityProviderDetails()
```
    Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
    
    Returns:
    
    Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
  - identityProviderType
```
public IdentityProviderType identityProviderType()
```
    This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED, means that you are using this Server to store and access SFTP 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.
    
    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:
    
    This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED, means that you are using this Server to store and access SFTP 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
  - identityProviderTypeAsString
```
public String identityProviderTypeAsString()
```
    This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED, means that you are using this Server to store and access SFTP 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.
    
    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:
    
    This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED, means that you are using this Server to store and access SFTP 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
  - loggingRole
```
public String loggingRole()
```
    This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs.
    
    Returns:
    
    This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs.
  - serverId
```
public String serverId()
```
    This property is a unique system assigned identifier for the SFTP server that you instantiate.
    
    Returns:
    
    This property is a unique system assigned identifier for the SFTP server that you instantiate.
  - state
```
public State state()
```
    The condition of the SFTP 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 indicated 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:
    
    The condition of the SFTP 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 indicated 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()
```
    The condition of the SFTP 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 indicated 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:
    
    The condition of the SFTP 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 indicated 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
  - tags
```
public List<Tag> tags()
```
    This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
  - userCount
```
public Integer userCount()
```
    The number of users that are assigned to the SFTP server you specified with the ServerId.
    
    Returns:
    
    The number of users that are assigned to the SFTP server you specified with the ServerId.
  - toBuilder
```
public DescribedServer.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribedServer.Builder,DescribedServer>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DescribedServer.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribedServer.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class DescribedServer

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

identityProviderDetails

identityProviderType

identityProviderTypeAsString

loggingRole

serverId

state

stateAsString

tags

userCount

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields