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/v3/notification.proto 18 19 package com.google.monitoring.v3; 20 21 public interface NotificationChannelOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.monitoring.v3.NotificationChannel) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The type of the notification channel. This field matches the 31 * value of the [NotificationChannelDescriptor.type][google.monitoring.v3.NotificationChannelDescriptor.type] field. 32 * </pre> 33 * 34 * <code>string type = 1;</code> 35 * 36 * @return The type. 37 */ getType()38 java.lang.String getType(); 39 /** 40 * 41 * 42 * <pre> 43 * The type of the notification channel. This field matches the 44 * value of the [NotificationChannelDescriptor.type][google.monitoring.v3.NotificationChannelDescriptor.type] field. 45 * </pre> 46 * 47 * <code>string type = 1;</code> 48 * 49 * @return The bytes for type. 50 */ getTypeBytes()51 com.google.protobuf.ByteString getTypeBytes(); 52 53 /** 54 * 55 * 56 * <pre> 57 * The full REST resource name for this channel. The format is: 58 * projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] 59 * The `[CHANNEL_ID]` is automatically assigned by the server on creation. 60 * </pre> 61 * 62 * <code>string name = 6;</code> 63 * 64 * @return The name. 65 */ getName()66 java.lang.String getName(); 67 /** 68 * 69 * 70 * <pre> 71 * The full REST resource name for this channel. The format is: 72 * projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] 73 * The `[CHANNEL_ID]` is automatically assigned by the server on creation. 74 * </pre> 75 * 76 * <code>string name = 6;</code> 77 * 78 * @return The bytes for name. 79 */ getNameBytes()80 com.google.protobuf.ByteString getNameBytes(); 81 82 /** 83 * 84 * 85 * <pre> 86 * An optional human-readable name for this notification channel. It is 87 * recommended that you specify a non-empty and unique name in order to 88 * make it easier to identify the channels in your project, though this is 89 * not enforced. The display name is limited to 512 Unicode characters. 90 * </pre> 91 * 92 * <code>string display_name = 3;</code> 93 * 94 * @return The displayName. 95 */ getDisplayName()96 java.lang.String getDisplayName(); 97 /** 98 * 99 * 100 * <pre> 101 * An optional human-readable name for this notification channel. It is 102 * recommended that you specify a non-empty and unique name in order to 103 * make it easier to identify the channels in your project, though this is 104 * not enforced. The display name is limited to 512 Unicode characters. 105 * </pre> 106 * 107 * <code>string display_name = 3;</code> 108 * 109 * @return The bytes for displayName. 110 */ getDisplayNameBytes()111 com.google.protobuf.ByteString getDisplayNameBytes(); 112 113 /** 114 * 115 * 116 * <pre> 117 * An optional human-readable description of this notification channel. This 118 * description may provide additional details, beyond the display 119 * name, for the channel. This may not exceed 1024 Unicode characters. 120 * </pre> 121 * 122 * <code>string description = 4;</code> 123 * 124 * @return The description. 125 */ getDescription()126 java.lang.String getDescription(); 127 /** 128 * 129 * 130 * <pre> 131 * An optional human-readable description of this notification channel. This 132 * description may provide additional details, beyond the display 133 * name, for the channel. This may not exceed 1024 Unicode characters. 134 * </pre> 135 * 136 * <code>string description = 4;</code> 137 * 138 * @return The bytes for description. 139 */ getDescriptionBytes()140 com.google.protobuf.ByteString getDescriptionBytes(); 141 142 /** 143 * 144 * 145 * <pre> 146 * Configuration fields that define the channel and its behavior. The 147 * permissible and required labels are specified in the 148 * [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels] of the 149 * `NotificationChannelDescriptor` corresponding to the `type` field. 150 * </pre> 151 * 152 * <code>map<string, string> labels = 5;</code> 153 */ getLabelsCount()154 int getLabelsCount(); 155 /** 156 * 157 * 158 * <pre> 159 * Configuration fields that define the channel and its behavior. The 160 * permissible and required labels are specified in the 161 * [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels] of the 162 * `NotificationChannelDescriptor` corresponding to the `type` field. 163 * </pre> 164 * 165 * <code>map<string, string> labels = 5;</code> 166 */ containsLabels(java.lang.String key)167 boolean containsLabels(java.lang.String key); 168 /** Use {@link #getLabelsMap()} instead. */ 169 @java.lang.Deprecated getLabels()170 java.util.Map<java.lang.String, java.lang.String> getLabels(); 171 /** 172 * 173 * 174 * <pre> 175 * Configuration fields that define the channel and its behavior. The 176 * permissible and required labels are specified in the 177 * [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels] of the 178 * `NotificationChannelDescriptor` corresponding to the `type` field. 179 * </pre> 180 * 181 * <code>map<string, string> labels = 5;</code> 182 */ getLabelsMap()183 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 184 /** 185 * 186 * 187 * <pre> 188 * Configuration fields that define the channel and its behavior. The 189 * permissible and required labels are specified in the 190 * [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels] of the 191 * `NotificationChannelDescriptor` corresponding to the `type` field. 192 * </pre> 193 * 194 * <code>map<string, string> labels = 5;</code> 195 */ 196 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)197 java.lang.String getLabelsOrDefault( 198 java.lang.String key, 199 /* nullable */ 200 java.lang.String defaultValue); 201 /** 202 * 203 * 204 * <pre> 205 * Configuration fields that define the channel and its behavior. The 206 * permissible and required labels are specified in the 207 * [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels] of the 208 * `NotificationChannelDescriptor` corresponding to the `type` field. 209 * </pre> 210 * 211 * <code>map<string, string> labels = 5;</code> 212 */ getLabelsOrThrow(java.lang.String key)213 java.lang.String getLabelsOrThrow(java.lang.String key); 214 215 /** 216 * 217 * 218 * <pre> 219 * User-supplied key/value data that does not need to conform to 220 * the corresponding `NotificationChannelDescriptor`'s schema, unlike 221 * the `labels` field. This field is intended to be used for organizing 222 * and identifying the `NotificationChannel` objects. 223 * The field can contain up to 64 entries. Each key and value is limited to 224 * 63 Unicode characters or 128 bytes, whichever is smaller. Labels and 225 * values can contain only lowercase letters, numerals, underscores, and 226 * dashes. Keys must begin with a letter. 227 * </pre> 228 * 229 * <code>map<string, string> user_labels = 8;</code> 230 */ getUserLabelsCount()231 int getUserLabelsCount(); 232 /** 233 * 234 * 235 * <pre> 236 * User-supplied key/value data that does not need to conform to 237 * the corresponding `NotificationChannelDescriptor`'s schema, unlike 238 * the `labels` field. This field is intended to be used for organizing 239 * and identifying the `NotificationChannel` objects. 240 * The field can contain up to 64 entries. Each key and value is limited to 241 * 63 Unicode characters or 128 bytes, whichever is smaller. Labels and 242 * values can contain only lowercase letters, numerals, underscores, and 243 * dashes. Keys must begin with a letter. 244 * </pre> 245 * 246 * <code>map<string, string> user_labels = 8;</code> 247 */ containsUserLabels(java.lang.String key)248 boolean containsUserLabels(java.lang.String key); 249 /** Use {@link #getUserLabelsMap()} instead. */ 250 @java.lang.Deprecated getUserLabels()251 java.util.Map<java.lang.String, java.lang.String> getUserLabels(); 252 /** 253 * 254 * 255 * <pre> 256 * User-supplied key/value data that does not need to conform to 257 * the corresponding `NotificationChannelDescriptor`'s schema, unlike 258 * the `labels` field. This field is intended to be used for organizing 259 * and identifying the `NotificationChannel` objects. 260 * The field can contain up to 64 entries. Each key and value is limited to 261 * 63 Unicode characters or 128 bytes, whichever is smaller. Labels and 262 * values can contain only lowercase letters, numerals, underscores, and 263 * dashes. Keys must begin with a letter. 264 * </pre> 265 * 266 * <code>map<string, string> user_labels = 8;</code> 267 */ getUserLabelsMap()268 java.util.Map<java.lang.String, java.lang.String> getUserLabelsMap(); 269 /** 270 * 271 * 272 * <pre> 273 * User-supplied key/value data that does not need to conform to 274 * the corresponding `NotificationChannelDescriptor`'s schema, unlike 275 * the `labels` field. This field is intended to be used for organizing 276 * and identifying the `NotificationChannel` objects. 277 * The field can contain up to 64 entries. Each key and value is limited to 278 * 63 Unicode characters or 128 bytes, whichever is smaller. Labels and 279 * values can contain only lowercase letters, numerals, underscores, and 280 * dashes. Keys must begin with a letter. 281 * </pre> 282 * 283 * <code>map<string, string> user_labels = 8;</code> 284 */ 285 /* nullable */ getUserLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)286 java.lang.String getUserLabelsOrDefault( 287 java.lang.String key, 288 /* nullable */ 289 java.lang.String defaultValue); 290 /** 291 * 292 * 293 * <pre> 294 * User-supplied key/value data that does not need to conform to 295 * the corresponding `NotificationChannelDescriptor`'s schema, unlike 296 * the `labels` field. This field is intended to be used for organizing 297 * and identifying the `NotificationChannel` objects. 298 * The field can contain up to 64 entries. Each key and value is limited to 299 * 63 Unicode characters or 128 bytes, whichever is smaller. Labels and 300 * values can contain only lowercase letters, numerals, underscores, and 301 * dashes. Keys must begin with a letter. 302 * </pre> 303 * 304 * <code>map<string, string> user_labels = 8;</code> 305 */ getUserLabelsOrThrow(java.lang.String key)306 java.lang.String getUserLabelsOrThrow(java.lang.String key); 307 308 /** 309 * 310 * 311 * <pre> 312 * Indicates whether this channel has been verified or not. On a 313 * [`ListNotificationChannels`][google.monitoring.v3.NotificationChannelService.ListNotificationChannels] 314 * or 315 * [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.GetNotificationChannel] 316 * operation, this field is expected to be populated. 317 * If the value is `UNVERIFIED`, then it indicates that the channel is 318 * non-functioning (it both requires verification and lacks verification); 319 * otherwise, it is assumed that the channel works. 320 * If the channel is neither `VERIFIED` nor `UNVERIFIED`, it implies that 321 * the channel is of a type that does not require verification or that 322 * this specific channel has been exempted from verification because it was 323 * created prior to verification being required for channels of this type. 324 * This field cannot be modified using a standard 325 * [`UpdateNotificationChannel`][google.monitoring.v3.NotificationChannelService.UpdateNotificationChannel] 326 * operation. To change the value of this field, you must call 327 * [`VerifyNotificationChannel`][google.monitoring.v3.NotificationChannelService.VerifyNotificationChannel]. 328 * </pre> 329 * 330 * <code>.google.monitoring.v3.NotificationChannel.VerificationStatus verification_status = 9; 331 * </code> 332 * 333 * @return The enum numeric value on the wire for verificationStatus. 334 */ getVerificationStatusValue()335 int getVerificationStatusValue(); 336 /** 337 * 338 * 339 * <pre> 340 * Indicates whether this channel has been verified or not. On a 341 * [`ListNotificationChannels`][google.monitoring.v3.NotificationChannelService.ListNotificationChannels] 342 * or 343 * [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.GetNotificationChannel] 344 * operation, this field is expected to be populated. 345 * If the value is `UNVERIFIED`, then it indicates that the channel is 346 * non-functioning (it both requires verification and lacks verification); 347 * otherwise, it is assumed that the channel works. 348 * If the channel is neither `VERIFIED` nor `UNVERIFIED`, it implies that 349 * the channel is of a type that does not require verification or that 350 * this specific channel has been exempted from verification because it was 351 * created prior to verification being required for channels of this type. 352 * This field cannot be modified using a standard 353 * [`UpdateNotificationChannel`][google.monitoring.v3.NotificationChannelService.UpdateNotificationChannel] 354 * operation. To change the value of this field, you must call 355 * [`VerifyNotificationChannel`][google.monitoring.v3.NotificationChannelService.VerifyNotificationChannel]. 356 * </pre> 357 * 358 * <code>.google.monitoring.v3.NotificationChannel.VerificationStatus verification_status = 9; 359 * </code> 360 * 361 * @return The verificationStatus. 362 */ getVerificationStatus()363 com.google.monitoring.v3.NotificationChannel.VerificationStatus getVerificationStatus(); 364 365 /** 366 * 367 * 368 * <pre> 369 * Whether notifications are forwarded to the described channel. This makes 370 * it possible to disable delivery of notifications to a particular channel 371 * without removing the channel from all alerting policies that reference 372 * the channel. This is a more convenient approach when the change is 373 * temporary and you want to receive notifications from the same set 374 * of alerting policies on the channel at some point in the future. 375 * </pre> 376 * 377 * <code>.google.protobuf.BoolValue enabled = 11;</code> 378 * 379 * @return Whether the enabled field is set. 380 */ hasEnabled()381 boolean hasEnabled(); 382 /** 383 * 384 * 385 * <pre> 386 * Whether notifications are forwarded to the described channel. This makes 387 * it possible to disable delivery of notifications to a particular channel 388 * without removing the channel from all alerting policies that reference 389 * the channel. This is a more convenient approach when the change is 390 * temporary and you want to receive notifications from the same set 391 * of alerting policies on the channel at some point in the future. 392 * </pre> 393 * 394 * <code>.google.protobuf.BoolValue enabled = 11;</code> 395 * 396 * @return The enabled. 397 */ getEnabled()398 com.google.protobuf.BoolValue getEnabled(); 399 /** 400 * 401 * 402 * <pre> 403 * Whether notifications are forwarded to the described channel. This makes 404 * it possible to disable delivery of notifications to a particular channel 405 * without removing the channel from all alerting policies that reference 406 * the channel. This is a more convenient approach when the change is 407 * temporary and you want to receive notifications from the same set 408 * of alerting policies on the channel at some point in the future. 409 * </pre> 410 * 411 * <code>.google.protobuf.BoolValue enabled = 11;</code> 412 */ getEnabledOrBuilder()413 com.google.protobuf.BoolValueOrBuilder getEnabledOrBuilder(); 414 415 /** 416 * 417 * 418 * <pre> 419 * Record of the creation of this channel. 420 * </pre> 421 * 422 * <code>.google.monitoring.v3.MutationRecord creation_record = 12;</code> 423 * 424 * @return Whether the creationRecord field is set. 425 */ hasCreationRecord()426 boolean hasCreationRecord(); 427 /** 428 * 429 * 430 * <pre> 431 * Record of the creation of this channel. 432 * </pre> 433 * 434 * <code>.google.monitoring.v3.MutationRecord creation_record = 12;</code> 435 * 436 * @return The creationRecord. 437 */ getCreationRecord()438 com.google.monitoring.v3.MutationRecord getCreationRecord(); 439 /** 440 * 441 * 442 * <pre> 443 * Record of the creation of this channel. 444 * </pre> 445 * 446 * <code>.google.monitoring.v3.MutationRecord creation_record = 12;</code> 447 */ getCreationRecordOrBuilder()448 com.google.monitoring.v3.MutationRecordOrBuilder getCreationRecordOrBuilder(); 449 450 /** 451 * 452 * 453 * <pre> 454 * Records of the modification of this channel. 455 * </pre> 456 * 457 * <code>repeated .google.monitoring.v3.MutationRecord mutation_records = 13;</code> 458 */ getMutationRecordsList()459 java.util.List<com.google.monitoring.v3.MutationRecord> getMutationRecordsList(); 460 /** 461 * 462 * 463 * <pre> 464 * Records of the modification of this channel. 465 * </pre> 466 * 467 * <code>repeated .google.monitoring.v3.MutationRecord mutation_records = 13;</code> 468 */ getMutationRecords(int index)469 com.google.monitoring.v3.MutationRecord getMutationRecords(int index); 470 /** 471 * 472 * 473 * <pre> 474 * Records of the modification of this channel. 475 * </pre> 476 * 477 * <code>repeated .google.monitoring.v3.MutationRecord mutation_records = 13;</code> 478 */ getMutationRecordsCount()479 int getMutationRecordsCount(); 480 /** 481 * 482 * 483 * <pre> 484 * Records of the modification of this channel. 485 * </pre> 486 * 487 * <code>repeated .google.monitoring.v3.MutationRecord mutation_records = 13;</code> 488 */ 489 java.util.List<? extends com.google.monitoring.v3.MutationRecordOrBuilder> getMutationRecordsOrBuilderList()490 getMutationRecordsOrBuilderList(); 491 /** 492 * 493 * 494 * <pre> 495 * Records of the modification of this channel. 496 * </pre> 497 * 498 * <code>repeated .google.monitoring.v3.MutationRecord mutation_records = 13;</code> 499 */ getMutationRecordsOrBuilder(int index)500 com.google.monitoring.v3.MutationRecordOrBuilder getMutationRecordsOrBuilder(int index); 501 } 502