Package io.envoyproxy.envoy.config.trace.v3

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 Details

    • bitField0_

      private int bitField0_

    • collectorCluster_

      private Object collectorCluster_

    • collectorEndpoint_

      private Object collectorEndpoint_

    • traceId128Bit_

      private boolean traceId128Bit_

    • sharedSpanContext_

      private com.google.protobuf.BoolValue sharedSpanContext_

    • sharedSpanContextBuilder_

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.BoolValue,com.google.protobuf.BoolValue.Builder,com.google.protobuf.BoolValueOrBuilder> sharedSpanContextBuilder_

    • collectorEndpointVersion_

      private int collectorEndpointVersion_

    • collectorHostname_

      private Object 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 class com.google.protobuf.GeneratedMessage.Builder<ZipkinConfig.Builder>

    • maybeForceBuilderInitialization

      private void maybeForceBuilderInitialization()

    • clear

      public ZipkinConfig.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.GeneratedMessage.Builder<ZipkinConfig.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.GeneratedMessage.Builder<ZipkinConfig.Builder>

    • getDefaultInstanceForType

      public ZipkinConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ZipkinConfig build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ZipkinConfig buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • buildPartial0

      private void buildPartial0(ZipkinConfig result)

    • mergeFrom

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

    • mergeFrom

      public ZipkinConfig.Builder mergeFrom(ZipkinConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.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 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<ZipkinConfig.Builder>
      Throws:
      IOException

    • getCollectorCluster

      public String getCollectorCluster()
       The cluster manager cluster that hosts the Zipkin collectors.
      string collector_cluster = 1 [(.validate.rules) = { ... }
      Specified by:
      getCollectorCluster in interface ZipkinConfigOrBuilder
      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 interface ZipkinConfigOrBuilder
      Returns:
      The bytes for collectorCluster.

    • setCollectorCluster

      public ZipkinConfig.Builder setCollectorCluster(String value)
       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

      public ZipkinConfig.Builder clearCollectorCluster()
       The cluster manager cluster that hosts the Zipkin collectors.
      string collector_cluster = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setCollectorClusterBytes

      public ZipkinConfig.Builder setCollectorClusterBytes(com.google.protobuf.ByteString value)
       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

      public String 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 interface ZipkinConfigOrBuilder
      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 interface ZipkinConfigOrBuilder
      Returns:
      The bytes for collectorEndpoint.

    • setCollectorEndpoint

      public ZipkinConfig.Builder setCollectorEndpoint(String value)
       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

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

      public ZipkinConfig.Builder setCollectorEndpointBytes(com.google.protobuf.ByteString value)
       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 interface ZipkinConfigOrBuilder
      Returns:
      The traceId128bit.

    • setTraceId128Bit

      public ZipkinConfig.Builder setTraceId128Bit(boolean value)
       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

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

    • 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
      Returns:
      Whether the sharedSpanContext field is set.

    • 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
      Returns:
      The sharedSpanContext.

    • setSharedSpanContext

      public ZipkinConfig.Builder setSharedSpanContext(com.google.protobuf.BoolValue value)
       Determines whether client and server spans will share the same span context.
 The default value is true.
      .google.protobuf.BoolValue shared_span_context = 4;

    • setSharedSpanContext

      public ZipkinConfig.Builder setSharedSpanContext(com.google.protobuf.BoolValue.Builder builderForValue)
       Determines whether client and server spans will share the same span context.
 The default value is true.
      .google.protobuf.BoolValue shared_span_context = 4;

    • mergeSharedSpanContext

      public ZipkinConfig.Builder mergeSharedSpanContext(com.google.protobuf.BoolValue value)
       Determines whether client and server spans will share the same span context.
 The default value is true.
      .google.protobuf.BoolValue shared_span_context = 4;

    • clearSharedSpanContext

      public ZipkinConfig.Builder clearSharedSpanContext()
       Determines whether client and server spans will share the same span context.
 The default value is true.
      .google.protobuf.BoolValue shared_span_context = 4;

    • getSharedSpanContextBuilder

      public com.google.protobuf.BoolValue.Builder getSharedSpanContextBuilder()
       Determines whether client and server spans will share the same span context.
 The default value is true.
      .google.protobuf.BoolValue shared_span_context = 4;

    • 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

    • getSharedSpanContextFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.BoolValue,com.google.protobuf.BoolValue.Builder,com.google.protobuf.BoolValueOrBuilder> getSharedSpanContextFieldBuilder()
       Determines whether client and server spans will share the same span context.
 The default value is true.
      .google.protobuf.BoolValue shared_span_context = 4;

    • getCollectorEndpointVersionValue

      public int getCollectorEndpointVersionValue()
       Determines the selected collector endpoint version.
      .envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
      Specified by:
      getCollectorEndpointVersionValue in interface ZipkinConfigOrBuilder
      Returns:
      The enum numeric value on the wire for collectorEndpointVersion.

    • setCollectorEndpointVersionValue

      public ZipkinConfig.Builder setCollectorEndpointVersionValue(int value)
       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

      public ZipkinConfig.CollectorEndpointVersion getCollectorEndpointVersion()
       Determines the selected collector endpoint version.
      .envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
      Specified by:
      getCollectorEndpointVersion in interface ZipkinConfigOrBuilder
      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

      public ZipkinConfig.Builder clearCollectorEndpointVersion()
       Determines the selected collector endpoint version.
      .envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
      Returns:
      This builder for chaining.

    • getCollectorHostname

      public String 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 interface ZipkinConfigOrBuilder
      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 interface ZipkinConfigOrBuilder
      Returns:
      The bytes for collectorHostname.

    • setCollectorHostname

      public ZipkinConfig.Builder setCollectorHostname(String value)
       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

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

      public ZipkinConfig.Builder setCollectorHostnameBytes(com.google.protobuf.ByteString value)
       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 public boolean getSplitSpansForRequest()
      Deprecated.
      envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=88
       If 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 interface ZipkinConfigOrBuilder
      Returns:
      The splitSpansForRequest.

    • setSplitSpansForRequest

      @Deprecated public ZipkinConfig.Builder setSplitSpansForRequest(boolean value)
      Deprecated.
      envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=88
       If 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 public ZipkinConfig.Builder clearSplitSpansForRequest()
      Deprecated.
      envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=88
       If 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.