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/cloud/datacatalog/v1/usage.proto 18 19 package com.google.cloud.datacatalog.v1; 20 21 public interface UsageSignalOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.datacatalog.v1.UsageSignal) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The end timestamp of the duration of usage statistics. 31 * </pre> 32 * 33 * <code>.google.protobuf.Timestamp update_time = 1;</code> 34 * 35 * @return Whether the updateTime field is set. 36 */ hasUpdateTime()37 boolean hasUpdateTime(); 38 /** 39 * 40 * 41 * <pre> 42 * The end timestamp of the duration of usage statistics. 43 * </pre> 44 * 45 * <code>.google.protobuf.Timestamp update_time = 1;</code> 46 * 47 * @return The updateTime. 48 */ getUpdateTime()49 com.google.protobuf.Timestamp getUpdateTime(); 50 /** 51 * 52 * 53 * <pre> 54 * The end timestamp of the duration of usage statistics. 55 * </pre> 56 * 57 * <code>.google.protobuf.Timestamp update_time = 1;</code> 58 */ getUpdateTimeOrBuilder()59 com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); 60 61 /** 62 * 63 * 64 * <pre> 65 * Output only. BigQuery usage statistics over each of the predefined time 66 * ranges. 67 * Supported time ranges are `{"24H", "7D", "30D"}`. 68 * </pre> 69 * 70 * <code> 71 * map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; 72 * </code> 73 */ getUsageWithinTimeRangeCount()74 int getUsageWithinTimeRangeCount(); 75 /** 76 * 77 * 78 * <pre> 79 * Output only. BigQuery usage statistics over each of the predefined time 80 * ranges. 81 * Supported time ranges are `{"24H", "7D", "30D"}`. 82 * </pre> 83 * 84 * <code> 85 * map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; 86 * </code> 87 */ containsUsageWithinTimeRange(java.lang.String key)88 boolean containsUsageWithinTimeRange(java.lang.String key); 89 /** Use {@link #getUsageWithinTimeRangeMap()} instead. */ 90 @java.lang.Deprecated 91 java.util.Map<java.lang.String, com.google.cloud.datacatalog.v1.UsageStats> getUsageWithinTimeRange()92 getUsageWithinTimeRange(); 93 /** 94 * 95 * 96 * <pre> 97 * Output only. BigQuery usage statistics over each of the predefined time 98 * ranges. 99 * Supported time ranges are `{"24H", "7D", "30D"}`. 100 * </pre> 101 * 102 * <code> 103 * map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; 104 * </code> 105 */ 106 java.util.Map<java.lang.String, com.google.cloud.datacatalog.v1.UsageStats> getUsageWithinTimeRangeMap()107 getUsageWithinTimeRangeMap(); 108 /** 109 * 110 * 111 * <pre> 112 * Output only. BigQuery usage statistics over each of the predefined time 113 * ranges. 114 * Supported time ranges are `{"24H", "7D", "30D"}`. 115 * </pre> 116 * 117 * <code> 118 * map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; 119 * </code> 120 */ 121 /* nullable */ getUsageWithinTimeRangeOrDefault( java.lang.String key, com.google.cloud.datacatalog.v1.UsageStats defaultValue)122 com.google.cloud.datacatalog.v1.UsageStats getUsageWithinTimeRangeOrDefault( 123 java.lang.String key, 124 /* nullable */ 125 com.google.cloud.datacatalog.v1.UsageStats defaultValue); 126 /** 127 * 128 * 129 * <pre> 130 * Output only. BigQuery usage statistics over each of the predefined time 131 * ranges. 132 * Supported time ranges are `{"24H", "7D", "30D"}`. 133 * </pre> 134 * 135 * <code> 136 * map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; 137 * </code> 138 */ getUsageWithinTimeRangeOrThrow(java.lang.String key)139 com.google.cloud.datacatalog.v1.UsageStats getUsageWithinTimeRangeOrThrow(java.lang.String key); 140 141 /** 142 * 143 * 144 * <pre> 145 * Common usage statistics over each of the predefined time ranges. 146 * Supported time ranges are `{"24H", "7D", "30D", "Lifetime"}`. 147 * </pre> 148 * 149 * <code> 150 * map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3; 151 * </code> 152 */ getCommonUsageWithinTimeRangeCount()153 int getCommonUsageWithinTimeRangeCount(); 154 /** 155 * 156 * 157 * <pre> 158 * Common usage statistics over each of the predefined time ranges. 159 * Supported time ranges are `{"24H", "7D", "30D", "Lifetime"}`. 160 * </pre> 161 * 162 * <code> 163 * map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3; 164 * </code> 165 */ containsCommonUsageWithinTimeRange(java.lang.String key)166 boolean containsCommonUsageWithinTimeRange(java.lang.String key); 167 /** Use {@link #getCommonUsageWithinTimeRangeMap()} instead. */ 168 @java.lang.Deprecated 169 java.util.Map<java.lang.String, com.google.cloud.datacatalog.v1.CommonUsageStats> getCommonUsageWithinTimeRange()170 getCommonUsageWithinTimeRange(); 171 /** 172 * 173 * 174 * <pre> 175 * Common usage statistics over each of the predefined time ranges. 176 * Supported time ranges are `{"24H", "7D", "30D", "Lifetime"}`. 177 * </pre> 178 * 179 * <code> 180 * map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3; 181 * </code> 182 */ 183 java.util.Map<java.lang.String, com.google.cloud.datacatalog.v1.CommonUsageStats> getCommonUsageWithinTimeRangeMap()184 getCommonUsageWithinTimeRangeMap(); 185 /** 186 * 187 * 188 * <pre> 189 * Common usage statistics over each of the predefined time ranges. 190 * Supported time ranges are `{"24H", "7D", "30D", "Lifetime"}`. 191 * </pre> 192 * 193 * <code> 194 * map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3; 195 * </code> 196 */ 197 /* nullable */ getCommonUsageWithinTimeRangeOrDefault( java.lang.String key, com.google.cloud.datacatalog.v1.CommonUsageStats defaultValue)198 com.google.cloud.datacatalog.v1.CommonUsageStats getCommonUsageWithinTimeRangeOrDefault( 199 java.lang.String key, 200 /* nullable */ 201 com.google.cloud.datacatalog.v1.CommonUsageStats defaultValue); 202 /** 203 * 204 * 205 * <pre> 206 * Common usage statistics over each of the predefined time ranges. 207 * Supported time ranges are `{"24H", "7D", "30D", "Lifetime"}`. 208 * </pre> 209 * 210 * <code> 211 * map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3; 212 * </code> 213 */ getCommonUsageWithinTimeRangeOrThrow( java.lang.String key)214 com.google.cloud.datacatalog.v1.CommonUsageStats getCommonUsageWithinTimeRangeOrThrow( 215 java.lang.String key); 216 217 /** 218 * 219 * 220 * <pre> 221 * Favorite count in the source system. 222 * </pre> 223 * 224 * <code>optional int64 favorite_count = 4;</code> 225 * 226 * @return Whether the favoriteCount field is set. 227 */ hasFavoriteCount()228 boolean hasFavoriteCount(); 229 /** 230 * 231 * 232 * <pre> 233 * Favorite count in the source system. 234 * </pre> 235 * 236 * <code>optional int64 favorite_count = 4;</code> 237 * 238 * @return The favoriteCount. 239 */ getFavoriteCount()240 long getFavoriteCount(); 241 } 242