public final class TimeSeriesFilter extends GeneratedMessageV3 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 Fields
AGGREGATION_FIELD_NUMBER
public static final int AGGREGATION_FIELD_NUMBER
Field Value
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
PICK_TIME_SERIES_FILTER_FIELD_NUMBER
public static final int PICK_TIME_SERIES_FILTER_FIELD_NUMBER
Field Value
SECONDARY_AGGREGATION_FIELD_NUMBER
public static final int SECONDARY_AGGREGATION_FIELD_NUMBER
Field Value
STATISTICAL_TIME_SERIES_FILTER_FIELD_NUMBER
public static final int STATISTICAL_TIME_SERIES_FILTER_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TimeSeriesFilter getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TimeSeriesFilter.Builder newBuilder()
Returns
newBuilder(TimeSeriesFilter prototype)
public static TimeSeriesFilter.Builder newBuilder(TimeSeriesFilter prototype)
Parameter
Returns
public static TimeSeriesFilter parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TimeSeriesFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TimeSeriesFilter parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TimeSeriesFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TimeSeriesFilter parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TimeSeriesFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TimeSeriesFilter parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TimeSeriesFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TimeSeriesFilter parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TimeSeriesFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TimeSeriesFilter parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TimeSeriesFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TimeSeriesFilter> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
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;
getDefaultInstanceForType()
public TimeSeriesFilter getDefaultInstanceForType()
Returns
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];
| Type | Description |
| 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];
getOutputFilterCase()
public TimeSeriesFilter.OutputFilterCase getOutputFilterCase()
Returns
getParserForType()
public Parser<TimeSeriesFilter> getParserForType()
Returns
Overrides
getPickTimeSeriesFilter()
public PickTimeSeriesFilter getPickTimeSeriesFilter()
Ranking based time series filter.
.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;
getPickTimeSeriesFilterOrBuilder()
public PickTimeSeriesFilterOrBuilder getPickTimeSeriesFilterOrBuilder()
Ranking based time series filter.
.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;
getSecondaryAggregation()
public Aggregation getSecondaryAggregation()
Apply a second aggregation after aggregation is applied.
.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;
getSecondaryAggregationOrBuilder()
public AggregationOrBuilder getSecondaryAggregationOrBuilder()
Apply a second aggregation after aggregation is applied.
.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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=79
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];
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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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=79
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];
| Type | Description |
| boolean | Whether the statisticalTimeSeriesFilter field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TimeSeriesFilter.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TimeSeriesFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TimeSeriesFilter.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
