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

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

Enclosing class:: VirtualCluster

public static final class VirtualCluster.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<VirtualCluster.Builder>
implements VirtualClusterOrBuilder

 A virtual cluster is a way of specifying a regex matching rule against
 certain important endpoints such that statistics are generated explicitly for
 the matched requests. The reason this is useful is that when doing
 prefix/path matching Envoy does not always know what the application
 considers to be an endpoint. Thus, it’s impossible for Envoy to generically
 emit per endpoint statistics. However, often systems have highly critical
 endpoints that they wish to get “perfect” statistics on. Virtual cluster
 statistics are perfect in the sense that they are emitted on the downstream
 side such that they include network level failures.
 Documentation for :ref:`virtual cluster statistics <config_http_filters_router_vcluster_stats>`.
 .. note::
    Virtual clusters are a useful tool, but we do not recommend setting up a virtual cluster for
    every application endpoint. This is both not easily maintainable and as well the matching and
    statistics output are not free.

Protobuf type envoy.api.v2.route.VirtualCluster

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`VirtualCluster.Builder`	`addAllHeaders(Iterable<? extends HeaderMatcher> values)` Specifies a list of header matchers to use for matching requests.
`VirtualCluster.Builder`	`addHeaders(HeaderMatcher.Builder builderForValue)` Specifies a list of header matchers to use for matching requests.
`VirtualCluster.Builder`	`addHeaders(HeaderMatcher value)` Specifies a list of header matchers to use for matching requests.
`VirtualCluster.Builder`	`addHeaders(int index, HeaderMatcher.Builder builderForValue)` Specifies a list of header matchers to use for matching requests.
`VirtualCluster.Builder`	`addHeaders(int index, HeaderMatcher value)` Specifies a list of header matchers to use for matching requests.
`HeaderMatcher.Builder`	`addHeadersBuilder()` Specifies a list of header matchers to use for matching requests.
`HeaderMatcher.Builder`	`addHeadersBuilder(int index)` Specifies a list of header matchers to use for matching requests.
`VirtualCluster.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`VirtualCluster`	`build()`
`VirtualCluster`	`buildPartial()`
`VirtualCluster.Builder`	`clear()`
`VirtualCluster.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`VirtualCluster.Builder`	`clearHeaders()` Specifies a list of header matchers to use for matching requests.
`VirtualCluster.Builder`	`clearMethod()` Deprecated.
`VirtualCluster.Builder`	`clearName()` Specifies the name of the virtual cluster.
`VirtualCluster.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`VirtualCluster.Builder`	`clearPattern()` Deprecated.
`VirtualCluster.Builder`	`clone()`
`VirtualCluster`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`HeaderMatcher`	`getHeaders(int index)` Specifies a list of header matchers to use for matching requests.
`HeaderMatcher.Builder`	`getHeadersBuilder(int index)` Specifies a list of header matchers to use for matching requests.
`List<HeaderMatcher.Builder>`	`getHeadersBuilderList()` Specifies a list of header matchers to use for matching requests.
`int`	`getHeadersCount()` Specifies a list of header matchers to use for matching requests.
`List<HeaderMatcher>`	`getHeadersList()` Specifies a list of header matchers to use for matching requests.
`HeaderMatcherOrBuilder`	`getHeadersOrBuilder(int index)` Specifies a list of header matchers to use for matching requests.
`List<? extends HeaderMatcherOrBuilder>`	`getHeadersOrBuilderList()` Specifies a list of header matchers to use for matching requests.
`RequestMethod`	`getMethod()` Deprecated.
`int`	`getMethodValue()` Deprecated.
`String`	`getName()` Specifies the name of the virtual cluster.
`com.google.protobuf.ByteString`	`getNameBytes()` Specifies the name of the virtual cluster.
`String`	`getPattern()` Deprecated.
`com.google.protobuf.ByteString`	`getPatternBytes()` Deprecated.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`VirtualCluster.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`VirtualCluster.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`VirtualCluster.Builder`	`mergeFrom(VirtualCluster other)`
`VirtualCluster.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`VirtualCluster.Builder`	`removeHeaders(int index)` Specifies a list of header matchers to use for matching requests.
`VirtualCluster.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`VirtualCluster.Builder`	`setHeaders(int index, HeaderMatcher.Builder builderForValue)` Specifies a list of header matchers to use for matching requests.
`VirtualCluster.Builder`	`setHeaders(int index, HeaderMatcher value)` Specifies a list of header matchers to use for matching requests.
`VirtualCluster.Builder`	`setMethod(RequestMethod value)` Deprecated.
`VirtualCluster.Builder`	`setMethodValue(int value)` Deprecated.
`VirtualCluster.Builder`	`setName(String value)` Specifies the name of the virtual cluster.
`VirtualCluster.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` Specifies the name of the virtual cluster.
`VirtualCluster.Builder`	`setPattern(String value)` Deprecated.
`VirtualCluster.Builder`	`setPatternBytes(com.google.protobuf.ByteString value)` Deprecated.
`VirtualCluster.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`VirtualCluster.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<VirtualCluster.Builder>

clear
```
public VirtualCluster.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<VirtualCluster.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<VirtualCluster.Builder>

getDefaultInstanceForType
```
public VirtualCluster getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public VirtualCluster build()
```
Specified by:

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

Specified by:

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

buildPartial
```
public VirtualCluster buildPartial()
```
Specified by:

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

Specified by:

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

clone
```
public VirtualCluster.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<VirtualCluster.Builder>

setField

public VirtualCluster.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<VirtualCluster.Builder>

clearField
```
public VirtualCluster.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<VirtualCluster.Builder>

clearOneof
```
public VirtualCluster.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<VirtualCluster.Builder>

setRepeatedField

public VirtualCluster.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<VirtualCluster.Builder>

addRepeatedField

public VirtualCluster.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<VirtualCluster.Builder>

mergeFrom
```
public VirtualCluster.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<VirtualCluster.Builder>

mergeFrom

public VirtualCluster.Builder mergeFrom(VirtualCluster other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<VirtualCluster.Builder>

mergeFrom
```
public VirtualCluster.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<VirtualCluster.Builder>

Throws:

IOException

getPattern

@Deprecated
public String getPattern()

Deprecated.

 Specifies a regex pattern to use for matching requests. The entire path of the request
 must match the regex. The regex grammar used is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``/rides/\d+`` matches the path */rides/0*
 * The regex ``/rides/\d+`` matches the path */rides/123*
 * The regex ``/rides/\d+`` does not match the path */rides/123/456*
 .. attention::
   This field has been deprecated in favor of `headers` as it is not safe for use with
   untrusted input in all cases.

string pattern = 1 [deprecated = true, (.validate.rules) = { ... }

Specified by:: getPattern in interface VirtualClusterOrBuilder

getPatternBytes

@Deprecated
public com.google.protobuf.ByteString getPatternBytes()

Deprecated.

 Specifies a regex pattern to use for matching requests. The entire path of the request
 must match the regex. The regex grammar used is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``/rides/\d+`` matches the path */rides/0*
 * The regex ``/rides/\d+`` matches the path */rides/123*
 * The regex ``/rides/\d+`` does not match the path */rides/123/456*
 .. attention::
   This field has been deprecated in favor of `headers` as it is not safe for use with
   untrusted input in all cases.

string pattern = 1 [deprecated = true, (.validate.rules) = { ... }

Specified by:: getPatternBytes in interface VirtualClusterOrBuilder

setPattern

@Deprecated
public VirtualCluster.Builder setPattern(String value)

Deprecated.

 Specifies a regex pattern to use for matching requests. The entire path of the request
 must match the regex. The regex grammar used is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``/rides/\d+`` matches the path */rides/0*
 * The regex ``/rides/\d+`` matches the path */rides/123*
 * The regex ``/rides/\d+`` does not match the path */rides/123/456*
 .. attention::
   This field has been deprecated in favor of `headers` as it is not safe for use with
   untrusted input in all cases.

string pattern = 1 [deprecated = true, (.validate.rules) = { ... }

clearPattern

@Deprecated
public VirtualCluster.Builder clearPattern()

Deprecated.

 Specifies a regex pattern to use for matching requests. The entire path of the request
 must match the regex. The regex grammar used is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``/rides/\d+`` matches the path */rides/0*
 * The regex ``/rides/\d+`` matches the path */rides/123*
 * The regex ``/rides/\d+`` does not match the path */rides/123/456*
 .. attention::
   This field has been deprecated in favor of `headers` as it is not safe for use with
   untrusted input in all cases.

string pattern = 1 [deprecated = true, (.validate.rules) = { ... }

setPatternBytes

@Deprecated
public VirtualCluster.Builder setPatternBytes(com.google.protobuf.ByteString value)

Deprecated.

 Specifies a regex pattern to use for matching requests. The entire path of the request
 must match the regex. The regex grammar used is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``/rides/\d+`` matches the path */rides/0*
 * The regex ``/rides/\d+`` matches the path */rides/123*
 * The regex ``/rides/\d+`` does not match the path */rides/123/456*
 .. attention::
   This field has been deprecated in favor of `headers` as it is not safe for use with
   untrusted input in all cases.

string pattern = 1 [deprecated = true, (.validate.rules) = { ... }