Class SftpPortWithOptions

java.lang.Object
software.amazon.awssdk.services.transfer.model.SftpPortWithOptions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SftpPortWithOptions.Builder,SftpPortWithOptions>
@Generated("software.amazon.awssdk:codegen") public final class SftpPortWithOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SftpPortWithOptions.Builder,SftpPortWithOptions>

Specifies the configuration for a single SFTP port on a Transfer Family server that uses the SFTP protocol and has a PUBLIC endpoint. Each entry in the SftpPorts list is an SftpPortWithOptions object that pairs a port number with a communication mode.

See Also:

  • Method Details

    • sftpPort

      public final Integer sftpPort()

      The port on which the Transfer Family server listens for SFTP connections. Specify any integer from 2000 to 65535, or 22. This value is required for each entry in the SftpPorts list.

      Returns:
      The port on which the Transfer Family server listens for SFTP connections. Specify any integer from 2000 to 65535, or 22. This value is required for each entry in the SftpPorts list.

    • communicationMode

      public final CommunicationMode communicationMode()

      Determines whether the server or the client sends data first when a client establishes an SFTP connection on this port. Valid values are SERVER_TALK_FIRST and CLIENT_TALK_FIRST. For a description of each mode, see the SftpPorts property. This value is optional.

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

      Returns:
      Determines whether the server or the client sends data first when a client establishes an SFTP connection on this port. Valid values are SERVER_TALK_FIRST and CLIENT_TALK_FIRST. For a description of each mode, see the SftpPorts property. This value is optional.
      See Also:

    • communicationModeAsString

      public final String communicationModeAsString()

      Determines whether the server or the client sends data first when a client establishes an SFTP connection on this port. Valid values are SERVER_TALK_FIRST and CLIENT_TALK_FIRST. For a description of each mode, see the SftpPorts property. This value is optional.

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

      Returns:
      Determines whether the server or the client sends data first when a client establishes an SFTP connection on this port. Valid values are SERVER_TALK_FIRST and CLIENT_TALK_FIRST. For a description of each mode, see the SftpPorts property. This value is optional.
      See Also:

    • toBuilder

      public SftpPortWithOptions.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<SftpPortWithOptions.Builder,SftpPortWithOptions>
      Returns:
      a builder for type T

    • builder

      public static SftpPortWithOptions.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.