Package software.amazon.awssdk.services.iotsecuretunneling.model

Class TunnelSummary

java.lang.Object

software.amazon.awssdk.services.iotsecuretunneling.model.TunnelSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TunnelSummary.Builder,TunnelSummary>

@Generated("software.amazon.awssdk:codegen")
public final class TunnelSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TunnelSummary.Builder,TunnelSummary>

Information about the tunnel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TunnelSummary.Builder

Method Summary

Modifier and Type	Method	Description
static TunnelSummary.Builder	builder()
Instant	createdAt()	The time the tunnel was created.
String	description()	A description of the tunnel.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedAt()	The time the tunnel was last updated.
List<SdkField<?>>	sdkFields()
static Class<? extends TunnelSummary.Builder>	serializableBuilderClass()
TunnelStatus	status()	The status of a tunnel.
String	statusAsString()	The status of a tunnel.
TunnelSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	tunnelArn()	The Amazon Resource Name of the tunnel.
String	tunnelId()	The unique alpha-numeric identifier for the tunnel.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

tunnelId

public final String tunnelId()

The unique alpha-numeric identifier for the tunnel.

Returns:

The unique alpha-numeric identifier for the tunnel.

tunnelArn

public final String tunnelArn()

The Amazon Resource Name of the tunnel.

Returns:

The Amazon Resource Name of the 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:

TunnelStatus

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:

TunnelStatus

description

public final String description()

A description of the tunnel.

Returns:

A description of the tunnel.

createdAt

public final Instant createdAt()

The time the tunnel was created.

Returns:

The time the tunnel was created.

lastUpdatedAt

public final Instant lastUpdatedAt()

The time the tunnel was last updated.

Returns:

The time the tunnel was last updated.

toBuilder

public TunnelSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TunnelSummary.Builder,TunnelSummary>

builder

public static TunnelSummary.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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