Package io.envoyproxy.envoy.config.rbac.v2

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 Detail

      • hasAndIds

        boolean hasAndIds()
         A set of identifiers that all must match in order to define the downstream.
        .envoy.config.rbac.v2.Principal.Set and_ids = 1;
        Returns:
        Whether the andIds field is set.

      • getAndIds

        Principal.Set getAndIds()
         A set of identifiers that all must match in order to define the downstream.
        .envoy.config.rbac.v2.Principal.Set and_ids = 1;
        Returns:
        The andIds.

      • getAndIdsOrBuilder

        Principal.SetOrBuilder getAndIdsOrBuilder()
         A set of identifiers that all must match in order to define the downstream.
        .envoy.config.rbac.v2.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.v2.Principal.Set or_ids = 2;
        Returns:
        Whether the orIds field is set.

      • getOrIds

        Principal.Set getOrIds()
         A set of identifiers at least one must match in order to define the downstream.
        .envoy.config.rbac.v2.Principal.Set or_ids = 2;
        Returns:
        The orIds.

      • getOrIdsOrBuilder

        Principal.SetOrBuilder getOrIdsOrBuilder()
         A set of identifiers at least one must match in order to define the downstream.
        .envoy.config.rbac.v2.Principal.Set or_ids = 2;

      • hasAny

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

      • getAny

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

      • hasAuthenticated

        boolean hasAuthenticated()
         Authenticated attributes that identify the downstream.
        .envoy.config.rbac.v2.Principal.Authenticated authenticated = 4;
        Returns:
        Whether the authenticated field is set.

      • getAuthenticated

        Principal.Authenticated getAuthenticated()
         Authenticated attributes that identify the downstream.
        .envoy.config.rbac.v2.Principal.Authenticated authenticated = 4;
        Returns:
        The authenticated.

      • getAuthenticatedOrBuilder

        Principal.AuthenticatedOrBuilder getAuthenticatedOrBuilder()
         Authenticated attributes that identify the downstream.
        .envoy.config.rbac.v2.Principal.Authenticated authenticated = 4;

      • hasSourceIp

        @Deprecated
boolean hasSourceIp()
        Deprecated.
        envoy.config.rbac.v2.Principal.source_ip is deprecated. See envoy/config/rbac/v2/rbac.proto;l=208
         A CIDR block that describes the downstream IP.
 This address will honor proxy protocol, but will not honor XFF.
        .envoy.api.v2.core.CidrRange source_ip = 5 [deprecated = true];
        Returns:
        Whether the sourceIp field is set.

      • getSourceIp

        @Deprecated
CidrRange getSourceIp()
        Deprecated.
        envoy.config.rbac.v2.Principal.source_ip is deprecated. See envoy/config/rbac/v2/rbac.proto;l=208
         A CIDR block that describes the downstream IP.
 This address will honor proxy protocol, but will not honor XFF.
        .envoy.api.v2.core.CidrRange source_ip = 5 [deprecated = true];
        Returns:
        The sourceIp.

      • 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.api.v2.core.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.v2.Principal.remote_ip>` is inferred
 from for example the x-forwarder-for header, proxy protocol, etc.
        .envoy.api.v2.core.CidrRange direct_remote_ip = 10;
        Returns:
        Whether the directRemoteIp field is set.

      • 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.v2.Principal.remote_ip>` is inferred
 from for example the x-forwarder-for header, proxy protocol, etc.
        .envoy.api.v2.core.CidrRange direct_remote_ip = 10;
        Returns:
        The directRemoteIp.

      • 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.v2.Principal.remote_ip>` is inferred
 from for example the x-forwarder-for header, proxy protocol, etc.
        .envoy.api.v2.core.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.v2.Principal.direct_remote_ip>`.
 E.g, if the remote ip is inferred from for example the x-forwarder-for header,
 proxy protocol, etc.
        .envoy.api.v2.core.CidrRange remote_ip = 11;
        Returns:
        Whether the remoteIp field is set.

      • 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.v2.Principal.direct_remote_ip>`.
 E.g, if the remote ip is inferred from for example the x-forwarder-for header,
 proxy protocol, etc.
        .envoy.api.v2.core.CidrRange remote_ip = 11;
        Returns:
        The remoteIp.

      • 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.v2.Principal.direct_remote_ip>`.
 E.g, if the remote ip is inferred from for example the x-forwarder-for header,
 proxy protocol, etc.
        .envoy.api.v2.core.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.api.v2.route.HeaderMatcher header = 6;
        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.api.v2.route.HeaderMatcher header = 6;
        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.api.v2.route.HeaderMatcher header = 6;

      • hasUrlPath

        boolean hasUrlPath()
         A URL path on the incoming HTTP request. Only available for HTTP.
        .envoy.type.matcher.PathMatcher url_path = 9;
        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.PathMatcher url_path = 9;
        Returns:
        The urlPath.

      • getUrlPathOrBuilder

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

      • hasMetadata

        boolean hasMetadata()
         Metadata that describes additional information about the principal.
        .envoy.type.matcher.MetadataMatcher metadata = 7;
        Returns:
        Whether the metadata field is set.

      • getMetadata

        MetadataMatcher getMetadata()
         Metadata that describes additional information about the principal.
        .envoy.type.matcher.MetadataMatcher metadata = 7;
        Returns:
        The metadata.

      • getMetadataOrBuilder

        MetadataMatcherOrBuilder getMetadataOrBuilder()
         Metadata that describes additional information about the principal.
        .envoy.type.matcher.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.v2.Principal not_id = 8;
        Returns:
        Whether the notId field is set.

      • 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.v2.Principal not_id = 8;
        Returns:
        The notId.

      • 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.v2.Principal not_id = 8;