Package com.github.xds.type.matcher.v3

Interface IPMatcher.IPRangeMatcherOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
IPMatcher.IPRangeMatcher, IPMatcher.IPRangeMatcher.Builder
Enclosing class:
IPMatcher
public static interface IPMatcher.IPRangeMatcherOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getExclusive()
    Indicates whether this match option should be considered if there is a more specific matcher.
    Matcher.OnMatch
    getOnMatch()
    Match action to apply when the IP address is within one of the CIDR ranges.
    Matcher.OnMatchOrBuilder
    getOnMatchOrBuilder()
    Match action to apply when the IP address is within one of the CIDR ranges.
    CidrRange
    getRanges(int index)
    A non-empty set of CIDR ranges.
    int
    getRangesCount()
    A non-empty set of CIDR ranges.
    List<CidrRange>
    getRangesList()
    A non-empty set of CIDR ranges.
    CidrRangeOrBuilder
    getRangesOrBuilder(int index)
    A non-empty set of CIDR ranges.
    List<? extends CidrRangeOrBuilder>
    getRangesOrBuilderList()
    A non-empty set of CIDR ranges.
    boolean
    hasOnMatch()
    Match action to apply when the IP address is within one of the CIDR ranges.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getRangesList

      List<CidrRange> getRangesList()
       A non-empty set of CIDR ranges.
      repeated .xds.core.v3.CidrRange ranges = 1 [(.validate.rules) = { ... }

    • getRanges

      CidrRange getRanges(int index)
       A non-empty set of CIDR ranges.
      repeated .xds.core.v3.CidrRange ranges = 1 [(.validate.rules) = { ... }

    • getRangesCount

      int getRangesCount()
       A non-empty set of CIDR ranges.
      repeated .xds.core.v3.CidrRange ranges = 1 [(.validate.rules) = { ... }

    • getRangesOrBuilderList

      List<? extends CidrRangeOrBuilder> getRangesOrBuilderList()
       A non-empty set of CIDR ranges.
      repeated .xds.core.v3.CidrRange ranges = 1 [(.validate.rules) = { ... }

    • getRangesOrBuilder

      CidrRangeOrBuilder getRangesOrBuilder(int index)
       A non-empty set of CIDR ranges.
      repeated .xds.core.v3.CidrRange ranges = 1 [(.validate.rules) = { ... }

    • hasOnMatch

      boolean hasOnMatch()
       Match action to apply when the IP address is within one of the CIDR ranges.
      .xds.type.matcher.v3.Matcher.OnMatch on_match = 2;
      Returns:
      Whether the onMatch field is set.

    • getOnMatch

      Matcher.OnMatch getOnMatch()
       Match action to apply when the IP address is within one of the CIDR ranges.
      .xds.type.matcher.v3.Matcher.OnMatch on_match = 2;
      Returns:
      The onMatch.

    • getOnMatchOrBuilder

      Matcher.OnMatchOrBuilder getOnMatchOrBuilder()
       Match action to apply when the IP address is within one of the CIDR ranges.
      .xds.type.matcher.v3.Matcher.OnMatch on_match = 2;

    • getExclusive

      boolean getExclusive()
       Indicates whether this match option should be considered if there is a
 more specific matcher. Exclusive matchers are not selected whenever a
 more specific matcher exists (e.g. matcher with a longer prefix) even
 when the more specific matcher fails its nested match condition.
 Non-exclusive matchers are considered if the more specific matcher
 exists but its nested match condition does not entirely match.
 Non-exclusive matchers are selected in the order of their specificity
 first (longest prefix first), then the order of declaration next.

 For example, consider two range matchers: an exclusive matcher *X* on
 ``0.0.0.0/0`` and a matcher *Y* on ``192.0.0.0/2`` with a nested match
 condition *Z*. For the input IP ``192.168.0.1`` matcher *Y* is the most
 specific. If its nested match condition *Z* does not accept the input,
 then the less specific matcher *X* does not apply either despite the
 input being within the range, because matcher *X* is exclusive.

 The opposite is true if matcher *X* is not marked as exclusive. In that
 case matcher *X* always matches whenever matcher "*Y* rejects the input.
      bool exclusive = 3;
      Returns:
      The exclusive.