software.amazon.awssdk.services.networkmanager.model

Class NetworkRoute

java.lang.Object

software.amazon.awssdk.services.networkmanager.model.NetworkRoute

All Implemented Interfaces:

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

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

Describes a network route.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NetworkRoute.Builder

Method Summary

Modifier and Type	Method and Description
static NetworkRoute.Builder	builder()
String	destinationCidrBlock() A unique identifier for the route, such as a CIDR block.
List<NetworkRouteDestination>	destinations() The destinations.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDestinations() For responses, this returns true if the service returned a value for the Destinations property.
int	hashCode()
String	prefixListId() The ID of the prefix list.
List<SdkField<?>>	sdkFields()
static Class<? extends NetworkRoute.Builder>	serializableBuilderClass()
RouteState	state() The route state.
String	stateAsString() The route state.
NetworkRoute.Builder	toBuilder()
String	toString() Returns a string representation of this object.
RouteType	type() The route type.
String	typeAsString() The route type.

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

destinationCidrBlock

public final String destinationCidrBlock()

A unique identifier for the route, such as a CIDR block.

Returns:

A unique identifier for the route, such as a CIDR block.

hasDestinations

public final boolean hasDestinations()

For responses, this returns true if the service returned a value for the Destinations 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.

destinations

public final List<NetworkRouteDestination> destinations()

The destinations.

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 hasDestinations() method.

Returns:

The destinations.

prefixListId

public final String prefixListId()

The ID of the prefix list.

Returns:

The ID of the prefix list.

state

public final RouteState state()

The route state. The possible values are active and blackhole.

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

Returns:

The route state. The possible values are active and blackhole.

See Also:

RouteState

stateAsString

public final String stateAsString()

The route state. The possible values are active and blackhole.

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

Returns:

The route state. The possible values are active and blackhole.

See Also:

RouteState

type

public final RouteType type()

The route type. The possible values are propagated and static.

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

Returns:

The route type. The possible values are propagated and static.

See Also:

RouteType

typeAsString

public final String typeAsString()

The route type. The possible values are propagated and static.

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

Returns:

The route type. The possible values are propagated and static.

See Also:

RouteType

toBuilder

public NetworkRoute.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NetworkRoute.Builder,NetworkRoute>

builder

public static NetworkRoute.Builder builder()

serializableBuilderClass

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