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.v4alpha.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 |
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() |
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 |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic 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 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.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public Principal.IdentifierCase getIdentifierCase()
getIdentifierCase in interface PrincipalOrBuilderpublic boolean hasAndIds()
A set of identifiers that all must match in order to define the downstream.
.envoy.config.rbac.v4alpha.Principal.Set and_ids = 1;hasAndIds in interface PrincipalOrBuilderpublic Principal.Set getAndIds()
A set of identifiers that all must match in order to define the downstream.
.envoy.config.rbac.v4alpha.Principal.Set and_ids = 1;getAndIds in interface PrincipalOrBuilderpublic Principal.SetOrBuilder getAndIdsOrBuilder()
A set of identifiers that all must match in order to define the downstream.
.envoy.config.rbac.v4alpha.Principal.Set and_ids = 1;getAndIdsOrBuilder in interface PrincipalOrBuilderpublic boolean hasOrIds()
A set of identifiers at least one must match in order to define the downstream.
.envoy.config.rbac.v4alpha.Principal.Set or_ids = 2;hasOrIds in interface PrincipalOrBuilderpublic Principal.Set getOrIds()
A set of identifiers at least one must match in order to define the downstream.
.envoy.config.rbac.v4alpha.Principal.Set or_ids = 2;getOrIds in interface PrincipalOrBuilderpublic Principal.SetOrBuilder getOrIdsOrBuilder()
A set of identifiers at least one must match in order to define the downstream.
.envoy.config.rbac.v4alpha.Principal.Set or_ids = 2;getOrIdsOrBuilder in interface PrincipalOrBuilderpublic boolean getAny()
When any is set, it matches any downstream.
bool any = 3 [(.validate.rules) = { ... }getAny in interface PrincipalOrBuilderpublic boolean hasAuthenticated()
Authenticated attributes that identify the downstream.
.envoy.config.rbac.v4alpha.Principal.Authenticated authenticated = 4;hasAuthenticated in interface PrincipalOrBuilderpublic Principal.Authenticated getAuthenticated()
Authenticated attributes that identify the downstream.
.envoy.config.rbac.v4alpha.Principal.Authenticated authenticated = 4;getAuthenticated in interface PrincipalOrBuilderpublic Principal.AuthenticatedOrBuilder getAuthenticatedOrBuilder()
Authenticated attributes that identify the downstream.
.envoy.config.rbac.v4alpha.Principal.Authenticated authenticated = 4;getAuthenticatedOrBuilder in interface PrincipalOrBuilderpublic 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.v4alpha.Principal.remote_ip>` is inferred from for example the x-forwarder-for header, proxy protocol, etc.
.envoy.config.core.v4alpha.CidrRange direct_remote_ip = 10;hasDirectRemoteIp in interface PrincipalOrBuilderpublic 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.v4alpha.Principal.remote_ip>` is inferred from for example the x-forwarder-for header, proxy protocol, etc.
.envoy.config.core.v4alpha.CidrRange direct_remote_ip = 10;getDirectRemoteIp in interface PrincipalOrBuilderpublic 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.v4alpha.Principal.remote_ip>` is inferred from for example the x-forwarder-for header, proxy protocol, etc.
.envoy.config.core.v4alpha.CidrRange direct_remote_ip = 10;getDirectRemoteIpOrBuilder in interface PrincipalOrBuilderpublic 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.v4alpha.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.v4alpha.CidrRange remote_ip = 11;hasRemoteIp in interface PrincipalOrBuilderpublic 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.v4alpha.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.v4alpha.CidrRange remote_ip = 11;getRemoteIp in interface PrincipalOrBuilderpublic 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.v4alpha.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.v4alpha.CidrRange remote_ip = 11;getRemoteIpOrBuilder in interface PrincipalOrBuilderpublic 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.v4alpha.HeaderMatcher header = 6;hasHeader in interface PrincipalOrBuilderpublic 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.v4alpha.HeaderMatcher header = 6;getHeader in interface PrincipalOrBuilderpublic 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.v4alpha.HeaderMatcher header = 6;getHeaderOrBuilder in interface PrincipalOrBuilderpublic boolean hasUrlPath()
A URL path on the incoming HTTP request. Only available for HTTP.
.envoy.type.matcher.v4alpha.PathMatcher url_path = 9;hasUrlPath in interface PrincipalOrBuilderpublic PathMatcher getUrlPath()
A URL path on the incoming HTTP request. Only available for HTTP.
.envoy.type.matcher.v4alpha.PathMatcher url_path = 9;getUrlPath in interface PrincipalOrBuilderpublic PathMatcherOrBuilder getUrlPathOrBuilder()
A URL path on the incoming HTTP request. Only available for HTTP.
.envoy.type.matcher.v4alpha.PathMatcher url_path = 9;getUrlPathOrBuilder in interface PrincipalOrBuilderpublic boolean hasMetadata()
Metadata that describes additional information about the principal.
.envoy.type.matcher.v4alpha.MetadataMatcher metadata = 7;hasMetadata in interface PrincipalOrBuilderpublic MetadataMatcher getMetadata()
Metadata that describes additional information about the principal.
.envoy.type.matcher.v4alpha.MetadataMatcher metadata = 7;getMetadata in interface PrincipalOrBuilderpublic MetadataMatcherOrBuilder getMetadataOrBuilder()
Metadata that describes additional information about the principal.
.envoy.type.matcher.v4alpha.MetadataMatcher metadata = 7;getMetadataOrBuilder in interface PrincipalOrBuilderpublic 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.v4alpha.Principal not_id = 8;hasNotId in interface PrincipalOrBuilderpublic 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.v4alpha.Principal not_id = 8;getNotId in interface PrincipalOrBuilderpublic 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.v4alpha.Principal not_id = 8;getNotIdOrBuilder in interface PrincipalOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Principal parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Principal parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Principal parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Principal parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Principal parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Principal parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Principal parseFrom(InputStream input) throws IOException
IOExceptionpublic static Principal parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Principal parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Principal parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Principal parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Principal parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Principal.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Principal.Builder newBuilder()
public static Principal.Builder newBuilder(Principal prototype)
public Principal.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Principal.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Principal getDefaultInstance()
public static com.google.protobuf.Parser<Principal> parser()
public com.google.protobuf.Parser<Principal> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Principal getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.