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 Details

    • 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;
      Returns:
      Whether the andRules field is set.
    • 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;
      Returns:
      The andRules.
    • 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;
      Returns:
      Whether the orRules field is set.
    • 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;
      Returns:
      The orRules.
    • 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;
    • hasAny

      boolean hasAny()
       When any is set, it matches any action.
       
      bool any = 3 [(.validate.rules) = { ... }
      Returns:
      Whether the any field is set.
    • getAny

      boolean getAny()
       When any is set, it matches any action.
       
      bool any = 3 [(.validate.rules) = { ... }
      Returns:
      The any.
    • 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;
      Returns:
      Whether the header field is set.
    • 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;
      Returns:
      The header.
    • 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;
      Returns:
      Whether the urlPath field is set.
    • getUrlPath

      PathMatcher getUrlPath()
       A URL path on the incoming HTTP request. Only available for HTTP.
       
      .envoy.type.matcher.v3.PathMatcher url_path = 10;
      Returns:
      The urlPath.
    • 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;
      Returns:
      Whether the destinationIp field is set.
    • getDestinationIp

      CidrRange getDestinationIp()
       A CIDR block that describes the destination IP.
       
      .envoy.config.core.v3.CidrRange destination_ip = 5;
      Returns:
      The destinationIp.
    • getDestinationIpOrBuilder

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

      boolean hasDestinationPort()
       A port number that describes the destination port connecting to.
       
      uint32 destination_port = 6 [(.validate.rules) = { ... }
      Returns:
      Whether the destinationPort field is set.
    • getDestinationPort

      int getDestinationPort()
       A port number that describes the destination port connecting to.
       
      uint32 destination_port = 6 [(.validate.rules) = { ... }
      Returns:
      The destinationPort.
    • hasDestinationPortRange

      boolean hasDestinationPortRange()
       A port number range that describes a range of destination ports connecting to.
       
      .envoy.type.v3.Int32Range destination_port_range = 11;
      Returns:
      Whether the destinationPortRange field is set.
    • getDestinationPortRange

      Int32Range getDestinationPortRange()
       A port number range that describes a range of destination ports connecting to.
       
      .envoy.type.v3.Int32Range destination_port_range = 11;
      Returns:
      The destinationPortRange.
    • 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;
      Returns:
      Whether the metadata field is set.
    • getMetadata

      MetadataMatcher getMetadata()
       Metadata that describes additional information about the action.
       
      .envoy.type.matcher.v3.MetadataMatcher metadata = 7;
      Returns:
      The metadata.
    • 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;
      Returns:
      Whether the notRule field is set.
    • 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;
      Returns:
      The notRule.
    • 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;
      Returns:
      Whether the requestedServerName field is set.
    • 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;
      Returns:
      The requestedServerName.
    • 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;
      Returns:
      Whether the matcher field is set.
    • getMatcher

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

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

      boolean hasUriTemplate()
       URI template path matching.
       [#extension-category: envoy.path.match]
       
      .envoy.config.core.v3.TypedExtensionConfig uri_template = 13;
      Returns:
      Whether the uriTemplate field is set.
    • getUriTemplate

      TypedExtensionConfig getUriTemplate()
       URI template path matching.
       [#extension-category: envoy.path.match]
       
      .envoy.config.core.v3.TypedExtensionConfig uri_template = 13;
      Returns:
      The uriTemplate.
    • getUriTemplateOrBuilder

      TypedExtensionConfigOrBuilder getUriTemplateOrBuilder()
       URI template path matching.
       [#extension-category: envoy.path.match]
       
      .envoy.config.core.v3.TypedExtensionConfig uri_template = 13;
    • getRuleCase

      Permission.RuleCase getRuleCase()