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

Class Principal

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.rbac.v3.Principal
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PrincipalOrBuilder, Serializable
public final class Principal extends com.google.protobuf.GeneratedMessageV3 implements PrincipalOrBuilder
 Principal defines an identity or a group of identities for a downstream
 subject.
 [#next-free-field: 15]
Protobuf type envoy.config.rbac.v3.Principal
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Principal.Authenticated
    Authentication attributes for a downstream.
    static interface 
    Principal.AuthenticatedOrBuilder
     
    static final class 
    Principal.Builder
    Principal defines an identity or a group of identities for a downstream subject.
    static enum 
    Principal.IdentifierCase
     
    static final class 
    Principal.Set
    Used in the ``and_ids`` and ``or_ids`` fields in the ``identifier`` oneof.
    static interface 
    Principal.SetOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AND_IDS_FIELD_NUMBER
     
    static final int
    ANY_FIELD_NUMBER
     
    static final int
    AUTHENTICATED_FIELD_NUMBER
     
    static final int
    CUSTOM_FIELD_NUMBER
     
    static final int
    DIRECT_REMOTE_IP_FIELD_NUMBER
     
    static final int
    FILTER_STATE_FIELD_NUMBER
     
    static final int
    HEADER_FIELD_NUMBER
     
    static final int
    METADATA_FIELD_NUMBER
     
    static final int
    NOT_ID_FIELD_NUMBER
     
    static final int
    OR_IDS_FIELD_NUMBER
     
    static final int
    REMOTE_IP_FIELD_NUMBER
     
    static final int
    SOURCE_IP_FIELD_NUMBER
     
    static final int
    SOURCED_METADATA_FIELD_NUMBER
     
    static final int
    URL_PATH_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    TypedExtensionConfig
    getCustom()
    Extension for configuring custom principals for RBAC.
    TypedExtensionConfigOrBuilder
    getCustomOrBuilder()
    Extension for configuring custom principals for RBAC.
    static Principal
    getDefaultInstance()
     
    Principal
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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_v3_api_field_config.rbac.v3.Principal.remote_ip>` is inferred from the x-forwarder-for header, the proxy protocol, etc.
    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_v3_api_field_config.rbac.v3.Principal.remote_ip>` is inferred from the x-forwarder-for header, the proxy protocol, etc.
    FilterStateMatcher
    getFilterState()
    Identifies the principal using a filter state object.
    FilterStateMatcherOrBuilder
    getFilterStateOrBuilder()
    Identifies the principal using a filter state object.
    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()
    Deprecated.
    envoy.config.rbac.v3.Principal.metadata is deprecated.
    MetadataMatcherOrBuilder
    getMetadataOrBuilder()
    Deprecated.
    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.
    com.google.protobuf.Parser<Principal>
    getParserForType()
     
    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_v3_api_field_config.rbac.v3.Principal.direct_remote_ip>`.
    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_v3_api_field_config.rbac.v3.Principal.direct_remote_ip>`.
    int
    getSerializedSize()
     
    SourcedMetadata
    getSourcedMetadata()
    Matches against metadata from either dynamic state or route configuration.
    SourcedMetadataOrBuilder
    getSourcedMetadataOrBuilder()
    Matches against metadata from either dynamic state or route configuration.
    CidrRange
    getSourceIp()
    Deprecated.
    envoy.config.rbac.v3.Principal.source_ip is 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
    hasAny()
    When any is set, it matches any downstream.
    boolean
    hasAuthenticated()
    Authenticated attributes that identify the downstream.
    boolean
    hasCustom()
    Extension for configuring custom principals for RBAC.
    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_v3_api_field_config.rbac.v3.Principal.remote_ip>` is inferred from the x-forwarder-for header, the proxy protocol, etc.
    boolean
    hasFilterState()
    Identifies the principal using a filter state object.
    int
    hashCode()
     
    boolean
    hasHeader()
    A header (or pseudo-header such as ``:path`` or ``:method``) on the incoming HTTP request.
    boolean
    hasMetadata()
    Deprecated.
    envoy.config.rbac.v3.Principal.metadata is deprecated.
    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. .. note:: This may not be the physical peer and could be different from the :ref:`direct_remote_ip <envoy_v3_api_field_config.rbac.v3.Principal.direct_remote_ip>`.
    boolean
    hasSourcedMetadata()
    Matches against metadata from either dynamic state or route configuration.
    boolean
    hasSourceIp()
    Deprecated.
    envoy.config.rbac.v3.Principal.source_ip is deprecated.
    boolean
    hasUrlPath()
    A URL path on the incoming HTTP request.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Principal.Builder
    newBuilder()
     
    static Principal.Builder
    newBuilder(Principal prototype)
     
    Principal.Builder
    newBuilderForType()
     
    protected Principal.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Principal
    parseDelimitedFrom(InputStream input)
     
    static Principal
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Principal
    parseFrom(byte[] data)
     
    static Principal
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Principal
    parseFrom(com.google.protobuf.ByteString data)
     
    static Principal
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Principal
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Principal
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Principal
    parseFrom(InputStream input)
     
    static Principal
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Principal
    parseFrom(ByteBuffer data)
     
    static Principal
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Principal>
    parser()
     
    Principal.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getIdentifierCase

      public Principal.IdentifierCase getIdentifierCase()
      Specified by:
      getIdentifierCase in interface PrincipalOrBuilder

    • hasAndIds

      public 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;
      Specified by:
      hasAndIds in interface PrincipalOrBuilder
      Returns:
      Whether the andIds field is set.

    • getAndIds

      public 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;
      Specified by:
      getAndIds in interface PrincipalOrBuilder
      Returns:
      The andIds.

    • getAndIdsOrBuilder

      public 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;
      Specified by:
      getAndIdsOrBuilder in interface PrincipalOrBuilder

    • hasOrIds

      public 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;
      Specified by:
      hasOrIds in interface PrincipalOrBuilder
      Returns:
      Whether the orIds field is set.

    • getOrIds

      public 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;
      Specified by:
      getOrIds in interface PrincipalOrBuilder
      Returns:
      The orIds.

    • getOrIdsOrBuilder

      public 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;
      Specified by:
      getOrIdsOrBuilder in interface PrincipalOrBuilder

    • hasAny

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

    • getAny

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

    • hasAuthenticated

      public boolean hasAuthenticated()
       Authenticated attributes that identify the downstream.
 It is recommended to NOT use this field, but instead use
 :ref:`MTlsAuthenticated <envoy_v3_api_msg_extensions.rbac.principals.mtls_authenticated.v3.Config>`,
 configured via :ref:`custom <envoy_v3_api_field_config.rbac.v3.Principal.custom>`,
 which should be used for most use cases due to its improved security.
      .envoy.config.rbac.v3.Principal.Authenticated authenticated = 4;
      Specified by:
      hasAuthenticated in interface PrincipalOrBuilder
      Returns:
      Whether the authenticated field is set.

    • getAuthenticated

      public Principal.Authenticated getAuthenticated()
       Authenticated attributes that identify the downstream.
 It is recommended to NOT use this field, but instead use
 :ref:`MTlsAuthenticated <envoy_v3_api_msg_extensions.rbac.principals.mtls_authenticated.v3.Config>`,
 configured via :ref:`custom <envoy_v3_api_field_config.rbac.v3.Principal.custom>`,
 which should be used for most use cases due to its improved security.
      .envoy.config.rbac.v3.Principal.Authenticated authenticated = 4;
      Specified by:
      getAuthenticated in interface PrincipalOrBuilder
      Returns:
      The authenticated.

    • getAuthenticatedOrBuilder

      public Principal.AuthenticatedOrBuilder getAuthenticatedOrBuilder()
       Authenticated attributes that identify the downstream.
 It is recommended to NOT use this field, but instead use
 :ref:`MTlsAuthenticated <envoy_v3_api_msg_extensions.rbac.principals.mtls_authenticated.v3.Config>`,
 configured via :ref:`custom <envoy_v3_api_field_config.rbac.v3.Principal.custom>`,
 which should be used for most use cases due to its improved security.
      .envoy.config.rbac.v3.Principal.Authenticated authenticated = 4;
      Specified by:
      getAuthenticatedOrBuilder in interface PrincipalOrBuilder

    • hasSourceIp

      @Deprecated public boolean hasSourceIp()
      Deprecated.
      envoy.config.rbac.v3.Principal.source_ip is deprecated. See envoy/config/rbac/v3/rbac.proto;l=386
       A CIDR block that describes the downstream IP.
 This address will honor proxy protocol, but will not honor XFF.

 This field is deprecated; either use :ref:`remote_ip
 <envoy_v3_api_field_config.rbac.v3.Principal.remote_ip>` for the same
 behavior, or use
 :ref:`direct_remote_ip <envoy_v3_api_field_config.rbac.v3.Principal.direct_remote_ip>`.
      .envoy.config.core.v3.CidrRange source_ip = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      hasSourceIp in interface PrincipalOrBuilder
      Returns:
      Whether the sourceIp field is set.

    • getSourceIp

      @Deprecated public CidrRange getSourceIp()
      Deprecated.
      envoy.config.rbac.v3.Principal.source_ip is deprecated. See envoy/config/rbac/v3/rbac.proto;l=386
       A CIDR block that describes the downstream IP.
 This address will honor proxy protocol, but will not honor XFF.

 This field is deprecated; either use :ref:`remote_ip
 <envoy_v3_api_field_config.rbac.v3.Principal.remote_ip>` for the same
 behavior, or use
 :ref:`direct_remote_ip <envoy_v3_api_field_config.rbac.v3.Principal.direct_remote_ip>`.
      .envoy.config.core.v3.CidrRange source_ip = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getSourceIp in interface PrincipalOrBuilder
      Returns:
      The sourceIp.

    • getSourceIpOrBuilder

      @Deprecated public CidrRangeOrBuilder getSourceIpOrBuilder()
      Deprecated.
       A CIDR block that describes the downstream IP.
 This address will honor proxy protocol, but will not honor XFF.

 This field is deprecated; either use :ref:`remote_ip
 <envoy_v3_api_field_config.rbac.v3.Principal.remote_ip>` for the same
 behavior, or use
 :ref:`direct_remote_ip <envoy_v3_api_field_config.rbac.v3.Principal.direct_remote_ip>`.
      .envoy.config.core.v3.CidrRange source_ip = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getSourceIpOrBuilder in interface PrincipalOrBuilder

    • hasDirectRemoteIp

      public 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_v3_api_field_config.rbac.v3.Principal.remote_ip>` is inferred from the
   x-forwarder-for header, the proxy protocol, etc.
      .envoy.config.core.v3.CidrRange direct_remote_ip = 10;
      Specified by:
      hasDirectRemoteIp in interface PrincipalOrBuilder
      Returns:
      Whether the directRemoteIp field is set.

    • getDirectRemoteIp

      public 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_v3_api_field_config.rbac.v3.Principal.remote_ip>` is inferred from the
   x-forwarder-for header, the proxy protocol, etc.
      .envoy.config.core.v3.CidrRange direct_remote_ip = 10;
      Specified by:
      getDirectRemoteIp in interface PrincipalOrBuilder
      Returns:
      The directRemoteIp.

    • getDirectRemoteIpOrBuilder

      public 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_v3_api_field_config.rbac.v3.Principal.remote_ip>` is inferred from the
   x-forwarder-for header, the proxy protocol, etc.
      .envoy.config.core.v3.CidrRange direct_remote_ip = 10;
      Specified by:
      getDirectRemoteIpOrBuilder in interface PrincipalOrBuilder

    • hasRemoteIp

      public 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_v3_api_field_config.rbac.v3.Principal.direct_remote_ip>`. E.g, if the remote ip is inferred from
   the x-forwarder-for header, the proxy protocol, etc.
      .envoy.config.core.v3.CidrRange remote_ip = 11;
      Specified by:
      hasRemoteIp in interface PrincipalOrBuilder
      Returns:
      Whether the remoteIp field is set.

    • getRemoteIp

      public 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_v3_api_field_config.rbac.v3.Principal.direct_remote_ip>`. E.g, if the remote ip is inferred from
   the x-forwarder-for header, the proxy protocol, etc.
      .envoy.config.core.v3.CidrRange remote_ip = 11;
      Specified by:
      getRemoteIp in interface PrincipalOrBuilder
      Returns:
      The remoteIp.

    • getRemoteIpOrBuilder

      public 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_v3_api_field_config.rbac.v3.Principal.direct_remote_ip>`. E.g, if the remote ip is inferred from
   the x-forwarder-for header, the proxy protocol, etc.
      .envoy.config.core.v3.CidrRange remote_ip = 11;
      Specified by:
      getRemoteIpOrBuilder in interface PrincipalOrBuilder

    • hasHeader

      public 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;
      Specified by:
      hasHeader in interface PrincipalOrBuilder
      Returns:
      Whether the header field is set.

    • getHeader

      public 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;
      Specified by:
      getHeader in interface PrincipalOrBuilder
      Returns:
      The header.

    • getHeaderOrBuilder

      public 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;
      Specified by:
      getHeaderOrBuilder in interface PrincipalOrBuilder

    • hasUrlPath

      public boolean hasUrlPath()
       A URL path on the incoming HTTP request. Only available for HTTP.
      .envoy.type.matcher.v3.PathMatcher url_path = 9;
      Specified by:
      hasUrlPath in interface PrincipalOrBuilder
      Returns:
      Whether the urlPath field is set.

    • getUrlPath

      public PathMatcher getUrlPath()
       A URL path on the incoming HTTP request. Only available for HTTP.
      .envoy.type.matcher.v3.PathMatcher url_path = 9;
      Specified by:
      getUrlPath in interface PrincipalOrBuilder
      Returns:
      The urlPath.

    • getUrlPathOrBuilder

      public PathMatcherOrBuilder getUrlPathOrBuilder()
       A URL path on the incoming HTTP request. Only available for HTTP.
      .envoy.type.matcher.v3.PathMatcher url_path = 9;
      Specified by:
      getUrlPathOrBuilder in interface PrincipalOrBuilder

    • hasMetadata

      @Deprecated public boolean hasMetadata()
      Deprecated.
      envoy.config.rbac.v3.Principal.metadata is deprecated. See envoy/config/rbac/v3/rbac.proto;l=424
       Metadata that describes additional information about the principal. This field is deprecated; please use
 :ref:`sourced_metadata<envoy_v3_api_field_config.rbac.v3.Principal.sourced_metadata>` instead.
      .envoy.type.matcher.v3.MetadataMatcher metadata = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      hasMetadata in interface PrincipalOrBuilder
      Returns:
      Whether the metadata field is set.

    • getMetadata

      @Deprecated public MetadataMatcher getMetadata()
      Deprecated.
      envoy.config.rbac.v3.Principal.metadata is deprecated. See envoy/config/rbac/v3/rbac.proto;l=424
       Metadata that describes additional information about the principal. This field is deprecated; please use
 :ref:`sourced_metadata<envoy_v3_api_field_config.rbac.v3.Principal.sourced_metadata>` instead.
      .envoy.type.matcher.v3.MetadataMatcher metadata = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getMetadata in interface PrincipalOrBuilder
      Returns:
      The metadata.

    • getMetadataOrBuilder

      @Deprecated public MetadataMatcherOrBuilder getMetadataOrBuilder()
      Deprecated.
       Metadata that describes additional information about the principal. This field is deprecated; please use
 :ref:`sourced_metadata<envoy_v3_api_field_config.rbac.v3.Principal.sourced_metadata>` instead.
      .envoy.type.matcher.v3.MetadataMatcher metadata = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getMetadataOrBuilder in interface PrincipalOrBuilder

    • hasFilterState

      public boolean hasFilterState()
       Identifies the principal using a filter state object.
      .envoy.type.matcher.v3.FilterStateMatcher filter_state = 12;
      Specified by:
      hasFilterState in interface PrincipalOrBuilder
      Returns:
      Whether the filterState field is set.

    • getFilterState

      public FilterStateMatcher getFilterState()
       Identifies the principal using a filter state object.
      .envoy.type.matcher.v3.FilterStateMatcher filter_state = 12;
      Specified by:
      getFilterState in interface PrincipalOrBuilder
      Returns:
      The filterState.

    • getFilterStateOrBuilder

      public FilterStateMatcherOrBuilder getFilterStateOrBuilder()
       Identifies the principal using a filter state object.
      .envoy.type.matcher.v3.FilterStateMatcher filter_state = 12;
      Specified by:
      getFilterStateOrBuilder in interface PrincipalOrBuilder

    • hasNotId

      public 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;
      Specified by:
      hasNotId in interface PrincipalOrBuilder
      Returns:
      Whether the notId field is set.

    • getNotId

      public 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;
      Specified by:
      getNotId in interface PrincipalOrBuilder
      Returns:
      The notId.

    • getNotIdOrBuilder

      public 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;
      Specified by:
      getNotIdOrBuilder in interface PrincipalOrBuilder

    • hasSourcedMetadata

      public boolean hasSourcedMetadata()
       Matches against metadata from either dynamic state or route configuration. Preferred over the
 ``metadata`` field as it provides more flexibility in metadata source selection.
      .envoy.config.rbac.v3.SourcedMetadata sourced_metadata = 13;
      Specified by:
      hasSourcedMetadata in interface PrincipalOrBuilder
      Returns:
      Whether the sourcedMetadata field is set.

    • getSourcedMetadata

      public SourcedMetadata getSourcedMetadata()
       Matches against metadata from either dynamic state or route configuration. Preferred over the
 ``metadata`` field as it provides more flexibility in metadata source selection.
      .envoy.config.rbac.v3.SourcedMetadata sourced_metadata = 13;
      Specified by:
      getSourcedMetadata in interface PrincipalOrBuilder
      Returns:
      The sourcedMetadata.

    • getSourcedMetadataOrBuilder

      public SourcedMetadataOrBuilder getSourcedMetadataOrBuilder()
       Matches against metadata from either dynamic state or route configuration. Preferred over the
 ``metadata`` field as it provides more flexibility in metadata source selection.
      .envoy.config.rbac.v3.SourcedMetadata sourced_metadata = 13;
      Specified by:
      getSourcedMetadataOrBuilder in interface PrincipalOrBuilder

    • hasCustom

      public boolean hasCustom()
       Extension for configuring custom principals for RBAC.
 [#extension-category: envoy.rbac.principals]
      .envoy.config.core.v3.TypedExtensionConfig custom = 14;
      Specified by:
      hasCustom in interface PrincipalOrBuilder
      Returns:
      Whether the custom field is set.

    • getCustom

      public TypedExtensionConfig getCustom()
       Extension for configuring custom principals for RBAC.
 [#extension-category: envoy.rbac.principals]
      .envoy.config.core.v3.TypedExtensionConfig custom = 14;
      Specified by:
      getCustom in interface PrincipalOrBuilder
      Returns:
      The custom.

    • getCustomOrBuilder

      public TypedExtensionConfigOrBuilder getCustomOrBuilder()
       Extension for configuring custom principals for RBAC.
 [#extension-category: envoy.rbac.principals]
      .envoy.config.core.v3.TypedExtensionConfig custom = 14;
      Specified by:
      getCustomOrBuilder in interface PrincipalOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Principal parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Principal parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Principal parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Principal parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Principal parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Principal parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Principal parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Principal parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Principal parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Principal parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Principal parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Principal parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Principal.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Principal.Builder newBuilder()

    • newBuilder

      public static Principal.Builder newBuilder(Principal prototype)

    • toBuilder

      public Principal.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Principal.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Principal getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Principal> parser()

    • getParserForType

      public com.google.protobuf.Parser<Principal> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Principal getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder