envoy.config.filter.http.jwt_authn.v2alpha

Class Config.RequirementRule

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

envoy.config.filter.http.jwt_authn.v2alpha.Config.RequirementRule

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Config.RequirementRuleOrBuilder, Serializable

Enclosing class:

Config

public static final class Config.RequirementRule
extends com.google.protobuf.GeneratedMessageV3
implements Config.RequirementRuleOrBuilder

 This message specifies a Jwt requirement for a specific Route condition.
 Example 1:
 .. code-block:: yaml
    - match:
         prefix: "/healthz"
 In above example, "requires" field is empty for /healthz prefix match,
 it means that requests matching the path prefix don't require JWT authentication.
 Example 2:
 .. code-block:: yaml
    - match:
         prefix: "/"
      requires: { provider_name: "provider-A" }
 In above example, all requests matched the path prefix require jwt authentication
 from "provider-A".
 

Protobuf type envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.RequirementRule.Builder This message specifies a Jwt requirement for a specific Route condition.

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	MATCH_FIELD_NUMBER
static int	REQUIRES_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 and Description
boolean	equals(Object obj)
static Config.RequirementRule	getDefaultInstance()
Config.RequirementRule	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
RouteOuterClass.RouteMatch	getMatch() The route matching parameter.
RouteOuterClass.RouteMatchOrBuilder	getMatchOrBuilder() The route matching parameter.
com.google.protobuf.Parser<Config.RequirementRule>	getParserForType()
Config.JwtRequirement	getRequires() Specify a Jwt Requirement.
Config.JwtRequirementOrBuilder	getRequiresOrBuilder() Specify a Jwt Requirement.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasMatch() The route matching parameter.
boolean	hasRequires() Specify a Jwt Requirement.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Config.RequirementRule.Builder	newBuilder()
static Config.RequirementRule.Builder	newBuilder(Config.RequirementRule prototype)
Config.RequirementRule.Builder	newBuilderForType()
protected Config.RequirementRule.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Config.RequirementRule	parseDelimitedFrom(InputStream input)
static Config.RequirementRule	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.RequirementRule	parseFrom(byte[] data)
static Config.RequirementRule	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.RequirementRule	parseFrom(ByteBuffer data)
static Config.RequirementRule	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.RequirementRule	parseFrom(com.google.protobuf.ByteString data)
static Config.RequirementRule	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.RequirementRule	parseFrom(com.google.protobuf.CodedInputStream input)
static Config.RequirementRule	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.RequirementRule	parseFrom(InputStream input)
static Config.RequirementRule	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Config.RequirementRule>	parser()
Config.RequirementRule.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MATCH_FIELD_NUMBER

public static final int MATCH_FIELD_NUMBER

See Also:

Constant Field Values

REQUIRES_FIELD_NUMBER

public static final int REQUIRES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

hasMatch

public boolean hasMatch()

 The route matching parameter. Only when the match is satisfied, the "requires" field will
 apply.
 For example: following match will match all requests.
 .. code-block:: yaml
    match:
       prefix: "/"
 

.envoy.api.v2.route.RouteMatch match = 1 [(.validate.rules) = { ... }

Specified by:

hasMatch in interface Config.RequirementRuleOrBuilder

getMatch

public RouteOuterClass.RouteMatch getMatch()

 The route matching parameter. Only when the match is satisfied, the "requires" field will
 apply.
 For example: following match will match all requests.
 .. code-block:: yaml
    match:
       prefix: "/"
 

.envoy.api.v2.route.RouteMatch match = 1 [(.validate.rules) = { ... }

Specified by:

getMatch in interface Config.RequirementRuleOrBuilder

getMatchOrBuilder

public RouteOuterClass.RouteMatchOrBuilder getMatchOrBuilder()

 The route matching parameter. Only when the match is satisfied, the "requires" field will
 apply.
 For example: following match will match all requests.
 .. code-block:: yaml
    match:
       prefix: "/"
 

.envoy.api.v2.route.RouteMatch match = 1 [(.validate.rules) = { ... }

Specified by:

getMatchOrBuilder in interface Config.RequirementRuleOrBuilder

hasRequires

public boolean hasRequires()

 Specify a Jwt Requirement. Please detail comment in message JwtRequirement.
 

.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirement requires = 2;

Specified by:

hasRequires in interface Config.RequirementRuleOrBuilder

getRequires

public Config.JwtRequirement getRequires()

 Specify a Jwt Requirement. Please detail comment in message JwtRequirement.
 

.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirement requires = 2;

Specified by:

getRequires in interface Config.RequirementRuleOrBuilder

getRequiresOrBuilder

public Config.JwtRequirementOrBuilder getRequiresOrBuilder()

 Specify a Jwt Requirement. Please detail comment in message JwtRequirement.
 

.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirement requires = 2;

Specified by:

getRequiresOrBuilder in interface Config.RequirementRuleOrBuilder

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 Config.RequirementRule parseFrom(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.RequirementRule parseFrom(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.RequirementRule parseFrom(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.RequirementRule parseFrom(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.RequirementRule parseFrom(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.RequirementRule parseFrom(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.RequirementRule parseFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static Config.RequirementRule parseFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Config.RequirementRule parseDelimitedFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Config.RequirementRule parseDelimitedFrom(InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

parseFrom

public static Config.RequirementRule parseFrom(com.google.protobuf.CodedInputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static Config.RequirementRule parseFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

newBuilderForType

public Config.RequirementRule.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Config.RequirementRule.Builder newBuilder()

newBuilder

public static Config.RequirementRule.Builder newBuilder(Config.RequirementRule prototype)

toBuilder

public Config.RequirementRule.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Config.RequirementRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Config.RequirementRule getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Config.RequirementRule> 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 Config.RequirementRule getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder