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: 12]Protobuf type
envoy.config.rbac.v2.Principal
Modifier and Type | Class and Description |
---|---|
static class |
Principal.Authenticated
Authentication attributes for a downstream.
|
static interface |
Principal.AuthenticatedOrBuilder |
static class |
Principal.Builder
Principal defines an identity or a group of identities for a downstream subject.
|
static class |
Principal.IdentifierCase |
static class |
Principal.Set
Used in the `and_ids` and `or_ids` fields in the `identifier` oneof.
|
static interface |
Principal.SetOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
AND_IDS_FIELD_NUMBER |
static int |
ANY_FIELD_NUMBER |
static int |
AUTHENTICATED_FIELD_NUMBER |
static int |
DIRECT_REMOTE_IP_FIELD_NUMBER |
static int |
HEADER_FIELD_NUMBER |
static int |
METADATA_FIELD_NUMBER |
static int |
NOT_ID_FIELD_NUMBER |
static int |
OR_IDS_FIELD_NUMBER |
static int |
REMOTE_IP_FIELD_NUMBER |
static int |
SOURCE_IP_FIELD_NUMBER |
static int |
URL_PATH_FIELD_NUMBER |
Modifier and Type | Method and 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.
|
static Principal |
getDefaultInstance() |
Principal |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<Principal> |
getParserForType() |
CidrRange |
getRemoteIp()
A CIDR block that describes the downstream remote/origin address.
|
CidrRangeOrBuilder |
getRemoteIpOrBuilder()
A CIDR block that describes the downstream remote/origin address.
|
int |
getSerializedSize() |
CidrRange |
getSourceIp()
Deprecated.
|
CidrRangeOrBuilder |
getSourceIpOrBuilder()
Deprecated.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
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.
|
int |
hashCode() |
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
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(ByteBuffer data) |
static Principal |
parseFrom(ByteBuffer 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 com.google.protobuf.Parser<Principal> |
parser() |
Principal.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, 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
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int AND_IDS_FIELD_NUMBER
public static final int OR_IDS_FIELD_NUMBER
public static final int ANY_FIELD_NUMBER
public static final int AUTHENTICATED_FIELD_NUMBER
public static final int SOURCE_IP_FIELD_NUMBER
public static final int DIRECT_REMOTE_IP_FIELD_NUMBER
public static final int REMOTE_IP_FIELD_NUMBER
public static final int HEADER_FIELD_NUMBER
public static final int URL_PATH_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
public static final int NOT_ID_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public Principal.IdentifierCase getIdentifierCase()
getIdentifierCase
in interface PrincipalOrBuilder
public 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;
hasAndIds
in interface PrincipalOrBuilder
public 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;
getAndIds
in interface PrincipalOrBuilder
public 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;
getAndIdsOrBuilder
in interface PrincipalOrBuilder
public 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;
hasOrIds
in interface PrincipalOrBuilder
public 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;
getOrIds
in interface PrincipalOrBuilder
public 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;
getOrIdsOrBuilder
in interface PrincipalOrBuilder
public boolean getAny()
When any is set, it matches any downstream.
bool any = 3 [(.validate.rules) = { ... }
getAny
in interface PrincipalOrBuilder
public boolean hasAuthenticated()
Authenticated attributes that identify the downstream.
.envoy.config.rbac.v2.Principal.Authenticated authenticated = 4;
hasAuthenticated
in interface PrincipalOrBuilder
public Principal.Authenticated getAuthenticated()
Authenticated attributes that identify the downstream.
.envoy.config.rbac.v2.Principal.Authenticated authenticated = 4;
getAuthenticated
in interface PrincipalOrBuilder
public Principal.AuthenticatedOrBuilder getAuthenticatedOrBuilder()
Authenticated attributes that identify the downstream.
.envoy.config.rbac.v2.Principal.Authenticated authenticated = 4;
getAuthenticatedOrBuilder
in interface PrincipalOrBuilder
@Deprecated public boolean hasSourceIp()
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];
hasSourceIp
in interface PrincipalOrBuilder
@Deprecated public CidrRange getSourceIp()
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];
getSourceIp
in interface PrincipalOrBuilder
@Deprecated public CidrRangeOrBuilder getSourceIpOrBuilder()
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];
getSourceIpOrBuilder
in interface PrincipalOrBuilder
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_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;
hasDirectRemoteIp
in interface PrincipalOrBuilder
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_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;
getDirectRemoteIp
in interface PrincipalOrBuilder
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_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;
getDirectRemoteIpOrBuilder
in interface PrincipalOrBuilder
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_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;
hasRemoteIp
in interface PrincipalOrBuilder
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_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;
getRemoteIp
in interface PrincipalOrBuilder
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_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;
getRemoteIpOrBuilder
in interface PrincipalOrBuilder
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.api.v2.route.HeaderMatcher header = 6;
hasHeader
in interface PrincipalOrBuilder
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.api.v2.route.HeaderMatcher header = 6;
getHeader
in interface PrincipalOrBuilder
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.api.v2.route.HeaderMatcher header = 6;
getHeaderOrBuilder
in interface PrincipalOrBuilder
public boolean hasUrlPath()
A URL path on the incoming HTTP request. Only available for HTTP.
.envoy.type.matcher.PathMatcher url_path = 9;
hasUrlPath
in interface PrincipalOrBuilder
public PathMatcher getUrlPath()
A URL path on the incoming HTTP request. Only available for HTTP.
.envoy.type.matcher.PathMatcher url_path = 9;
getUrlPath
in interface PrincipalOrBuilder
public PathMatcherOrBuilder getUrlPathOrBuilder()
A URL path on the incoming HTTP request. Only available for HTTP.
.envoy.type.matcher.PathMatcher url_path = 9;
getUrlPathOrBuilder
in interface PrincipalOrBuilder
public boolean hasMetadata()
Metadata that describes additional information about the principal.
.envoy.type.matcher.MetadataMatcher metadata = 7;
hasMetadata
in interface PrincipalOrBuilder
public MetadataMatcher getMetadata()
Metadata that describes additional information about the principal.
.envoy.type.matcher.MetadataMatcher metadata = 7;
getMetadata
in interface PrincipalOrBuilder
public MetadataMatcherOrBuilder getMetadataOrBuilder()
Metadata that describes additional information about the principal.
.envoy.type.matcher.MetadataMatcher metadata = 7;
getMetadataOrBuilder
in interface PrincipalOrBuilder
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.v2.Principal not_id = 8;
hasNotId
in interface PrincipalOrBuilder
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.v2.Principal not_id = 8;
getNotId
in interface PrincipalOrBuilder
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.v2.Principal not_id = 8;
getNotIdOrBuilder
in interface PrincipalOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static Principal parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Principal parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Principal parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Principal parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Principal parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Principal parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Principal parseFrom(InputStream input) throws IOException
IOException
public static Principal parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Principal parseDelimitedFrom(InputStream input) throws IOException
IOException
public static Principal parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Principal parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static Principal parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public Principal.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static Principal.Builder newBuilder()
public static Principal.Builder newBuilder(Principal prototype)
public Principal.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected Principal.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static Principal getDefaultInstance()
public static com.google.protobuf.Parser<Principal> parser()
public com.google.protobuf.Parser<Principal> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public Principal getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2018–2021 The Envoy Project. All rights reserved.