Package io.envoyproxy.envoy.config.metrics.v3

Class TagSpecifier.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<TagSpecifier.Builder>
com.google.protobuf.GeneratedMessage.Builder<TagSpecifier.Builder>
io.envoyproxy.envoy.config.metrics.v3.TagSpecifier.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TagSpecifierOrBuilder, Cloneable
Enclosing class:
TagSpecifier
public static final class TagSpecifier.Builder extends com.google.protobuf.GeneratedMessage.Builder<TagSpecifier.Builder> implements TagSpecifierOrBuilder
 Designates a tag name and value pair. The value may be either a fixed value
 or a regex providing the value via capture groups. The specified tag will be
 unconditionally set if a fixed value, otherwise it will only be set if one
 or more capture groups in the regex match.
Protobuf type envoy.config.metrics.v3.TagSpecifier

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private int
    bitField0_
     
    private Object
    tagName_
     
    private Object
    tagValue_
     
    private int
    tagValueCase_
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Builder()
     
    private
    Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    TagSpecifier
    build()
     
    TagSpecifier
    buildPartial()
     
    private void
    buildPartial0(TagSpecifier result)
     
    private void
    buildPartialOneofs(TagSpecifier result)
     
    TagSpecifier.Builder
    clear()
     
    TagSpecifier.Builder
    clearFixedValue()
    Specifies a fixed tag value for the ``tag_name``.
    TagSpecifier.Builder
    clearRegex()
    Designates a tag to strip from the tag extracted name and provide as a named tag value for all statistics.
    TagSpecifier.Builder
    clearTagName()
    Attaches an identifier to the tag values to identify the tag being in the sink.
    TagSpecifier.Builder
    clearTagValue()
     
    TagSpecifier
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getFixedValue()
    Specifies a fixed tag value for the ``tag_name``.
    com.google.protobuf.ByteString
    getFixedValueBytes()
    Specifies a fixed tag value for the ``tag_name``.
    String
    getRegex()
    Designates a tag to strip from the tag extracted name and provide as a named tag value for all statistics.
    com.google.protobuf.ByteString
    getRegexBytes()
    Designates a tag to strip from the tag extracted name and provide as a named tag value for all statistics.
    String
    getTagName()
    Attaches an identifier to the tag values to identify the tag being in the sink.
    com.google.protobuf.ByteString
    getTagNameBytes()
    Attaches an identifier to the tag values to identify the tag being in the sink.
    TagSpecifier.TagValueCase
    getTagValueCase()
     
    boolean
    hasFixedValue()
    Specifies a fixed tag value for the ``tag_name``.
    boolean
    hasRegex()
    Designates a tag to strip from the tag extracted name and provide as a named tag value for all statistics.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    TagSpecifier.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    TagSpecifier.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    TagSpecifier.Builder
    mergeFrom(TagSpecifier other)
     
    TagSpecifier.Builder
    setFixedValue(String value)
    Specifies a fixed tag value for the ``tag_name``.
    TagSpecifier.Builder
    setFixedValueBytes(com.google.protobuf.ByteString value)
    Specifies a fixed tag value for the ``tag_name``.
    TagSpecifier.Builder
    setRegex(String value)
    Designates a tag to strip from the tag extracted name and provide as a named tag value for all statistics.
    TagSpecifier.Builder
    setRegexBytes(com.google.protobuf.ByteString value)
    Designates a tag to strip from the tag extracted name and provide as a named tag value for all statistics.
    TagSpecifier.Builder
    setTagName(String value)
    Attaches an identifier to the tag values to identify the tag being in the sink.
    TagSpecifier.Builder
    setTagNameBytes(com.google.protobuf.ByteString value)
    Attaches an identifier to the tag values to identify the tag being in the sink.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

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

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

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

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • tagValueCase_

      private int tagValueCase_

    • tagValue_

      private Object tagValue_

    • bitField0_

      private int bitField0_

    • tagName_

      private Object tagName_

  • Constructor Details

    • Builder

      private Builder()

    • Builder

      private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<TagSpecifier.Builder>

    • clear

      public TagSpecifier.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.GeneratedMessage.Builder<TagSpecifier.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.GeneratedMessage.Builder<TagSpecifier.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • buildPartial0

      private void buildPartial0(TagSpecifier result)

    • buildPartialOneofs

      private void buildPartialOneofs(TagSpecifier result)

    • mergeFrom

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

    • mergeFrom

      public TagSpecifier.Builder mergeFrom(TagSpecifier other)

    • isInitialized

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

    • mergeFrom

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

    • getTagValueCase

      public TagSpecifier.TagValueCase getTagValueCase()
      Specified by:
      getTagValueCase in interface TagSpecifierOrBuilder

    • clearTagValue

      public TagSpecifier.Builder clearTagValue()

    • getTagName

      public String getTagName()
       Attaches an identifier to the tag values to identify the tag being in the
 sink. Envoy has a set of default names and regexes to extract dynamic
 portions of existing stats, which can be found in :repo:`well_known_names.h
 <source/common/config/well_known_names.h>` in the Envoy repository. If a :ref:`tag_name
 <envoy_v3_api_field_config.metrics.v3.TagSpecifier.tag_name>` is provided in the config and
 neither :ref:`regex <envoy_v3_api_field_config.metrics.v3.TagSpecifier.regex>` or
 :ref:`fixed_value <envoy_v3_api_field_config.metrics.v3.TagSpecifier.fixed_value>` were specified,
 Envoy will attempt to find that name in its set of defaults and use the accompanying regex.

 .. note::

 A stat name may be spelled in such a way that it matches two different
 tag extractors for the same tag name. In that case, all but one of the
 tag values will be dropped. It is not specified which tag value will be
 retained. The extraction will only occur for one of the extractors, and
 only the matched extraction will be removed from the tag name.
      string tag_name = 1;
      Specified by:
      getTagName in interface TagSpecifierOrBuilder
      Returns:
      The tagName.

    • getTagNameBytes

      public com.google.protobuf.ByteString getTagNameBytes()
       Attaches an identifier to the tag values to identify the tag being in the
 sink. Envoy has a set of default names and regexes to extract dynamic
 portions of existing stats, which can be found in :repo:`well_known_names.h
 <source/common/config/well_known_names.h>` in the Envoy repository. If a :ref:`tag_name
 <envoy_v3_api_field_config.metrics.v3.TagSpecifier.tag_name>` is provided in the config and
 neither :ref:`regex <envoy_v3_api_field_config.metrics.v3.TagSpecifier.regex>` or
 :ref:`fixed_value <envoy_v3_api_field_config.metrics.v3.TagSpecifier.fixed_value>` were specified,
 Envoy will attempt to find that name in its set of defaults and use the accompanying regex.

 .. note::

 A stat name may be spelled in such a way that it matches two different
 tag extractors for the same tag name. In that case, all but one of the
 tag values will be dropped. It is not specified which tag value will be
 retained. The extraction will only occur for one of the extractors, and
 only the matched extraction will be removed from the tag name.
      string tag_name = 1;
      Specified by:
      getTagNameBytes in interface TagSpecifierOrBuilder
      Returns:
      The bytes for tagName.

    • setTagName

      public TagSpecifier.Builder setTagName(String value)
       Attaches an identifier to the tag values to identify the tag being in the
 sink. Envoy has a set of default names and regexes to extract dynamic
 portions of existing stats, which can be found in :repo:`well_known_names.h
 <source/common/config/well_known_names.h>` in the Envoy repository. If a :ref:`tag_name
 <envoy_v3_api_field_config.metrics.v3.TagSpecifier.tag_name>` is provided in the config and
 neither :ref:`regex <envoy_v3_api_field_config.metrics.v3.TagSpecifier.regex>` or
 :ref:`fixed_value <envoy_v3_api_field_config.metrics.v3.TagSpecifier.fixed_value>` were specified,
 Envoy will attempt to find that name in its set of defaults and use the accompanying regex.

 .. note::

 A stat name may be spelled in such a way that it matches two different
 tag extractors for the same tag name. In that case, all but one of the
 tag values will be dropped. It is not specified which tag value will be
 retained. The extraction will only occur for one of the extractors, and
 only the matched extraction will be removed from the tag name.
      string tag_name = 1;
      Parameters:
      value - The tagName to set.
      Returns:
      This builder for chaining.

    • clearTagName

      public TagSpecifier.Builder clearTagName()
       Attaches an identifier to the tag values to identify the tag being in the
 sink. Envoy has a set of default names and regexes to extract dynamic
 portions of existing stats, which can be found in :repo:`well_known_names.h
 <source/common/config/well_known_names.h>` in the Envoy repository. If a :ref:`tag_name
 <envoy_v3_api_field_config.metrics.v3.TagSpecifier.tag_name>` is provided in the config and
 neither :ref:`regex <envoy_v3_api_field_config.metrics.v3.TagSpecifier.regex>` or
 :ref:`fixed_value <envoy_v3_api_field_config.metrics.v3.TagSpecifier.fixed_value>` were specified,
 Envoy will attempt to find that name in its set of defaults and use the accompanying regex.

 .. note::

 A stat name may be spelled in such a way that it matches two different
 tag extractors for the same tag name. In that case, all but one of the
 tag values will be dropped. It is not specified which tag value will be
 retained. The extraction will only occur for one of the extractors, and
 only the matched extraction will be removed from the tag name.
      string tag_name = 1;
      Returns:
      This builder for chaining.

    • setTagNameBytes

      public TagSpecifier.Builder setTagNameBytes(com.google.protobuf.ByteString value)
       Attaches an identifier to the tag values to identify the tag being in the
 sink. Envoy has a set of default names and regexes to extract dynamic
 portions of existing stats, which can be found in :repo:`well_known_names.h
 <source/common/config/well_known_names.h>` in the Envoy repository. If a :ref:`tag_name
 <envoy_v3_api_field_config.metrics.v3.TagSpecifier.tag_name>` is provided in the config and
 neither :ref:`regex <envoy_v3_api_field_config.metrics.v3.TagSpecifier.regex>` or
 :ref:`fixed_value <envoy_v3_api_field_config.metrics.v3.TagSpecifier.fixed_value>` were specified,
 Envoy will attempt to find that name in its set of defaults and use the accompanying regex.

 .. note::

 A stat name may be spelled in such a way that it matches two different
 tag extractors for the same tag name. In that case, all but one of the
 tag values will be dropped. It is not specified which tag value will be
 retained. The extraction will only occur for one of the extractors, and
 only the matched extraction will be removed from the tag name.
      string tag_name = 1;
      Parameters:
      value - The bytes for tagName to set.
      Returns:
      This builder for chaining.

    • hasRegex

      public boolean hasRegex()
       Designates a tag to strip from the tag extracted name and provide as a named
 tag value for all statistics. This will only occur if any part of the name
 matches the regex provided with one or more capture groups.

 The first capture group identifies the portion of the name to remove. The
 second capture group (which will normally be nested inside the first) will
 designate the value of the tag for the statistic. If no second capture
 group is provided, the first will also be used to set the value of the tag.
 All other capture groups will be ignored.

 Example 1. a stat name ``cluster.foo_cluster.upstream_rq_timeout`` and
 one tag specifier:

 .. code-block:: json

 {
 "tag_name": "envoy.cluster_name",
 "regex": "^cluster\\.((.+?)\\.)"
 }

 Note that the regex will remove ``foo_cluster.`` making the tag extracted
 name ``cluster.upstream_rq_timeout`` and the tag value for
 ``envoy.cluster_name`` will be ``foo_cluster`` (note: there will be no
 ``.`` character because of the second capture group).

 Example 2. a stat name
 ``http.connection_manager_1.user_agent.ios.downstream_cx_total`` and two
 tag specifiers:

 .. code-block:: json

 [
 {
 "tag_name": "envoy.http_user_agent",
 "regex": "^http(?=\\.).*?\\.user_agent\\.((.+?)\\.)\\w+?$"
 },
 {
 "tag_name": "envoy.http_conn_manager_prefix",
 "regex": "^http\\.((.*?)\\.)"
 }
 ]

 The two regexes of the specifiers will be processed from the elaborated
 stat name.

 The first regex will save ``ios.`` as the tag value for ``envoy.http_user_agent``. It will
 leave it in the name for potential matching with additional tag specifiers. After all tag
 specifiers are processed the tags will be removed from the name.

 The second regex will populate tag ``envoy.http_conn_manager_prefix`` with value
 ``connection_manager_1.``, based on the original stat name.

 As a final step, the matched tags are removed, leaving
 ``http.user_agent.downstream_cx_total`` as the tag extracted name.
      string regex = 2 [(.validate.rules) = { ... }
      Specified by:
      hasRegex in interface TagSpecifierOrBuilder
      Returns:
      Whether the regex field is set.

    • getRegex

      public String getRegex()
       Designates a tag to strip from the tag extracted name and provide as a named
 tag value for all statistics. This will only occur if any part of the name
 matches the regex provided with one or more capture groups.

 The first capture group identifies the portion of the name to remove. The
 second capture group (which will normally be nested inside the first) will
 designate the value of the tag for the statistic. If no second capture
 group is provided, the first will also be used to set the value of the tag.
 All other capture groups will be ignored.

 Example 1. a stat name ``cluster.foo_cluster.upstream_rq_timeout`` and
 one tag specifier:

 .. code-block:: json

 {
 "tag_name": "envoy.cluster_name",
 "regex": "^cluster\\.((.+?)\\.)"
 }

 Note that the regex will remove ``foo_cluster.`` making the tag extracted
 name ``cluster.upstream_rq_timeout`` and the tag value for
 ``envoy.cluster_name`` will be ``foo_cluster`` (note: there will be no
 ``.`` character because of the second capture group).

 Example 2. a stat name
 ``http.connection_manager_1.user_agent.ios.downstream_cx_total`` and two
 tag specifiers:

 .. code-block:: json

 [
 {
 "tag_name": "envoy.http_user_agent",
 "regex": "^http(?=\\.).*?\\.user_agent\\.((.+?)\\.)\\w+?$"
 },
 {
 "tag_name": "envoy.http_conn_manager_prefix",
 "regex": "^http\\.((.*?)\\.)"
 }
 ]

 The two regexes of the specifiers will be processed from the elaborated
 stat name.

 The first regex will save ``ios.`` as the tag value for ``envoy.http_user_agent``. It will
 leave it in the name for potential matching with additional tag specifiers. After all tag
 specifiers are processed the tags will be removed from the name.

 The second regex will populate tag ``envoy.http_conn_manager_prefix`` with value
 ``connection_manager_1.``, based on the original stat name.

 As a final step, the matched tags are removed, leaving
 ``http.user_agent.downstream_cx_total`` as the tag extracted name.
      string regex = 2 [(.validate.rules) = { ... }
      Specified by:
      getRegex in interface TagSpecifierOrBuilder
      Returns:
      The regex.

    • getRegexBytes

      public com.google.protobuf.ByteString getRegexBytes()
       Designates a tag to strip from the tag extracted name and provide as a named
 tag value for all statistics. This will only occur if any part of the name
 matches the regex provided with one or more capture groups.

 The first capture group identifies the portion of the name to remove. The
 second capture group (which will normally be nested inside the first) will
 designate the value of the tag for the statistic. If no second capture
 group is provided, the first will also be used to set the value of the tag.
 All other capture groups will be ignored.

 Example 1. a stat name ``cluster.foo_cluster.upstream_rq_timeout`` and
 one tag specifier:

 .. code-block:: json

 {
 "tag_name": "envoy.cluster_name",
 "regex": "^cluster\\.((.+?)\\.)"
 }

 Note that the regex will remove ``foo_cluster.`` making the tag extracted
 name ``cluster.upstream_rq_timeout`` and the tag value for
 ``envoy.cluster_name`` will be ``foo_cluster`` (note: there will be no
 ``.`` character because of the second capture group).

 Example 2. a stat name
 ``http.connection_manager_1.user_agent.ios.downstream_cx_total`` and two
 tag specifiers:

 .. code-block:: json

 [
 {
 "tag_name": "envoy.http_user_agent",
 "regex": "^http(?=\\.).*?\\.user_agent\\.((.+?)\\.)\\w+?$"
 },
 {
 "tag_name": "envoy.http_conn_manager_prefix",
 "regex": "^http\\.((.*?)\\.)"
 }
 ]

 The two regexes of the specifiers will be processed from the elaborated
 stat name.

 The first regex will save ``ios.`` as the tag value for ``envoy.http_user_agent``. It will
 leave it in the name for potential matching with additional tag specifiers. After all tag
 specifiers are processed the tags will be removed from the name.

 The second regex will populate tag ``envoy.http_conn_manager_prefix`` with value
 ``connection_manager_1.``, based on the original stat name.

 As a final step, the matched tags are removed, leaving
 ``http.user_agent.downstream_cx_total`` as the tag extracted name.
      string regex = 2 [(.validate.rules) = { ... }
      Specified by:
      getRegexBytes in interface TagSpecifierOrBuilder
      Returns:
      The bytes for regex.

    • setRegex

      public TagSpecifier.Builder setRegex(String value)
       Designates a tag to strip from the tag extracted name and provide as a named
 tag value for all statistics. This will only occur if any part of the name
 matches the regex provided with one or more capture groups.

 The first capture group identifies the portion of the name to remove. The
 second capture group (which will normally be nested inside the first) will
 designate the value of the tag for the statistic. If no second capture
 group is provided, the first will also be used to set the value of the tag.
 All other capture groups will be ignored.

 Example 1. a stat name ``cluster.foo_cluster.upstream_rq_timeout`` and
 one tag specifier:

 .. code-block:: json

 {
 "tag_name": "envoy.cluster_name",
 "regex": "^cluster\\.((.+?)\\.)"
 }

 Note that the regex will remove ``foo_cluster.`` making the tag extracted
 name ``cluster.upstream_rq_timeout`` and the tag value for
 ``envoy.cluster_name`` will be ``foo_cluster`` (note: there will be no
 ``.`` character because of the second capture group).

 Example 2. a stat name
 ``http.connection_manager_1.user_agent.ios.downstream_cx_total`` and two
 tag specifiers:

 .. code-block:: json

 [
 {
 "tag_name": "envoy.http_user_agent",
 "regex": "^http(?=\\.).*?\\.user_agent\\.((.+?)\\.)\\w+?$"
 },
 {
 "tag_name": "envoy.http_conn_manager_prefix",
 "regex": "^http\\.((.*?)\\.)"
 }
 ]

 The two regexes of the specifiers will be processed from the elaborated
 stat name.

 The first regex will save ``ios.`` as the tag value for ``envoy.http_user_agent``. It will
 leave it in the name for potential matching with additional tag specifiers. After all tag
 specifiers are processed the tags will be removed from the name.

 The second regex will populate tag ``envoy.http_conn_manager_prefix`` with value
 ``connection_manager_1.``, based on the original stat name.

 As a final step, the matched tags are removed, leaving
 ``http.user_agent.downstream_cx_total`` as the tag extracted name.
      string regex = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The regex to set.
      Returns:
      This builder for chaining.

    • clearRegex

      public TagSpecifier.Builder clearRegex()
       Designates a tag to strip from the tag extracted name and provide as a named
 tag value for all statistics. This will only occur if any part of the name
 matches the regex provided with one or more capture groups.

 The first capture group identifies the portion of the name to remove. The
 second capture group (which will normally be nested inside the first) will
 designate the value of the tag for the statistic. If no second capture
 group is provided, the first will also be used to set the value of the tag.
 All other capture groups will be ignored.

 Example 1. a stat name ``cluster.foo_cluster.upstream_rq_timeout`` and
 one tag specifier:

 .. code-block:: json

 {
 "tag_name": "envoy.cluster_name",
 "regex": "^cluster\\.((.+?)\\.)"
 }

 Note that the regex will remove ``foo_cluster.`` making the tag extracted
 name ``cluster.upstream_rq_timeout`` and the tag value for
 ``envoy.cluster_name`` will be ``foo_cluster`` (note: there will be no
 ``.`` character because of the second capture group).

 Example 2. a stat name
 ``http.connection_manager_1.user_agent.ios.downstream_cx_total`` and two
 tag specifiers:

 .. code-block:: json

 [
 {
 "tag_name": "envoy.http_user_agent",
 "regex": "^http(?=\\.).*?\\.user_agent\\.((.+?)\\.)\\w+?$"
 },
 {
 "tag_name": "envoy.http_conn_manager_prefix",
 "regex": "^http\\.((.*?)\\.)"
 }
 ]

 The two regexes of the specifiers will be processed from the elaborated
 stat name.

 The first regex will save ``ios.`` as the tag value for ``envoy.http_user_agent``. It will
 leave it in the name for potential matching with additional tag specifiers. After all tag
 specifiers are processed the tags will be removed from the name.

 The second regex will populate tag ``envoy.http_conn_manager_prefix`` with value
 ``connection_manager_1.``, based on the original stat name.

 As a final step, the matched tags are removed, leaving
 ``http.user_agent.downstream_cx_total`` as the tag extracted name.
      string regex = 2 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setRegexBytes

      public TagSpecifier.Builder setRegexBytes(com.google.protobuf.ByteString value)
       Designates a tag to strip from the tag extracted name and provide as a named
 tag value for all statistics. This will only occur if any part of the name
 matches the regex provided with one or more capture groups.

 The first capture group identifies the portion of the name to remove. The
 second capture group (which will normally be nested inside the first) will
 designate the value of the tag for the statistic. If no second capture
 group is provided, the first will also be used to set the value of the tag.
 All other capture groups will be ignored.

 Example 1. a stat name ``cluster.foo_cluster.upstream_rq_timeout`` and
 one tag specifier:

 .. code-block:: json

 {
 "tag_name": "envoy.cluster_name",
 "regex": "^cluster\\.((.+?)\\.)"
 }

 Note that the regex will remove ``foo_cluster.`` making the tag extracted
 name ``cluster.upstream_rq_timeout`` and the tag value for
 ``envoy.cluster_name`` will be ``foo_cluster`` (note: there will be no
 ``.`` character because of the second capture group).

 Example 2. a stat name
 ``http.connection_manager_1.user_agent.ios.downstream_cx_total`` and two
 tag specifiers:

 .. code-block:: json

 [
 {
 "tag_name": "envoy.http_user_agent",
 "regex": "^http(?=\\.).*?\\.user_agent\\.((.+?)\\.)\\w+?$"
 },
 {
 "tag_name": "envoy.http_conn_manager_prefix",
 "regex": "^http\\.((.*?)\\.)"
 }
 ]

 The two regexes of the specifiers will be processed from the elaborated
 stat name.

 The first regex will save ``ios.`` as the tag value for ``envoy.http_user_agent``. It will
 leave it in the name for potential matching with additional tag specifiers. After all tag
 specifiers are processed the tags will be removed from the name.

 The second regex will populate tag ``envoy.http_conn_manager_prefix`` with value
 ``connection_manager_1.``, based on the original stat name.

 As a final step, the matched tags are removed, leaving
 ``http.user_agent.downstream_cx_total`` as the tag extracted name.
      string regex = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for regex to set.
      Returns:
      This builder for chaining.

    • hasFixedValue

      public boolean hasFixedValue()
       Specifies a fixed tag value for the ``tag_name``.
      string fixed_value = 3;
      Specified by:
      hasFixedValue in interface TagSpecifierOrBuilder
      Returns:
      Whether the fixedValue field is set.

    • getFixedValue

      public String getFixedValue()
       Specifies a fixed tag value for the ``tag_name``.
      string fixed_value = 3;
      Specified by:
      getFixedValue in interface TagSpecifierOrBuilder
      Returns:
      The fixedValue.

    • getFixedValueBytes

      public com.google.protobuf.ByteString getFixedValueBytes()
       Specifies a fixed tag value for the ``tag_name``.
      string fixed_value = 3;
      Specified by:
      getFixedValueBytes in interface TagSpecifierOrBuilder
      Returns:
      The bytes for fixedValue.

    • setFixedValue

      public TagSpecifier.Builder setFixedValue(String value)
       Specifies a fixed tag value for the ``tag_name``.
      string fixed_value = 3;
      Parameters:
      value - The fixedValue to set.
      Returns:
      This builder for chaining.

    • clearFixedValue

      public TagSpecifier.Builder clearFixedValue()
       Specifies a fixed tag value for the ``tag_name``.
      string fixed_value = 3;
      Returns:
      This builder for chaining.

    • setFixedValueBytes

      public TagSpecifier.Builder setFixedValueBytes(com.google.protobuf.ByteString value)
       Specifies a fixed tag value for the ``tag_name``.
      string fixed_value = 3;
      Parameters:
      value - The bytes for fixedValue to set.
      Returns:
      This builder for chaining.