io.envoyproxy.envoy.api.v2.core

Class ConfigSource

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.api.v2.core.ConfigSource

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ConfigSourceOrBuilder, Serializable

public final class ConfigSource
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigSource.Builder 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.
static class	ConfigSource.ConfigSourceSpecifierCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADS_FIELD_NUMBER
static int	API_CONFIG_SOURCE_FIELD_NUMBER
static int	PATH_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AggregatedConfigSource	getAds() 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.
ApiConfigSourceOrBuilder	getApiConfigSourceOrBuilder() API configuration source.
ConfigSource.ConfigSourceSpecifierCase	getConfigSourceSpecifierCase()
static ConfigSource	getDefaultInstance()
ConfigSource	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<ConfigSource>	getParserForType()
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.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasAds() When set, ADS will be used to fetch resources.
boolean	hasApiConfigSource() API configuration source.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ConfigSource.Builder	newBuilder()
static ConfigSource.Builder	newBuilder(ConfigSource prototype)
ConfigSource.Builder	newBuilderForType()
protected ConfigSource.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static ConfigSource	parseDelimitedFrom(InputStream input)
static ConfigSource	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConfigSource	parseFrom(byte[] data)
static ConfigSource	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConfigSource	parseFrom(ByteBuffer data)
static ConfigSource	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConfigSource	parseFrom(com.google.protobuf.ByteString data)
static ConfigSource	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConfigSource	parseFrom(com.google.protobuf.CodedInputStream input)
static ConfigSource	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConfigSource	parseFrom(InputStream input)
static ConfigSource	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ConfigSource>	parser()
ConfigSource.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER

See Also:

Constant Field Values

API_CONFIG_SOURCE_FIELD_NUMBER

public static final int API_CONFIG_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

ADS_FIELD_NUMBER

public static final int ADS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

getConfigSourceSpecifierCase

public ConfigSource.ConfigSourceSpecifierCase getConfigSourceSpecifierCase()

Specified by:

getConfigSourceSpecifierCase in interface ConfigSourceOrBuilder

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

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

getApiConfigSourceOrBuilder

public ApiConfigSourceOrBuilder getApiConfigSourceOrBuilder()

 API configuration source.
 

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

Specified by:

getApiConfigSourceOrBuilder in interface ConfigSourceOrBuilder

hasAds

public boolean hasAds()

 When set, ADS will be used to fetch resources. The ADS API configuration
 source in the bootstrap configuration is used.
 

.envoy.api.v2.core.AggregatedConfigSource ads = 3;

Specified by:

hasAds in interface ConfigSourceOrBuilder

getAds

public AggregatedConfigSource getAds()

 When set, ADS will be used to fetch resources. The ADS API configuration
 source in the bootstrap configuration is used.
 

.envoy.api.v2.core.AggregatedConfigSource ads = 3;

Specified by:

getAds in interface ConfigSourceOrBuilder

getAdsOrBuilder

public AggregatedConfigSourceOrBuilder getAdsOrBuilder()

 When set, ADS will be used to fetch resources. The ADS API configuration
 source in the bootstrap configuration is used.
 

.envoy.api.v2.core.AggregatedConfigSource ads = 3;

Specified by:

getAdsOrBuilder in interface ConfigSourceOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ConfigSource parseFrom(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ConfigSource parseFrom(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ConfigSource parseFrom(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ConfigSource parseFrom(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ConfigSource parseFrom(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ConfigSource parseFrom(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ConfigSource parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static ConfigSource parseFrom(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static ConfigSource parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static ConfigSource parseDelimitedFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseFrom

public static ConfigSource parseFrom(com.google.protobuf.CodedInputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static ConfigSource parseFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

newBuilderForType

public ConfigSource.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ConfigSource.Builder newBuilder()

newBuilder

public static ConfigSource.Builder newBuilder(ConfigSource prototype)

toBuilder

public ConfigSource.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ConfigSource.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ConfigSource getDefaultInstance()

parser

public static com.google.protobuf.Parser<ConfigSource> parser()

getParserForType

public com.google.protobuf.Parser<ConfigSource> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ConfigSource getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder