RateLimitDescriptor.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<RateLimitDescriptor.Builder>
    - - io.envoyproxy.envoy.api.v2.ratelimit.RateLimitDescriptor.Builder

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

Enclosing class:: RateLimitDescriptor

public static final class RateLimitDescriptor.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimitDescriptor.Builder>
implements RateLimitDescriptorOrBuilder

 A RateLimitDescriptor is a list of hierarchical entries that are used by the service to
 determine the final rate limit key and overall allowed limit. Here are some examples of how
 they might be used for the domain "envoy".
 .. code-block:: cpp
   ["authenticated": "false"], ["remote_address": "10.0.0.1"]
 What it does: Limits all unauthenticated traffic for the IP address 10.0.0.1. The
 configuration supplies a default limit for the *remote_address* key. If there is a desire to
 raise the limit for 10.0.0.1 or block it entirely it can be specified directly in the
 configuration.
 .. code-block:: cpp
   ["authenticated": "false"], ["path": "/foo/bar"]
 What it does: Limits all unauthenticated traffic globally for a specific path (or prefix if
 configured that way in the service).
 .. code-block:: cpp
   ["authenticated": "false"], ["path": "/foo/bar"], ["remote_address": "10.0.0.1"]
 What it does: Limits unauthenticated traffic to a specific path for a specific IP address.
 Like (1) we can raise/block specific IP addresses if we want with an override configuration.
 .. code-block:: cpp
   ["authenticated": "true"], ["client_id": "foo"]
 What it does: Limits all traffic for an authenticated client "foo"
 .. code-block:: cpp
   ["authenticated": "true"], ["client_id": "foo"], ["path": "/foo/bar"]
 What it does: Limits traffic to a specific path for an authenticated client "foo"
 The idea behind the API is that (1)/(2)/(3) and (4)/(5) can be sent in 1 request if desired.
 This enables building complex application scenarios with a generic backend.

Protobuf type envoy.api.v2.ratelimit.RateLimitDescriptor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RateLimitDescriptor.Builder`	`addAllEntries(Iterable<? extends RateLimitDescriptor.Entry> values)` Descriptor entries.
`RateLimitDescriptor.Builder`	`addEntries(int index, RateLimitDescriptor.Entry.Builder builderForValue)` Descriptor entries.
`RateLimitDescriptor.Builder`	`addEntries(int index, RateLimitDescriptor.Entry value)` Descriptor entries.
`RateLimitDescriptor.Builder`	`addEntries(RateLimitDescriptor.Entry.Builder builderForValue)` Descriptor entries.
`RateLimitDescriptor.Builder`	`addEntries(RateLimitDescriptor.Entry value)` Descriptor entries.
`RateLimitDescriptor.Entry.Builder`	`addEntriesBuilder()` Descriptor entries.
`RateLimitDescriptor.Entry.Builder`	`addEntriesBuilder(int index)` Descriptor entries.
`RateLimitDescriptor.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`RateLimitDescriptor`	`build()`
`RateLimitDescriptor`	`buildPartial()`
`RateLimitDescriptor.Builder`	`clear()`
`RateLimitDescriptor.Builder`	`clearEntries()` Descriptor entries.
`RateLimitDescriptor.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`RateLimitDescriptor.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`RateLimitDescriptor.Builder`	`clone()`
`RateLimitDescriptor`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`RateLimitDescriptor.Entry`	`getEntries(int index)` Descriptor entries.
`RateLimitDescriptor.Entry.Builder`	`getEntriesBuilder(int index)` Descriptor entries.
`List<RateLimitDescriptor.Entry.Builder>`	`getEntriesBuilderList()` Descriptor entries.
`int`	`getEntriesCount()` Descriptor entries.
`List<RateLimitDescriptor.Entry>`	`getEntriesList()` Descriptor entries.
`RateLimitDescriptor.EntryOrBuilder`	`getEntriesOrBuilder(int index)` Descriptor entries.
`List<? extends RateLimitDescriptor.EntryOrBuilder>`	`getEntriesOrBuilderList()` Descriptor entries.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`RateLimitDescriptor.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`RateLimitDescriptor.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`RateLimitDescriptor.Builder`	`mergeFrom(RateLimitDescriptor other)`
`RateLimitDescriptor.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`RateLimitDescriptor.Builder`	`removeEntries(int index)` Descriptor entries.
`RateLimitDescriptor.Builder`	`setEntries(int index, RateLimitDescriptor.Entry.Builder builderForValue)` Descriptor entries.
`RateLimitDescriptor.Builder`	`setEntries(int index, RateLimitDescriptor.Entry value)` Descriptor entries.
`RateLimitDescriptor.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`RateLimitDescriptor.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`RateLimitDescriptor.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<RateLimitDescriptor.Builder>
  - clear
```
public RateLimitDescriptor.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<RateLimitDescriptor.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<RateLimitDescriptor.Builder>
  - getDefaultInstanceForType
```
public RateLimitDescriptor getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public RateLimitDescriptor build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public RateLimitDescriptor buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public RateLimitDescriptor.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<RateLimitDescriptor.Builder>
  - setField
```
public RateLimitDescriptor.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<RateLimitDescriptor.Builder>
  - clearField
```
public RateLimitDescriptor.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<RateLimitDescriptor.Builder>
  - clearOneof
```
public RateLimitDescriptor.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<RateLimitDescriptor.Builder>
  - setRepeatedField
```
public RateLimitDescriptor.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<RateLimitDescriptor.Builder>
  - addRepeatedField
```
public RateLimitDescriptor.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<RateLimitDescriptor.Builder>
  - mergeFrom
```
public RateLimitDescriptor.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<RateLimitDescriptor.Builder>
  - mergeFrom
```
public RateLimitDescriptor.Builder mergeFrom(RateLimitDescriptor other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitDescriptor.Builder>
  - mergeFrom
```
public RateLimitDescriptor.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<RateLimitDescriptor.Builder>
    
    Throws:
    
    IOException
  - getEntriesList
```
public List<RateLimitDescriptor.Entry> getEntriesList()
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
    Specified by:
    
    getEntriesList in interface RateLimitDescriptorOrBuilder
  - getEntriesCount
```
public int getEntriesCount()
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
    Specified by:
    
    getEntriesCount in interface RateLimitDescriptorOrBuilder
  - getEntries
```
public RateLimitDescriptor.Entry getEntries(int index)
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
    Specified by:
    
    getEntries in interface RateLimitDescriptorOrBuilder
  - setEntries
```
public RateLimitDescriptor.Builder setEntries(int index,
                                              RateLimitDescriptor.Entry value)
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - setEntries
```
public RateLimitDescriptor.Builder setEntries(int index,
                                              RateLimitDescriptor.Entry.Builder builderForValue)
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - addEntries
```
public RateLimitDescriptor.Builder addEntries(RateLimitDescriptor.Entry value)
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - addEntries
```
public RateLimitDescriptor.Builder addEntries(int index,
                                              RateLimitDescriptor.Entry value)
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - addEntries
```
public RateLimitDescriptor.Builder addEntries(RateLimitDescriptor.Entry.Builder builderForValue)
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - addEntries
```
public RateLimitDescriptor.Builder addEntries(int index,
                                              RateLimitDescriptor.Entry.Builder builderForValue)
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - addAllEntries
```
public RateLimitDescriptor.Builder addAllEntries(Iterable<? extends RateLimitDescriptor.Entry> values)
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - clearEntries
```
public RateLimitDescriptor.Builder clearEntries()
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - removeEntries
```
public RateLimitDescriptor.Builder removeEntries(int index)
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - getEntriesBuilder
```
public RateLimitDescriptor.Entry.Builder getEntriesBuilder(int index)
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - getEntriesOrBuilder
```
public RateLimitDescriptor.EntryOrBuilder getEntriesOrBuilder(int index)
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
    Specified by:
    
    getEntriesOrBuilder in interface RateLimitDescriptorOrBuilder
  - getEntriesOrBuilderList
```
public List<? extends RateLimitDescriptor.EntryOrBuilder> getEntriesOrBuilderList()
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
    Specified by:
    
    getEntriesOrBuilderList in interface RateLimitDescriptorOrBuilder
  - addEntriesBuilder
```
public RateLimitDescriptor.Entry.Builder addEntriesBuilder()
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - addEntriesBuilder
```
public RateLimitDescriptor.Entry.Builder addEntriesBuilder(int index)
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - getEntriesBuilderList
```
public List<RateLimitDescriptor.Entry.Builder> getEntriesBuilderList()
```
```
 Descriptor entries.
 
```
    repeated .envoy.api.v2.ratelimit.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
  - setUnknownFields
```
public final RateLimitDescriptor.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<RateLimitDescriptor.Builder>
  - mergeUnknownFields
```
public final RateLimitDescriptor.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<RateLimitDescriptor.Builder>

Class RateLimitDescriptor.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

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getEntriesList

getEntriesCount

getEntries

setEntries

setEntries

addEntries

addEntries

addEntries

addEntries

addAllEntries

clearEntries

removeEntries

getEntriesBuilder

getEntriesOrBuilder

getEntriesOrBuilderList

addEntriesBuilder

addEntriesBuilder

getEntriesBuilderList

setUnknownFields

mergeUnknownFields