Class Tunnel

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

A connection between a source computer and a destination device.

See Also:

  • Method Details

    • tunnelId

      public final String tunnelId()

      A unique alpha-numeric ID that identifies a tunnel.

      Returns:
      A unique alpha-numeric ID that identifies a tunnel.

    • tunnelArn

      public final String tunnelArn()

      The Amazon Resource Name (ARN) of a tunnel.

      Returns:
      The Amazon Resource Name (ARN) of a tunnel.

    • status

      public final TunnelStatus status()

      The status of a tunnel. Valid values are: Open and Closed.

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

      Returns:
      The status of a tunnel. Valid values are: Open and Closed.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of a tunnel. Valid values are: Open and Closed.

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

      Returns:
      The status of a tunnel. Valid values are: Open and Closed.
      See Also:

    • sourceConnectionState

      public final ConnectionState sourceConnectionState()

      The connection state of the source application.

      Returns:
      The connection state of the source application.

    • destinationConnectionState

      public final ConnectionState destinationConnectionState()

      The connection state of the destination application.

      Returns:
      The connection state of the destination application.

    • description

      public final String description()

      A description of the tunnel.

      Returns:
      A description of the tunnel.

    • destinationConfig

      public final DestinationConfig destinationConfig()

      The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.

      Returns:
      The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.

    • timeoutConfig

      public final TimeoutConfig timeoutConfig()

      Timeout configuration for the tunnel.

      Returns:
      Timeout configuration for the tunnel.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      A list of tag metadata associated with the secure tunnel.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A list of tag metadata associated with the secure tunnel.

    • createdAt

      public final Instant createdAt()

      The time when the tunnel was created.

      Returns:
      The time when the tunnel was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The last time the tunnel was updated.

      Returns:
      The last time the tunnel was updated.

    • toBuilder

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

    • builder

      public static Tunnel.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Tunnel.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.