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

Class OpenTunnelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotsecuretunneling.model.IoTSecureTunnelingRequest

software.amazon.awssdk.services.iotsecuretunneling.model.OpenTunnelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<OpenTunnelRequest.Builder,OpenTunnelRequest>

@Generated("software.amazon.awssdk:codegen")
public final class OpenTunnelRequest
extends IoTSecureTunnelingRequest
implements ToCopyableBuilder<OpenTunnelRequest.Builder,OpenTunnelRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpenTunnelRequest.Builder

Method Summary

Modifier and Type	Method	Description
static OpenTunnelRequest.Builder	builder()
String	description()	A short text description of the tunnel.
DestinationConfig	destinationConfig()	The destination configuration for the OpenTunnel request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends OpenTunnelRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	A collection of tag metadata.
TimeoutConfig	timeoutConfig()	Timeout configuration for a tunnel.
OpenTunnelRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

description

public final String description()

A short text description of the tunnel.

Returns:

A short text description of 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 collection of tag metadata.

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 collection of tag metadata.

destinationConfig

public final DestinationConfig destinationConfig()

The destination configuration for the OpenTunnel request.

Returns:

The destination configuration for the OpenTunnel request.

timeoutConfig

public final TimeoutConfig timeoutConfig()

Timeout configuration for a tunnel.

Returns:

Timeout configuration for a tunnel.

toBuilder

public OpenTunnelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OpenTunnelRequest.Builder,OpenTunnelRequest>

Specified by:

toBuilder in class IoTSecureTunnelingRequest

builder

public static OpenTunnelRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo