io.envoyproxy.envoy.config.trace.v2

Class ZipkinConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.trace.v2.ZipkinConfig

All Implemented Interfaces:

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

public final class ZipkinConfig
extends com.google.protobuf.GeneratedMessageV3
implements ZipkinConfigOrBuilder

 Configuration for the Zipkin tracer.
 [#extension: envoy.tracers.zipkin]
 [#next-free-field: 6]
 

Protobuf type envoy.config.trace.v2.ZipkinConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZipkinConfig.Builder Configuration for the Zipkin tracer.
static class	ZipkinConfig.CollectorEndpointVersion Available Zipkin collector endpoint versions.

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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLLECTOR_CLUSTER_FIELD_NUMBER
static int	COLLECTOR_ENDPOINT_FIELD_NUMBER
static int	COLLECTOR_ENDPOINT_VERSION_FIELD_NUMBER
static int	SHARED_SPAN_CONTEXT_FIELD_NUMBER
static int	TRACE_ID_128BIT_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)
String	getCollectorCluster() The cluster manager cluster that hosts the Zipkin collectors.
com.google.protobuf.ByteString	getCollectorClusterBytes() The cluster manager cluster that hosts the Zipkin collectors.
String	getCollectorEndpoint() The API endpoint of the Zipkin service where the spans will be sent.
com.google.protobuf.ByteString	getCollectorEndpointBytes() The API endpoint of the Zipkin service where the spans will be sent.
ZipkinConfig.CollectorEndpointVersion	getCollectorEndpointVersion() Determines the selected collector endpoint version.
int	getCollectorEndpointVersionValue() Determines the selected collector endpoint version.
static ZipkinConfig	getDefaultInstance()
ZipkinConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<ZipkinConfig>	getParserForType()
int	getSerializedSize()
com.google.protobuf.BoolValue	getSharedSpanContext() Determines whether client and server spans will share the same span context.
com.google.protobuf.BoolValueOrBuilder	getSharedSpanContextOrBuilder() Determines whether client and server spans will share the same span context.
boolean	getTraceId128Bit() Determines whether a 128bit trace id will be used when creating a new trace instance.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasSharedSpanContext() Determines whether client and server spans will share the same span context.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ZipkinConfig.Builder	newBuilder()
static ZipkinConfig.Builder	newBuilder(ZipkinConfig prototype)
ZipkinConfig.Builder	newBuilderForType()
protected ZipkinConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ZipkinConfig	parseDelimitedFrom(InputStream input)
static ZipkinConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ZipkinConfig	parseFrom(byte[] data)
static ZipkinConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ZipkinConfig	parseFrom(ByteBuffer data)
static ZipkinConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ZipkinConfig	parseFrom(com.google.protobuf.ByteString data)
static ZipkinConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ZipkinConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static ZipkinConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ZipkinConfig	parseFrom(InputStream input)
static ZipkinConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ZipkinConfig>	parser()
ZipkinConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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

COLLECTOR_CLUSTER_FIELD_NUMBER

public static final int COLLECTOR_CLUSTER_FIELD_NUMBER

See Also:

Constant Field Values

COLLECTOR_ENDPOINT_FIELD_NUMBER

public static final int COLLECTOR_ENDPOINT_FIELD_NUMBER

See Also:

Constant Field Values

TRACE_ID_128BIT_FIELD_NUMBER

public static final int TRACE_ID_128BIT_FIELD_NUMBER

See Also:

Constant Field Values

SHARED_SPAN_CONTEXT_FIELD_NUMBER

public static final int SHARED_SPAN_CONTEXT_FIELD_NUMBER

See Also:

Constant Field Values

COLLECTOR_ENDPOINT_VERSION_FIELD_NUMBER

public static final int COLLECTOR_ENDPOINT_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

getCollectorCluster

public String getCollectorCluster()

 The cluster manager cluster that hosts the Zipkin collectors. Note that the
 Zipkin cluster must be defined in the :ref:`Bootstrap static cluster
 resources <envoy_api_field_config.bootstrap.v2.Bootstrap.StaticResources.clusters>`.
 

string collector_cluster = 1 [(.validate.rules) = { ... }

Specified by:

getCollectorCluster in interface ZipkinConfigOrBuilder

getCollectorClusterBytes

public com.google.protobuf.ByteString getCollectorClusterBytes()

 The cluster manager cluster that hosts the Zipkin collectors. Note that the
 Zipkin cluster must be defined in the :ref:`Bootstrap static cluster
 resources <envoy_api_field_config.bootstrap.v2.Bootstrap.StaticResources.clusters>`.
 

string collector_cluster = 1 [(.validate.rules) = { ... }

Specified by:

getCollectorClusterBytes in interface ZipkinConfigOrBuilder

getCollectorEndpoint

public String getCollectorEndpoint()

 The API endpoint of the Zipkin service where the spans will be sent. When
 using a standard Zipkin installation, the API endpoint is typically
 /api/v1/spans, which is the default value.
 

string collector_endpoint = 2 [(.validate.rules) = { ... }

Specified by:

getCollectorEndpoint in interface ZipkinConfigOrBuilder

getCollectorEndpointBytes

public com.google.protobuf.ByteString getCollectorEndpointBytes()

 The API endpoint of the Zipkin service where the spans will be sent. When
 using a standard Zipkin installation, the API endpoint is typically
 /api/v1/spans, which is the default value.
 

string collector_endpoint = 2 [(.validate.rules) = { ... }

Specified by:

getCollectorEndpointBytes in interface ZipkinConfigOrBuilder

getTraceId128Bit

public boolean getTraceId128Bit()

 Determines whether a 128bit trace id will be used when creating a new
 trace instance. The default value is false, which will result in a 64 bit trace id being used.
 

bool trace_id_128bit = 3;

Specified by:

getTraceId128Bit in interface ZipkinConfigOrBuilder

hasSharedSpanContext

public boolean hasSharedSpanContext()

 Determines whether client and server spans will share the same span context.
 The default value is true.
 

.google.protobuf.BoolValue shared_span_context = 4;

Specified by:

hasSharedSpanContext in interface ZipkinConfigOrBuilder

getSharedSpanContext

public com.google.protobuf.BoolValue getSharedSpanContext()

 Determines whether client and server spans will share the same span context.
 The default value is true.
 

.google.protobuf.BoolValue shared_span_context = 4;

Specified by:

getSharedSpanContext in interface ZipkinConfigOrBuilder

getSharedSpanContextOrBuilder

public com.google.protobuf.BoolValueOrBuilder getSharedSpanContextOrBuilder()

 Determines whether client and server spans will share the same span context.
 The default value is true.
 

.google.protobuf.BoolValue shared_span_context = 4;

Specified by:

getSharedSpanContextOrBuilder in interface ZipkinConfigOrBuilder

getCollectorEndpointVersionValue

public int getCollectorEndpointVersionValue()

 Determines the selected collector endpoint version. By default, the ``HTTP_JSON_V1`` will be
 used.
 

.envoy.config.trace.v2.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;

Specified by:

getCollectorEndpointVersionValue in interface ZipkinConfigOrBuilder

getCollectorEndpointVersion

public ZipkinConfig.CollectorEndpointVersion getCollectorEndpointVersion()

 Determines the selected collector endpoint version. By default, the ``HTTP_JSON_V1`` will be
 used.
 

.envoy.config.trace.v2.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;

Specified by:

getCollectorEndpointVersion in interface ZipkinConfigOrBuilder

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 ZipkinConfig parseFrom(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ZipkinConfig parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ZipkinConfig parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ZipkinConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ZipkinConfig.Builder newBuilder()

newBuilder

public static ZipkinConfig.Builder newBuilder(ZipkinConfig prototype)

toBuilder

public ZipkinConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ZipkinConfig getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ZipkinConfig> 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 ZipkinConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder