Class CreateVpcRouteOptions

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

  • Method Details

    • newBuilder

      public CreateVpcRouteOptions.Builder newBuilder()
      New builder.
      Returns:
      a CreateVpcRouteOptions builder

    • vpcId

      public String vpcId()
      Gets the vpcId. The VPC identifier.
      Returns:
      the vpcId

    • destination

      public String destination()
      Gets the destination. The destination CIDR of the route. The host identifier in the CIDR must be zero. At most two routes per `zone` in a table can have the same `destination` and `priority`, and only if both routes have an `action` of `deliver` and the `next_hop` is an IP address.
      Returns:
      the destination

    • zone

      public ZoneIdentity zone()
      Gets the zone. The zone to apply the route 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

    • action

      public String action()
      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.
      Returns:
      the action

    • advertise

      public Boolean advertise()
      Gets the advertise. Indicates whether this route will be advertised to the ingress sources specified by the `advertise_routes_to` routing table property. All routes in a routing table with the same `destination` and `zone` must have the same `advertise` value.
      Returns:
      the advertise

    • name

      public String name()
      Gets the name. The name for this route. The name must not be used by another route in the routing table. Names starting with `ibm-` are reserved for system-provided routes, and are not allowed. If unspecified, the name will be a hyphenated list of randomly-selected words.
      Returns:
      the name

    • nextHop

      public RouteNextHopPrototype nextHop()
      Gets the nextHop. If `action` is `deliver`, the next hop that packets will be delivered to (must not be `0.0.0.0`). For other `action` values, it must be omitted or specified as `0.0.0.0`. At most two routes per `zone` in a table can have the same `destination` and `priority`, and only when each route has an `action` of `deliver` and `next_hop` is an IP address.
      Returns:
      the nextHop

    • priority

      public Long priority()
      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