Tunnel (AWS Java SDK for AWS IoT Secure Tunneling 1.11.720 API)

java.lang.Object
- com.amazonaws.services.iotsecuretunneling.model.Tunnel

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Tunnel
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A connection between a source computer and a destination device.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Tunnel()

Constructors
Constructor and Description
`Tunnel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Tunnel`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedAt()` The time when the tunnel was created.
`String`	`getDescription()` A description of the tunnel.
`DestinationConfig`	`getDestinationConfig()` 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.
`ConnectionState`	`getDestinationConnectionState()` The connection state of the destination application.
`Date`	`getLastUpdatedAt()` The last time the tunnel was updated.
`ConnectionState`	`getSourceConnectionState()` The connection state of the source application.
`String`	`getStatus()` The status of a tunnel.
`List<Tag>`	`getTags()` A list of tag metadata associated with the secure tunnel.
`TimeoutConfig`	`getTimeoutConfig()` Timeout configuration for the tunnel.
`String`	`getTunnelArn()` The Amazon Resource Name (ARN) of a tunnel.
`String`	`getTunnelId()` A unique alpha-numeric ID that identifies a tunnel.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setCreatedAt(Date createdAt)` The time when the tunnel was created.
`void`	`setDescription(String description)` A description of the tunnel.
`void`	`setDestinationConfig(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.
`void`	`setDestinationConnectionState(ConnectionState destinationConnectionState)` The connection state of the destination application.
`void`	`setLastUpdatedAt(Date lastUpdatedAt)` The last time the tunnel was updated.
`void`	`setSourceConnectionState(ConnectionState sourceConnectionState)` The connection state of the source application.
`void`	`setStatus(String status)` The status of a tunnel.
`void`	`setTags(Collection<Tag> tags)` A list of tag metadata associated with the secure tunnel.
`void`	`setTimeoutConfig(TimeoutConfig timeoutConfig)` Timeout configuration for the tunnel.
`void`	`setTunnelArn(String tunnelArn)` The Amazon Resource Name (ARN) of a tunnel.
`void`	`setTunnelId(String tunnelId)` A unique alpha-numeric ID that identifies a tunnel.
`String`	`toString()` Returns a string representation of this object.
`Tunnel`	`withCreatedAt(Date createdAt)` The time when the tunnel was created.
`Tunnel`	`withDescription(String description)` A description of the tunnel.
`Tunnel`	`withDestinationConfig(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.
`Tunnel`	`withDestinationConnectionState(ConnectionState destinationConnectionState)` The connection state of the destination application.
`Tunnel`	`withLastUpdatedAt(Date lastUpdatedAt)` The last time the tunnel was updated.
`Tunnel`	`withSourceConnectionState(ConnectionState sourceConnectionState)` The connection state of the source application.
`Tunnel`	`withStatus(String status)` The status of a tunnel.
`Tunnel`	`withStatus(TunnelStatus status)` The status of a tunnel.
`Tunnel`	`withTags(Collection<Tag> tags)` A list of tag metadata associated with the secure tunnel.
`Tunnel`	`withTags(Tag... tags)` A list of tag metadata associated with the secure tunnel.
`Tunnel`	`withTimeoutConfig(TimeoutConfig timeoutConfig)` Timeout configuration for the tunnel.
`Tunnel`	`withTunnelArn(String tunnelArn)` The Amazon Resource Name (ARN) of a tunnel.
`Tunnel`	`withTunnelId(String tunnelId)` A unique alpha-numeric ID that identifies a tunnel.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Tunnel
```
public Tunnel()
```
- Method Detail
  - setTunnelId
```
public void setTunnelId(String tunnelId)
```
    A unique alpha-numeric ID that identifies a tunnel.
    
    Parameters:
    
    tunnelId - A unique alpha-numeric ID that identifies a tunnel.
  - getTunnelId
```
public String getTunnelId()
```
    A unique alpha-numeric ID that identifies a tunnel.
    
    Returns:
    
    A unique alpha-numeric ID that identifies a tunnel.
  - withTunnelId
```
public Tunnel withTunnelId(String tunnelId)
```
    A unique alpha-numeric ID that identifies a tunnel.
    
    Parameters:
    
    tunnelId - A unique alpha-numeric ID that identifies a tunnel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTunnelArn
```
public void setTunnelArn(String tunnelArn)
```
    The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
    
    Parameters:
    
    tunnelArn - The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
  - getTunnelArn
```
public String getTunnelArn()
```
    The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
    
    Returns:
    
    The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
  - withTunnelArn
```
public Tunnel withTunnelArn(String tunnelArn)
```
    The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
    
    Parameters:
    
    tunnelArn - The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of a tunnel. Valid values are: Open and Closed.
    
    Parameters:
    
    status - The status of a tunnel. Valid values are: Open and Closed.
    
    See Also:
    
    TunnelStatus
  - getStatus
```
public String getStatus()
```
    The status of a tunnel. Valid values are: Open and Closed.
    
    Returns:
    
    The status of a tunnel. Valid values are: Open and Closed.
    
    See Also:
    
    TunnelStatus
  - withStatus
```
public Tunnel withStatus(String status)
```
    The status of a tunnel. Valid values are: Open and Closed.
    
    Parameters:
    
    status - The status of a tunnel. Valid values are: Open and Closed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TunnelStatus
  - withStatus
```
public Tunnel withStatus(TunnelStatus status)
```
    The status of a tunnel. Valid values are: Open and Closed.
    
    Parameters:
    
    status - The status of a tunnel. Valid values are: Open and Closed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TunnelStatus
  - setSourceConnectionState
```
public void setSourceConnectionState(ConnectionState sourceConnectionState)
```
    The connection state of the source application.
    
    Parameters:
    
    sourceConnectionState - The connection state of the source application.
  - getSourceConnectionState
```
public ConnectionState getSourceConnectionState()
```
    The connection state of the source application.
    
    Returns:
    
    The connection state of the source application.
  - withSourceConnectionState
```
public Tunnel withSourceConnectionState(ConnectionState sourceConnectionState)
```
    The connection state of the source application.
    
    Parameters:
    
    sourceConnectionState - The connection state of the source application.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestinationConnectionState
```
public void setDestinationConnectionState(ConnectionState destinationConnectionState)
```
    The connection state of the destination application.
    
    Parameters:
    
    destinationConnectionState - The connection state of the destination application.
  - getDestinationConnectionState
```
public ConnectionState getDestinationConnectionState()
```
    The connection state of the destination application.
    
    Returns:
    
    The connection state of the destination application.
  - withDestinationConnectionState
```
public Tunnel withDestinationConnectionState(ConnectionState destinationConnectionState)
```
    The connection state of the destination application.
    
    Parameters:
    
    destinationConnectionState - The connection state of the destination application.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the tunnel.
    
    Parameters:
    
    description - A description of the tunnel.
  - getDescription
```
public String getDescription()
```
    A description of the tunnel.
    
    Returns:
    
    A description of the tunnel.
  - withDescription
```
public Tunnel withDescription(String description)
```
    A description of the tunnel.
    
    Parameters:
    
    description - A description of the tunnel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestinationConfig
```
public void setDestinationConfig(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.
    
    Parameters:
    
    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.
  - getDestinationConfig
```
public DestinationConfig getDestinationConfig()
```
    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.
  - withDestinationConfig
```
public Tunnel withDestinationConfig(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeoutConfig
```
public void setTimeoutConfig(TimeoutConfig timeoutConfig)
```
    Timeout configuration for the tunnel.
    
    Parameters:
    
    timeoutConfig - Timeout configuration for the tunnel.
  - getTimeoutConfig
```
public TimeoutConfig getTimeoutConfig()
```
    Timeout configuration for the tunnel.
    
    Returns:
    
    Timeout configuration for the tunnel.
  - withTimeoutConfig
```
public Tunnel withTimeoutConfig(TimeoutConfig timeoutConfig)
```
    Timeout configuration for the tunnel.
    
    Parameters:
    
    timeoutConfig - Timeout configuration for the tunnel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    A list of tag metadata associated with the secure tunnel.
    
    Returns:
    
    A list of tag metadata associated with the secure tunnel.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of tag metadata associated with the secure tunnel.
    
    Parameters:
    
    tags - A list of tag metadata associated with the secure tunnel.
  - withTags
```
public Tunnel withTags(Tag... tags)
```
    A list of tag metadata associated with the secure tunnel.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - A list of tag metadata associated with the secure tunnel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public Tunnel withTags(Collection<Tag> tags)
```
    A list of tag metadata associated with the secure tunnel.
    
    Parameters:
    
    tags - A list of tag metadata associated with the secure tunnel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time when the tunnel was created.
    
    Parameters:
    
    createdAt - The time when the tunnel was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time when the tunnel was created.
    
    Returns:
    
    The time when the tunnel was created.
  - withCreatedAt
```
public Tunnel withCreatedAt(Date createdAt)
```
    The time when the tunnel was created.
    
    Parameters:
    
    createdAt - The time when the tunnel was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedAt
```
public void setLastUpdatedAt(Date lastUpdatedAt)
```
    The last time the tunnel was updated.
    
    Parameters:
    
    lastUpdatedAt - The last time the tunnel was updated.
  - getLastUpdatedAt
```
public Date getLastUpdatedAt()
```
    The last time the tunnel was updated.
    
    Returns:
    
    The last time the tunnel was updated.
  - withLastUpdatedAt
```
public Tunnel withLastUpdatedAt(Date lastUpdatedAt)
```
    The last time the tunnel was updated.
    
    Parameters:
    
    lastUpdatedAt - The last time the tunnel was updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Tunnel clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Tunnel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Tunnel

Method Detail

setTunnelId

getTunnelId

withTunnelId

setTunnelArn

getTunnelArn

withTunnelArn

setStatus

getStatus

withStatus

withStatus

setSourceConnectionState

getSourceConnectionState

withSourceConnectionState

setDestinationConnectionState

getDestinationConnectionState

withDestinationConnectionState

setDescription

getDescription

withDescription

setDestinationConfig

getDestinationConfig

withDestinationConfig

setTimeoutConfig

getTimeoutConfig

withTimeoutConfig

getTags

setTags

withTags

withTags

setCreatedAt

getCreatedAt

withCreatedAt

setLastUpdatedAt

getLastUpdatedAt

withLastUpdatedAt

toString

equals

hashCode

clone

marshall