io.envoyproxy.envoy.config.rbac.v2

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 Summary

Modifier and Type	Method and Description
Permission.Set	getAndRules() A set of rules that all must match in order to define the action.
Permission.SetOrBuilder	getAndRulesOrBuilder() A set of rules that all must match in order to define the action.
boolean	getAny() When any is set, it matches any action.
CidrRange	getDestinationIp() A CIDR block that describes the destination IP.
CidrRangeOrBuilder	getDestinationIpOrBuilder() A CIDR block that describes the destination IP.
int	getDestinationPort() A port number that describes the destination port connecting to.
HeaderMatcher	getHeader() A header (or pseudo-header such as :path or :method) on the incoming HTTP request.
HeaderMatcherOrBuilder	getHeaderOrBuilder() A header (or pseudo-header such as :path or :method) on the incoming HTTP request.
MetadataMatcher	getMetadata() Metadata that describes additional information about the action.
MetadataMatcherOrBuilder	getMetadataOrBuilder() Metadata that describes additional information about the action.
Permission	getNotRule() Negates matching the provided permission.
PermissionOrBuilder	getNotRuleOrBuilder() Negates matching the provided permission.
Permission.Set	getOrRules() A set of rules where at least one must match in order to define the action.
Permission.SetOrBuilder	getOrRulesOrBuilder() A set of rules where at least one must match in order to define the action.
StringMatcher	getRequestedServerName() The request server from the client's connection request.
StringMatcherOrBuilder	getRequestedServerNameOrBuilder() The request server from the client's connection request.
Permission.RuleCase	getRuleCase()
PathMatcher	getUrlPath() A URL path on the incoming HTTP request.
PathMatcherOrBuilder	getUrlPathOrBuilder() A URL path on the incoming HTTP request.
boolean	hasAndRules() A set of rules that all must match in order to define the action.
boolean	hasDestinationIp() A CIDR block that describes the destination IP.
boolean	hasHeader() A header (or pseudo-header such as :path or :method) on the incoming HTTP request.
boolean	hasMetadata() Metadata that describes additional information about the action.
boolean	hasNotRule() Negates matching the provided permission.
boolean	hasOrRules() A set of rules where at least one must match in order to define the action.
boolean	hasRequestedServerName() The request server from the client's connection request.
boolean	hasUrlPath() A URL path on the incoming HTTP request.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasAndRules

boolean hasAndRules()

 A set of rules that all must match in order to define the action.
 

.envoy.config.rbac.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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.api.v2.route.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.api.v2.route.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.api.v2.route.HeaderMatcher header = 4;

hasUrlPath

boolean hasUrlPath()

 A URL path on the incoming HTTP request. Only available for HTTP.
 

.envoy.type.matcher.PathMatcher url_path = 10;

getUrlPath

PathMatcher getUrlPath()

 A URL path on the incoming HTTP request. Only available for HTTP.
 

.envoy.type.matcher.PathMatcher url_path = 10;

getUrlPathOrBuilder

PathMatcherOrBuilder getUrlPathOrBuilder()

 A URL path on the incoming HTTP request. Only available for HTTP.
 

.envoy.type.matcher.PathMatcher url_path = 10;

hasDestinationIp

boolean hasDestinationIp()

 A CIDR block that describes the destination IP.
 

.envoy.api.v2.core.CidrRange destination_ip = 5;

getDestinationIp

CidrRange getDestinationIp()

 A CIDR block that describes the destination IP.
 

.envoy.api.v2.core.CidrRange destination_ip = 5;

getDestinationIpOrBuilder

CidrRangeOrBuilder getDestinationIpOrBuilder()

 A CIDR block that describes the destination IP.
 

.envoy.api.v2.core.CidrRange destination_ip = 5;

getDestinationPort

int getDestinationPort()

 A port number that describes the destination port connecting to.
 

uint32 destination_port = 6 [(.validate.rules) = { ... }

hasMetadata

boolean hasMetadata()

 Metadata that describes additional information about the action.
 

.envoy.type.matcher.MetadataMatcher metadata = 7;

getMetadata

MetadataMatcher getMetadata()

 Metadata that describes additional information about the action.
 

.envoy.type.matcher.MetadataMatcher metadata = 7;

getMetadataOrBuilder

MetadataMatcherOrBuilder getMetadataOrBuilder()

 Metadata that describes additional information about the action.
 

.envoy.type.matcher.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.v2.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.v2.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.v2.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_api_field_listener.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.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_api_field_listener.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.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_api_field_listener.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.StringMatcher requested_server_name = 9;

getRuleCase

Permission.RuleCase getRuleCase()