Package io.envoyproxy.envoy.extensions.request_id.uuid.v3

Class UuidRequestIdConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.request_id.uuid.v3.UuidRequestIdConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UuidRequestIdConfigOrBuilder, Serializable
public final class UuidRequestIdConfig extends com.google.protobuf.GeneratedMessageV3 implements UuidRequestIdConfigOrBuilder
 Configuration for the default UUID request ID extension which has the following behavior:

 1. Request ID is propagated using the :ref:`x-request-id
    <config_http_conn_man_headers_x-request-id>` header.

 2. Request ID is a universally unique identifier `(UUID4)
    <https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)>`_.

 3. Tracing decision (sampled, forced, etc) is set in 14th nibble of the UUID. By default this will
    overwrite existing UUIDs received in the ``x-request-id`` header if the trace sampling decision
    is changed. The 14th nibble of the UUID4 has been chosen because it is fixed to '4' by the
    standard. Thus, '4' indicates a default UUID and no trace status. This nibble is swapped to:

      a. '9': Sampled.
      b. 'a': Force traced due to server-side override.
      c. 'b': Force traced due to client-side request ID joining.

    See the :ref:`x-request-id <config_http_conn_man_headers_x-request-id>` documentation for
    more information.
Protobuf type envoy.extensions.request_id.uuid.v3.UuidRequestIdConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    UuidRequestIdConfig.Builder
    Configuration for the default UUID request ID extension which has the following behavior: 1.

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    PACK_TRACE_REASON_FIELD_NUMBER
     
    static final int
    USE_REQUEST_ID_FOR_TRACE_SAMPLING_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static UuidRequestIdConfig
    getDefaultInstance()
     
    UuidRequestIdConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.BoolValue
    getPackTraceReason()
    Whether the implementation alters the UUID to contain the trace sampling decision as per the ``UuidRequestIdConfig`` message documentation.
    com.google.protobuf.BoolValueOrBuilder
    getPackTraceReasonOrBuilder()
    Whether the implementation alters the UUID to contain the trace sampling decision as per the ``UuidRequestIdConfig`` message documentation.
    com.google.protobuf.Parser<UuidRequestIdConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.BoolValue
    getUseRequestIdForTraceSampling()
    Set whether to use :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` for sampling or not.
    com.google.protobuf.BoolValueOrBuilder
    getUseRequestIdForTraceSamplingOrBuilder()
    Set whether to use :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` for sampling or not.
    int
    hashCode()
     
    boolean
    hasPackTraceReason()
    Whether the implementation alters the UUID to contain the trace sampling decision as per the ``UuidRequestIdConfig`` message documentation.
    boolean
    hasUseRequestIdForTraceSampling()
    Set whether to use :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` for sampling or not.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static UuidRequestIdConfig.Builder
    newBuilder()
     
    static UuidRequestIdConfig.Builder
    newBuilder(UuidRequestIdConfig prototype)
     
    UuidRequestIdConfig.Builder
    newBuilderForType()
     
    protected UuidRequestIdConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static UuidRequestIdConfig
    parseDelimitedFrom(InputStream input)
     
    static UuidRequestIdConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UuidRequestIdConfig
    parseFrom(byte[] data)
     
    static UuidRequestIdConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UuidRequestIdConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static UuidRequestIdConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UuidRequestIdConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static UuidRequestIdConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UuidRequestIdConfig
    parseFrom(InputStream input)
     
    static UuidRequestIdConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UuidRequestIdConfig
    parseFrom(ByteBuffer data)
     
    static UuidRequestIdConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<UuidRequestIdConfig>
    parser()
     
    UuidRequestIdConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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 class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    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, getUnknownFields, hasField, hasOneof

  • Field Details

    • PACK_TRACE_REASON_FIELD_NUMBER

      public static final int PACK_TRACE_REASON_FIELD_NUMBER
      See Also:

    • USE_REQUEST_ID_FOR_TRACE_SAMPLING_FIELD_NUMBER

      public static final int USE_REQUEST_ID_FOR_TRACE_SAMPLING_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • hasPackTraceReason

      public boolean hasPackTraceReason()
       Whether the implementation alters the UUID to contain the trace sampling decision as per the
 ``UuidRequestIdConfig`` message documentation. This defaults to true. If disabled no
 modification to the UUID will be performed. It is important to note that if disabled,
 stable sampling of traces, access logs, etc. will no longer work and only random sampling will
 be possible.
      .google.protobuf.BoolValue pack_trace_reason = 1;
      Specified by:
      hasPackTraceReason in interface UuidRequestIdConfigOrBuilder
      Returns:
      Whether the packTraceReason field is set.

    • getPackTraceReason

      public com.google.protobuf.BoolValue getPackTraceReason()
       Whether the implementation alters the UUID to contain the trace sampling decision as per the
 ``UuidRequestIdConfig`` message documentation. This defaults to true. If disabled no
 modification to the UUID will be performed. It is important to note that if disabled,
 stable sampling of traces, access logs, etc. will no longer work and only random sampling will
 be possible.
      .google.protobuf.BoolValue pack_trace_reason = 1;
      Specified by:
      getPackTraceReason in interface UuidRequestIdConfigOrBuilder
      Returns:
      The packTraceReason.

    • getPackTraceReasonOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getPackTraceReasonOrBuilder()
       Whether the implementation alters the UUID to contain the trace sampling decision as per the
 ``UuidRequestIdConfig`` message documentation. This defaults to true. If disabled no
 modification to the UUID will be performed. It is important to note that if disabled,
 stable sampling of traces, access logs, etc. will no longer work and only random sampling will
 be possible.
      .google.protobuf.BoolValue pack_trace_reason = 1;
      Specified by:
      getPackTraceReasonOrBuilder in interface UuidRequestIdConfigOrBuilder

    • hasUseRequestIdForTraceSampling

      public boolean hasUseRequestIdForTraceSampling()
       Set whether to use :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` for sampling or not.
 This defaults to true. See the :ref:`context propagation <arch_overview_tracing_context_propagation>`
 overview for more information.
      .google.protobuf.BoolValue use_request_id_for_trace_sampling = 2;
      Specified by:
      hasUseRequestIdForTraceSampling in interface UuidRequestIdConfigOrBuilder
      Returns:
      Whether the useRequestIdForTraceSampling field is set.

    • getUseRequestIdForTraceSampling

      public com.google.protobuf.BoolValue getUseRequestIdForTraceSampling()
       Set whether to use :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` for sampling or not.
 This defaults to true. See the :ref:`context propagation <arch_overview_tracing_context_propagation>`
 overview for more information.
      .google.protobuf.BoolValue use_request_id_for_trace_sampling = 2;
      Specified by:
      getUseRequestIdForTraceSampling in interface UuidRequestIdConfigOrBuilder
      Returns:
      The useRequestIdForTraceSampling.

    • getUseRequestIdForTraceSamplingOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getUseRequestIdForTraceSamplingOrBuilder()
       Set whether to use :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` for sampling or not.
 This defaults to true. See the :ref:`context propagation <arch_overview_tracing_context_propagation>`
 overview for more information.
      .google.protobuf.BoolValue use_request_id_for_trace_sampling = 2;
      Specified by:
      getUseRequestIdForTraceSamplingOrBuilder in interface UuidRequestIdConfigOrBuilder

    • 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 UuidRequestIdConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static UuidRequestIdConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UuidRequestIdConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UuidRequestIdConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UuidRequestIdConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UuidRequestIdConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static UuidRequestIdConfig.Builder newBuilder()

    • newBuilder

      public static UuidRequestIdConfig.Builder newBuilder(UuidRequestIdConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static UuidRequestIdConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<UuidRequestIdConfig> 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 UuidRequestIdConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder