io.envoyproxy.envoy.config.rbac.v3

Interface PrincipalOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Principal, Principal.Builder

public interface PrincipalOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Principal.Set	getAndIds() A set of identifiers that all must match in order to define the downstream.
Principal.SetOrBuilder	getAndIdsOrBuilder() A set of identifiers that all must match in order to define the downstream.
boolean	getAny() When any is set, it matches any downstream.
Principal.Authenticated	getAuthenticated() Authenticated attributes that identify the downstream.
Principal.AuthenticatedOrBuilder	getAuthenticatedOrBuilder() Authenticated attributes that identify the downstream.
CidrRange	getDirectRemoteIp() A CIDR block that describes the downstream remote/origin address.
CidrRangeOrBuilder	getDirectRemoteIpOrBuilder() A CIDR block that describes the downstream remote/origin address.
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.
Principal.IdentifierCase	getIdentifierCase()
MetadataMatcher	getMetadata() Metadata that describes additional information about the principal.
MetadataMatcherOrBuilder	getMetadataOrBuilder() Metadata that describes additional information about the principal.
Principal	getNotId() Negates matching the provided principal.
PrincipalOrBuilder	getNotIdOrBuilder() Negates matching the provided principal.
Principal.Set	getOrIds() A set of identifiers at least one must match in order to define the downstream.
Principal.SetOrBuilder	getOrIdsOrBuilder() A set of identifiers at least one must match in order to define the downstream.
CidrRange	getRemoteIp() A CIDR block that describes the downstream remote/origin address.
CidrRangeOrBuilder	getRemoteIpOrBuilder() A CIDR block that describes the downstream remote/origin address.
CidrRange	getSourceIp() Deprecated.
CidrRangeOrBuilder	getSourceIpOrBuilder() Deprecated.
PathMatcher	getUrlPath() A URL path on the incoming HTTP request.
PathMatcherOrBuilder	getUrlPathOrBuilder() A URL path on the incoming HTTP request.
boolean	hasAndIds() A set of identifiers that all must match in order to define the downstream.
boolean	hasAuthenticated() Authenticated attributes that identify the downstream.
boolean	hasDirectRemoteIp() A CIDR block that describes the downstream remote/origin address.
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 principal.
boolean	hasNotId() Negates matching the provided principal.
boolean	hasOrIds() A set of identifiers at least one must match in order to define the downstream.
boolean	hasRemoteIp() A CIDR block that describes the downstream remote/origin address.
boolean	hasSourceIp() Deprecated.
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

hasAndIds

boolean hasAndIds()

 A set of identifiers that all must match in order to define the
 downstream.
 

.envoy.config.rbac.v3.Principal.Set and_ids = 1;

getAndIds

Principal.Set getAndIds()

 A set of identifiers that all must match in order to define the
 downstream.
 

.envoy.config.rbac.v3.Principal.Set and_ids = 1;

getAndIdsOrBuilder

Principal.SetOrBuilder getAndIdsOrBuilder()

 A set of identifiers that all must match in order to define the
 downstream.
 

.envoy.config.rbac.v3.Principal.Set and_ids = 1;

hasOrIds

boolean hasOrIds()

 A set of identifiers at least one must match in order to define the
 downstream.
 

.envoy.config.rbac.v3.Principal.Set or_ids = 2;

getOrIds

Principal.Set getOrIds()

 A set of identifiers at least one must match in order to define the
 downstream.
 

.envoy.config.rbac.v3.Principal.Set or_ids = 2;

getOrIdsOrBuilder

Principal.SetOrBuilder getOrIdsOrBuilder()

 A set of identifiers at least one must match in order to define the
 downstream.
 

.envoy.config.rbac.v3.Principal.Set or_ids = 2;

getAny

boolean getAny()

 When any is set, it matches any downstream.
 

bool any = 3 [(.validate.rules) = { ... }

hasAuthenticated

boolean hasAuthenticated()

 Authenticated attributes that identify the downstream.
 

.envoy.config.rbac.v3.Principal.Authenticated authenticated = 4;

getAuthenticated

Principal.Authenticated getAuthenticated()

 Authenticated attributes that identify the downstream.
 

.envoy.config.rbac.v3.Principal.Authenticated authenticated = 4;

getAuthenticatedOrBuilder

Principal.AuthenticatedOrBuilder getAuthenticatedOrBuilder()

 Authenticated attributes that identify the downstream.
 

.envoy.config.rbac.v3.Principal.Authenticated authenticated = 4;

hasSourceIp

@Deprecated
boolean hasSourceIp()

Deprecated.

 A CIDR block that describes the downstream IP.
 This address will honor proxy protocol, but will not honor XFF.
 

.envoy.config.core.v3.CidrRange source_ip = 5 [deprecated = true];

getSourceIp

@Deprecated
CidrRange getSourceIp()

Deprecated.

 A CIDR block that describes the downstream IP.
 This address will honor proxy protocol, but will not honor XFF.
 

.envoy.config.core.v3.CidrRange source_ip = 5 [deprecated = true];

getSourceIpOrBuilder

@Deprecated
CidrRangeOrBuilder getSourceIpOrBuilder()

Deprecated.

 A CIDR block that describes the downstream IP.
 This address will honor proxy protocol, but will not honor XFF.
 

.envoy.config.core.v3.CidrRange source_ip = 5 [deprecated = true];

hasDirectRemoteIp

boolean hasDirectRemoteIp()

 A CIDR block that describes the downstream remote/origin address.
 Note: This is always the physical peer even if the
 :ref:`remote_ip <envoy_api_field_config.rbac.v3.Principal.remote_ip>` is
 inferred from for example the x-forwarder-for header, proxy protocol,
 etc.
 

.envoy.config.core.v3.CidrRange direct_remote_ip = 10;

getDirectRemoteIp

CidrRange getDirectRemoteIp()

 A CIDR block that describes the downstream remote/origin address.
 Note: This is always the physical peer even if the
 :ref:`remote_ip <envoy_api_field_config.rbac.v3.Principal.remote_ip>` is
 inferred from for example the x-forwarder-for header, proxy protocol,
 etc.
 

.envoy.config.core.v3.CidrRange direct_remote_ip = 10;

getDirectRemoteIpOrBuilder

CidrRangeOrBuilder getDirectRemoteIpOrBuilder()

 A CIDR block that describes the downstream remote/origin address.
 Note: This is always the physical peer even if the
 :ref:`remote_ip <envoy_api_field_config.rbac.v3.Principal.remote_ip>` is
 inferred from for example the x-forwarder-for header, proxy protocol,
 etc.
 

.envoy.config.core.v3.CidrRange direct_remote_ip = 10;

hasRemoteIp

boolean hasRemoteIp()

 A CIDR block that describes the downstream remote/origin address.
 Note: This may not be the physical peer and could be different from the
 :ref:`direct_remote_ip
 <envoy_api_field_config.rbac.v3.Principal.direct_remote_ip>`. E.g, if the
 remote ip is inferred from for example the x-forwarder-for header, proxy
 protocol, etc.
 

.envoy.config.core.v3.CidrRange remote_ip = 11;

getRemoteIp

CidrRange getRemoteIp()

 A CIDR block that describes the downstream remote/origin address.
 Note: This may not be the physical peer and could be different from the
 :ref:`direct_remote_ip
 <envoy_api_field_config.rbac.v3.Principal.direct_remote_ip>`. E.g, if the
 remote ip is inferred from for example the x-forwarder-for header, proxy
 protocol, etc.
 

.envoy.config.core.v3.CidrRange remote_ip = 11;

getRemoteIpOrBuilder

CidrRangeOrBuilder getRemoteIpOrBuilder()

 A CIDR block that describes the downstream remote/origin address.
 Note: This may not be the physical peer and could be different from the
 :ref:`direct_remote_ip
 <envoy_api_field_config.rbac.v3.Principal.direct_remote_ip>`. E.g, if the
 remote ip is inferred from for example the x-forwarder-for header, proxy
 protocol, etc.
 

.envoy.config.core.v3.CidrRange remote_ip = 11;

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 = 6;

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 = 6;

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 = 6;

hasUrlPath

boolean hasUrlPath()

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

.envoy.type.matcher.v3.PathMatcher url_path = 9;

getUrlPath

PathMatcher getUrlPath()

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

.envoy.type.matcher.v3.PathMatcher url_path = 9;

getUrlPathOrBuilder

PathMatcherOrBuilder getUrlPathOrBuilder()

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

.envoy.type.matcher.v3.PathMatcher url_path = 9;

hasMetadata

boolean hasMetadata()

 Metadata that describes additional information about the principal.
 

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

getMetadata

MetadataMatcher getMetadata()

 Metadata that describes additional information about the principal.
 

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

getMetadataOrBuilder

MetadataMatcherOrBuilder getMetadataOrBuilder()

 Metadata that describes additional information about the principal.
 

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

hasNotId

boolean hasNotId()

 Negates matching the provided principal. For instance, if the value of
 `not_id` would match, this principal would not match. Conversely, if the
 value of `not_id` would not match, this principal would match.
 

.envoy.config.rbac.v3.Principal not_id = 8;

getNotId

Principal getNotId()

 Negates matching the provided principal. For instance, if the value of
 `not_id` would match, this principal would not match. Conversely, if the
 value of `not_id` would not match, this principal would match.
 

.envoy.config.rbac.v3.Principal not_id = 8;

getNotIdOrBuilder

PrincipalOrBuilder getNotIdOrBuilder()

 Negates matching the provided principal. For instance, if the value of
 `not_id` would match, this principal would not match. Conversely, if the
 value of `not_id` would not match, this principal would match.
 

.envoy.config.rbac.v3.Principal not_id = 8;

getIdentifierCase

Principal.IdentifierCase getIdentifierCase()