Package io.envoyproxy.envoy.config.rbac.v3

Interface PermissionOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Permission, Permission.Builder
    public interface PermissionOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasAndRules

        boolean hasAndRules()
         A set of rules that all must match in order to define the action.
        .envoy.config.rbac.v3.Permission.Set and_rules = 1;

      • getAndRules

        Permission.Set getAndRules()
         A set of rules that all must match in order to define the action.
        .envoy.config.rbac.v3.Permission.Set and_rules = 1;

      • getAndRulesOrBuilder

        Permission.SetOrBuilder getAndRulesOrBuilder()
         A set of rules that all must match in order to define the action.
        .envoy.config.rbac.v3.Permission.Set and_rules = 1;

      • hasOrRules

        boolean hasOrRules()
         A set of rules where at least one must match in order to define the action.
        .envoy.config.rbac.v3.Permission.Set or_rules = 2;

      • getOrRules

        Permission.Set getOrRules()
         A set of rules where at least one must match in order to define the action.
        .envoy.config.rbac.v3.Permission.Set or_rules = 2;

      • getOrRulesOrBuilder

        Permission.SetOrBuilder getOrRulesOrBuilder()
         A set of rules where at least one must match in order to define the action.
        .envoy.config.rbac.v3.Permission.Set or_rules = 2;

      • getAny

        boolean getAny()
         When any is set, it matches any action.
        bool any = 3 [(.validate.rules) = { ... }

      • hasHeader

        boolean hasHeader()
         A header (or pseudo-header such as :path or :method) on the incoming HTTP request. Only
 available for HTTP request.
 Note: the pseudo-header :path includes the query and fragment string. Use the `url_path`
 field if you want to match the URL path without the query and fragment string.
        .envoy.config.route.v3.HeaderMatcher header = 4;

      • getHeader

        HeaderMatcher getHeader()
         A header (or pseudo-header such as :path or :method) on the incoming HTTP request. Only
 available for HTTP request.
 Note: the pseudo-header :path includes the query and fragment string. Use the `url_path`
 field if you want to match the URL path without the query and fragment string.
        .envoy.config.route.v3.HeaderMatcher header = 4;

      • getHeaderOrBuilder

        HeaderMatcherOrBuilder getHeaderOrBuilder()
         A header (or pseudo-header such as :path or :method) on the incoming HTTP request. Only
 available for HTTP request.
 Note: the pseudo-header :path includes the query and fragment string. Use the `url_path`
 field if you want to match the URL path without the query and fragment string.
        .envoy.config.route.v3.HeaderMatcher header = 4;

      • hasUrlPath

        boolean hasUrlPath()
         A URL path on the incoming HTTP request. Only available for HTTP.
        .envoy.type.matcher.v3.PathMatcher url_path = 10;

      • getUrlPath

        PathMatcher getUrlPath()
         A URL path on the incoming HTTP request. Only available for HTTP.
        .envoy.type.matcher.v3.PathMatcher url_path = 10;

      • getUrlPathOrBuilder

        PathMatcherOrBuilder getUrlPathOrBuilder()
         A URL path on the incoming HTTP request. Only available for HTTP.
        .envoy.type.matcher.v3.PathMatcher url_path = 10;

      • hasDestinationIp

        boolean hasDestinationIp()
         A CIDR block that describes the destination IP.
        .envoy.config.core.v3.CidrRange destination_ip = 5;

      • getDestinationIp

        CidrRange getDestinationIp()
         A CIDR block that describes the destination IP.
        .envoy.config.core.v3.CidrRange destination_ip = 5;

      • getDestinationIpOrBuilder

        CidrRangeOrBuilder getDestinationIpOrBuilder()
         A CIDR block that describes the destination IP.
        .envoy.config.core.v3.CidrRange destination_ip = 5;

      • getDestinationPort

        int getDestinationPort()
         A port number that describes the destination port connecting to.
        uint32 destination_port = 6 [(.validate.rules) = { ... }

      • hasDestinationPortRange

        boolean hasDestinationPortRange()
         A port number range that describes a range of destination ports connecting to.
        .envoy.type.v3.Int32Range destination_port_range = 11;

      • getDestinationPortRange

        Int32Range getDestinationPortRange()
         A port number range that describes a range of destination ports connecting to.
        .envoy.type.v3.Int32Range destination_port_range = 11;

      • getDestinationPortRangeOrBuilder

        Int32RangeOrBuilder getDestinationPortRangeOrBuilder()
         A port number range that describes a range of destination ports connecting to.
        .envoy.type.v3.Int32Range destination_port_range = 11;

      • hasMetadata

        boolean hasMetadata()
         Metadata that describes additional information about the action.
        .envoy.type.matcher.v3.MetadataMatcher metadata = 7;

      • getMetadata

        MetadataMatcher getMetadata()
         Metadata that describes additional information about the action.
        .envoy.type.matcher.v3.MetadataMatcher metadata = 7;

      • getMetadataOrBuilder

        MetadataMatcherOrBuilder getMetadataOrBuilder()
         Metadata that describes additional information about the action.
        .envoy.type.matcher.v3.MetadataMatcher metadata = 7;

      • hasNotRule

        boolean hasNotRule()
         Negates matching the provided permission. For instance, if the value of
 `not_rule` would match, this permission would not match. Conversely, if
 the value of `not_rule` would not match, this permission would match.
        .envoy.config.rbac.v3.Permission not_rule = 8;

      • getNotRule

        Permission getNotRule()
         Negates matching the provided permission. For instance, if the value of
 `not_rule` would match, this permission would not match. Conversely, if
 the value of `not_rule` would not match, this permission would match.
        .envoy.config.rbac.v3.Permission not_rule = 8;

      • getNotRuleOrBuilder

        PermissionOrBuilder getNotRuleOrBuilder()
         Negates matching the provided permission. For instance, if the value of
 `not_rule` would match, this permission would not match. Conversely, if
 the value of `not_rule` would not match, this permission would match.
        .envoy.config.rbac.v3.Permission not_rule = 8;

      • hasRequestedServerName

        boolean hasRequestedServerName()
         The request server from the client's connection request. This is
 typically TLS SNI.
 .. attention::
   The behavior of this field may be affected by how Envoy is configured
   as explained below.
   * If the :ref:`TLS Inspector <config_listener_filters_tls_inspector>`
     filter is not added, and if a `FilterChainMatch` is not defined for
     the :ref:`server name
     <envoy_v3_api_field_config.listener.v3.FilterChainMatch.server_names>`,
     a TLS connection's requested SNI server name will be treated as if it
     wasn't present.
   * A :ref:`listener filter <arch_overview_listener_filters>` may
     overwrite a connection's requested server name within Envoy.
 Please refer to :ref:`this FAQ entry <faq_how_to_setup_sni>` to learn to
 setup SNI.
        .envoy.type.matcher.v3.StringMatcher requested_server_name = 9;

      • getRequestedServerName

        StringMatcher getRequestedServerName()
         The request server from the client's connection request. This is
 typically TLS SNI.
 .. attention::
   The behavior of this field may be affected by how Envoy is configured
   as explained below.
   * If the :ref:`TLS Inspector <config_listener_filters_tls_inspector>`
     filter is not added, and if a `FilterChainMatch` is not defined for
     the :ref:`server name
     <envoy_v3_api_field_config.listener.v3.FilterChainMatch.server_names>`,
     a TLS connection's requested SNI server name will be treated as if it
     wasn't present.
   * A :ref:`listener filter <arch_overview_listener_filters>` may
     overwrite a connection's requested server name within Envoy.
 Please refer to :ref:`this FAQ entry <faq_how_to_setup_sni>` to learn to
 setup SNI.
        .envoy.type.matcher.v3.StringMatcher requested_server_name = 9;

      • getRequestedServerNameOrBuilder

        StringMatcherOrBuilder getRequestedServerNameOrBuilder()
         The request server from the client's connection request. This is
 typically TLS SNI.
 .. attention::
   The behavior of this field may be affected by how Envoy is configured
   as explained below.
   * If the :ref:`TLS Inspector <config_listener_filters_tls_inspector>`
     filter is not added, and if a `FilterChainMatch` is not defined for
     the :ref:`server name
     <envoy_v3_api_field_config.listener.v3.FilterChainMatch.server_names>`,
     a TLS connection's requested SNI server name will be treated as if it
     wasn't present.
   * A :ref:`listener filter <arch_overview_listener_filters>` may
     overwrite a connection's requested server name within Envoy.
 Please refer to :ref:`this FAQ entry <faq_how_to_setup_sni>` to learn to
 setup SNI.
        .envoy.type.matcher.v3.StringMatcher requested_server_name = 9;

      • hasMatcher

        boolean hasMatcher()
         Extension for configuring custom matchers for RBAC.
 [#extension-category: envoy.rbac.matchers]
        .envoy.config.core.v3.TypedExtensionConfig matcher = 12;

      • getMatcher

        TypedExtensionConfig getMatcher()
         Extension for configuring custom matchers for RBAC.
 [#extension-category: envoy.rbac.matchers]
        .envoy.config.core.v3.TypedExtensionConfig matcher = 12;

      • getMatcherOrBuilder

        TypedExtensionConfigOrBuilder getMatcherOrBuilder()
         Extension for configuring custom matchers for RBAC.
 [#extension-category: envoy.rbac.matchers]
        .envoy.config.core.v3.TypedExtensionConfig matcher = 12;