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

Class OpenTelemetryConfig.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OpenTelemetryConfigOrBuilder, Cloneable
    Enclosing class:
    OpenTelemetryConfig
    public static final class OpenTelemetryConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<OpenTelemetryConfig.Builder>
implements OpenTelemetryConfigOrBuilder
     Configuration for the OpenTelemetry tracer.
  [#extension: envoy.tracers.opentelemetry]
    Protobuf type envoy.config.trace.v3.OpenTelemetryConfig

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • isInitialized

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

      • mergeFrom

        public OpenTelemetryConfig.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<OpenTelemetryConfig.Builder>
        Throws:
        IOException

      • hasGrpcService

        public boolean hasGrpcService()
         The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        hasGrpcService in interface OpenTelemetryConfigOrBuilder
        Returns:
        Whether the grpcService field is set.

      • getGrpcService

        public GrpcService getGrpcService()
         The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getGrpcService in interface OpenTelemetryConfigOrBuilder
        Returns:
        The grpcService.

      • setGrpcService

        public OpenTelemetryConfig.Builder setGrpcService​(GrpcService value)
         The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }

      • setGrpcService

        public OpenTelemetryConfig.Builder setGrpcService​(GrpcService.Builder builderForValue)
         The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }

      • mergeGrpcService

        public OpenTelemetryConfig.Builder mergeGrpcService​(GrpcService value)
         The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }

      • clearGrpcService

        public OpenTelemetryConfig.Builder clearGrpcService()
         The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }

      • getGrpcServiceBuilder

        public GrpcService.Builder getGrpcServiceBuilder()
         The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }

      • getGrpcServiceOrBuilder

        public GrpcServiceOrBuilder getGrpcServiceOrBuilder()
         The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getGrpcServiceOrBuilder in interface OpenTelemetryConfigOrBuilder

      • hasHttpService

        public boolean hasHttpService()
         The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.
 .. note::
   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
        .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        hasHttpService in interface OpenTelemetryConfigOrBuilder
        Returns:
        Whether the httpService field is set.

      • getHttpService

        public HttpService getHttpService()
         The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.
 .. note::
   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
        .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getHttpService in interface OpenTelemetryConfigOrBuilder
        Returns:
        The httpService.

      • setHttpService

        public OpenTelemetryConfig.Builder setHttpService​(HttpService value)
         The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.
 .. note::
   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
        .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }

      • setHttpService

        public OpenTelemetryConfig.Builder setHttpService​(HttpService.Builder builderForValue)
         The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.
 .. note::
   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
        .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }

      • mergeHttpService

        public OpenTelemetryConfig.Builder mergeHttpService​(HttpService value)
         The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.
 .. note::
   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
        .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }

      • clearHttpService

        public OpenTelemetryConfig.Builder clearHttpService()
         The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.
 .. note::
   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
        .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }

      • getHttpServiceBuilder

        public HttpService.Builder getHttpServiceBuilder()
         The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.
 .. note::
   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
        .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }

      • getHttpServiceOrBuilder

        public HttpServiceOrBuilder getHttpServiceOrBuilder()
         The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.
 .. note::
   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
        .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getHttpServiceOrBuilder in interface OpenTelemetryConfigOrBuilder

      • getServiceName

        public String getServiceName()
         The name for the service. This will be populated in the ResourceSpan Resource attributes.
 If it is not provided, it will default to "unknown_service:envoy".
        string service_name = 2;
        Specified by:
        getServiceName in interface OpenTelemetryConfigOrBuilder
        Returns:
        The serviceName.

      • getServiceNameBytes

        public com.google.protobuf.ByteString getServiceNameBytes()
         The name for the service. This will be populated in the ResourceSpan Resource attributes.
 If it is not provided, it will default to "unknown_service:envoy".
        string service_name = 2;
        Specified by:
        getServiceNameBytes in interface OpenTelemetryConfigOrBuilder
        Returns:
        The bytes for serviceName.

      • setServiceName

        public OpenTelemetryConfig.Builder setServiceName​(String value)
         The name for the service. This will be populated in the ResourceSpan Resource attributes.
 If it is not provided, it will default to "unknown_service:envoy".
        string service_name = 2;
        Parameters:
        value - The serviceName to set.
        Returns:
        This builder for chaining.

      • clearServiceName

        public OpenTelemetryConfig.Builder clearServiceName()
         The name for the service. This will be populated in the ResourceSpan Resource attributes.
 If it is not provided, it will default to "unknown_service:envoy".
        string service_name = 2;
        Returns:
        This builder for chaining.

      • setServiceNameBytes

        public OpenTelemetryConfig.Builder setServiceNameBytes​(com.google.protobuf.ByteString value)
         The name for the service. This will be populated in the ResourceSpan Resource attributes.
 If it is not provided, it will default to "unknown_service:envoy".
        string service_name = 2;
        Parameters:
        value - The bytes for serviceName to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final OpenTelemetryConfig.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<OpenTelemetryConfig.Builder>

      • mergeUnknownFields

        public final OpenTelemetryConfig.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<OpenTelemetryConfig.Builder>