1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/monitoring/dashboard/v1/metrics.proto 18 19 package com.google.monitoring.dashboard.v1; 20 21 public interface TimeSeriesFilterOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.monitoring.dashboard.v1.TimeSeriesFilter) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The [monitoring 31 * filter](https://cloud.google.com/monitoring/api/v3/filters) that identifies 32 * the metric types, resources, and projects to query. 33 * </pre> 34 * 35 * <code>string filter = 1 [(.google.api.field_behavior) = REQUIRED];</code> 36 * 37 * @return The filter. 38 */ getFilter()39 java.lang.String getFilter(); 40 /** 41 * 42 * 43 * <pre> 44 * Required. The [monitoring 45 * filter](https://cloud.google.com/monitoring/api/v3/filters) that identifies 46 * the metric types, resources, and projects to query. 47 * </pre> 48 * 49 * <code>string filter = 1 [(.google.api.field_behavior) = REQUIRED];</code> 50 * 51 * @return The bytes for filter. 52 */ getFilterBytes()53 com.google.protobuf.ByteString getFilterBytes(); 54 55 /** 56 * 57 * 58 * <pre> 59 * By default, the raw time series data is returned. 60 * Use this field to combine multiple time series for different views of the 61 * data. 62 * </pre> 63 * 64 * <code>.google.monitoring.dashboard.v1.Aggregation aggregation = 2;</code> 65 * 66 * @return Whether the aggregation field is set. 67 */ hasAggregation()68 boolean hasAggregation(); 69 /** 70 * 71 * 72 * <pre> 73 * By default, the raw time series data is returned. 74 * Use this field to combine multiple time series for different views of the 75 * data. 76 * </pre> 77 * 78 * <code>.google.monitoring.dashboard.v1.Aggregation aggregation = 2;</code> 79 * 80 * @return The aggregation. 81 */ getAggregation()82 com.google.monitoring.dashboard.v1.Aggregation getAggregation(); 83 /** 84 * 85 * 86 * <pre> 87 * By default, the raw time series data is returned. 88 * Use this field to combine multiple time series for different views of the 89 * data. 90 * </pre> 91 * 92 * <code>.google.monitoring.dashboard.v1.Aggregation aggregation = 2;</code> 93 */ getAggregationOrBuilder()94 com.google.monitoring.dashboard.v1.AggregationOrBuilder getAggregationOrBuilder(); 95 96 /** 97 * 98 * 99 * <pre> 100 * Apply a second aggregation after `aggregation` is applied. 101 * </pre> 102 * 103 * <code>.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;</code> 104 * 105 * @return Whether the secondaryAggregation field is set. 106 */ hasSecondaryAggregation()107 boolean hasSecondaryAggregation(); 108 /** 109 * 110 * 111 * <pre> 112 * Apply a second aggregation after `aggregation` is applied. 113 * </pre> 114 * 115 * <code>.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;</code> 116 * 117 * @return The secondaryAggregation. 118 */ getSecondaryAggregation()119 com.google.monitoring.dashboard.v1.Aggregation getSecondaryAggregation(); 120 /** 121 * 122 * 123 * <pre> 124 * Apply a second aggregation after `aggregation` is applied. 125 * </pre> 126 * 127 * <code>.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;</code> 128 */ getSecondaryAggregationOrBuilder()129 com.google.monitoring.dashboard.v1.AggregationOrBuilder getSecondaryAggregationOrBuilder(); 130 131 /** 132 * 133 * 134 * <pre> 135 * Ranking based time series filter. 136 * </pre> 137 * 138 * <code>.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;</code> 139 * 140 * @return Whether the pickTimeSeriesFilter field is set. 141 */ hasPickTimeSeriesFilter()142 boolean hasPickTimeSeriesFilter(); 143 /** 144 * 145 * 146 * <pre> 147 * Ranking based time series filter. 148 * </pre> 149 * 150 * <code>.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;</code> 151 * 152 * @return The pickTimeSeriesFilter. 153 */ getPickTimeSeriesFilter()154 com.google.monitoring.dashboard.v1.PickTimeSeriesFilter getPickTimeSeriesFilter(); 155 /** 156 * 157 * 158 * <pre> 159 * Ranking based time series filter. 160 * </pre> 161 * 162 * <code>.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;</code> 163 */ 164 com.google.monitoring.dashboard.v1.PickTimeSeriesFilterOrBuilder getPickTimeSeriesFilterOrBuilder()165 getPickTimeSeriesFilterOrBuilder(); 166 167 /** 168 * 169 * 170 * <pre> 171 * Statistics based time series filter. 172 * Note: This field is deprecated and completely ignored by the API. 173 * </pre> 174 * 175 * <code> 176 * .google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true]; 177 * </code> 178 * 179 * @deprecated google.monitoring.dashboard.v1.TimeSeriesFilter.statistical_time_series_filter is 180 * deprecated. See google/monitoring/dashboard/v1/metrics.proto;l=80 181 * @return Whether the statisticalTimeSeriesFilter field is set. 182 */ 183 @java.lang.Deprecated hasStatisticalTimeSeriesFilter()184 boolean hasStatisticalTimeSeriesFilter(); 185 /** 186 * 187 * 188 * <pre> 189 * Statistics based time series filter. 190 * Note: This field is deprecated and completely ignored by the API. 191 * </pre> 192 * 193 * <code> 194 * .google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true]; 195 * </code> 196 * 197 * @deprecated google.monitoring.dashboard.v1.TimeSeriesFilter.statistical_time_series_filter is 198 * deprecated. See google/monitoring/dashboard/v1/metrics.proto;l=80 199 * @return The statisticalTimeSeriesFilter. 200 */ 201 @java.lang.Deprecated getStatisticalTimeSeriesFilter()202 com.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter getStatisticalTimeSeriesFilter(); 203 /** 204 * 205 * 206 * <pre> 207 * Statistics based time series filter. 208 * Note: This field is deprecated and completely ignored by the API. 209 * </pre> 210 * 211 * <code> 212 * .google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true]; 213 * </code> 214 */ 215 @java.lang.Deprecated 216 com.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilterOrBuilder getStatisticalTimeSeriesFilterOrBuilder()217 getStatisticalTimeSeriesFilterOrBuilder(); 218 getOutputFilterCase()219 public com.google.monitoring.dashboard.v1.TimeSeriesFilter.OutputFilterCase getOutputFilterCase(); 220 } 221