io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v4alpha

Class FilterStateRule

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v4alpha.FilterStateRule

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FilterStateRuleOrBuilder, Serializable

public final class FilterStateRule
extends com.google.protobuf.GeneratedMessageV3
implements FilterStateRuleOrBuilder

 This message specifies Jwt requirements based on stream_info.filterState.
 This FilterState should use `Router::StringAccessor` object to set a string value.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 Example:
 .. code-block:: yaml
    name: jwt_selector
    requires:
      issuer_1:
        provider_name: issuer1
      issuer_2:
        provider_name: issuer2
 If a filter set "jwt_selector" with "issuer_1" to FilterState for a request,
 jwt_authn filter will use JwtRequirement{"provider_name": "issuer1"} to verify.
 

Protobuf type envoy.extensions.filters.http.jwt_authn.v4alpha.FilterStateRule

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterStateRule.Builder This message specifies Jwt requirements based on stream_info.filterState.

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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_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	containsRequires(String key) A map of string keys to requirements.
boolean	equals(Object obj)
static FilterStateRule	getDefaultInstance()
FilterStateRule	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getName() The filter state name to retrieve the `Router::StringAccessor` object.
com.google.protobuf.ByteString	getNameBytes() The filter state name to retrieve the `Router::StringAccessor` object.
com.google.protobuf.Parser<FilterStateRule>	getParserForType()
Map<String,JwtRequirement>	getRequires() Deprecated.
int	getRequiresCount() A map of string keys to requirements.
Map<String,JwtRequirement>	getRequiresMap() A map of string keys to requirements.
JwtRequirement	getRequiresOrDefault(String key, JwtRequirement defaultValue) A map of string keys to requirements.
JwtRequirement	getRequiresOrThrow(String key) A map of string keys to requirements.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static FilterStateRule.Builder	newBuilder()
static FilterStateRule.Builder	newBuilder(FilterStateRule prototype)
FilterStateRule.Builder	newBuilderForType()
protected FilterStateRule.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FilterStateRule	parseDelimitedFrom(InputStream input)
static FilterStateRule	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterStateRule	parseFrom(byte[] data)
static FilterStateRule	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterStateRule	parseFrom(ByteBuffer data)
static FilterStateRule	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterStateRule	parseFrom(com.google.protobuf.ByteString data)
static FilterStateRule	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterStateRule	parseFrom(com.google.protobuf.CodedInputStream input)
static FilterStateRule	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterStateRule	parseFrom(InputStream input)
static FilterStateRule	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FilterStateRule>	parser()
FilterStateRule.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, 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

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

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

REQUIRES_FIELD_NUMBER

public static final int REQUIRES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 The filter state name to retrieve the `Router::StringAccessor` object.
 

string name = 1 [(.validate.rules) = { ... }

Specified by:

getName in interface FilterStateRuleOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The filter state name to retrieve the `Router::StringAccessor` object.
 

string name = 1 [(.validate.rules) = { ... }

Specified by:

getNameBytes in interface FilterStateRuleOrBuilder

getRequiresCount

public int getRequiresCount()

Description copied from interface: FilterStateRuleOrBuilder

 A map of string keys to requirements. The string key is the string value
 in the FilterState with the name specified in the *name* field above.
 

map<string, .envoy.extensions.filters.http.jwt_authn.v4alpha.JwtRequirement> requires = 3;

Specified by:

getRequiresCount in interface FilterStateRuleOrBuilder

containsRequires

public boolean containsRequires(String key)

 A map of string keys to requirements. The string key is the string value
 in the FilterState with the name specified in the *name* field above.
 

map<string, .envoy.extensions.filters.http.jwt_authn.v4alpha.JwtRequirement> requires = 3;

Specified by:

containsRequires in interface FilterStateRuleOrBuilder

getRequires

@Deprecated
public Map<String,JwtRequirement> getRequires()

Deprecated.

Use getRequiresMap() instead.

Specified by:

getRequires in interface FilterStateRuleOrBuilder

getRequiresMap

public Map<String,JwtRequirement> getRequiresMap()

 A map of string keys to requirements. The string key is the string value
 in the FilterState with the name specified in the *name* field above.
 

map<string, .envoy.extensions.filters.http.jwt_authn.v4alpha.JwtRequirement> requires = 3;

Specified by:

getRequiresMap in interface FilterStateRuleOrBuilder

getRequiresOrDefault

public JwtRequirement getRequiresOrDefault(String key,
                                           JwtRequirement defaultValue)

 A map of string keys to requirements. The string key is the string value
 in the FilterState with the name specified in the *name* field above.
 

map<string, .envoy.extensions.filters.http.jwt_authn.v4alpha.JwtRequirement> requires = 3;

Specified by:

getRequiresOrDefault in interface FilterStateRuleOrBuilder

getRequiresOrThrow

public JwtRequirement getRequiresOrThrow(String key)

 A map of string keys to requirements. The string key is the string value
 in the FilterState with the name specified in the *name* field above.
 

map<string, .envoy.extensions.filters.http.jwt_authn.v4alpha.JwtRequirement> requires = 3;

Specified by:

getRequiresOrThrow in interface FilterStateRuleOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FilterStateRule parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static FilterStateRule parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public FilterStateRule.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FilterStateRule.Builder newBuilder()

newBuilder

public static FilterStateRule.Builder newBuilder(FilterStateRule prototype)

toBuilder

public FilterStateRule.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FilterStateRule getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder