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

Enum ZipkinConfig.CollectorEndpointVersion

    • Enum Constant Detail

      • DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE

        @Deprecated
public static final ZipkinConfig.CollectorEndpointVersion DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE
        Deprecated.
         Zipkin API v1, JSON over HTTP.
 [#comment: The default implementation of Zipkin client before this field is added was only v1
 and the way user configure this was by not explicitly specifying the version. Consequently,
 before this is added, the corresponding Zipkin collector expected to receive v1 payload.
 Hence the motivation of adding HTTP_JSON_V1 as the default is to avoid a breaking change when
 user upgrading Envoy with this change. Furthermore, we also immediately deprecate this field,
 since in Zipkin realm this v1 version is considered to be not preferable anymore.]
        DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE = 0 [deprecated = true, (.envoy.annotations.disallowed_by_default_enum) = true];

    • Field Detail

      • DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE_VALUE

        @Deprecated
public static final int DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE_VALUE
        Deprecated.
         Zipkin API v1, JSON over HTTP.
 [#comment: The default implementation of Zipkin client before this field is added was only v1
 and the way user configure this was by not explicitly specifying the version. Consequently,
 before this is added, the corresponding Zipkin collector expected to receive v1 payload.
 Hence the motivation of adding HTTP_JSON_V1 as the default is to avoid a breaking change when
 user upgrading Envoy with this change. Furthermore, we also immediately deprecate this field,
 since in Zipkin realm this v1 version is considered to be not preferable anymore.]
        DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE = 0 [deprecated = true, (.envoy.annotations.disallowed_by_default_enum) = true];
        See Also:
        Constant Field Values

      • HTTP_JSON_VALUE

        public static final int HTTP_JSON_VALUE
         Zipkin API v2, JSON over HTTP.
        HTTP_JSON = 1;
        See Also:
        Constant Field Values

      • HTTP_PROTO_VALUE

        public static final int HTTP_PROTO_VALUE
         Zipkin API v2, protobuf over HTTP.
        HTTP_PROTO = 2;
        See Also:
        Constant Field Values

      • GRPC_VALUE

        public static final int GRPC_VALUE
         [#not-implemented-hide:]
        GRPC = 3;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static ZipkinConfig.CollectorEndpointVersion[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ZipkinConfig.CollectorEndpointVersion c : ZipkinConfig.CollectorEndpointVersion.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ZipkinConfig.CollectorEndpointVersion valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum

      • valueOf

        @Deprecated
public static ZipkinConfig.CollectorEndpointVersion valueOf​(int value)
        Deprecated.
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • forNumber

        public static ZipkinConfig.CollectorEndpointVersion forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptor

        public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static ZipkinConfig.CollectorEndpointVersion valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null