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

Class ZipkinConfig.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ZipkinConfigOrBuilder, java.lang.Cloneable
    Enclosing class:
    ZipkinConfig
    public static final class ZipkinConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.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

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

      • 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.GeneratedMessageV3.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.GeneratedMessageV3.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

      • clone

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

      • setField

        public ZipkinConfig.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>

      • clearField

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

      • clearOneof

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

      • setRepeatedField

        public ZipkinConfig.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             int index,
                                             java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>

      • addRepeatedField

        public ZipkinConfig.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>

      • 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>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>

      • mergeFrom

        public ZipkinConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.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:
        java.io.IOException

      • getCollectorCluster

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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

      • 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.

      • 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 java.lang.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​(java.lang.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

        public boolean getSplitSpansForRequest()
         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 `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.
        bool split_spans_for_request = 7;
        Specified by:
        getSplitSpansForRequest in interface ZipkinConfigOrBuilder
        Returns:
        The splitSpansForRequest.

      • setSplitSpansForRequest

        public ZipkinConfig.Builder setSplitSpansForRequest​(boolean value)
         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 `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.
        bool split_spans_for_request = 7;
        Parameters:
        value - The splitSpansForRequest to set.
        Returns:
        This builder for chaining.

      • clearSplitSpansForRequest

        public ZipkinConfig.Builder clearSplitSpansForRequest()
         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 `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.
        bool split_spans_for_request = 7;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ZipkinConfig.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>

      • mergeUnknownFields

        public final ZipkinConfig.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>