Class GetNetworkRoutesRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetNetworkRoutesRequest.Builder,GetNetworkRoutesRequest>

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

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetNetworkRoutesRequest.Builder,GetNetworkRoutesRequest>
      Specified by:
      toBuilder in class NetworkManagerRequest
      Returns:
      a builder for type T
    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.