Class TrackClusterStats.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<TrackClusterStats.Builder>
com.google.protobuf.GeneratedMessage.Builder<TrackClusterStats.Builder>
io.envoyproxy.envoy.config.cluster.v3.TrackClusterStats.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TrackClusterStatsOrBuilder, Cloneable
Enclosing class:
TrackClusterStats
public static final class TrackClusterStats.Builder extends com.google.protobuf.GeneratedMessage.Builder<TrackClusterStats.Builder> implements TrackClusterStatsOrBuilder
Protobuf type envoy.config.cluster.v3.TrackClusterStats

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private int
    bitField0_
     
    private boolean
    perEndpointStats_
     
    private boolean
    requestResponseSizes_
     
    private boolean
    timeoutBudgets_
     

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    TrackClusterStats
    build()
     
    TrackClusterStats
    buildPartial()
     
    private void
    buildPartial0(TrackClusterStats result)
     
    TrackClusterStats.Builder
    clear()
     
    TrackClusterStats.Builder
    clearPerEndpointStats()
    If true, some stats will be emitted per-endpoint, similar to the stats in admin ``/clusters`` output.
    TrackClusterStats.Builder
    clearRequestResponseSizes()
    If request_response_sizes is true, then the :ref:`histograms <config_cluster_manager_cluster_stats_request_response_sizes>` tracking header and body sizes of requests and responses will be published.
    TrackClusterStats.Builder
    clearTimeoutBudgets()
    If timeout_budgets is true, the :ref:`timeout budget histograms <config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each request.
    TrackClusterStats
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    boolean
    getPerEndpointStats()
    If true, some stats will be emitted per-endpoint, similar to the stats in admin ``/clusters`` output.
    boolean
    getRequestResponseSizes()
    If request_response_sizes is true, then the :ref:`histograms <config_cluster_manager_cluster_stats_request_response_sizes>` tracking header and body sizes of requests and responses will be published.
    boolean
    getTimeoutBudgets()
    If timeout_budgets is true, the :ref:`timeout budget histograms <config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each request.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    TrackClusterStats.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    TrackClusterStats.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    TrackClusterStats.Builder
    mergeFrom(TrackClusterStats other)
     
    TrackClusterStats.Builder
    setPerEndpointStats(boolean value)
    If true, some stats will be emitted per-endpoint, similar to the stats in admin ``/clusters`` output.
    TrackClusterStats.Builder
    setRequestResponseSizes(boolean value)
    If request_response_sizes is true, then the :ref:`histograms <config_cluster_manager_cluster_stats_request_response_sizes>` tracking header and body sizes of requests and responses will be published.
    TrackClusterStats.Builder
    setTimeoutBudgets(boolean value)
    If timeout_budgets is true, the :ref:`timeout budget histograms <config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each request.

    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 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

    • bitField0_

      private int bitField0_

    • timeoutBudgets_

      private boolean timeoutBudgets_

    • requestResponseSizes_

      private boolean requestResponseSizes_

    • perEndpointStats_

      private boolean perEndpointStats_

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

      public TrackClusterStats 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(TrackClusterStats result)

    • mergeFrom

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

    • mergeFrom

      public TrackClusterStats.Builder mergeFrom(TrackClusterStats other)

    • isInitialized

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

    • mergeFrom

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

    • getTimeoutBudgets

      public boolean getTimeoutBudgets()
      If timeout_budgets is true, the :ref:`timeout budget histograms
<config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each
request. These show what percentage of a request's per try and global timeout was used. A value
of 0 would indicate that none of the timeout was used or that the timeout was infinite. A value
of 100 would indicate that the request took the entirety of the timeout given to it.
      bool timeout_budgets = 1;
      Specified by:
      getTimeoutBudgets in interface TrackClusterStatsOrBuilder
      Returns:
      The timeoutBudgets.

    • setTimeoutBudgets

      public TrackClusterStats.Builder setTimeoutBudgets(boolean value)
      If timeout_budgets is true, the :ref:`timeout budget histograms
<config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each
request. These show what percentage of a request's per try and global timeout was used. A value
of 0 would indicate that none of the timeout was used or that the timeout was infinite. A value
of 100 would indicate that the request took the entirety of the timeout given to it.
      bool timeout_budgets = 1;
      Parameters:
      value - The timeoutBudgets to set.
      Returns:
      This builder for chaining.

    • clearTimeoutBudgets

      public TrackClusterStats.Builder clearTimeoutBudgets()
      If timeout_budgets is true, the :ref:`timeout budget histograms
<config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each
request. These show what percentage of a request's per try and global timeout was used. A value
of 0 would indicate that none of the timeout was used or that the timeout was infinite. A value
of 100 would indicate that the request took the entirety of the timeout given to it.
      bool timeout_budgets = 1;
      Returns:
      This builder for chaining.

    • getRequestResponseSizes

      public boolean getRequestResponseSizes()
      If request_response_sizes is true, then the :ref:`histograms
<config_cluster_manager_cluster_stats_request_response_sizes>`  tracking header and body sizes
of requests and responses will be published.
      bool request_response_sizes = 2;
      Specified by:
      getRequestResponseSizes in interface TrackClusterStatsOrBuilder
      Returns:
      The requestResponseSizes.

    • setRequestResponseSizes

      public TrackClusterStats.Builder setRequestResponseSizes(boolean value)
      If request_response_sizes is true, then the :ref:`histograms
<config_cluster_manager_cluster_stats_request_response_sizes>`  tracking header and body sizes
of requests and responses will be published.
      bool request_response_sizes = 2;
      Parameters:
      value - The requestResponseSizes to set.
      Returns:
      This builder for chaining.

    • clearRequestResponseSizes

      public TrackClusterStats.Builder clearRequestResponseSizes()
      If request_response_sizes is true, then the :ref:`histograms
<config_cluster_manager_cluster_stats_request_response_sizes>`  tracking header and body sizes
of requests and responses will be published.
      bool request_response_sizes = 2;
      Returns:
      This builder for chaining.

    • getPerEndpointStats

      public boolean getPerEndpointStats()
      If true, some stats will be emitted per-endpoint, similar to the stats in admin ``/clusters``
output.

This does not currently output correct stats during a hot-restart.

This is not currently implemented by all stat sinks.

These stats do not honor filtering or tag extraction rules in :ref:`StatsConfig
<envoy_v3_api_msg_config.metrics.v3.StatsConfig>` (but fixed-value tags are supported). Admin
endpoint filtering is supported.

This may not be used at the same time as
:ref:`load_stats_config <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.load_stats_config>`.
      bool per_endpoint_stats = 3;
      Specified by:
      getPerEndpointStats in interface TrackClusterStatsOrBuilder
      Returns:
      The perEndpointStats.

    • setPerEndpointStats

      public TrackClusterStats.Builder setPerEndpointStats(boolean value)
      If true, some stats will be emitted per-endpoint, similar to the stats in admin ``/clusters``
output.

This does not currently output correct stats during a hot-restart.

This is not currently implemented by all stat sinks.

These stats do not honor filtering or tag extraction rules in :ref:`StatsConfig
<envoy_v3_api_msg_config.metrics.v3.StatsConfig>` (but fixed-value tags are supported). Admin
endpoint filtering is supported.

This may not be used at the same time as
:ref:`load_stats_config <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.load_stats_config>`.
      bool per_endpoint_stats = 3;
      Parameters:
      value - The perEndpointStats to set.
      Returns:
      This builder for chaining.

    • clearPerEndpointStats

      public TrackClusterStats.Builder clearPerEndpointStats()
      If true, some stats will be emitted per-endpoint, similar to the stats in admin ``/clusters``
output.

This does not currently output correct stats during a hot-restart.

This is not currently implemented by all stat sinks.

These stats do not honor filtering or tag extraction rules in :ref:`StatsConfig
<envoy_v3_api_msg_config.metrics.v3.StatsConfig>` (but fixed-value tags are supported). Admin
endpoint filtering is supported.

This may not be used at the same time as
:ref:`load_stats_config <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.load_stats_config>`.
      bool per_endpoint_stats = 3;
      Returns:
      This builder for chaining.