Class Route

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.is.vpc.v1.model.Route
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class Route extends com.ibm.cloud.sdk.core.service.model.GenericModel
Route.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    Route.Action
    The action to perform with a packet matching the route: - `delegate`: delegate to system-provided routes - `delegate_vpc`: delegate to system-provided routes, ignoring Internet-bound routes - `deliver`: deliver the packet to the specified `next_hop` - `drop`: drop the packet The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
    static interface 
    Route.LifecycleState
    The lifecycle state of the route.
    static interface 
    Route.Origin
    The origin of this route: - `service`: route was directly created by a service - `user`: route was directly created by a user The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAction()
    Gets the action.
    Date
    getCreatedAt()
    Gets the createdAt.
    RouteCreator
    getCreator()
    Gets the creator.
    String
    getDestination()
    Gets the destination.
    String
    getHref()
    Gets the href.
    String
    getId()
    Gets the id.
    String
    getLifecycleState()
    Gets the lifecycleState.
    String
    getName()
    Gets the name.
    RouteNextHop
    getNextHop()
    Gets the nextHop.
    String
    getOrigin()
    Gets the origin.
    Long
    getPriority()
    Gets the priority.
    ZoneReference
    getZone()
    Gets the zone.
    Boolean
    isAdvertise()
    Gets the advertise.

    Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

    equals, hashCode, toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • getAction

      public String getAction()
      Gets the action. The action to perform with a packet matching the route: - `delegate`: delegate to system-provided routes - `delegate_vpc`: delegate to system-provided routes, ignoring Internet-bound routes - `deliver`: deliver the packet to the specified `next_hop` - `drop`: drop the packet The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
      Returns:
      the action

    • isAdvertise

      public Boolean isAdvertise()
      Gets the advertise. Indicates whether this route will be advertised to the ingress sources specified by the `advertise_routes_to` routing table property.
      Returns:
      the advertise

    • getCreatedAt

      public Date getCreatedAt()
      Gets the createdAt. The date and time that the route was created.
      Returns:
      the createdAt

    • getCreator

      public RouteCreator getCreator()
      Gets the creator. If present, the resource that created the route. Routes with this property present cannot be directly deleted. All routes with an `origin` of `service` will have this property set, and future `origin` values may also have this property set.
      Returns:
      the creator

    • getDestination

      public String getDestination()
      Gets the destination. The destination CIDR of the route.
      Returns:
      the destination

    • getHref

      public String getHref()
      Gets the href. The URL for this route.
      Returns:
      the href

    • getId

      public String getId()
      Gets the id. The unique identifier for this route.
      Returns:
      the id

    • getLifecycleState

      public String getLifecycleState()
      Gets the lifecycleState. The lifecycle state of the route.
      Returns:
      the lifecycleState

    • getName

      public String getName()
      Gets the name. The name for this route. The name is unique across all routes in the routing table.
      Returns:
      the name

    • getNextHop

      public RouteNextHop getNextHop()
      Gets the nextHop. If `action` is `deliver`, the next hop that packets will be delivered to. For other `action` values, its `address` will be `0.0.0.0`.
      Returns:
      the nextHop

    • getOrigin

      public String getOrigin()
      Gets the origin. The origin of this route: - `service`: route was directly created by a service - `user`: route was directly created by a user The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
      Returns:
      the origin

    • getPriority

      public Long getPriority()
      Gets the priority. The priority of this route. Smaller values have higher priority. If a routing table contains multiple routes with the same `zone` and `destination`, the route with the highest priority (smallest value) is selected. If two routes have the same `destination` and `priority`, traffic is distributed between them.
      Returns:
      the priority

    • getZone

      public ZoneReference getZone()
      Gets the zone. The zone the route applies to. If subnets are attached to the route's routing table, egress traffic from those subnets in this zone will be subject to this route. If this route's routing table has any of `route_direct_link_ingress`, `route_internet_ingress`, `route_transit_gateway_ingress` or `route_vpc_zone_ingress` set to`true`, traffic from those ingress sources arriving in this zone will be subject to this route.
      Returns:
      the zone