ConfigSource.Builder (api 0.1.16 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<ConfigSource.Builder>
    - - io.envoyproxy.envoy.api.v2.core.ConfigSource.Builder

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

Enclosing class:: ConfigSource

public static final class ConfigSource.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ConfigSource.Builder>
implements ConfigSourceOrBuilder

 Configuration for :ref:`listeners <config_listeners>`, :ref:`clusters
 <config_cluster_manager>`, :ref:`routes
 <envoy_api_msg_RouteConfiguration>`, :ref:`endpoints
 <arch_overview_service_discovery>` etc. may either be sourced from the
 filesystem or from an xDS API source. Filesystem configs are watched with
 inotify for updates.

Protobuf type envoy.api.v2.core.ConfigSource

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConfigSource.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ConfigSource`	`build()`
`ConfigSource`	`buildPartial()`
`ConfigSource.Builder`	`clear()`
`ConfigSource.Builder`	`clearAds()` When set, ADS will be used to fetch resources.
`ConfigSource.Builder`	`clearApiConfigSource()` API configuration source.
`ConfigSource.Builder`	`clearConfigSourceSpecifier()`
`ConfigSource.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ConfigSource.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ConfigSource.Builder`	`clearPath()` Path on the filesystem to source and watch for configuration updates. .. note:: The path to the source must exist at config load time. .. note:: Envoy will only watch the file path for moves. This is because in general only moves are atomic.
`ConfigSource.Builder`	`clone()`
`AggregatedConfigSource`	`getAds()` When set, ADS will be used to fetch resources.
`AggregatedConfigSource.Builder`	`getAdsBuilder()` When set, ADS will be used to fetch resources.
`AggregatedConfigSourceOrBuilder`	`getAdsOrBuilder()` When set, ADS will be used to fetch resources.
`ApiConfigSource`	`getApiConfigSource()` API configuration source.
`ApiConfigSource.Builder`	`getApiConfigSourceBuilder()` API configuration source.
`ApiConfigSourceOrBuilder`	`getApiConfigSourceOrBuilder()` API configuration source.
`ConfigSource.ConfigSourceSpecifierCase`	`getConfigSourceSpecifierCase()`
`ConfigSource`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getPath()` Path on the filesystem to source and watch for configuration updates. .. note:: The path to the source must exist at config load time. .. note:: Envoy will only watch the file path for moves. This is because in general only moves are atomic.
`com.google.protobuf.ByteString`	`getPathBytes()` Path on the filesystem to source and watch for configuration updates. .. note:: The path to the source must exist at config load time. .. note:: Envoy will only watch the file path for moves. This is because in general only moves are atomic.
`boolean`	`hasAds()` When set, ADS will be used to fetch resources.
`boolean`	`hasApiConfigSource()` API configuration source.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ConfigSource.Builder`	`mergeAds(AggregatedConfigSource value)` When set, ADS will be used to fetch resources.
`ConfigSource.Builder`	`mergeApiConfigSource(ApiConfigSource value)` API configuration source.
`ConfigSource.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ConfigSource.Builder`	`mergeFrom(ConfigSource other)`
`ConfigSource.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ConfigSource.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ConfigSource.Builder`	`setAds(AggregatedConfigSource.Builder builderForValue)` When set, ADS will be used to fetch resources.
`ConfigSource.Builder`	`setAds(AggregatedConfigSource value)` When set, ADS will be used to fetch resources.
`ConfigSource.Builder`	`setApiConfigSource(ApiConfigSource.Builder builderForValue)` API configuration source.
`ConfigSource.Builder`	`setApiConfigSource(ApiConfigSource value)` API configuration source.
`ConfigSource.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ConfigSource.Builder`	`setPath(String value)` Path on the filesystem to source and watch for configuration updates. .. note:: The path to the source must exist at config load time. .. note:: Envoy will only watch the file path for moves. This is because in general only moves are atomic.
`ConfigSource.Builder`	`setPathBytes(com.google.protobuf.ByteString value)` Path on the filesystem to source and watch for configuration updates. .. note:: The path to the source must exist at config load time. .. note:: Envoy will only watch the file path for moves. This is because in general only moves are atomic.
`ConfigSource.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ConfigSource.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<ConfigSource.Builder>

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

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

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

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

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

Specified by:

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

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

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

Specified by:

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

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

setField

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

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

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

setRepeatedField

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

addRepeatedField

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

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

mergeFrom

public ConfigSource.Builder mergeFrom(ConfigSource other)

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

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

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

Throws:

IOException

getConfigSourceSpecifierCase
```
public ConfigSource.ConfigSourceSpecifierCase getConfigSourceSpecifierCase()
```
Specified by:

getConfigSourceSpecifierCase in interface ConfigSourceOrBuilder

clearConfigSourceSpecifier

public ConfigSource.Builder clearConfigSourceSpecifier()

getPath

public String getPath()

 Path on the filesystem to source and watch for configuration updates.
 .. note::
  The path to the source must exist at config load time.
 .. note::
   Envoy will only watch the file path for *moves.* This is because in general only moves
   are atomic. The same method of swapping files as is demonstrated in the
   :ref:`runtime documentation <config_runtime_symbolic_link_swap>` can be used here also.

string path = 1;

Specified by:: getPath in interface ConfigSourceOrBuilder

getPathBytes

public com.google.protobuf.ByteString getPathBytes()

 Path on the filesystem to source and watch for configuration updates.
 .. note::
  The path to the source must exist at config load time.
 .. note::
   Envoy will only watch the file path for *moves.* This is because in general only moves
   are atomic. The same method of swapping files as is demonstrated in the
   :ref:`runtime documentation <config_runtime_symbolic_link_swap>` can be used here also.

string path = 1;

Specified by:: getPathBytes in interface ConfigSourceOrBuilder

setPath

public ConfigSource.Builder setPath(String value)

 Path on the filesystem to source and watch for configuration updates.
 .. note::
  The path to the source must exist at config load time.
 .. note::
   Envoy will only watch the file path for *moves.* This is because in general only moves
   are atomic. The same method of swapping files as is demonstrated in the
   :ref:`runtime documentation <config_runtime_symbolic_link_swap>` can be used here also.

string path = 1;

clearPath

public ConfigSource.Builder clearPath()

 Path on the filesystem to source and watch for configuration updates.
 .. note::
  The path to the source must exist at config load time.
 .. note::
   Envoy will only watch the file path for *moves.* This is because in general only moves
   are atomic. The same method of swapping files as is demonstrated in the
   :ref:`runtime documentation <config_runtime_symbolic_link_swap>` can be used here also.

string path = 1;

setPathBytes

public ConfigSource.Builder setPathBytes(com.google.protobuf.ByteString value)

 Path on the filesystem to source and watch for configuration updates.
 .. note::
  The path to the source must exist at config load time.
 .. note::
   Envoy will only watch the file path for *moves.* This is because in general only moves
   are atomic. The same method of swapping files as is demonstrated in the
   :ref:`runtime documentation <config_runtime_symbolic_link_swap>` can be used here also.

string path = 1;

hasApiConfigSource
```
public boolean hasApiConfigSource()
```
```
 API configuration source.
 
```
.envoy.api.v2.core.ApiConfigSource api_config_source = 2;
Specified by:

hasApiConfigSource in interface ConfigSourceOrBuilder

getApiConfigSource
```
public ApiConfigSource getApiConfigSource()
```
```
 API configuration source.
 
```
.envoy.api.v2.core.ApiConfigSource api_config_source = 2;
Specified by:

getApiConfigSource in interface ConfigSourceOrBuilder

setApiConfigSource

public ConfigSource.Builder setApiConfigSource(ApiConfigSource value)

 API configuration source.

.envoy.api.v2.core.ApiConfigSource api_config_source = 2;

setApiConfigSource

public ConfigSource.Builder setApiConfigSource(ApiConfigSource.Builder builderForValue)

 API configuration source.

.envoy.api.v2.core.ApiConfigSource api_config_source = 2;

mergeApiConfigSource

public ConfigSource.Builder mergeApiConfigSource(ApiConfigSource value)

 API configuration source.

.envoy.api.v2.core.ApiConfigSource api_config_source = 2;

clearApiConfigSource

public ConfigSource.Builder clearApiConfigSource()

 API configuration source.

.envoy.api.v2.core.ApiConfigSource api_config_source = 2;

getApiConfigSourceBuilder

public ApiConfigSource.Builder getApiConfigSourceBuilder()

 API configuration source.

.envoy.api.v2.core.ApiConfigSource api_config_source = 2;

getApiConfigSourceOrBuilder
```
public ApiConfigSourceOrBuilder getApiConfigSourceOrBuilder()
```
```
 API configuration source.
 
```
.envoy.api.v2.core.ApiConfigSource api_config_source = 2;
Specified by:

getApiConfigSourceOrBuilder in interface ConfigSourceOrBuilder