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

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

Enclosing class:: ScopedRouteConfiguration

public static final class ScopedRouteConfiguration.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ScopedRouteConfiguration.Builder>
implements ScopedRouteConfigurationOrBuilder

 Specifies a routing scope, which associates a
 :ref:`Key<envoy_api_msg_ScopedRouteConfiguration.Key>` to a
 :ref:`envoy_api_msg_RouteConfiguration` (identified by its resource name).
 The HTTP connection manager builds up a table consisting of these Key to
 RouteConfiguration mappings, and looks up the RouteConfiguration to use per
 request according to the algorithm specified in the
 :ref:`scope_key_builder<envoy_api_field_config.filter.network.http_connection_manager.v2.ScopedRoutes.scope_key_builder>`
 assigned to the HttpConnectionManager.
 For example, with the following configurations (in YAML):
 HttpConnectionManager config:
 .. code::
   ...
   scoped_routes:
     name: foo-scoped-routes
     scope_key_builder:
       fragments:
         - header_value_extractor:
             name: X-Route-Selector
             element_separator: ,
             element:
               separator: =
               key: vip
 ScopedRouteConfiguration resources (specified statically via
 :ref:`scoped_route_configurations_list<envoy_api_field_config.filter.network.http_connection_manager.v2.ScopedRoutes.scoped_route_configurations_list>`
 or obtained dynamically via SRDS):
 .. code::
  (1)
   name: route-scope1
   route_configuration_name: route-config1
   key:
      fragments:
        - string_key: 172.10.10.20
  (2)
   name: route-scope2
   route_configuration_name: route-config2
   key:
     fragments:
       - string_key: 172.20.20.30
 A request from a client such as:
 .. code::
     GET / HTTP/1.1
     Host: foo.com
     X-Route-Selector: vip=172.10.10.20
 would result in the routing table defined by the `route-config1`
 RouteConfiguration being assigned to the HTTP request/stream.

Protobuf type envoy.api.v2.ScopedRouteConfiguration

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScopedRouteConfiguration.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ScopedRouteConfiguration`	`build()`
`ScopedRouteConfiguration`	`buildPartial()`
`ScopedRouteConfiguration.Builder`	`clear()`
`ScopedRouteConfiguration.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ScopedRouteConfiguration.Builder`	`clearKey()` The key to match against.
`ScopedRouteConfiguration.Builder`	`clearName()` The name assigned to the routing scope.
`ScopedRouteConfiguration.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ScopedRouteConfiguration.Builder`	`clearRouteConfigurationName()` The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated with this scope.
`ScopedRouteConfiguration.Builder`	`clone()`
`ScopedRouteConfiguration`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`ScopedRouteConfiguration.Key`	`getKey()` The key to match against.
`ScopedRouteConfiguration.Key.Builder`	`getKeyBuilder()` The key to match against.
`ScopedRouteConfiguration.KeyOrBuilder`	`getKeyOrBuilder()` The key to match against.
`String`	`getName()` The name assigned to the routing scope.
`com.google.protobuf.ByteString`	`getNameBytes()` The name assigned to the routing scope.
`String`	`getRouteConfigurationName()` The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated with this scope.
`com.google.protobuf.ByteString`	`getRouteConfigurationNameBytes()` The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated with this scope.
`boolean`	`hasKey()` The key to match against.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ScopedRouteConfiguration.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ScopedRouteConfiguration.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ScopedRouteConfiguration.Builder`	`mergeFrom(ScopedRouteConfiguration other)`
`ScopedRouteConfiguration.Builder`	`mergeKey(ScopedRouteConfiguration.Key value)` The key to match against.
`ScopedRouteConfiguration.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ScopedRouteConfiguration.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ScopedRouteConfiguration.Builder`	`setKey(ScopedRouteConfiguration.Key.Builder builderForValue)` The key to match against.
`ScopedRouteConfiguration.Builder`	`setKey(ScopedRouteConfiguration.Key value)` The key to match against.
`ScopedRouteConfiguration.Builder`	`setName(String value)` The name assigned to the routing scope.
`ScopedRouteConfiguration.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` The name assigned to the routing scope.
`ScopedRouteConfiguration.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ScopedRouteConfiguration.Builder`	`setRouteConfigurationName(String value)` The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated with this scope.
`ScopedRouteConfiguration.Builder`	`setRouteConfigurationNameBytes(com.google.protobuf.ByteString value)` The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated with this scope.
`ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>
  - clear
```
public ScopedRouteConfiguration.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<ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>
  - getDefaultInstanceForType
```
public ScopedRouteConfiguration getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public ScopedRouteConfiguration build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public ScopedRouteConfiguration buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>
  - setField
```
public ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>
  - clearField
```
public ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>
  - clearOneof
```
public ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>
  - setRepeatedField
```
public ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>
  - addRepeatedField
```
public ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>
  - mergeFrom
```
public ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>
  - mergeFrom
```
public ScopedRouteConfiguration.Builder mergeFrom(ScopedRouteConfiguration other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ScopedRouteConfiguration.Builder>
  - mergeFrom
```
public ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>
    
    Throws:
    
    IOException
  - getName
```
public String getName()
```
```
 The name assigned to the routing scope.
 
```
    string name = 1 [(.validate.rules) = { ... }
    Specified by:
    
    getName in interface ScopedRouteConfigurationOrBuilder
  - getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 The name assigned to the routing scope.
 
```
    string name = 1 [(.validate.rules) = { ... }
    Specified by:
    
    getNameBytes in interface ScopedRouteConfigurationOrBuilder
  - setName
```
public ScopedRouteConfiguration.Builder setName(String value)
```
```
 The name assigned to the routing scope.
 
```
    string name = 1 [(.validate.rules) = { ... }
  - clearName
```
public ScopedRouteConfiguration.Builder clearName()
```
```
 The name assigned to the routing scope.
 
```
    string name = 1 [(.validate.rules) = { ... }
  - setNameBytes
```
public ScopedRouteConfiguration.Builder setNameBytes(com.google.protobuf.ByteString value)
```
```
 The name assigned to the routing scope.
 
```
    string name = 1 [(.validate.rules) = { ... }
  - getRouteConfigurationName
```
public String getRouteConfigurationName()
```
```
 The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an
 RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated
 with this scope.
 
```
    string route_configuration_name = 2 [(.validate.rules) = { ... }
    Specified by:
    
    getRouteConfigurationName in interface ScopedRouteConfigurationOrBuilder
  - getRouteConfigurationNameBytes
```
public com.google.protobuf.ByteString getRouteConfigurationNameBytes()
```
```
 The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an
 RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated
 with this scope.
 
```
    string route_configuration_name = 2 [(.validate.rules) = { ... }
    Specified by:
    
    getRouteConfigurationNameBytes in interface ScopedRouteConfigurationOrBuilder
  - setRouteConfigurationName
```
public ScopedRouteConfiguration.Builder setRouteConfigurationName(String value)
```
```
 The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an
 RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated
 with this scope.
 
```
    string route_configuration_name = 2 [(.validate.rules) = { ... }
  - clearRouteConfigurationName
```
public ScopedRouteConfiguration.Builder clearRouteConfigurationName()
```
```
 The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an
 RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated
 with this scope.
 
```
    string route_configuration_name = 2 [(.validate.rules) = { ... }
  - setRouteConfigurationNameBytes
```
public ScopedRouteConfiguration.Builder setRouteConfigurationNameBytes(com.google.protobuf.ByteString value)
```
```
 The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an
 RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated
 with this scope.
 
```
    string route_configuration_name = 2 [(.validate.rules) = { ... }
  - hasKey
```
public boolean hasKey()
```
```
 The key to match against.
 
```
    .envoy.api.v2.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
    Specified by:
    
    hasKey in interface ScopedRouteConfigurationOrBuilder
  - getKey
```
public ScopedRouteConfiguration.Key getKey()
```
```
 The key to match against.
 
```
    .envoy.api.v2.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
    Specified by:
    
    getKey in interface ScopedRouteConfigurationOrBuilder
  - setKey
```
public ScopedRouteConfiguration.Builder setKey(ScopedRouteConfiguration.Key value)
```
```
 The key to match against.
 
```
    .envoy.api.v2.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
  - setKey
```
public ScopedRouteConfiguration.Builder setKey(ScopedRouteConfiguration.Key.Builder builderForValue)
```
```
 The key to match against.
 
```
    .envoy.api.v2.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
  - mergeKey
```
public ScopedRouteConfiguration.Builder mergeKey(ScopedRouteConfiguration.Key value)
```
```
 The key to match against.
 
```
    .envoy.api.v2.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
  - clearKey
```
public ScopedRouteConfiguration.Builder clearKey()
```
```
 The key to match against.
 
```
    .envoy.api.v2.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
  - getKeyBuilder
```
public ScopedRouteConfiguration.Key.Builder getKeyBuilder()
```
```
 The key to match against.
 
```
    .envoy.api.v2.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
  - getKeyOrBuilder
```
public ScopedRouteConfiguration.KeyOrBuilder getKeyOrBuilder()
```
```
 The key to match against.
 
```
    .envoy.api.v2.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
    Specified by:
    
    getKeyOrBuilder in interface ScopedRouteConfigurationOrBuilder
  - setUnknownFields
```
public final ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>
  - mergeUnknownFields
```
public final ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>

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

getName

getNameBytes

setName

clearName

setNameBytes

getRouteConfigurationName

getRouteConfigurationNameBytes

setRouteConfigurationName

clearRouteConfigurationName

setRouteConfigurationNameBytes

hasKey

getKey

setKey

setKey

mergeKey

clearKey

getKeyBuilder

getKeyOrBuilder

setUnknownFields

mergeUnknownFields