public static final class Config.JwtRequirement.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder> implements Config.JwtRequirementOrBuilder
This message specifies a Jwt requirement. An empty message means JWT verification is not
required. Here are some config examples:
.. code-block:: yaml
# Example 1: not required with an empty message
# Example 2: require A
provider_name: "provider-A"
# Example 3: require A or B
requires_any:
requirements:
- provider_name: "provider-A"
- provider_name: "provider-B"
# Example 4: require A and B
requires_all:
requirements:
- provider_name: "provider-A"
- provider_name: "provider-B"
# Example 5: require A and (B or C)
requires_all:
requirements:
- provider_name: "provider-A"
- requires_any:
requirements:
- provider_name: "provider-B"
- provider_name: "provider-C"
# Example 6: require A or (B and C)
requires_any:
requirements:
- provider_name: "provider-A"
- requires_all:
requirements:
- provider_name: "provider-B"
- provider_name: "provider-C"
Protobuf type envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirement| Modifier and Type | Method and Description |
|---|---|
Config.JwtRequirement.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Config.JwtRequirement |
build() |
Config.JwtRequirement |
buildPartial() |
Config.JwtRequirement.Builder |
clear() |
Config.JwtRequirement.Builder |
clearAllowMissingOrFailed()
The requirement is always satisfied even if JWT is missing or the JWT
verification fails.
|
Config.JwtRequirement.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Config.JwtRequirement.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Config.JwtRequirement.Builder |
clearProviderAndAudiences()
Specify a required provider with audiences.
|
Config.JwtRequirement.Builder |
clearProviderName()
Specify a required provider name.
|
Config.JwtRequirement.Builder |
clearRequiresAll()
Specify list of JwtRequirement.
|
Config.JwtRequirement.Builder |
clearRequiresAny()
Specify list of JwtRequirement.
|
Config.JwtRequirement.Builder |
clearRequiresType() |
Config.JwtRequirement.Builder |
clone() |
com.google.protobuf.Empty |
getAllowMissingOrFailed()
The requirement is always satisfied even if JWT is missing or the JWT
verification fails.
|
com.google.protobuf.Empty.Builder |
getAllowMissingOrFailedBuilder()
The requirement is always satisfied even if JWT is missing or the JWT
verification fails.
|
com.google.protobuf.EmptyOrBuilder |
getAllowMissingOrFailedOrBuilder()
The requirement is always satisfied even if JWT is missing or the JWT
verification fails.
|
Config.JwtRequirement |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Config.ProviderWithAudiences |
getProviderAndAudiences()
Specify a required provider with audiences.
|
Config.ProviderWithAudiences.Builder |
getProviderAndAudiencesBuilder()
Specify a required provider with audiences.
|
Config.ProviderWithAudiencesOrBuilder |
getProviderAndAudiencesOrBuilder()
Specify a required provider with audiences.
|
String |
getProviderName()
Specify a required provider name.
|
com.google.protobuf.ByteString |
getProviderNameBytes()
Specify a required provider name.
|
Config.JwtRequirementAndList |
getRequiresAll()
Specify list of JwtRequirement.
|
Config.JwtRequirementAndList.Builder |
getRequiresAllBuilder()
Specify list of JwtRequirement.
|
Config.JwtRequirementAndListOrBuilder |
getRequiresAllOrBuilder()
Specify list of JwtRequirement.
|
Config.JwtRequirementOrList |
getRequiresAny()
Specify list of JwtRequirement.
|
Config.JwtRequirementOrList.Builder |
getRequiresAnyBuilder()
Specify list of JwtRequirement.
|
Config.JwtRequirementOrListOrBuilder |
getRequiresAnyOrBuilder()
Specify list of JwtRequirement.
|
Config.JwtRequirement.RequiresTypeCase |
getRequiresTypeCase() |
boolean |
hasAllowMissingOrFailed()
The requirement is always satisfied even if JWT is missing or the JWT
verification fails.
|
boolean |
hasProviderAndAudiences()
Specify a required provider with audiences.
|
boolean |
hasRequiresAll()
Specify list of JwtRequirement.
|
boolean |
hasRequiresAny()
Specify list of JwtRequirement.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Config.JwtRequirement.Builder |
mergeAllowMissingOrFailed(com.google.protobuf.Empty value)
The requirement is always satisfied even if JWT is missing or the JWT
verification fails.
|
Config.JwtRequirement.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Config.JwtRequirement.Builder |
mergeFrom(Config.JwtRequirement other) |
Config.JwtRequirement.Builder |
mergeFrom(com.google.protobuf.Message other) |
Config.JwtRequirement.Builder |
mergeProviderAndAudiences(Config.ProviderWithAudiences value)
Specify a required provider with audiences.
|
Config.JwtRequirement.Builder |
mergeRequiresAll(Config.JwtRequirementAndList value)
Specify list of JwtRequirement.
|
Config.JwtRequirement.Builder |
mergeRequiresAny(Config.JwtRequirementOrList value)
Specify list of JwtRequirement.
|
Config.JwtRequirement.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Config.JwtRequirement.Builder |
setAllowMissingOrFailed(com.google.protobuf.Empty.Builder builderForValue)
The requirement is always satisfied even if JWT is missing or the JWT
verification fails.
|
Config.JwtRequirement.Builder |
setAllowMissingOrFailed(com.google.protobuf.Empty value)
The requirement is always satisfied even if JWT is missing or the JWT
verification fails.
|
Config.JwtRequirement.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Config.JwtRequirement.Builder |
setProviderAndAudiences(Config.ProviderWithAudiences.Builder builderForValue)
Specify a required provider with audiences.
|
Config.JwtRequirement.Builder |
setProviderAndAudiences(Config.ProviderWithAudiences value)
Specify a required provider with audiences.
|
Config.JwtRequirement.Builder |
setProviderName(String value)
Specify a required provider name.
|
Config.JwtRequirement.Builder |
setProviderNameBytes(com.google.protobuf.ByteString value)
Specify a required provider name.
|
Config.JwtRequirement.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Config.JwtRequirement.Builder |
setRequiresAll(Config.JwtRequirementAndList.Builder builderForValue)
Specify list of JwtRequirement.
|
Config.JwtRequirement.Builder |
setRequiresAll(Config.JwtRequirementAndList value)
Specify list of JwtRequirement.
|
Config.JwtRequirement.Builder |
setRequiresAny(Config.JwtRequirementOrList.Builder builderForValue)
Specify list of JwtRequirement.
|
Config.JwtRequirement.Builder |
setRequiresAny(Config.JwtRequirementOrList value)
Specify list of JwtRequirement.
|
Config.JwtRequirement.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder>public Config.JwtRequirement.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder>public Config.JwtRequirement getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Config.JwtRequirement build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Config.JwtRequirement buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Config.JwtRequirement.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder>public Config.JwtRequirement.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder>public Config.JwtRequirement.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder>public Config.JwtRequirement.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder>public Config.JwtRequirement.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder>public Config.JwtRequirement.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder>public Config.JwtRequirement.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Config.JwtRequirement.Builder>public Config.JwtRequirement.Builder mergeFrom(Config.JwtRequirement other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder>public Config.JwtRequirement.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Config.JwtRequirement.Builder>IOExceptionpublic Config.JwtRequirement.RequiresTypeCase getRequiresTypeCase()
getRequiresTypeCase in interface Config.JwtRequirementOrBuilderpublic Config.JwtRequirement.Builder clearRequiresType()
public String getProviderName()
Specify a required provider name.
string provider_name = 1;getProviderName in interface Config.JwtRequirementOrBuilderpublic com.google.protobuf.ByteString getProviderNameBytes()
Specify a required provider name.
string provider_name = 1;getProviderNameBytes in interface Config.JwtRequirementOrBuilderpublic Config.JwtRequirement.Builder setProviderName(String value)
Specify a required provider name.
string provider_name = 1;public Config.JwtRequirement.Builder clearProviderName()
Specify a required provider name.
string provider_name = 1;public Config.JwtRequirement.Builder setProviderNameBytes(com.google.protobuf.ByteString value)
Specify a required provider name.
string provider_name = 1;public boolean hasProviderAndAudiences()
Specify a required provider with audiences.
.envoy.config.filter.http.jwt_authn.v2alpha.ProviderWithAudiences provider_and_audiences = 2;hasProviderAndAudiences in interface Config.JwtRequirementOrBuilderpublic Config.ProviderWithAudiences getProviderAndAudiences()
Specify a required provider with audiences.
.envoy.config.filter.http.jwt_authn.v2alpha.ProviderWithAudiences provider_and_audiences = 2;getProviderAndAudiences in interface Config.JwtRequirementOrBuilderpublic Config.JwtRequirement.Builder setProviderAndAudiences(Config.ProviderWithAudiences value)
Specify a required provider with audiences.
.envoy.config.filter.http.jwt_authn.v2alpha.ProviderWithAudiences provider_and_audiences = 2;public Config.JwtRequirement.Builder setProviderAndAudiences(Config.ProviderWithAudiences.Builder builderForValue)
Specify a required provider with audiences.
.envoy.config.filter.http.jwt_authn.v2alpha.ProviderWithAudiences provider_and_audiences = 2;public Config.JwtRequirement.Builder mergeProviderAndAudiences(Config.ProviderWithAudiences value)
Specify a required provider with audiences.
.envoy.config.filter.http.jwt_authn.v2alpha.ProviderWithAudiences provider_and_audiences = 2;public Config.JwtRequirement.Builder clearProviderAndAudiences()
Specify a required provider with audiences.
.envoy.config.filter.http.jwt_authn.v2alpha.ProviderWithAudiences provider_and_audiences = 2;public Config.ProviderWithAudiences.Builder getProviderAndAudiencesBuilder()
Specify a required provider with audiences.
.envoy.config.filter.http.jwt_authn.v2alpha.ProviderWithAudiences provider_and_audiences = 2;public Config.ProviderWithAudiencesOrBuilder getProviderAndAudiencesOrBuilder()
Specify a required provider with audiences.
.envoy.config.filter.http.jwt_authn.v2alpha.ProviderWithAudiences provider_and_audiences = 2;getProviderAndAudiencesOrBuilder in interface Config.JwtRequirementOrBuilderpublic boolean hasRequiresAny()
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementOrList requires_any = 3;hasRequiresAny in interface Config.JwtRequirementOrBuilderpublic Config.JwtRequirementOrList getRequiresAny()
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementOrList requires_any = 3;getRequiresAny in interface Config.JwtRequirementOrBuilderpublic Config.JwtRequirement.Builder setRequiresAny(Config.JwtRequirementOrList value)
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementOrList requires_any = 3;public Config.JwtRequirement.Builder setRequiresAny(Config.JwtRequirementOrList.Builder builderForValue)
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementOrList requires_any = 3;public Config.JwtRequirement.Builder mergeRequiresAny(Config.JwtRequirementOrList value)
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementOrList requires_any = 3;public Config.JwtRequirement.Builder clearRequiresAny()
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementOrList requires_any = 3;public Config.JwtRequirementOrList.Builder getRequiresAnyBuilder()
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementOrList requires_any = 3;public Config.JwtRequirementOrListOrBuilder getRequiresAnyOrBuilder()
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementOrList requires_any = 3;getRequiresAnyOrBuilder in interface Config.JwtRequirementOrBuilderpublic boolean hasRequiresAll()
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementAndList requires_all = 4;hasRequiresAll in interface Config.JwtRequirementOrBuilderpublic Config.JwtRequirementAndList getRequiresAll()
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementAndList requires_all = 4;getRequiresAll in interface Config.JwtRequirementOrBuilderpublic Config.JwtRequirement.Builder setRequiresAll(Config.JwtRequirementAndList value)
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementAndList requires_all = 4;public Config.JwtRequirement.Builder setRequiresAll(Config.JwtRequirementAndList.Builder builderForValue)
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementAndList requires_all = 4;public Config.JwtRequirement.Builder mergeRequiresAll(Config.JwtRequirementAndList value)
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementAndList requires_all = 4;public Config.JwtRequirement.Builder clearRequiresAll()
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementAndList requires_all = 4;public Config.JwtRequirementAndList.Builder getRequiresAllBuilder()
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementAndList requires_all = 4;public Config.JwtRequirementAndListOrBuilder getRequiresAllOrBuilder()
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementAndList requires_all = 4;getRequiresAllOrBuilder in interface Config.JwtRequirementOrBuilderpublic boolean hasAllowMissingOrFailed()
The requirement is always satisfied even if JWT is missing or the JWT verification fails. A typical usage is: this filter is used to only verify JWTs and pass the verified JWT payloads to another filter, the other filter will make decision. In this mode, all JWT tokens will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5;hasAllowMissingOrFailed in interface Config.JwtRequirementOrBuilderpublic com.google.protobuf.Empty getAllowMissingOrFailed()
The requirement is always satisfied even if JWT is missing or the JWT verification fails. A typical usage is: this filter is used to only verify JWTs and pass the verified JWT payloads to another filter, the other filter will make decision. In this mode, all JWT tokens will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5;getAllowMissingOrFailed in interface Config.JwtRequirementOrBuilderpublic Config.JwtRequirement.Builder setAllowMissingOrFailed(com.google.protobuf.Empty value)
The requirement is always satisfied even if JWT is missing or the JWT verification fails. A typical usage is: this filter is used to only verify JWTs and pass the verified JWT payloads to another filter, the other filter will make decision. In this mode, all JWT tokens will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5;public Config.JwtRequirement.Builder setAllowMissingOrFailed(com.google.protobuf.Empty.Builder builderForValue)
The requirement is always satisfied even if JWT is missing or the JWT verification fails. A typical usage is: this filter is used to only verify JWTs and pass the verified JWT payloads to another filter, the other filter will make decision. In this mode, all JWT tokens will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5;public Config.JwtRequirement.Builder mergeAllowMissingOrFailed(com.google.protobuf.Empty value)
The requirement is always satisfied even if JWT is missing or the JWT verification fails. A typical usage is: this filter is used to only verify JWTs and pass the verified JWT payloads to another filter, the other filter will make decision. In this mode, all JWT tokens will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5;public Config.JwtRequirement.Builder clearAllowMissingOrFailed()
The requirement is always satisfied even if JWT is missing or the JWT verification fails. A typical usage is: this filter is used to only verify JWTs and pass the verified JWT payloads to another filter, the other filter will make decision. In this mode, all JWT tokens will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5;public com.google.protobuf.Empty.Builder getAllowMissingOrFailedBuilder()
The requirement is always satisfied even if JWT is missing or the JWT verification fails. A typical usage is: this filter is used to only verify JWTs and pass the verified JWT payloads to another filter, the other filter will make decision. In this mode, all JWT tokens will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5;public com.google.protobuf.EmptyOrBuilder getAllowMissingOrFailedOrBuilder()
The requirement is always satisfied even if JWT is missing or the JWT verification fails. A typical usage is: this filter is used to only verify JWTs and pass the verified JWT payloads to another filter, the other filter will make decision. In this mode, all JWT tokens will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5;getAllowMissingOrFailedOrBuilder in interface Config.JwtRequirementOrBuilderpublic final Config.JwtRequirement.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder>public final Config.JwtRequirement.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtRequirement.Builder>Copyright © 2018 The Envoy Project. All rights reserved.