FilterStateRule.Builder (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<FilterStateRule.Builder>
    - - io.envoyproxy.envoy.config.filter.http.jwt_authn.v2alpha.FilterStateRule.Builder

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FilterStateRuleOrBuilder, Cloneable

Enclosing class:: FilterStateRule

public static final class FilterStateRule.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FilterStateRule.Builder>
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.config.filter.http.jwt_authn.v2alpha.FilterStateRule

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`FilterStateRule.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`FilterStateRule`	`build()`
`FilterStateRule`	`buildPartial()`
`FilterStateRule.Builder`	`clear()`
`FilterStateRule.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`FilterStateRule.Builder`	`clearName()` The filter state name to retrieve the `Router::StringAccessor` object.
`FilterStateRule.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`FilterStateRule.Builder`	`clearRequires()`
`FilterStateRule.Builder`	`clone()`
`boolean`	`containsRequires(String key)` A map of string keys to requirements.
`FilterStateRule`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`Map<String,JwtRequirement>`	`getMutableRequires()` Deprecated.
`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.
`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.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`protected com.google.protobuf.MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`FilterStateRule.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`FilterStateRule.Builder`	`mergeFrom(FilterStateRule other)`
`FilterStateRule.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`FilterStateRule.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`FilterStateRule.Builder`	`putAllRequires(Map<String,JwtRequirement> values)` A map of string keys to requirements.
`FilterStateRule.Builder`	`putRequires(String key, JwtRequirement value)` A map of string keys to requirements.
`FilterStateRule.Builder`	`removeRequires(String key)` A map of string keys to requirements.
`FilterStateRule.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`FilterStateRule.Builder`	`setName(String value)` The filter state name to retrieve the `Router::StringAccessor` object.
`FilterStateRule.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` The filter state name to retrieve the `Router::StringAccessor` object.
`FilterStateRule.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`FilterStateRule.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, 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()
```
  - internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
    Overrides:
    
    internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<FilterStateRule.Builder>
  - internalGetMutableMapField
```
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
```
    Overrides:
    
    internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<FilterStateRule.Builder>
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<FilterStateRule.Builder>
  - clear
```
public FilterStateRule.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<FilterStateRule.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<FilterStateRule.Builder>
  - getDefaultInstanceForType
```
public FilterStateRule getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public FilterStateRule build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public FilterStateRule buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public FilterStateRule.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<FilterStateRule.Builder>
  - setField
```
public FilterStateRule.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<FilterStateRule.Builder>
  - clearField
```
public FilterStateRule.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<FilterStateRule.Builder>
  - clearOneof
```
public FilterStateRule.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<FilterStateRule.Builder>
  - setRepeatedField
```
public FilterStateRule.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<FilterStateRule.Builder>
  - addRepeatedField
```
public FilterStateRule.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<FilterStateRule.Builder>
  - mergeFrom
```
public FilterStateRule.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<FilterStateRule.Builder>
  - mergeFrom
```
public FilterStateRule.Builder mergeFrom(FilterStateRule other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FilterStateRule.Builder>
  - mergeFrom
```
public FilterStateRule.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<FilterStateRule.Builder>
    
    Throws:
    
    IOException
  - 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
  - setName
```
public FilterStateRule.Builder setName(String value)
```
```
 The filter state name to retrieve the `Router::StringAccessor` object.
 
```
    string name = 1 [(.validate.rules) = { ... }
  - clearName
```
public FilterStateRule.Builder clearName()
```
```
 The filter state name to retrieve the `Router::StringAccessor` object.
 
```
    string name = 1 [(.validate.rules) = { ... }
  - setNameBytes
```
public FilterStateRule.Builder setNameBytes(com.google.protobuf.ByteString value)
```
```
 The filter state name to retrieve the `Router::StringAccessor` object.
 
```
    string name = 1 [(.validate.rules) = { ... }
  - 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.config.filter.http.jwt_authn.v2alpha.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.config.filter.http.jwt_authn.v2alpha.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.config.filter.http.jwt_authn.v2alpha.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.config.filter.http.jwt_authn.v2alpha.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.config.filter.http.jwt_authn.v2alpha.JwtRequirement> requires = 3;
    Specified by:
    
    getRequiresOrThrow in interface FilterStateRuleOrBuilder
  - clearRequires
```
public FilterStateRule.Builder clearRequires()
```
  - removeRequires
```
public FilterStateRule.Builder removeRequires(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.config.filter.http.jwt_authn.v2alpha.JwtRequirement> requires = 3;
  - getMutableRequires
```
@Deprecated
public Map<String,JwtRequirement> getMutableRequires()
```
    Deprecated.
    
    Use alternate mutation accessors instead.
  - putRequires
```
public FilterStateRule.Builder putRequires(String key,
                                           JwtRequirement value)
```
```
 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.config.filter.http.jwt_authn.v2alpha.JwtRequirement> requires = 3;
  - putAllRequires
```
public FilterStateRule.Builder putAllRequires(Map<String,JwtRequirement> values)
```
```
 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.config.filter.http.jwt_authn.v2alpha.JwtRequirement> requires = 3;
  - setUnknownFields
```
public final FilterStateRule.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<FilterStateRule.Builder>
  - mergeUnknownFields
```
public final FilterStateRule.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<FilterStateRule.Builder>

Class FilterStateRule.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getDescriptor

internalGetMapField

internalGetMutableMapField

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getName

getNameBytes

setName

clearName

setNameBytes

getRequiresCount

containsRequires

getRequires

getRequiresMap

getRequiresOrDefault

getRequiresOrThrow

clearRequires

removeRequires

getMutableRequires

putRequires

putAllRequires

setUnknownFields

mergeUnknownFields