public final class Permission extends com.google.protobuf.GeneratedMessageV3 implements PermissionOrBuilder
Permission defines an action (or actions) that a principal can take. [#next-free-field: 11]Protobuf type
envoy.config.rbac.v2.Permission| Modifier and Type | Class and Description |
|---|---|
static class |
Permission.Builder
Permission defines an action (or actions) that a principal can take.
|
static class |
Permission.RuleCase |
static class |
Permission.Set
Used in the `and_rules` and `or_rules` fields in the `rule` oneof.
|
static interface |
Permission.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_RULES_FIELD_NUMBER |
static int |
ANY_FIELD_NUMBER |
static int |
DESTINATION_IP_FIELD_NUMBER |
static int |
DESTINATION_PORT_FIELD_NUMBER |
static int |
HEADER_FIELD_NUMBER |
static int |
METADATA_FIELD_NUMBER |
static int |
NOT_RULE_FIELD_NUMBER |
static int |
OR_RULES_FIELD_NUMBER |
static int |
REQUESTED_SERVER_NAME_FIELD_NUMBER |
static int |
URL_PATH_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
Permission.Set |
getAndRules()
A set of rules that all must match in order to define the action.
|
Permission.SetOrBuilder |
getAndRulesOrBuilder()
A set of rules that all must match in order to define the action.
|
boolean |
getAny()
When any is set, it matches any action.
|
static Permission |
getDefaultInstance() |
Permission |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
CidrRange |
getDestinationIp()
A CIDR block that describes the destination IP.
|
CidrRangeOrBuilder |
getDestinationIpOrBuilder()
A CIDR block that describes the destination IP.
|
int |
getDestinationPort()
A port number that describes the destination port connecting to.
|
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.
|
MetadataMatcher |
getMetadata()
Metadata that describes additional information about the action.
|
MetadataMatcherOrBuilder |
getMetadataOrBuilder()
Metadata that describes additional information about the action.
|
Permission |
getNotRule()
Negates matching the provided permission.
|
PermissionOrBuilder |
getNotRuleOrBuilder()
Negates matching the provided permission.
|
Permission.Set |
getOrRules()
A set of rules where at least one must match in order to define the action.
|
Permission.SetOrBuilder |
getOrRulesOrBuilder()
A set of rules where at least one must match in order to define the action.
|
com.google.protobuf.Parser<Permission> |
getParserForType() |
StringMatcher |
getRequestedServerName()
The request server from the client's connection request.
|
StringMatcherOrBuilder |
getRequestedServerNameOrBuilder()
The request server from the client's connection request.
|
Permission.RuleCase |
getRuleCase() |
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 |
hasAndRules()
A set of rules that all must match in order to define the action.
|
boolean |
hasDestinationIp()
A CIDR block that describes the destination IP.
|
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 action.
|
boolean |
hasNotRule()
Negates matching the provided permission.
|
boolean |
hasOrRules()
A set of rules where at least one must match in order to define the action.
|
boolean |
hasRequestedServerName()
The request server from the client's connection request.
|
boolean |
hasUrlPath()
A URL path on the incoming HTTP request.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Permission.Builder |
newBuilder() |
static Permission.Builder |
newBuilder(Permission prototype) |
Permission.Builder |
newBuilderForType() |
protected Permission.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Permission |
parseDelimitedFrom(InputStream input) |
static Permission |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Permission |
parseFrom(byte[] data) |
static Permission |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Permission |
parseFrom(ByteBuffer data) |
static Permission |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Permission |
parseFrom(com.google.protobuf.ByteString data) |
static Permission |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Permission |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Permission |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Permission |
parseFrom(InputStream input) |
static Permission |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Permission> |
parser() |
Permission.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_RULES_FIELD_NUMBER
public static final int OR_RULES_FIELD_NUMBER
public static final int ANY_FIELD_NUMBER
public static final int HEADER_FIELD_NUMBER
public static final int URL_PATH_FIELD_NUMBER
public static final int DESTINATION_IP_FIELD_NUMBER
public static final int DESTINATION_PORT_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
public static final int NOT_RULE_FIELD_NUMBER
public static final int REQUESTED_SERVER_NAME_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 Permission.RuleCase getRuleCase()
getRuleCase in interface PermissionOrBuilderpublic boolean hasAndRules()
A set of rules that all must match in order to define the action.
.envoy.config.rbac.v2.Permission.Set and_rules = 1;hasAndRules in interface PermissionOrBuilderpublic Permission.Set getAndRules()
A set of rules that all must match in order to define the action.
.envoy.config.rbac.v2.Permission.Set and_rules = 1;getAndRules in interface PermissionOrBuilderpublic Permission.SetOrBuilder getAndRulesOrBuilder()
A set of rules that all must match in order to define the action.
.envoy.config.rbac.v2.Permission.Set and_rules = 1;getAndRulesOrBuilder in interface PermissionOrBuilderpublic boolean hasOrRules()
A set of rules where at least one must match in order to define the action.
.envoy.config.rbac.v2.Permission.Set or_rules = 2;hasOrRules in interface PermissionOrBuilderpublic Permission.Set getOrRules()
A set of rules where at least one must match in order to define the action.
.envoy.config.rbac.v2.Permission.Set or_rules = 2;getOrRules in interface PermissionOrBuilderpublic Permission.SetOrBuilder getOrRulesOrBuilder()
A set of rules where at least one must match in order to define the action.
.envoy.config.rbac.v2.Permission.Set or_rules = 2;getOrRulesOrBuilder in interface PermissionOrBuilderpublic boolean getAny()
When any is set, it matches any action.
bool any = 3 [(.validate.rules) = { ... }getAny in interface PermissionOrBuilderpublic 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 = 4;hasHeader in interface PermissionOrBuilderpublic 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 = 4;getHeader in interface PermissionOrBuilderpublic 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 = 4;getHeaderOrBuilder in interface PermissionOrBuilderpublic boolean hasUrlPath()
A URL path on the incoming HTTP request. Only available for HTTP.
.envoy.type.matcher.PathMatcher url_path = 10;hasUrlPath in interface PermissionOrBuilderpublic PathMatcher getUrlPath()
A URL path on the incoming HTTP request. Only available for HTTP.
.envoy.type.matcher.PathMatcher url_path = 10;getUrlPath in interface PermissionOrBuilderpublic PathMatcherOrBuilder getUrlPathOrBuilder()
A URL path on the incoming HTTP request. Only available for HTTP.
.envoy.type.matcher.PathMatcher url_path = 10;getUrlPathOrBuilder in interface PermissionOrBuilderpublic boolean hasDestinationIp()
A CIDR block that describes the destination IP.
.envoy.api.v2.core.CidrRange destination_ip = 5;hasDestinationIp in interface PermissionOrBuilderpublic CidrRange getDestinationIp()
A CIDR block that describes the destination IP.
.envoy.api.v2.core.CidrRange destination_ip = 5;getDestinationIp in interface PermissionOrBuilderpublic CidrRangeOrBuilder getDestinationIpOrBuilder()
A CIDR block that describes the destination IP.
.envoy.api.v2.core.CidrRange destination_ip = 5;getDestinationIpOrBuilder in interface PermissionOrBuilderpublic int getDestinationPort()
A port number that describes the destination port connecting to.
uint32 destination_port = 6 [(.validate.rules) = { ... }getDestinationPort in interface PermissionOrBuilderpublic boolean hasMetadata()
Metadata that describes additional information about the action.
.envoy.type.matcher.MetadataMatcher metadata = 7;hasMetadata in interface PermissionOrBuilderpublic MetadataMatcher getMetadata()
Metadata that describes additional information about the action.
.envoy.type.matcher.MetadataMatcher metadata = 7;getMetadata in interface PermissionOrBuilderpublic MetadataMatcherOrBuilder getMetadataOrBuilder()
Metadata that describes additional information about the action.
.envoy.type.matcher.MetadataMatcher metadata = 7;getMetadataOrBuilder in interface PermissionOrBuilderpublic boolean hasNotRule()
Negates matching the provided permission. For instance, if the value of `not_rule` would match, this permission would not match. Conversely, if the value of `not_rule` would not match, this permission would match.
.envoy.config.rbac.v2.Permission not_rule = 8;hasNotRule in interface PermissionOrBuilderpublic Permission getNotRule()
Negates matching the provided permission. For instance, if the value of `not_rule` would match, this permission would not match. Conversely, if the value of `not_rule` would not match, this permission would match.
.envoy.config.rbac.v2.Permission not_rule = 8;getNotRule in interface PermissionOrBuilderpublic PermissionOrBuilder getNotRuleOrBuilder()
Negates matching the provided permission. For instance, if the value of `not_rule` would match, this permission would not match. Conversely, if the value of `not_rule` would not match, this permission would match.
.envoy.config.rbac.v2.Permission not_rule = 8;getNotRuleOrBuilder in interface PermissionOrBuilderpublic boolean hasRequestedServerName()
The request server from the client's connection request. This is
typically TLS SNI.
.. attention::
The behavior of this field may be affected by how Envoy is configured
as explained below.
* If the :ref:`TLS Inspector <config_listener_filters_tls_inspector>`
filter is not added, and if a `FilterChainMatch` is not defined for
the :ref:`server name <envoy_api_field_listener.FilterChainMatch.server_names>`,
a TLS connection's requested SNI server name will be treated as if it
wasn't present.
* A :ref:`listener filter <arch_overview_listener_filters>` may
overwrite a connection's requested server name within Envoy.
Please refer to :ref:`this FAQ entry <faq_how_to_setup_sni>` to learn to
setup SNI.
.envoy.type.matcher.StringMatcher requested_server_name = 9;hasRequestedServerName in interface PermissionOrBuilderpublic StringMatcher getRequestedServerName()
The request server from the client's connection request. This is
typically TLS SNI.
.. attention::
The behavior of this field may be affected by how Envoy is configured
as explained below.
* If the :ref:`TLS Inspector <config_listener_filters_tls_inspector>`
filter is not added, and if a `FilterChainMatch` is not defined for
the :ref:`server name <envoy_api_field_listener.FilterChainMatch.server_names>`,
a TLS connection's requested SNI server name will be treated as if it
wasn't present.
* A :ref:`listener filter <arch_overview_listener_filters>` may
overwrite a connection's requested server name within Envoy.
Please refer to :ref:`this FAQ entry <faq_how_to_setup_sni>` to learn to
setup SNI.
.envoy.type.matcher.StringMatcher requested_server_name = 9;getRequestedServerName in interface PermissionOrBuilderpublic StringMatcherOrBuilder getRequestedServerNameOrBuilder()
The request server from the client's connection request. This is
typically TLS SNI.
.. attention::
The behavior of this field may be affected by how Envoy is configured
as explained below.
* If the :ref:`TLS Inspector <config_listener_filters_tls_inspector>`
filter is not added, and if a `FilterChainMatch` is not defined for
the :ref:`server name <envoy_api_field_listener.FilterChainMatch.server_names>`,
a TLS connection's requested SNI server name will be treated as if it
wasn't present.
* A :ref:`listener filter <arch_overview_listener_filters>` may
overwrite a connection's requested server name within Envoy.
Please refer to :ref:`this FAQ entry <faq_how_to_setup_sni>` to learn to
setup SNI.
.envoy.type.matcher.StringMatcher requested_server_name = 9;getRequestedServerNameOrBuilder in interface PermissionOrBuilderpublic 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 Permission parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Permission parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Permission parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Permission parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Permission parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Permission parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Permission parseFrom(InputStream input) throws IOException
IOExceptionpublic static Permission parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Permission parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Permission parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Permission parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Permission parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Permission.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Permission.Builder newBuilder()
public static Permission.Builder newBuilder(Permission prototype)
public Permission.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Permission.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Permission getDefaultInstance()
public static com.google.protobuf.Parser<Permission> parser()
public com.google.protobuf.Parser<Permission> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Permission getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.