envoy.config.filter.http.jwt_authn.v2alpha

Class Config.RequirementRule.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>

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

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Config.RequirementRuleOrBuilder, Cloneable

Enclosing class:

Config.RequirementRule

public static final class Config.RequirementRule.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>
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

Method Summary

Modifier and Type	Method and Description
Config.RequirementRule.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Config.RequirementRule	build()
Config.RequirementRule	buildPartial()
Config.RequirementRule.Builder	clear()
Config.RequirementRule.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Config.RequirementRule.Builder	clearMatch() The route matching parameter.
Config.RequirementRule.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Config.RequirementRule.Builder	clearRequires() Specify a Jwt Requirement.
Config.RequirementRule.Builder	clone()
Config.RequirementRule	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
RouteOuterClass.RouteMatch	getMatch() The route matching parameter.
RouteOuterClass.RouteMatch.Builder	getMatchBuilder() The route matching parameter.
RouteOuterClass.RouteMatchOrBuilder	getMatchOrBuilder() The route matching parameter.
Config.JwtRequirement	getRequires() Specify a Jwt Requirement.
Config.JwtRequirement.Builder	getRequiresBuilder() Specify a Jwt Requirement.
Config.JwtRequirementOrBuilder	getRequiresOrBuilder() Specify a Jwt Requirement.
boolean	hasMatch() The route matching parameter.
boolean	hasRequires() Specify a Jwt Requirement.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Config.RequirementRule.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Config.RequirementRule.Builder	mergeFrom(Config.RequirementRule other)
Config.RequirementRule.Builder	mergeFrom(com.google.protobuf.Message other)
Config.RequirementRule.Builder	mergeMatch(RouteOuterClass.RouteMatch value) The route matching parameter.
Config.RequirementRule.Builder	mergeRequires(Config.JwtRequirement value) Specify a Jwt Requirement.
Config.RequirementRule.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Config.RequirementRule.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Config.RequirementRule.Builder	setMatch(RouteOuterClass.RouteMatch.Builder builderForValue) The route matching parameter.
Config.RequirementRule.Builder	setMatch(RouteOuterClass.RouteMatch value) The route matching parameter.
Config.RequirementRule.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Config.RequirementRule.Builder	setRequires(Config.JwtRequirement.Builder builderForValue) Specify a Jwt Requirement.
Config.RequirementRule.Builder	setRequires(Config.JwtRequirement value) Specify a Jwt Requirement.
Config.RequirementRule.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<Config.RequirementRule.Builder>

clear

public Config.RequirementRule.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>

getDefaultInstanceForType

public Config.RequirementRule getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Config.RequirementRule build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Config.RequirementRule buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Config.RequirementRule.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>

setField

public Config.RequirementRule.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>

clearField

public Config.RequirementRule.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>

clearOneof

public Config.RequirementRule.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>

setRepeatedField

public Config.RequirementRule.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>

addRepeatedField

public Config.RequirementRule.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>

mergeFrom

public Config.RequirementRule.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Config.RequirementRule.Builder>

mergeFrom

public Config.RequirementRule.Builder mergeFrom(Config.RequirementRule other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Config.RequirementRule.Builder>

Throws:

IOException

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

setMatch

public Config.RequirementRule.Builder setMatch(RouteOuterClass.RouteMatch value)

 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) = { ... }

setMatch

public Config.RequirementRule.Builder setMatch(RouteOuterClass.RouteMatch.Builder builderForValue)

 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) = { ... }

mergeMatch

public Config.RequirementRule.Builder mergeMatch(RouteOuterClass.RouteMatch value)

 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) = { ... }

clearMatch

public Config.RequirementRule.Builder clearMatch()

 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) = { ... }

getMatchBuilder

public RouteOuterClass.RouteMatch.Builder getMatchBuilder()

 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) = { ... }

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

setRequires

public Config.RequirementRule.Builder setRequires(Config.JwtRequirement value)

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

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

setRequires

public Config.RequirementRule.Builder setRequires(Config.JwtRequirement.Builder builderForValue)

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

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

mergeRequires

public Config.RequirementRule.Builder mergeRequires(Config.JwtRequirement value)

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

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

clearRequires

public Config.RequirementRule.Builder clearRequires()

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

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

getRequiresBuilder

public Config.JwtRequirement.Builder getRequiresBuilder()

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

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

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

setUnknownFields

public final Config.RequirementRule.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>

mergeUnknownFields

public final Config.RequirementRule.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Config.RequirementRule.Builder>