Class ZipkinConfig.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<ZipkinConfig.Builder>
com.google.protobuf.GeneratedMessage.Builder<ZipkinConfig.Builder>
io.envoyproxy.envoy.config.trace.v3.ZipkinConfig.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,ZipkinConfigOrBuilder
,Cloneable
- Enclosing class:
ZipkinConfig
public static final class ZipkinConfig.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ZipkinConfig.Builder>
implements ZipkinConfigOrBuilder
Configuration for the Zipkin tracer. [#extension: envoy.tracers.zipkin] [#next-free-field: 8]Protobuf type
envoy.config.trace.v3.ZipkinConfig
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private Object
private Object
private int
private Object
private com.google.protobuf.BoolValue
private com.google.protobuf.SingleFieldBuilder
<com.google.protobuf.BoolValue, com.google.protobuf.BoolValue.Builder, com.google.protobuf.BoolValueOrBuilder> private boolean
private boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
private void
buildPartial0
(ZipkinConfig result) clear()
The cluster manager cluster that hosts the Zipkin collectors.The API endpoint of the Zipkin service where the spans will be sent.Determines the selected collector endpoint version.Optional hostname to use when sending spans to the collector_cluster.Determines whether client and server spans will share the same span context.Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated.Determines whether a 128bit trace id will be used when creating a new trace instance.The cluster manager cluster that hosts the Zipkin collectors.com.google.protobuf.ByteString
The cluster manager cluster that hosts the Zipkin collectors.The API endpoint of the Zipkin service where the spans will be sent.com.google.protobuf.ByteString
The API endpoint of the Zipkin service where the spans will be sent.Determines the selected collector endpoint version.int
Determines the selected collector endpoint version.Optional hostname to use when sending spans to the collector_cluster.com.google.protobuf.ByteString
Optional hostname to use when sending spans to the collector_cluster.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.BoolValue
Determines whether client and server spans will share the same span context.com.google.protobuf.BoolValue.Builder
Determines whether client and server spans will share the same span context.private com.google.protobuf.SingleFieldBuilder
<com.google.protobuf.BoolValue, com.google.protobuf.BoolValue.Builder, com.google.protobuf.BoolValueOrBuilder> Determines whether client and server spans will share the same span context.com.google.protobuf.BoolValueOrBuilder
Determines whether client and server spans will share the same span context.boolean
Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated.boolean
Determines whether a 128bit trace id will be used when creating a new trace instance.boolean
Determines whether client and server spans will share the same span context.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
private void
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeFrom
(ZipkinConfig other) mergeSharedSpanContext
(com.google.protobuf.BoolValue value) Determines whether client and server spans will share the same span context.setCollectorCluster
(String value) The cluster manager cluster that hosts the Zipkin collectors.setCollectorClusterBytes
(com.google.protobuf.ByteString value) The cluster manager cluster that hosts the Zipkin collectors.setCollectorEndpoint
(String value) The API endpoint of the Zipkin service where the spans will be sent.setCollectorEndpointBytes
(com.google.protobuf.ByteString value) The API endpoint of the Zipkin service where the spans will be sent.Determines the selected collector endpoint version.setCollectorEndpointVersionValue
(int value) Determines the selected collector endpoint version.setCollectorHostname
(String value) Optional hostname to use when sending spans to the collector_cluster.setCollectorHostnameBytes
(com.google.protobuf.ByteString value) Optional hostname to use when sending spans to the collector_cluster.setSharedSpanContext
(com.google.protobuf.BoolValue value) Determines whether client and server spans will share the same span context.setSharedSpanContext
(com.google.protobuf.BoolValue.Builder builderForValue) Determines whether client and server spans will share the same span context.setSplitSpansForRequest
(boolean value) Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated.setTraceId128Bit
(boolean value) Determines whether a 128bit trace id will be used when creating a new trace instance.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
bitField0_
private int bitField0_ -
collectorCluster_
-
collectorEndpoint_
-
traceId128Bit_
private boolean traceId128Bit_ -
collectorEndpointVersion_
private int collectorEndpointVersion_ -
collectorHostname_
-
splitSpansForRequest_
private boolean splitSpansForRequest_
-
-
Constructor Details
-
Builder
private Builder() -
Builder
private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage.Builder<ZipkinConfig.Builder>
-
maybeForceBuilderInitialization
private void maybeForceBuilderInitialization() -
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessage.Builder<ZipkinConfig.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<ZipkinConfig.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial0
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<ZipkinConfig.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<ZipkinConfig.Builder>
-
mergeFrom
public ZipkinConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<ZipkinConfig.Builder>
- Throws:
IOException
-
getCollectorCluster
The cluster manager cluster that hosts the Zipkin collectors.
string collector_cluster = 1 [(.validate.rules) = { ... }
- Specified by:
getCollectorCluster
in interfaceZipkinConfigOrBuilder
- Returns:
- The collectorCluster.
-
getCollectorClusterBytes
public com.google.protobuf.ByteString getCollectorClusterBytes()The cluster manager cluster that hosts the Zipkin collectors.
string collector_cluster = 1 [(.validate.rules) = { ... }
- Specified by:
getCollectorClusterBytes
in interfaceZipkinConfigOrBuilder
- Returns:
- The bytes for collectorCluster.
-
setCollectorCluster
The cluster manager cluster that hosts the Zipkin collectors.
string collector_cluster = 1 [(.validate.rules) = { ... }
- Parameters:
value
- The collectorCluster to set.- Returns:
- This builder for chaining.
-
clearCollectorCluster
The cluster manager cluster that hosts the Zipkin collectors.
string collector_cluster = 1 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
setCollectorClusterBytes
The cluster manager cluster that hosts the Zipkin collectors.
string collector_cluster = 1 [(.validate.rules) = { ... }
- Parameters:
value
- The bytes for collectorCluster to set.- Returns:
- This builder for chaining.
-
getCollectorEndpoint
The API endpoint of the Zipkin service where the spans will be sent. When using a standard Zipkin installation.
string collector_endpoint = 2 [(.validate.rules) = { ... }
- Specified by:
getCollectorEndpoint
in interfaceZipkinConfigOrBuilder
- Returns:
- The collectorEndpoint.
-
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.
string collector_endpoint = 2 [(.validate.rules) = { ... }
- Specified by:
getCollectorEndpointBytes
in interfaceZipkinConfigOrBuilder
- Returns:
- The bytes for collectorEndpoint.
-
setCollectorEndpoint
The API endpoint of the Zipkin service where the spans will be sent. When using a standard Zipkin installation.
string collector_endpoint = 2 [(.validate.rules) = { ... }
- Parameters:
value
- The collectorEndpoint to set.- Returns:
- This builder for chaining.
-
clearCollectorEndpoint
The API endpoint of the Zipkin service where the spans will be sent. When using a standard Zipkin installation.
string collector_endpoint = 2 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
setCollectorEndpointBytes
The API endpoint of the Zipkin service where the spans will be sent. When using a standard Zipkin installation.
string collector_endpoint = 2 [(.validate.rules) = { ... }
- Parameters:
value
- The bytes for collectorEndpoint to set.- Returns:
- This builder for chaining.
-
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 interfaceZipkinConfigOrBuilder
- Returns:
- The traceId128bit.
-
setTraceId128Bit
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;
- Parameters:
value
- The traceId128bit to set.- Returns:
- This builder for chaining.
-
clearTraceId128Bit
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;
- Returns:
- This builder for chaining.
-
getCollectorEndpointVersionValue
public int getCollectorEndpointVersionValue()Determines the selected collector endpoint version.
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
- Specified by:
getCollectorEndpointVersionValue
in interfaceZipkinConfigOrBuilder
- Returns:
- The enum numeric value on the wire for collectorEndpointVersion.
-
setCollectorEndpointVersionValue
Determines the selected collector endpoint version.
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
- Parameters:
value
- The enum numeric value on the wire for collectorEndpointVersion to set.- Returns:
- This builder for chaining.
-
getCollectorEndpointVersion
Determines the selected collector endpoint version.
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
- Specified by:
getCollectorEndpointVersion
in interfaceZipkinConfigOrBuilder
- Returns:
- The collectorEndpointVersion.
-
setCollectorEndpointVersion
public ZipkinConfig.Builder setCollectorEndpointVersion(ZipkinConfig.CollectorEndpointVersion value) Determines the selected collector endpoint version.
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
- Parameters:
value
- The collectorEndpointVersion to set.- Returns:
- This builder for chaining.
-
clearCollectorEndpointVersion
Determines the selected collector endpoint version.
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
- Returns:
- This builder for chaining.
-
getCollectorHostname
Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above.
string collector_hostname = 6;
- Specified by:
getCollectorHostname
in interfaceZipkinConfigOrBuilder
- Returns:
- The collectorHostname.
-
getCollectorHostnameBytes
public com.google.protobuf.ByteString getCollectorHostnameBytes()Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above.
string collector_hostname = 6;
- Specified by:
getCollectorHostnameBytes
in interfaceZipkinConfigOrBuilder
- Returns:
- The bytes for collectorHostname.
-
setCollectorHostname
Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above.
string collector_hostname = 6;
- Parameters:
value
- The collectorHostname to set.- Returns:
- This builder for chaining.
-
clearCollectorHostname
Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above.
string collector_hostname = 6;
- Returns:
- This builder for chaining.
-
setCollectorHostnameBytes
Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above.
string collector_hostname = 6;
- Parameters:
value
- The bytes for collectorHostname to set.- Returns:
- This builder for chaining.
-
getSplitSpansForRequest
Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=88If this is set to true, then Envoy will be treated as an independent hop in trace chain. A complete span pair will be created for a single request. Server span will be created for the downstream request and client span will be created for the related upstream request. This should be set to true in the following cases: * The Envoy Proxy is used as gateway or ingress. * The Envoy Proxy is used as sidecar but inbound traffic capturing or outbound traffic capturing is disabled. * Any case that the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` is set to true. .. attention:: If this is set to true, then the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` SHOULD be set to true also to ensure the correctness of trace chain. Both this field and ``start_child_span`` are deprecated by the :ref:`spawn_upstream_span <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.spawn_upstream_span>`. Please use that ``spawn_upstream_span`` field to control the span creation.
bool split_spans_for_request = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Specified by:
getSplitSpansForRequest
in interfaceZipkinConfigOrBuilder
- Returns:
- The splitSpansForRequest.
-
setSplitSpansForRequest
Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=88If this is set to true, then Envoy will be treated as an independent hop in trace chain. A complete span pair will be created for a single request. Server span will be created for the downstream request and client span will be created for the related upstream request. This should be set to true in the following cases: * The Envoy Proxy is used as gateway or ingress. * The Envoy Proxy is used as sidecar but inbound traffic capturing or outbound traffic capturing is disabled. * Any case that the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` is set to true. .. attention:: If this is set to true, then the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` SHOULD be set to true also to ensure the correctness of trace chain. Both this field and ``start_child_span`` are deprecated by the :ref:`spawn_upstream_span <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.spawn_upstream_span>`. Please use that ``spawn_upstream_span`` field to control the span creation.
bool split_spans_for_request = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Parameters:
value
- The splitSpansForRequest to set.- Returns:
- This builder for chaining.
-
clearSplitSpansForRequest
Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=88If this is set to true, then Envoy will be treated as an independent hop in trace chain. A complete span pair will be created for a single request. Server span will be created for the downstream request and client span will be created for the related upstream request. This should be set to true in the following cases: * The Envoy Proxy is used as gateway or ingress. * The Envoy Proxy is used as sidecar but inbound traffic capturing or outbound traffic capturing is disabled. * Any case that the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` is set to true. .. attention:: If this is set to true, then the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` SHOULD be set to true also to ensure the correctness of trace chain. Both this field and ``start_child_span`` are deprecated by the :ref:`spawn_upstream_span <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.spawn_upstream_span>`. Please use that ``spawn_upstream_span`` field to control the span creation.
bool split_spans_for_request = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- This builder for chaining.
-