Class TimeSeriesFilter.Builder (2.5.4)

Stay organized with collections Save and categorize content based on your preferences.
public static final class TimeSeriesFilter.Builder extends GeneratedMessageV3.Builder<TimeSeriesFilter.Builder> implements TimeSeriesFilterOrBuilder

A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries method.

Protobuf type google.monitoring.dashboard.v1.TimeSeriesFilter

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TimeSeriesFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TimeSeriesFilter.Builder
Overrides

build()

public TimeSeriesFilter build()
Returns
TypeDescription
TimeSeriesFilter

buildPartial()

public TimeSeriesFilter buildPartial()
Returns
TypeDescription
TimeSeriesFilter

clear()

public TimeSeriesFilter.Builder clear()
Returns
TypeDescription
TimeSeriesFilter.Builder
Overrides

clearAggregation()

public TimeSeriesFilter.Builder clearAggregation()

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

.google.monitoring.dashboard.v1.Aggregation aggregation = 2;

Returns
TypeDescription
TimeSeriesFilter.Builder

clearField(Descriptors.FieldDescriptor field)

public TimeSeriesFilter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TimeSeriesFilter.Builder
Overrides

clearFilter()

public TimeSeriesFilter.Builder clearFilter()

Required. The monitoring filter that identifies the metric types, resources, and projects to query.

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TimeSeriesFilter.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TimeSeriesFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
TimeSeriesFilter.Builder
Overrides

clearOutputFilter()

public TimeSeriesFilter.Builder clearOutputFilter()
Returns
TypeDescription
TimeSeriesFilter.Builder

clearPickTimeSeriesFilter()

public TimeSeriesFilter.Builder clearPickTimeSeriesFilter()

Ranking based time series filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;

Returns
TypeDescription
TimeSeriesFilter.Builder

clearSecondaryAggregation()

public TimeSeriesFilter.Builder clearSecondaryAggregation()

Apply a second aggregation after aggregation is applied.

.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;

Returns
TypeDescription
TimeSeriesFilter.Builder

clearStatisticalTimeSeriesFilter()

public TimeSeriesFilter.Builder clearStatisticalTimeSeriesFilter()

Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.

.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true];

Returns
TypeDescription
TimeSeriesFilter.Builder

clone()

public TimeSeriesFilter.Builder clone()
Returns
TypeDescription
TimeSeriesFilter.Builder
Overrides

getAggregation()

public Aggregation getAggregation()

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

.google.monitoring.dashboard.v1.Aggregation aggregation = 2;

Returns
TypeDescription
Aggregation

The aggregation.

getAggregationBuilder()

public Aggregation.Builder getAggregationBuilder()

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

.google.monitoring.dashboard.v1.Aggregation aggregation = 2;

Returns
TypeDescription
Aggregation.Builder

getAggregationOrBuilder()

public AggregationOrBuilder getAggregationOrBuilder()

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

.google.monitoring.dashboard.v1.Aggregation aggregation = 2;

Returns
TypeDescription
AggregationOrBuilder

getDefaultInstanceForType()

public TimeSeriesFilter getDefaultInstanceForType()
Returns
TypeDescription
TimeSeriesFilter

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

Required. The monitoring filter that identifies the metric types, resources, and projects to query.

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Required. The monitoring filter that identifies the metric types, resources, and projects to query.

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for filter.

getOutputFilterCase()

public TimeSeriesFilter.OutputFilterCase getOutputFilterCase()
Returns
TypeDescription
TimeSeriesFilter.OutputFilterCase

getPickTimeSeriesFilter()

public PickTimeSeriesFilter getPickTimeSeriesFilter()

Ranking based time series filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;

Returns
TypeDescription
PickTimeSeriesFilter

The pickTimeSeriesFilter.

getPickTimeSeriesFilterBuilder()

public PickTimeSeriesFilter.Builder getPickTimeSeriesFilterBuilder()

Ranking based time series filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;

Returns
TypeDescription
PickTimeSeriesFilter.Builder

getPickTimeSeriesFilterOrBuilder()

public PickTimeSeriesFilterOrBuilder getPickTimeSeriesFilterOrBuilder()

Ranking based time series filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;

Returns
TypeDescription
PickTimeSeriesFilterOrBuilder

getSecondaryAggregation()

public Aggregation getSecondaryAggregation()

Apply a second aggregation after aggregation is applied.

.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;

Returns
TypeDescription
Aggregation

The secondaryAggregation.

getSecondaryAggregationBuilder()

public Aggregation.Builder getSecondaryAggregationBuilder()

Apply a second aggregation after aggregation is applied.

.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;

Returns
TypeDescription
Aggregation.Builder

getSecondaryAggregationOrBuilder()

public AggregationOrBuilder getSecondaryAggregationOrBuilder()

Apply a second aggregation after aggregation is applied.

.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;

Returns
TypeDescription
AggregationOrBuilder

getStatisticalTimeSeriesFilter() (deprecated)

public StatisticalTimeSeriesFilter getStatisticalTimeSeriesFilter()

Deprecated. google.monitoring.dashboard.v1.TimeSeriesFilter.statistical_time_series_filter is deprecated. See google/monitoring/dashboard/v1/metrics.proto;l=76

Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.

.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true];

Returns
TypeDescription
StatisticalTimeSeriesFilter

The statisticalTimeSeriesFilter.

getStatisticalTimeSeriesFilterBuilder()

public StatisticalTimeSeriesFilter.Builder getStatisticalTimeSeriesFilterBuilder()

Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.

.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true];

Returns
TypeDescription
StatisticalTimeSeriesFilter.Builder

getStatisticalTimeSeriesFilterOrBuilder()

public StatisticalTimeSeriesFilterOrBuilder getStatisticalTimeSeriesFilterOrBuilder()

Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.

.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true];

Returns
TypeDescription
StatisticalTimeSeriesFilterOrBuilder

hasAggregation()

public boolean hasAggregation()

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

.google.monitoring.dashboard.v1.Aggregation aggregation = 2;

Returns
TypeDescription
boolean

Whether the aggregation field is set.

hasPickTimeSeriesFilter()

public boolean hasPickTimeSeriesFilter()

Ranking based time series filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;

Returns
TypeDescription
boolean

Whether the pickTimeSeriesFilter field is set.

hasSecondaryAggregation()

public boolean hasSecondaryAggregation()

Apply a second aggregation after aggregation is applied.

.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;

Returns
TypeDescription
boolean

Whether the secondaryAggregation field is set.

hasStatisticalTimeSeriesFilter() (deprecated)

public boolean hasStatisticalTimeSeriesFilter()

Deprecated. google.monitoring.dashboard.v1.TimeSeriesFilter.statistical_time_series_filter is deprecated. See google/monitoring/dashboard/v1/metrics.proto;l=76

Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.

.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true];

Returns
TypeDescription
boolean

Whether the statisticalTimeSeriesFilter field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAggregation(Aggregation value)

public TimeSeriesFilter.Builder mergeAggregation(Aggregation value)

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

.google.monitoring.dashboard.v1.Aggregation aggregation = 2;

Parameter
NameDescription
valueAggregation
Returns
TypeDescription
TimeSeriesFilter.Builder

mergeFrom(TimeSeriesFilter other)

public TimeSeriesFilter.Builder mergeFrom(TimeSeriesFilter other)
Parameter
NameDescription
otherTimeSeriesFilter
Returns
TypeDescription
TimeSeriesFilter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TimeSeriesFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeSeriesFilter.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public TimeSeriesFilter.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
TimeSeriesFilter.Builder
Overrides

mergePickTimeSeriesFilter(PickTimeSeriesFilter value)

public TimeSeriesFilter.Builder mergePickTimeSeriesFilter(PickTimeSeriesFilter value)

Ranking based time series filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;

Parameter
NameDescription
valuePickTimeSeriesFilter
Returns
TypeDescription
TimeSeriesFilter.Builder

mergeSecondaryAggregation(Aggregation value)

public TimeSeriesFilter.Builder mergeSecondaryAggregation(Aggregation value)

Apply a second aggregation after aggregation is applied.

.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;

Parameter
NameDescription
valueAggregation
Returns
TypeDescription
TimeSeriesFilter.Builder

mergeStatisticalTimeSeriesFilter(StatisticalTimeSeriesFilter value)

public TimeSeriesFilter.Builder mergeStatisticalTimeSeriesFilter(StatisticalTimeSeriesFilter value)

Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.

.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true];

Parameter
NameDescription
valueStatisticalTimeSeriesFilter
Returns
TypeDescription
TimeSeriesFilter.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TimeSeriesFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TimeSeriesFilter.Builder
Overrides

setAggregation(Aggregation value)

public TimeSeriesFilter.Builder setAggregation(Aggregation value)

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

.google.monitoring.dashboard.v1.Aggregation aggregation = 2;

Parameter
NameDescription
valueAggregation
Returns
TypeDescription
TimeSeriesFilter.Builder

setAggregation(Aggregation.Builder builderForValue)

public TimeSeriesFilter.Builder setAggregation(Aggregation.Builder builderForValue)

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

.google.monitoring.dashboard.v1.Aggregation aggregation = 2;

Parameter
NameDescription
builderForValueAggregation.Builder
Returns
TypeDescription
TimeSeriesFilter.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public TimeSeriesFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TimeSeriesFilter.Builder
Overrides

setFilter(String value)

public TimeSeriesFilter.Builder setFilter(String value)

Required. The monitoring filter that identifies the metric types, resources, and projects to query.

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
TimeSeriesFilter.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public TimeSeriesFilter.Builder setFilterBytes(ByteString value)

Required. The monitoring filter that identifies the metric types, resources, and projects to query.

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
TimeSeriesFilter.Builder

This builder for chaining.

setPickTimeSeriesFilter(PickTimeSeriesFilter value)

public TimeSeriesFilter.Builder setPickTimeSeriesFilter(PickTimeSeriesFilter value)

Ranking based time series filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;

Parameter
NameDescription
valuePickTimeSeriesFilter
Returns
TypeDescription
TimeSeriesFilter.Builder

setPickTimeSeriesFilter(PickTimeSeriesFilter.Builder builderForValue)

public TimeSeriesFilter.Builder setPickTimeSeriesFilter(PickTimeSeriesFilter.Builder builderForValue)

Ranking based time series filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;

Parameter
NameDescription
builderForValuePickTimeSeriesFilter.Builder
Returns
TypeDescription
TimeSeriesFilter.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TimeSeriesFilter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
TimeSeriesFilter.Builder
Overrides

setSecondaryAggregation(Aggregation value)

public TimeSeriesFilter.Builder setSecondaryAggregation(Aggregation value)

Apply a second aggregation after aggregation is applied.

.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;

Parameter
NameDescription
valueAggregation
Returns
TypeDescription
TimeSeriesFilter.Builder

setSecondaryAggregation(Aggregation.Builder builderForValue)

public TimeSeriesFilter.Builder setSecondaryAggregation(Aggregation.Builder builderForValue)

Apply a second aggregation after aggregation is applied.

.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;

Parameter
NameDescription
builderForValueAggregation.Builder
Returns
TypeDescription
TimeSeriesFilter.Builder

setStatisticalTimeSeriesFilter(StatisticalTimeSeriesFilter value)

public TimeSeriesFilter.Builder setStatisticalTimeSeriesFilter(StatisticalTimeSeriesFilter value)

Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.

.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true];

Parameter
NameDescription
valueStatisticalTimeSeriesFilter
Returns
TypeDescription
TimeSeriesFilter.Builder

setStatisticalTimeSeriesFilter(StatisticalTimeSeriesFilter.Builder builderForValue)

public TimeSeriesFilter.Builder setStatisticalTimeSeriesFilter(StatisticalTimeSeriesFilter.Builder builderForValue)

Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.

.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true];

Parameter
NameDescription
builderForValueStatisticalTimeSeriesFilter.Builder
Returns
TypeDescription
TimeSeriesFilter.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final TimeSeriesFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TimeSeriesFilter.Builder
Overrides