Package com.oracle.bmc.core.model

Class DrgRouteRule

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class DrgRouteRule
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A DRG route rule is a mapping between a destination IP address range and a DRG attachment.

    The map is used to route matching packets. Traffic will be routed across the attachments using Equal-cost multi-path routing (ECMP) if there are multiple rules with identical destinations and none of the rules conflict.
    Note: Objects should always be created or deserialized using the DrgRouteRule.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the DrgRouteRule.Builder, which maintain a set of all explicitly set fields called DrgRouteRule.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getDestination

        public String getDestination()
        Represents the range of IP addresses to match against when routing traffic.

        Potential values: * An IP address range (IPv4 or IPv6) in CIDR notation. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56. * When you're setting up a security rule for traffic destined for a particular Service through a service gateway, this is the cidrBlock value associated with that Service. For example: oci-phx-objectstorage.

        Returns:
        the value

      • getDestinationType

        public DrgRouteRule.DestinationType getDestinationType()
        The type of destination for the rule.

        Allowed values:

        CIDR_BLOCK: If the rule's destination is an IP address range in CIDR notation. * SERVICE_CIDR_BLOCK: If the rule's destination is the cidrBlock value for a Service (the rule is for traffic destined for a particular Service through a service gateway).

        Returns:
        the value

      • getNextHopDrgAttachmentId

        public String getNextHopDrgAttachmentId()
        The OCID of the next hop DRG attachment responsible for reaching the network destination.

        A value of BLACKHOLE means traffic for this route is discarded without notification.

        Returns:
        the value

      • getRouteType

        public DrgRouteRule.RouteType getRouteType()
        You can specify static routes for the DRG route table using the API.

        The DRG learns dynamic routes from the DRG attachments using various routing protocols.

        Returns:
        the value

      • getIsConflict

        public Boolean getIsConflict()
        Indicates that the route was not imported due to a conflict between route rules.
        Returns:
        the value

      • getIsBlackhole

        public Boolean getIsBlackhole()
        Indicates that if the next hop attachment does not exist, so traffic for this route is discarded without notification.
        Returns:
        the value

      • getId

        public String getId()
        The Oracle-assigned ID of the DRG route rule.
        Returns:
        the value

      • getRouteProvenance

        public DrgRouteRule.RouteProvenance getRouteProvenance()
        The earliest origin of a route.

        If a route is advertised to a DRG through an IPsec tunnel attachment, and is propagated to peered DRGs via RPC attachments, the route’s provenance in the peered DRGs remains IPSEC_TUNNEL, because that is the earliest origin.

        No routes with a provenance IPSEC_TUNNEL or VIRTUAL_CIRCUIT will be exported to IPsec tunnel or virtual circuit attachments, regardless of the attachment's export distribution.

        Returns:
        the value

      • getAttributes

        public Object getAttributes()
        Additional properties for the route, computed by the service.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel