Package com.ibm.cloud.is.vpc.v1.model

Class RoutePatch

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class RoutePatch
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    RoutePatch.

    • Method Detail

      • newBuilder

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

      • 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. Since all routes in a routing table with the same `destination` and `zone` must have the same `advertise` value, this property can only be changed for routes with a unique `destination` and `zone` in the routing table. For more information, see [Advertising routes](https://cloud.ibm.com/docs/vpc?topic=vpc-about-custom-routes#rt-advertising-routes).
        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.
        Returns:
        the name

      • nextHop

        public RouteNextHopPatch 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, specify `0.0.0.0` or remove it by specifying `null`. 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

      • asPatch

        public Map<String,​Object> asPatch()
        Construct a JSON merge-patch from the RoutePatch. Note that properties of the RoutePatch with null values are not represented in the constructed JSON merge-patch object, but can be explicitly set afterward to signify a property delete.
        Returns:
        a JSON merge-patch for the RoutePatch