Package io.envoyproxy.envoy.extensions.stat_sinks.open_telemetry.v3

Class SinkConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SinkConfigOrBuilder, Serializable
    public final class SinkConfig
extends com.google.protobuf.GeneratedMessageV3
implements SinkConfigOrBuilder
     [#next-free-field: 7]
    Protobuf type envoy.extensions.stat_sinks.open_telemetry.v3.SinkConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SinkConfig.Builder
      [#next-free-field: 7]
      static class  SinkConfig.ProtocolSpecifierCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static SinkConfig getDefaultInstance()  
      SinkConfig getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.BoolValue getEmitTagsAsAttributes()
      If set to true, metrics will have their tags emitted as OTLP attributes, which may contain values used by the tag extractor or additional tags added during stats creation.
      com.google.protobuf.BoolValueOrBuilder getEmitTagsAsAttributesOrBuilder()
      If set to true, metrics will have their tags emitted as OTLP attributes, which may contain values used by the tag extractor or additional tags added during stats creation.
      GrpcService getGrpcService()
      The upstream gRPC cluster that implements the OTLP/gRPC collector.
      GrpcServiceOrBuilder getGrpcServiceOrBuilder()
      The upstream gRPC cluster that implements the OTLP/gRPC collector.
      com.google.protobuf.Parser<SinkConfig> getParserForType()  
      String getPrefix()
      If set, emitted stats names will be prepended with a prefix, so full stat name will be <prefix>.<stats_name>.
      com.google.protobuf.ByteString getPrefixBytes()
      If set, emitted stats names will be prepended with a prefix, so full stat name will be <prefix>.<stats_name>.
      SinkConfig.ProtocolSpecifierCase getProtocolSpecifierCase()  
      boolean getReportCountersAsDeltas()
      If set to true, counters will be emitted as deltas, and the OTLP message will have ``AGGREGATION_TEMPORALITY_DELTA`` set as AggregationTemporality.
      boolean getReportHistogramsAsDeltas()
      If set to true, histograms will be emitted as deltas, and the OTLP message will have ``AGGREGATION_TEMPORALITY_DELTA`` set as AggregationTemporality.
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      com.google.protobuf.BoolValue getUseTagExtractedName()
      If set to true, metric names will be represented as the tag extracted name instead of the full metric name.
      com.google.protobuf.BoolValueOrBuilder getUseTagExtractedNameOrBuilder()
      If set to true, metric names will be represented as the tag extracted name instead of the full metric name.
      boolean hasEmitTagsAsAttributes()
      If set to true, metrics will have their tags emitted as OTLP attributes, which may contain values used by the tag extractor or additional tags added during stats creation.
      boolean hasGrpcService()
      The upstream gRPC cluster that implements the OTLP/gRPC collector.
      int hashCode()  
      boolean hasUseTagExtractedName()
      If set to true, metric names will be represented as the tag extracted name instead of the full metric name.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static SinkConfig.Builder newBuilder()  
      static SinkConfig.Builder newBuilder​(SinkConfig prototype)  
      SinkConfig.Builder newBuilderForType()  
      protected SinkConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static SinkConfig parseDelimitedFrom​(InputStream input)  
      static SinkConfig parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SinkConfig parseFrom​(byte[] data)  
      static SinkConfig parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SinkConfig parseFrom​(com.google.protobuf.ByteString data)  
      static SinkConfig parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SinkConfig parseFrom​(com.google.protobuf.CodedInputStream input)  
      static SinkConfig parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SinkConfig parseFrom​(InputStream input)  
      static SinkConfig parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SinkConfig parseFrom​(ByteBuffer data)  
      static SinkConfig parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<SinkConfig> parser()  
      SinkConfig.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

    • Field Detail

      • GRPC_SERVICE_FIELD_NUMBER

        public static final int GRPC_SERVICE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPORT_COUNTERS_AS_DELTAS_FIELD_NUMBER

        public static final int REPORT_COUNTERS_AS_DELTAS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPORT_HISTOGRAMS_AS_DELTAS_FIELD_NUMBER

        public static final int REPORT_HISTOGRAMS_AS_DELTAS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EMIT_TAGS_AS_ATTRIBUTES_FIELD_NUMBER

        public static final int EMIT_TAGS_AS_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USE_TAG_EXTRACTED_NAME_FIELD_NUMBER

        public static final int USE_TAG_EXTRACTED_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • hasGrpcService

        public boolean hasGrpcService()
         The upstream gRPC cluster that implements the OTLP/gRPC collector.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.validate.rules) = { ... }
        Specified by:
        hasGrpcService in interface SinkConfigOrBuilder
        Returns:
        Whether the grpcService field is set.

      • getGrpcService

        public GrpcService getGrpcService()
         The upstream gRPC cluster that implements the OTLP/gRPC collector.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.validate.rules) = { ... }
        Specified by:
        getGrpcService in interface SinkConfigOrBuilder
        Returns:
        The grpcService.

      • getReportCountersAsDeltas

        public boolean getReportCountersAsDeltas()
         If set to true, counters will be emitted as deltas, and the OTLP message will have
 ``AGGREGATION_TEMPORALITY_DELTA`` set as AggregationTemporality.
        bool report_counters_as_deltas = 2;
        Specified by:
        getReportCountersAsDeltas in interface SinkConfigOrBuilder
        Returns:
        The reportCountersAsDeltas.

      • getReportHistogramsAsDeltas

        public boolean getReportHistogramsAsDeltas()
         If set to true, histograms will be emitted as deltas, and the OTLP message will have
 ``AGGREGATION_TEMPORALITY_DELTA`` set as AggregationTemporality.
        bool report_histograms_as_deltas = 3;
        Specified by:
        getReportHistogramsAsDeltas in interface SinkConfigOrBuilder
        Returns:
        The reportHistogramsAsDeltas.

      • hasEmitTagsAsAttributes

        public boolean hasEmitTagsAsAttributes()
         If set to true, metrics will have their tags emitted as OTLP attributes, which may
 contain values used by the tag extractor or additional tags added during stats creation.
 Otherwise, no attributes will be associated with the export message. Default value is true.
        .google.protobuf.BoolValue emit_tags_as_attributes = 4;
        Specified by:
        hasEmitTagsAsAttributes in interface SinkConfigOrBuilder
        Returns:
        Whether the emitTagsAsAttributes field is set.

      • getEmitTagsAsAttributes

        public com.google.protobuf.BoolValue getEmitTagsAsAttributes()
         If set to true, metrics will have their tags emitted as OTLP attributes, which may
 contain values used by the tag extractor or additional tags added during stats creation.
 Otherwise, no attributes will be associated with the export message. Default value is true.
        .google.protobuf.BoolValue emit_tags_as_attributes = 4;
        Specified by:
        getEmitTagsAsAttributes in interface SinkConfigOrBuilder
        Returns:
        The emitTagsAsAttributes.

      • getEmitTagsAsAttributesOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getEmitTagsAsAttributesOrBuilder()
         If set to true, metrics will have their tags emitted as OTLP attributes, which may
 contain values used by the tag extractor or additional tags added during stats creation.
 Otherwise, no attributes will be associated with the export message. Default value is true.
        .google.protobuf.BoolValue emit_tags_as_attributes = 4;
        Specified by:
        getEmitTagsAsAttributesOrBuilder in interface SinkConfigOrBuilder

      • hasUseTagExtractedName

        public boolean hasUseTagExtractedName()
         If set to true, metric names will be represented as the tag extracted name instead
 of the full metric name. Default value is true.
        .google.protobuf.BoolValue use_tag_extracted_name = 5;
        Specified by:
        hasUseTagExtractedName in interface SinkConfigOrBuilder
        Returns:
        Whether the useTagExtractedName field is set.

      • getUseTagExtractedName

        public com.google.protobuf.BoolValue getUseTagExtractedName()
         If set to true, metric names will be represented as the tag extracted name instead
 of the full metric name. Default value is true.
        .google.protobuf.BoolValue use_tag_extracted_name = 5;
        Specified by:
        getUseTagExtractedName in interface SinkConfigOrBuilder
        Returns:
        The useTagExtractedName.

      • getUseTagExtractedNameOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getUseTagExtractedNameOrBuilder()
         If set to true, metric names will be represented as the tag extracted name instead
 of the full metric name. Default value is true.
        .google.protobuf.BoolValue use_tag_extracted_name = 5;
        Specified by:
        getUseTagExtractedNameOrBuilder in interface SinkConfigOrBuilder

      • getPrefix

        public String getPrefix()
         If set, emitted stats names will be prepended with a prefix, so full stat name will be
 <prefix>.<stats_name>. For example, if the stat name is "foo.bar" and prefix is
 "pre", the full stat name will be "pre.foo.bar". If this field is not set, there is no
 prefix added. According to the example, the full stat name will remain "foo.bar".
        string prefix = 6;
        Specified by:
        getPrefix in interface SinkConfigOrBuilder
        Returns:
        The prefix.

      • getPrefixBytes

        public com.google.protobuf.ByteString getPrefixBytes()
         If set, emitted stats names will be prepended with a prefix, so full stat name will be
 <prefix>.<stats_name>. For example, if the stat name is "foo.bar" and prefix is
 "pre", the full stat name will be "pre.foo.bar". If this field is not set, there is no
 prefix added. According to the example, the full stat name will remain "foo.bar".
        string prefix = 6;
        Specified by:
        getPrefixBytes in interface SinkConfigOrBuilder
        Returns:
        The bytes for prefix.

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static SinkConfig parseFrom​(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SinkConfig parseFrom​(ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SinkConfig parseFrom​(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SinkConfig parseFrom​(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SinkConfig parseFrom​(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SinkConfig parseFrom​(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SinkConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Throws:
        IOException

      • newBuilderForType

        public SinkConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public SinkConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected SinkConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static SinkConfig getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<SinkConfig> parser()

      • getParserForType

        public com.google.protobuf.Parser<SinkConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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