Class Tunnel
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Tunnel.Builder,
Tunnel>
A connection between a source computer and a destination device.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Tunnel.Builder
builder()
final Instant
The time when the tunnel was created.final String
A description of the tunnel.final 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.final ConnectionState
The connection state of the destination application.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Instant
The last time the tunnel was updated.static Class
<? extends Tunnel.Builder> final ConnectionState
The connection state of the source application.final TunnelStatus
status()
The status of a tunnel.final String
The status of a tunnel.tags()
A list of tag metadata associated with the secure tunnel.final TimeoutConfig
Timeout configuration for the tunnel.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The Amazon Resource Name (ARN) of a tunnel.final String
tunnelId()
A unique alpha-numeric ID that identifies a tunnel.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
tunnelId
A unique alpha-numeric ID that identifies a tunnel.
- Returns:
- A unique alpha-numeric ID that identifies a tunnel.
-
tunnelArn
The Amazon Resource Name (ARN) of a tunnel.
- Returns:
- The Amazon Resource Name (ARN) of a tunnel.
-
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 returnTunnelStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of a tunnel. Valid values are: Open and Closed.
- See Also:
-
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 returnTunnelStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of a tunnel. Valid values are: Open and Closed.
- See Also:
-
sourceConnectionState
The connection state of the source application.
- Returns:
- The connection state of the source application.
-
destinationConnectionState
The connection state of the destination application.
- Returns:
- The connection state of the destination application.
-
description
A description of the tunnel.
- Returns:
- A description of the tunnel.
-
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
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 theisEmpty()
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
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
The time when the tunnel was created.
- Returns:
- The time when the tunnel was created.
-
lastUpdatedAt
The last time the tunnel was updated.
- Returns:
- The last time the tunnel was updated.
-
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 interfaceToCopyableBuilder<Tunnel.Builder,
Tunnel> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-