Package io.opencensus.proto.stats.v1
Interface ViewOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
View,View.Builder
public interface ViewOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description View.AggregationCasegetAggregationCase()StringgetColumns(int index)An array of tag keys.com.google.protobuf.ByteStringgetColumnsBytes(int index)An array of tag keys.intgetColumnsCount()An array of tag keys.List<String>getColumnsList()An array of tag keys.CountAggregationgetCountAggregation()Counts the number of measurements recorded.CountAggregationOrBuildergetCountAggregationOrBuilder()Counts the number of measurements recorded.StringgetDescription()Describes the view, e.g.com.google.protobuf.ByteStringgetDescriptionBytes()Describes the view, e.g.DistributionAggregationgetDistributionAggregation()Indicates that the desired Aggregation is a histogram distribution.DistributionAggregationOrBuildergetDistributionAggregationOrBuilder()Indicates that the desired Aggregation is a histogram distribution.LastValueAggregationgetLastValueAggregation()Indicates that data collected and aggregated with this Aggregation will represent the last recorded value.LastValueAggregationOrBuildergetLastValueAggregationOrBuilder()Indicates that data collected and aggregated with this Aggregation will represent the last recorded value.MeasuregetMeasure()The Measure to which this view is applied.MeasureOrBuildergetMeasureOrBuilder()The Measure to which this view is applied.StringgetName()A string by which the View will be referred to, e.g.com.google.protobuf.ByteStringgetNameBytes()A string by which the View will be referred to, e.g.SumAggregationgetSumAggregation()Indicates that data collected and aggregated with this Aggregation will be summed up.SumAggregationOrBuildergetSumAggregationOrBuilder()Indicates that data collected and aggregated with this Aggregation will be summed up.booleanhasCountAggregation()Counts the number of measurements recorded.booleanhasDistributionAggregation()Indicates that the desired Aggregation is a histogram distribution.booleanhasLastValueAggregation()Indicates that data collected and aggregated with this Aggregation will represent the last recorded value.booleanhasMeasure()The Measure to which this view is applied.booleanhasSumAggregation()Indicates that data collected and aggregated with this Aggregation will be summed up.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getName
String getName()
A string by which the View will be referred to, e.g. "rpc_latency". Names MUST be unique within the library.
string name = 1;- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()
A string by which the View will be referred to, e.g. "rpc_latency". Names MUST be unique within the library.
string name = 1;- Returns:
- The bytes for name.
-
getDescription
String getDescription()
Describes the view, e.g. "RPC latency distribution"
string description = 2;- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()
Describes the view, e.g. "RPC latency distribution"
string description = 2;- Returns:
- The bytes for description.
-
hasMeasure
boolean hasMeasure()
The Measure to which this view is applied.
.opencensus.proto.stats.v1.Measure measure = 3;- Returns:
- Whether the measure field is set.
-
getMeasure
Measure getMeasure()
The Measure to which this view is applied.
.opencensus.proto.stats.v1.Measure measure = 3;- Returns:
- The measure.
-
getMeasureOrBuilder
MeasureOrBuilder getMeasureOrBuilder()
The Measure to which this view is applied.
.opencensus.proto.stats.v1.Measure measure = 3;
-
getColumnsList
List<String> getColumnsList()
An array of tag keys. These values associated with tags of this name form the basis by which individual stats will be aggregated (one aggregation per unique tag value). If none are provided, then all data is recorded in a single aggregation.
repeated string columns = 4;- Returns:
- A list containing the columns.
-
getColumnsCount
int getColumnsCount()
An array of tag keys. These values associated with tags of this name form the basis by which individual stats will be aggregated (one aggregation per unique tag value). If none are provided, then all data is recorded in a single aggregation.
repeated string columns = 4;- Returns:
- The count of columns.
-
getColumns
String getColumns(int index)
An array of tag keys. These values associated with tags of this name form the basis by which individual stats will be aggregated (one aggregation per unique tag value). If none are provided, then all data is recorded in a single aggregation.
repeated string columns = 4;- Parameters:
index- The index of the element to return.- Returns:
- The columns at the given index.
-
getColumnsBytes
com.google.protobuf.ByteString getColumnsBytes(int index)
An array of tag keys. These values associated with tags of this name form the basis by which individual stats will be aggregated (one aggregation per unique tag value). If none are provided, then all data is recorded in a single aggregation.
repeated string columns = 4;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the columns at the given index.
-
hasCountAggregation
boolean hasCountAggregation()
Counts the number of measurements recorded.
.opencensus.proto.stats.v1.CountAggregation count_aggregation = 5;- Returns:
- Whether the countAggregation field is set.
-
getCountAggregation
CountAggregation getCountAggregation()
Counts the number of measurements recorded.
.opencensus.proto.stats.v1.CountAggregation count_aggregation = 5;- Returns:
- The countAggregation.
-
getCountAggregationOrBuilder
CountAggregationOrBuilder getCountAggregationOrBuilder()
Counts the number of measurements recorded.
.opencensus.proto.stats.v1.CountAggregation count_aggregation = 5;
-
hasSumAggregation
boolean hasSumAggregation()
Indicates that data collected and aggregated with this Aggregation will be summed up.
.opencensus.proto.stats.v1.SumAggregation sum_aggregation = 6;- Returns:
- Whether the sumAggregation field is set.
-
getSumAggregation
SumAggregation getSumAggregation()
Indicates that data collected and aggregated with this Aggregation will be summed up.
.opencensus.proto.stats.v1.SumAggregation sum_aggregation = 6;- Returns:
- The sumAggregation.
-
getSumAggregationOrBuilder
SumAggregationOrBuilder getSumAggregationOrBuilder()
Indicates that data collected and aggregated with this Aggregation will be summed up.
.opencensus.proto.stats.v1.SumAggregation sum_aggregation = 6;
-
hasLastValueAggregation
boolean hasLastValueAggregation()
Indicates that data collected and aggregated with this Aggregation will represent the last recorded value. This is useful to support Gauges.
.opencensus.proto.stats.v1.LastValueAggregation last_value_aggregation = 7;- Returns:
- Whether the lastValueAggregation field is set.
-
getLastValueAggregation
LastValueAggregation getLastValueAggregation()
Indicates that data collected and aggregated with this Aggregation will represent the last recorded value. This is useful to support Gauges.
.opencensus.proto.stats.v1.LastValueAggregation last_value_aggregation = 7;- Returns:
- The lastValueAggregation.
-
getLastValueAggregationOrBuilder
LastValueAggregationOrBuilder getLastValueAggregationOrBuilder()
Indicates that data collected and aggregated with this Aggregation will represent the last recorded value. This is useful to support Gauges.
.opencensus.proto.stats.v1.LastValueAggregation last_value_aggregation = 7;
-
hasDistributionAggregation
boolean hasDistributionAggregation()
Indicates that the desired Aggregation is a histogram distribution. A distribution Aggregation may contain a histogram of the values in the population. User should define the bucket boundaries for that histogram (see DistributionAggregation).
.opencensus.proto.stats.v1.DistributionAggregation distribution_aggregation = 8;- Returns:
- Whether the distributionAggregation field is set.
-
getDistributionAggregation
DistributionAggregation getDistributionAggregation()
Indicates that the desired Aggregation is a histogram distribution. A distribution Aggregation may contain a histogram of the values in the population. User should define the bucket boundaries for that histogram (see DistributionAggregation).
.opencensus.proto.stats.v1.DistributionAggregation distribution_aggregation = 8;- Returns:
- The distributionAggregation.
-
getDistributionAggregationOrBuilder
DistributionAggregationOrBuilder getDistributionAggregationOrBuilder()
Indicates that the desired Aggregation is a histogram distribution. A distribution Aggregation may contain a histogram of the values in the population. User should define the bucket boundaries for that histogram (see DistributionAggregation).
.opencensus.proto.stats.v1.DistributionAggregation distribution_aggregation = 8;
-
getAggregationCase
View.AggregationCase getAggregationCase()
-
-