software.amazon.awssdk.services.networkmanager.model

Class GetNetworkRoutesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.networkmanager.model.NetworkManagerRequest

software.amazon.awssdk.services.networkmanager.model.GetNetworkRoutesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetNetworkRoutesRequest.Builder,GetNetworkRoutesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetNetworkRoutesRequest
extends NetworkManagerRequest
implements ToCopyableBuilder<GetNetworkRoutesRequest.Builder,GetNetworkRoutesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetNetworkRoutesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetNetworkRoutesRequest.Builder	builder()
Map<String,List<String>>	destinationFilters() Filter by route table destination.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	exactCidrMatches() An exact CIDR block.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	globalNetworkId() The ID of the global network.
boolean	hasDestinationFilters() For responses, this returns true if the service returned a value for the DestinationFilters property.
boolean	hasExactCidrMatches() For responses, this returns true if the service returned a value for the ExactCidrMatches property.
int	hashCode()
boolean	hasLongestPrefixMatches() For responses, this returns true if the service returned a value for the LongestPrefixMatches property.
boolean	hasPrefixListIds() For responses, this returns true if the service returned a value for the PrefixListIds property.
boolean	hasStates() For responses, this returns true if the service returned a value for the States property.
boolean	hasSubnetOfMatches() For responses, this returns true if the service returned a value for the SubnetOfMatches property.
boolean	hasSupernetOfMatches() For responses, this returns true if the service returned a value for the SupernetOfMatches property.
boolean	hasTypes() For responses, this returns true if the service returned a value for the Types property.
List<String>	longestPrefixMatches() The most specific route that matches the traffic (longest prefix match).
List<String>	prefixListIds() The IDs of the prefix lists.
RouteTableIdentifier	routeTableIdentifier() The ID of the route table.
List<SdkField<?>>	sdkFields()
static Class<? extends GetNetworkRoutesRequest.Builder>	serializableBuilderClass()
List<RouteState>	states() The route states.
List<String>	statesAsStrings() The route states.
List<String>	subnetOfMatches() The routes with a subnet that match the specified CIDR filter.
List<String>	supernetOfMatches() The routes with a CIDR that encompasses the CIDR filter.
GetNetworkRoutesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<RouteType>	types() The route types.
List<String>	typesAsStrings() The route types.

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

globalNetworkId

public final String globalNetworkId()

The ID of the global network.

Returns:

The ID of the global network.

routeTableIdentifier

public final RouteTableIdentifier routeTableIdentifier()

The ID of the route table.

Returns:

The ID of the route table.

hasExactCidrMatches

public final boolean hasExactCidrMatches()

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

exactCidrMatches

public final List<String> exactCidrMatches()

An exact CIDR block.

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

Returns:

An exact CIDR block.

hasLongestPrefixMatches

public final boolean hasLongestPrefixMatches()

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

longestPrefixMatches

public final List<String> longestPrefixMatches()

The most specific route that matches the traffic (longest prefix match).

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

Returns:

The most specific route that matches the traffic (longest prefix match).

hasSubnetOfMatches

public final boolean hasSubnetOfMatches()

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

subnetOfMatches

public final List<String> subnetOfMatches()

The routes with a subnet that match the specified CIDR filter.

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

Returns:

The routes with a subnet that match the specified CIDR filter.

hasSupernetOfMatches

public final boolean hasSupernetOfMatches()

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

supernetOfMatches

public final List<String> supernetOfMatches()

The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

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

Returns:

The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

hasPrefixListIds

public final boolean hasPrefixListIds()

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

prefixListIds

public final List<String> prefixListIds()

The IDs of the prefix lists.

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

Returns:

The IDs of the prefix lists.

states

public final List<RouteState> states()

The route states.

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

Returns:

The route states.

hasStates

public final boolean hasStates()

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

statesAsStrings

public final List<String> statesAsStrings()

The route states.

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

Returns:

The route states.

types

public final List<RouteType> types()

The route types.

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

Returns:

The route types.

hasTypes

public final boolean hasTypes()

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

typesAsStrings

public final List<String> typesAsStrings()

The route types.

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

Returns:

The route types.

hasDestinationFilters

public final boolean hasDestinationFilters()

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

destinationFilters

public final Map<String,List<String>> destinationFilters()

Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

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

Returns:

Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

toBuilder

public GetNetworkRoutesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetNetworkRoutesRequest.Builder,GetNetworkRoutesRequest>

Specified by:

toBuilder in class NetworkManagerRequest

builder

public static GetNetworkRoutesRequest.Builder builder()

serializableBuilderClass

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