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/redis/v1/cloud_redis.proto 18 19 package com.google.cloud.redis.v1; 20 21 public interface InstanceOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.redis.v1.Instance) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. Unique name of the resource in this scope including project and 31 * location using the form: 32 * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 33 * Note: Redis instances are managed and addressed at regional level so 34 * location_id here refers to a GCP region; however, users may choose which 35 * specific zone (or collection of zones for cross-zone instances) an instance 36 * should be provisioned in. Refer to 37 * [location_id][google.cloud.redis.v1.Instance.location_id] and 38 * [alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id] 39 * fields for more details. 40 * </pre> 41 * 42 * <code>string name = 1 [(.google.api.field_behavior) = REQUIRED];</code> 43 * 44 * @return The name. 45 */ getName()46 java.lang.String getName(); 47 /** 48 * 49 * 50 * <pre> 51 * Required. Unique name of the resource in this scope including project and 52 * location using the form: 53 * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 54 * Note: Redis instances are managed and addressed at regional level so 55 * location_id here refers to a GCP region; however, users may choose which 56 * specific zone (or collection of zones for cross-zone instances) an instance 57 * should be provisioned in. Refer to 58 * [location_id][google.cloud.redis.v1.Instance.location_id] and 59 * [alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id] 60 * fields for more details. 61 * </pre> 62 * 63 * <code>string name = 1 [(.google.api.field_behavior) = REQUIRED];</code> 64 * 65 * @return The bytes for name. 66 */ getNameBytes()67 com.google.protobuf.ByteString getNameBytes(); 68 69 /** 70 * 71 * 72 * <pre> 73 * An arbitrary and optional user-provided name for the instance. 74 * </pre> 75 * 76 * <code>string display_name = 2;</code> 77 * 78 * @return The displayName. 79 */ getDisplayName()80 java.lang.String getDisplayName(); 81 /** 82 * 83 * 84 * <pre> 85 * An arbitrary and optional user-provided name for the instance. 86 * </pre> 87 * 88 * <code>string display_name = 2;</code> 89 * 90 * @return The bytes for displayName. 91 */ getDisplayNameBytes()92 com.google.protobuf.ByteString getDisplayNameBytes(); 93 94 /** 95 * 96 * 97 * <pre> 98 * Resource labels to represent user provided metadata 99 * </pre> 100 * 101 * <code>map<string, string> labels = 3;</code> 102 */ getLabelsCount()103 int getLabelsCount(); 104 /** 105 * 106 * 107 * <pre> 108 * Resource labels to represent user provided metadata 109 * </pre> 110 * 111 * <code>map<string, string> labels = 3;</code> 112 */ containsLabels(java.lang.String key)113 boolean containsLabels(java.lang.String key); 114 /** Use {@link #getLabelsMap()} instead. */ 115 @java.lang.Deprecated getLabels()116 java.util.Map<java.lang.String, java.lang.String> getLabels(); 117 /** 118 * 119 * 120 * <pre> 121 * Resource labels to represent user provided metadata 122 * </pre> 123 * 124 * <code>map<string, string> labels = 3;</code> 125 */ getLabelsMap()126 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 127 /** 128 * 129 * 130 * <pre> 131 * Resource labels to represent user provided metadata 132 * </pre> 133 * 134 * <code>map<string, string> labels = 3;</code> 135 */ 136 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)137 java.lang.String getLabelsOrDefault( 138 java.lang.String key, 139 /* nullable */ 140 java.lang.String defaultValue); 141 /** 142 * 143 * 144 * <pre> 145 * Resource labels to represent user provided metadata 146 * </pre> 147 * 148 * <code>map<string, string> labels = 3;</code> 149 */ getLabelsOrThrow(java.lang.String key)150 java.lang.String getLabelsOrThrow(java.lang.String key); 151 152 /** 153 * 154 * 155 * <pre> 156 * Optional. The zone where the instance will be provisioned. If not provided, 157 * the service will choose a zone from the specified region for the instance. 158 * For standard tier, additional nodes will be added across multiple zones for 159 * protection against zonal failures. If specified, at least one node will be 160 * provisioned in this zone. 161 * </pre> 162 * 163 * <code>string location_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 164 * 165 * @return The locationId. 166 */ getLocationId()167 java.lang.String getLocationId(); 168 /** 169 * 170 * 171 * <pre> 172 * Optional. The zone where the instance will be provisioned. If not provided, 173 * the service will choose a zone from the specified region for the instance. 174 * For standard tier, additional nodes will be added across multiple zones for 175 * protection against zonal failures. If specified, at least one node will be 176 * provisioned in this zone. 177 * </pre> 178 * 179 * <code>string location_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 180 * 181 * @return The bytes for locationId. 182 */ getLocationIdBytes()183 com.google.protobuf.ByteString getLocationIdBytes(); 184 185 /** 186 * 187 * 188 * <pre> 189 * Optional. If specified, at least one node will be provisioned in this zone 190 * in addition to the zone specified in location_id. Only applicable to 191 * standard tier. If provided, it must be a different zone from the one 192 * provided in [location_id]. Additional nodes beyond the first 2 will be 193 * placed in zones selected by the service. 194 * </pre> 195 * 196 * <code>string alternative_location_id = 5 [(.google.api.field_behavior) = OPTIONAL];</code> 197 * 198 * @return The alternativeLocationId. 199 */ getAlternativeLocationId()200 java.lang.String getAlternativeLocationId(); 201 /** 202 * 203 * 204 * <pre> 205 * Optional. If specified, at least one node will be provisioned in this zone 206 * in addition to the zone specified in location_id. Only applicable to 207 * standard tier. If provided, it must be a different zone from the one 208 * provided in [location_id]. Additional nodes beyond the first 2 will be 209 * placed in zones selected by the service. 210 * </pre> 211 * 212 * <code>string alternative_location_id = 5 [(.google.api.field_behavior) = OPTIONAL];</code> 213 * 214 * @return The bytes for alternativeLocationId. 215 */ getAlternativeLocationIdBytes()216 com.google.protobuf.ByteString getAlternativeLocationIdBytes(); 217 218 /** 219 * 220 * 221 * <pre> 222 * Optional. The version of Redis software. 223 * If not provided, latest supported version will be used. Currently, the 224 * supported values are: 225 * * `REDIS_3_2` for Redis 3.2 compatibility 226 * * `REDIS_4_0` for Redis 4.0 compatibility (default) 227 * * `REDIS_5_0` for Redis 5.0 compatibility 228 * * `REDIS_6_X` for Redis 6.x compatibility 229 * </pre> 230 * 231 * <code>string redis_version = 7 [(.google.api.field_behavior) = OPTIONAL];</code> 232 * 233 * @return The redisVersion. 234 */ getRedisVersion()235 java.lang.String getRedisVersion(); 236 /** 237 * 238 * 239 * <pre> 240 * Optional. The version of Redis software. 241 * If not provided, latest supported version will be used. Currently, the 242 * supported values are: 243 * * `REDIS_3_2` for Redis 3.2 compatibility 244 * * `REDIS_4_0` for Redis 4.0 compatibility (default) 245 * * `REDIS_5_0` for Redis 5.0 compatibility 246 * * `REDIS_6_X` for Redis 6.x compatibility 247 * </pre> 248 * 249 * <code>string redis_version = 7 [(.google.api.field_behavior) = OPTIONAL];</code> 250 * 251 * @return The bytes for redisVersion. 252 */ getRedisVersionBytes()253 com.google.protobuf.ByteString getRedisVersionBytes(); 254 255 /** 256 * 257 * 258 * <pre> 259 * Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses 260 * that are reserved for this instance. Range must 261 * be unique and non-overlapping with existing subnets in an authorized 262 * network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP 263 * address ranges associated with this private service access connection. 264 * If not provided, the service will choose an unused /29 block, for 265 * example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED 266 * the default block size is /28. 267 * </pre> 268 * 269 * <code>string reserved_ip_range = 9 [(.google.api.field_behavior) = OPTIONAL];</code> 270 * 271 * @return The reservedIpRange. 272 */ getReservedIpRange()273 java.lang.String getReservedIpRange(); 274 /** 275 * 276 * 277 * <pre> 278 * Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses 279 * that are reserved for this instance. Range must 280 * be unique and non-overlapping with existing subnets in an authorized 281 * network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP 282 * address ranges associated with this private service access connection. 283 * If not provided, the service will choose an unused /29 block, for 284 * example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED 285 * the default block size is /28. 286 * </pre> 287 * 288 * <code>string reserved_ip_range = 9 [(.google.api.field_behavior) = OPTIONAL];</code> 289 * 290 * @return The bytes for reservedIpRange. 291 */ getReservedIpRangeBytes()292 com.google.protobuf.ByteString getReservedIpRangeBytes(); 293 294 /** 295 * 296 * 297 * <pre> 298 * Optional. Additional IP range for node placement. Required when enabling 299 * read replicas on an existing instance. For DIRECT_PEERING mode value must 300 * be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode 301 * value must be the name of an allocated address range associated with the 302 * private service access connection, or "auto". 303 * </pre> 304 * 305 * <code>string secondary_ip_range = 30 [(.google.api.field_behavior) = OPTIONAL];</code> 306 * 307 * @return The secondaryIpRange. 308 */ getSecondaryIpRange()309 java.lang.String getSecondaryIpRange(); 310 /** 311 * 312 * 313 * <pre> 314 * Optional. Additional IP range for node placement. Required when enabling 315 * read replicas on an existing instance. For DIRECT_PEERING mode value must 316 * be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode 317 * value must be the name of an allocated address range associated with the 318 * private service access connection, or "auto". 319 * </pre> 320 * 321 * <code>string secondary_ip_range = 30 [(.google.api.field_behavior) = OPTIONAL];</code> 322 * 323 * @return The bytes for secondaryIpRange. 324 */ getSecondaryIpRangeBytes()325 com.google.protobuf.ByteString getSecondaryIpRangeBytes(); 326 327 /** 328 * 329 * 330 * <pre> 331 * Output only. Hostname or IP address of the exposed Redis endpoint used by 332 * clients to connect to the service. 333 * </pre> 334 * 335 * <code>string host = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 336 * 337 * @return The host. 338 */ getHost()339 java.lang.String getHost(); 340 /** 341 * 342 * 343 * <pre> 344 * Output only. Hostname or IP address of the exposed Redis endpoint used by 345 * clients to connect to the service. 346 * </pre> 347 * 348 * <code>string host = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 349 * 350 * @return The bytes for host. 351 */ getHostBytes()352 com.google.protobuf.ByteString getHostBytes(); 353 354 /** 355 * 356 * 357 * <pre> 358 * Output only. The port number of the exposed Redis endpoint. 359 * </pre> 360 * 361 * <code>int32 port = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 362 * 363 * @return The port. 364 */ getPort()365 int getPort(); 366 367 /** 368 * 369 * 370 * <pre> 371 * Output only. The current zone where the Redis primary node is located. In 372 * basic tier, this will always be the same as [location_id]. In 373 * standard tier, this can be the zone of any node in the instance. 374 * </pre> 375 * 376 * <code>string current_location_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 377 * 378 * @return The currentLocationId. 379 */ getCurrentLocationId()380 java.lang.String getCurrentLocationId(); 381 /** 382 * 383 * 384 * <pre> 385 * Output only. The current zone where the Redis primary node is located. In 386 * basic tier, this will always be the same as [location_id]. In 387 * standard tier, this can be the zone of any node in the instance. 388 * </pre> 389 * 390 * <code>string current_location_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 391 * 392 * @return The bytes for currentLocationId. 393 */ getCurrentLocationIdBytes()394 com.google.protobuf.ByteString getCurrentLocationIdBytes(); 395 396 /** 397 * 398 * 399 * <pre> 400 * Output only. The time the instance was created. 401 * </pre> 402 * 403 * <code>.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 404 * </code> 405 * 406 * @return Whether the createTime field is set. 407 */ hasCreateTime()408 boolean hasCreateTime(); 409 /** 410 * 411 * 412 * <pre> 413 * Output only. The time the instance was created. 414 * </pre> 415 * 416 * <code>.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 417 * </code> 418 * 419 * @return The createTime. 420 */ getCreateTime()421 com.google.protobuf.Timestamp getCreateTime(); 422 /** 423 * 424 * 425 * <pre> 426 * Output only. The time the instance was created. 427 * </pre> 428 * 429 * <code>.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 430 * </code> 431 */ getCreateTimeOrBuilder()432 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 433 434 /** 435 * 436 * 437 * <pre> 438 * Output only. The current state of this instance. 439 * </pre> 440 * 441 * <code> 442 * .google.cloud.redis.v1.Instance.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; 443 * </code> 444 * 445 * @return The enum numeric value on the wire for state. 446 */ getStateValue()447 int getStateValue(); 448 /** 449 * 450 * 451 * <pre> 452 * Output only. The current state of this instance. 453 * </pre> 454 * 455 * <code> 456 * .google.cloud.redis.v1.Instance.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; 457 * </code> 458 * 459 * @return The state. 460 */ getState()461 com.google.cloud.redis.v1.Instance.State getState(); 462 463 /** 464 * 465 * 466 * <pre> 467 * Output only. Additional information about the current status of this 468 * instance, if available. 469 * </pre> 470 * 471 * <code>string status_message = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 472 * 473 * @return The statusMessage. 474 */ getStatusMessage()475 java.lang.String getStatusMessage(); 476 /** 477 * 478 * 479 * <pre> 480 * Output only. Additional information about the current status of this 481 * instance, if available. 482 * </pre> 483 * 484 * <code>string status_message = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 485 * 486 * @return The bytes for statusMessage. 487 */ getStatusMessageBytes()488 com.google.protobuf.ByteString getStatusMessageBytes(); 489 490 /** 491 * 492 * 493 * <pre> 494 * Optional. Redis configuration parameters, according to 495 * http://redis.io/topics/config. Currently, the only supported parameters 496 * are: 497 * Redis version 3.2 and newer: 498 * * maxmemory-policy 499 * * notify-keyspace-events 500 * Redis version 4.0 and newer: 501 * * activedefrag 502 * * lfu-decay-time 503 * * lfu-log-factor 504 * * maxmemory-gb 505 * Redis version 5.0 and newer: 506 * * stream-node-max-bytes 507 * * stream-node-max-entries 508 * </pre> 509 * 510 * <code>map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL]; 511 * </code> 512 */ getRedisConfigsCount()513 int getRedisConfigsCount(); 514 /** 515 * 516 * 517 * <pre> 518 * Optional. Redis configuration parameters, according to 519 * http://redis.io/topics/config. Currently, the only supported parameters 520 * are: 521 * Redis version 3.2 and newer: 522 * * maxmemory-policy 523 * * notify-keyspace-events 524 * Redis version 4.0 and newer: 525 * * activedefrag 526 * * lfu-decay-time 527 * * lfu-log-factor 528 * * maxmemory-gb 529 * Redis version 5.0 and newer: 530 * * stream-node-max-bytes 531 * * stream-node-max-entries 532 * </pre> 533 * 534 * <code>map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL]; 535 * </code> 536 */ containsRedisConfigs(java.lang.String key)537 boolean containsRedisConfigs(java.lang.String key); 538 /** Use {@link #getRedisConfigsMap()} instead. */ 539 @java.lang.Deprecated getRedisConfigs()540 java.util.Map<java.lang.String, java.lang.String> getRedisConfigs(); 541 /** 542 * 543 * 544 * <pre> 545 * Optional. Redis configuration parameters, according to 546 * http://redis.io/topics/config. Currently, the only supported parameters 547 * are: 548 * Redis version 3.2 and newer: 549 * * maxmemory-policy 550 * * notify-keyspace-events 551 * Redis version 4.0 and newer: 552 * * activedefrag 553 * * lfu-decay-time 554 * * lfu-log-factor 555 * * maxmemory-gb 556 * Redis version 5.0 and newer: 557 * * stream-node-max-bytes 558 * * stream-node-max-entries 559 * </pre> 560 * 561 * <code>map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL]; 562 * </code> 563 */ getRedisConfigsMap()564 java.util.Map<java.lang.String, java.lang.String> getRedisConfigsMap(); 565 /** 566 * 567 * 568 * <pre> 569 * Optional. Redis configuration parameters, according to 570 * http://redis.io/topics/config. Currently, the only supported parameters 571 * are: 572 * Redis version 3.2 and newer: 573 * * maxmemory-policy 574 * * notify-keyspace-events 575 * Redis version 4.0 and newer: 576 * * activedefrag 577 * * lfu-decay-time 578 * * lfu-log-factor 579 * * maxmemory-gb 580 * Redis version 5.0 and newer: 581 * * stream-node-max-bytes 582 * * stream-node-max-entries 583 * </pre> 584 * 585 * <code>map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL]; 586 * </code> 587 */ 588 /* nullable */ getRedisConfigsOrDefault( java.lang.String key, java.lang.String defaultValue)589 java.lang.String getRedisConfigsOrDefault( 590 java.lang.String key, 591 /* nullable */ 592 java.lang.String defaultValue); 593 /** 594 * 595 * 596 * <pre> 597 * Optional. Redis configuration parameters, according to 598 * http://redis.io/topics/config. Currently, the only supported parameters 599 * are: 600 * Redis version 3.2 and newer: 601 * * maxmemory-policy 602 * * notify-keyspace-events 603 * Redis version 4.0 and newer: 604 * * activedefrag 605 * * lfu-decay-time 606 * * lfu-log-factor 607 * * maxmemory-gb 608 * Redis version 5.0 and newer: 609 * * stream-node-max-bytes 610 * * stream-node-max-entries 611 * </pre> 612 * 613 * <code>map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL]; 614 * </code> 615 */ getRedisConfigsOrThrow(java.lang.String key)616 java.lang.String getRedisConfigsOrThrow(java.lang.String key); 617 618 /** 619 * 620 * 621 * <pre> 622 * Required. The service tier of the instance. 623 * </pre> 624 * 625 * <code>.google.cloud.redis.v1.Instance.Tier tier = 17 [(.google.api.field_behavior) = REQUIRED]; 626 * </code> 627 * 628 * @return The enum numeric value on the wire for tier. 629 */ getTierValue()630 int getTierValue(); 631 /** 632 * 633 * 634 * <pre> 635 * Required. The service tier of the instance. 636 * </pre> 637 * 638 * <code>.google.cloud.redis.v1.Instance.Tier tier = 17 [(.google.api.field_behavior) = REQUIRED]; 639 * </code> 640 * 641 * @return The tier. 642 */ getTier()643 com.google.cloud.redis.v1.Instance.Tier getTier(); 644 645 /** 646 * 647 * 648 * <pre> 649 * Required. Redis memory size in GiB. 650 * </pre> 651 * 652 * <code>int32 memory_size_gb = 18 [(.google.api.field_behavior) = REQUIRED];</code> 653 * 654 * @return The memorySizeGb. 655 */ getMemorySizeGb()656 int getMemorySizeGb(); 657 658 /** 659 * 660 * 661 * <pre> 662 * Optional. The full name of the Google Compute Engine 663 * [network](https://cloud.google.com/vpc/docs/vpc) to which the 664 * instance is connected. If left unspecified, the `default` network 665 * will be used. 666 * </pre> 667 * 668 * <code>string authorized_network = 20 [(.google.api.field_behavior) = OPTIONAL];</code> 669 * 670 * @return The authorizedNetwork. 671 */ getAuthorizedNetwork()672 java.lang.String getAuthorizedNetwork(); 673 /** 674 * 675 * 676 * <pre> 677 * Optional. The full name of the Google Compute Engine 678 * [network](https://cloud.google.com/vpc/docs/vpc) to which the 679 * instance is connected. If left unspecified, the `default` network 680 * will be used. 681 * </pre> 682 * 683 * <code>string authorized_network = 20 [(.google.api.field_behavior) = OPTIONAL];</code> 684 * 685 * @return The bytes for authorizedNetwork. 686 */ getAuthorizedNetworkBytes()687 com.google.protobuf.ByteString getAuthorizedNetworkBytes(); 688 689 /** 690 * 691 * 692 * <pre> 693 * Output only. Cloud IAM identity used by import / export operations to 694 * transfer data to/from Cloud Storage. Format is 695 * "serviceAccount:<service_account_email>". The value may change over time 696 * for a given instance so should be checked before each import/export 697 * operation. 698 * </pre> 699 * 700 * <code>string persistence_iam_identity = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 701 * 702 * @return The persistenceIamIdentity. 703 */ getPersistenceIamIdentity()704 java.lang.String getPersistenceIamIdentity(); 705 /** 706 * 707 * 708 * <pre> 709 * Output only. Cloud IAM identity used by import / export operations to 710 * transfer data to/from Cloud Storage. Format is 711 * "serviceAccount:<service_account_email>". The value may change over time 712 * for a given instance so should be checked before each import/export 713 * operation. 714 * </pre> 715 * 716 * <code>string persistence_iam_identity = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 717 * 718 * @return The bytes for persistenceIamIdentity. 719 */ getPersistenceIamIdentityBytes()720 com.google.protobuf.ByteString getPersistenceIamIdentityBytes(); 721 722 /** 723 * 724 * 725 * <pre> 726 * Optional. The network connect mode of the Redis instance. 727 * If not provided, the connect mode defaults to DIRECT_PEERING. 728 * </pre> 729 * 730 * <code> 731 * .google.cloud.redis.v1.Instance.ConnectMode connect_mode = 22 [(.google.api.field_behavior) = OPTIONAL]; 732 * </code> 733 * 734 * @return The enum numeric value on the wire for connectMode. 735 */ getConnectModeValue()736 int getConnectModeValue(); 737 /** 738 * 739 * 740 * <pre> 741 * Optional. The network connect mode of the Redis instance. 742 * If not provided, the connect mode defaults to DIRECT_PEERING. 743 * </pre> 744 * 745 * <code> 746 * .google.cloud.redis.v1.Instance.ConnectMode connect_mode = 22 [(.google.api.field_behavior) = OPTIONAL]; 747 * </code> 748 * 749 * @return The connectMode. 750 */ getConnectMode()751 com.google.cloud.redis.v1.Instance.ConnectMode getConnectMode(); 752 753 /** 754 * 755 * 756 * <pre> 757 * Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If 758 * set to "true" AUTH is enabled on the instance. Default value is "false" 759 * meaning AUTH is disabled. 760 * </pre> 761 * 762 * <code>bool auth_enabled = 23 [(.google.api.field_behavior) = OPTIONAL];</code> 763 * 764 * @return The authEnabled. 765 */ getAuthEnabled()766 boolean getAuthEnabled(); 767 768 /** 769 * 770 * 771 * <pre> 772 * Output only. List of server CA certificates for the instance. 773 * </pre> 774 * 775 * <code> 776 * repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; 777 * </code> 778 */ getServerCaCertsList()779 java.util.List<com.google.cloud.redis.v1.TlsCertificate> getServerCaCertsList(); 780 /** 781 * 782 * 783 * <pre> 784 * Output only. List of server CA certificates for the instance. 785 * </pre> 786 * 787 * <code> 788 * repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; 789 * </code> 790 */ getServerCaCerts(int index)791 com.google.cloud.redis.v1.TlsCertificate getServerCaCerts(int index); 792 /** 793 * 794 * 795 * <pre> 796 * Output only. List of server CA certificates for the instance. 797 * </pre> 798 * 799 * <code> 800 * repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; 801 * </code> 802 */ getServerCaCertsCount()803 int getServerCaCertsCount(); 804 /** 805 * 806 * 807 * <pre> 808 * Output only. List of server CA certificates for the instance. 809 * </pre> 810 * 811 * <code> 812 * repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; 813 * </code> 814 */ 815 java.util.List<? extends com.google.cloud.redis.v1.TlsCertificateOrBuilder> getServerCaCertsOrBuilderList()816 getServerCaCertsOrBuilderList(); 817 /** 818 * 819 * 820 * <pre> 821 * Output only. List of server CA certificates for the instance. 822 * </pre> 823 * 824 * <code> 825 * repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; 826 * </code> 827 */ getServerCaCertsOrBuilder(int index)828 com.google.cloud.redis.v1.TlsCertificateOrBuilder getServerCaCertsOrBuilder(int index); 829 830 /** 831 * 832 * 833 * <pre> 834 * Optional. The TLS mode of the Redis instance. 835 * If not provided, TLS is disabled for the instance. 836 * </pre> 837 * 838 * <code> 839 * .google.cloud.redis.v1.Instance.TransitEncryptionMode transit_encryption_mode = 26 [(.google.api.field_behavior) = OPTIONAL]; 840 * </code> 841 * 842 * @return The enum numeric value on the wire for transitEncryptionMode. 843 */ getTransitEncryptionModeValue()844 int getTransitEncryptionModeValue(); 845 /** 846 * 847 * 848 * <pre> 849 * Optional. The TLS mode of the Redis instance. 850 * If not provided, TLS is disabled for the instance. 851 * </pre> 852 * 853 * <code> 854 * .google.cloud.redis.v1.Instance.TransitEncryptionMode transit_encryption_mode = 26 [(.google.api.field_behavior) = OPTIONAL]; 855 * </code> 856 * 857 * @return The transitEncryptionMode. 858 */ getTransitEncryptionMode()859 com.google.cloud.redis.v1.Instance.TransitEncryptionMode getTransitEncryptionMode(); 860 861 /** 862 * 863 * 864 * <pre> 865 * Optional. The maintenance policy for the instance. If not provided, 866 * maintenance events can be performed at any time. 867 * </pre> 868 * 869 * <code> 870 * .google.cloud.redis.v1.MaintenancePolicy maintenance_policy = 27 [(.google.api.field_behavior) = OPTIONAL]; 871 * </code> 872 * 873 * @return Whether the maintenancePolicy field is set. 874 */ hasMaintenancePolicy()875 boolean hasMaintenancePolicy(); 876 /** 877 * 878 * 879 * <pre> 880 * Optional. The maintenance policy for the instance. If not provided, 881 * maintenance events can be performed at any time. 882 * </pre> 883 * 884 * <code> 885 * .google.cloud.redis.v1.MaintenancePolicy maintenance_policy = 27 [(.google.api.field_behavior) = OPTIONAL]; 886 * </code> 887 * 888 * @return The maintenancePolicy. 889 */ getMaintenancePolicy()890 com.google.cloud.redis.v1.MaintenancePolicy getMaintenancePolicy(); 891 /** 892 * 893 * 894 * <pre> 895 * Optional. The maintenance policy for the instance. If not provided, 896 * maintenance events can be performed at any time. 897 * </pre> 898 * 899 * <code> 900 * .google.cloud.redis.v1.MaintenancePolicy maintenance_policy = 27 [(.google.api.field_behavior) = OPTIONAL]; 901 * </code> 902 */ getMaintenancePolicyOrBuilder()903 com.google.cloud.redis.v1.MaintenancePolicyOrBuilder getMaintenancePolicyOrBuilder(); 904 905 /** 906 * 907 * 908 * <pre> 909 * Output only. Date and time of upcoming maintenance events which have been 910 * scheduled. 911 * </pre> 912 * 913 * <code> 914 * .google.cloud.redis.v1.MaintenanceSchedule maintenance_schedule = 28 [(.google.api.field_behavior) = OUTPUT_ONLY]; 915 * </code> 916 * 917 * @return Whether the maintenanceSchedule field is set. 918 */ hasMaintenanceSchedule()919 boolean hasMaintenanceSchedule(); 920 /** 921 * 922 * 923 * <pre> 924 * Output only. Date and time of upcoming maintenance events which have been 925 * scheduled. 926 * </pre> 927 * 928 * <code> 929 * .google.cloud.redis.v1.MaintenanceSchedule maintenance_schedule = 28 [(.google.api.field_behavior) = OUTPUT_ONLY]; 930 * </code> 931 * 932 * @return The maintenanceSchedule. 933 */ getMaintenanceSchedule()934 com.google.cloud.redis.v1.MaintenanceSchedule getMaintenanceSchedule(); 935 /** 936 * 937 * 938 * <pre> 939 * Output only. Date and time of upcoming maintenance events which have been 940 * scheduled. 941 * </pre> 942 * 943 * <code> 944 * .google.cloud.redis.v1.MaintenanceSchedule maintenance_schedule = 28 [(.google.api.field_behavior) = OUTPUT_ONLY]; 945 * </code> 946 */ getMaintenanceScheduleOrBuilder()947 com.google.cloud.redis.v1.MaintenanceScheduleOrBuilder getMaintenanceScheduleOrBuilder(); 948 949 /** 950 * 951 * 952 * <pre> 953 * Optional. The number of replica nodes. The valid range for the Standard 954 * Tier with read replicas enabled is [1-5] and defaults to 2. If read 955 * replicas are not enabled for a Standard Tier instance, the only valid value 956 * is 1 and the default is 1. The valid value for basic tier is 0 and the 957 * default is also 0. 958 * </pre> 959 * 960 * <code>int32 replica_count = 31 [(.google.api.field_behavior) = OPTIONAL];</code> 961 * 962 * @return The replicaCount. 963 */ getReplicaCount()964 int getReplicaCount(); 965 966 /** 967 * 968 * 969 * <pre> 970 * Output only. Info per node. 971 * </pre> 972 * 973 * <code> 974 * repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY]; 975 * </code> 976 */ getNodesList()977 java.util.List<com.google.cloud.redis.v1.NodeInfo> getNodesList(); 978 /** 979 * 980 * 981 * <pre> 982 * Output only. Info per node. 983 * </pre> 984 * 985 * <code> 986 * repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY]; 987 * </code> 988 */ getNodes(int index)989 com.google.cloud.redis.v1.NodeInfo getNodes(int index); 990 /** 991 * 992 * 993 * <pre> 994 * Output only. Info per node. 995 * </pre> 996 * 997 * <code> 998 * repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY]; 999 * </code> 1000 */ getNodesCount()1001 int getNodesCount(); 1002 /** 1003 * 1004 * 1005 * <pre> 1006 * Output only. Info per node. 1007 * </pre> 1008 * 1009 * <code> 1010 * repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1011 * </code> 1012 */ getNodesOrBuilderList()1013 java.util.List<? extends com.google.cloud.redis.v1.NodeInfoOrBuilder> getNodesOrBuilderList(); 1014 /** 1015 * 1016 * 1017 * <pre> 1018 * Output only. Info per node. 1019 * </pre> 1020 * 1021 * <code> 1022 * repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1023 * </code> 1024 */ getNodesOrBuilder(int index)1025 com.google.cloud.redis.v1.NodeInfoOrBuilder getNodesOrBuilder(int index); 1026 1027 /** 1028 * 1029 * 1030 * <pre> 1031 * Output only. Hostname or IP address of the exposed readonly Redis 1032 * endpoint. Standard tier only. Targets all healthy replica nodes in 1033 * instance. Replication is asynchronous and replica nodes will exhibit some 1034 * lag behind the primary. Write requests must target 'host'. 1035 * </pre> 1036 * 1037 * <code>string read_endpoint = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 1038 * 1039 * @return The readEndpoint. 1040 */ getReadEndpoint()1041 java.lang.String getReadEndpoint(); 1042 /** 1043 * 1044 * 1045 * <pre> 1046 * Output only. Hostname or IP address of the exposed readonly Redis 1047 * endpoint. Standard tier only. Targets all healthy replica nodes in 1048 * instance. Replication is asynchronous and replica nodes will exhibit some 1049 * lag behind the primary. Write requests must target 'host'. 1050 * </pre> 1051 * 1052 * <code>string read_endpoint = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 1053 * 1054 * @return The bytes for readEndpoint. 1055 */ getReadEndpointBytes()1056 com.google.protobuf.ByteString getReadEndpointBytes(); 1057 1058 /** 1059 * 1060 * 1061 * <pre> 1062 * Output only. The port number of the exposed readonly redis 1063 * endpoint. Standard tier only. Write requests should target 'port'. 1064 * </pre> 1065 * 1066 * <code>int32 read_endpoint_port = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 1067 * 1068 * @return The readEndpointPort. 1069 */ getReadEndpointPort()1070 int getReadEndpointPort(); 1071 1072 /** 1073 * 1074 * 1075 * <pre> 1076 * Optional. Read replicas mode for the instance. Defaults to 1077 * READ_REPLICAS_DISABLED. 1078 * </pre> 1079 * 1080 * <code> 1081 * .google.cloud.redis.v1.Instance.ReadReplicasMode read_replicas_mode = 35 [(.google.api.field_behavior) = OPTIONAL]; 1082 * </code> 1083 * 1084 * @return The enum numeric value on the wire for readReplicasMode. 1085 */ getReadReplicasModeValue()1086 int getReadReplicasModeValue(); 1087 /** 1088 * 1089 * 1090 * <pre> 1091 * Optional. Read replicas mode for the instance. Defaults to 1092 * READ_REPLICAS_DISABLED. 1093 * </pre> 1094 * 1095 * <code> 1096 * .google.cloud.redis.v1.Instance.ReadReplicasMode read_replicas_mode = 35 [(.google.api.field_behavior) = OPTIONAL]; 1097 * </code> 1098 * 1099 * @return The readReplicasMode. 1100 */ getReadReplicasMode()1101 com.google.cloud.redis.v1.Instance.ReadReplicasMode getReadReplicasMode(); 1102 1103 /** 1104 * 1105 * 1106 * <pre> 1107 * Optional. The KMS key reference that the customer provides when trying to 1108 * create the instance. 1109 * </pre> 1110 * 1111 * <code>string customer_managed_key = 36 [(.google.api.field_behavior) = OPTIONAL];</code> 1112 * 1113 * @return The customerManagedKey. 1114 */ getCustomerManagedKey()1115 java.lang.String getCustomerManagedKey(); 1116 /** 1117 * 1118 * 1119 * <pre> 1120 * Optional. The KMS key reference that the customer provides when trying to 1121 * create the instance. 1122 * </pre> 1123 * 1124 * <code>string customer_managed_key = 36 [(.google.api.field_behavior) = OPTIONAL];</code> 1125 * 1126 * @return The bytes for customerManagedKey. 1127 */ getCustomerManagedKeyBytes()1128 com.google.protobuf.ByteString getCustomerManagedKeyBytes(); 1129 1130 /** 1131 * 1132 * 1133 * <pre> 1134 * Optional. Persistence configuration parameters 1135 * </pre> 1136 * 1137 * <code> 1138 * .google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL]; 1139 * </code> 1140 * 1141 * @return Whether the persistenceConfig field is set. 1142 */ hasPersistenceConfig()1143 boolean hasPersistenceConfig(); 1144 /** 1145 * 1146 * 1147 * <pre> 1148 * Optional. Persistence configuration parameters 1149 * </pre> 1150 * 1151 * <code> 1152 * .google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL]; 1153 * </code> 1154 * 1155 * @return The persistenceConfig. 1156 */ getPersistenceConfig()1157 com.google.cloud.redis.v1.PersistenceConfig getPersistenceConfig(); 1158 /** 1159 * 1160 * 1161 * <pre> 1162 * Optional. Persistence configuration parameters 1163 * </pre> 1164 * 1165 * <code> 1166 * .google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL]; 1167 * </code> 1168 */ getPersistenceConfigOrBuilder()1169 com.google.cloud.redis.v1.PersistenceConfigOrBuilder getPersistenceConfigOrBuilder(); 1170 1171 /** 1172 * 1173 * 1174 * <pre> 1175 * Optional. reasons that causes instance in "SUSPENDED" state. 1176 * </pre> 1177 * 1178 * <code> 1179 * repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL]; 1180 * </code> 1181 * 1182 * @return A list containing the suspensionReasons. 1183 */ getSuspensionReasonsList()1184 java.util.List<com.google.cloud.redis.v1.Instance.SuspensionReason> getSuspensionReasonsList(); 1185 /** 1186 * 1187 * 1188 * <pre> 1189 * Optional. reasons that causes instance in "SUSPENDED" state. 1190 * </pre> 1191 * 1192 * <code> 1193 * repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL]; 1194 * </code> 1195 * 1196 * @return The count of suspensionReasons. 1197 */ getSuspensionReasonsCount()1198 int getSuspensionReasonsCount(); 1199 /** 1200 * 1201 * 1202 * <pre> 1203 * Optional. reasons that causes instance in "SUSPENDED" state. 1204 * </pre> 1205 * 1206 * <code> 1207 * repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL]; 1208 * </code> 1209 * 1210 * @param index The index of the element to return. 1211 * @return The suspensionReasons at the given index. 1212 */ getSuspensionReasons(int index)1213 com.google.cloud.redis.v1.Instance.SuspensionReason getSuspensionReasons(int index); 1214 /** 1215 * 1216 * 1217 * <pre> 1218 * Optional. reasons that causes instance in "SUSPENDED" state. 1219 * </pre> 1220 * 1221 * <code> 1222 * repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL]; 1223 * </code> 1224 * 1225 * @return A list containing the enum numeric values on the wire for suspensionReasons. 1226 */ getSuspensionReasonsValueList()1227 java.util.List<java.lang.Integer> getSuspensionReasonsValueList(); 1228 /** 1229 * 1230 * 1231 * <pre> 1232 * Optional. reasons that causes instance in "SUSPENDED" state. 1233 * </pre> 1234 * 1235 * <code> 1236 * repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL]; 1237 * </code> 1238 * 1239 * @param index The index of the value to return. 1240 * @return The enum numeric value on the wire of suspensionReasons at the given index. 1241 */ getSuspensionReasonsValue(int index)1242 int getSuspensionReasonsValue(int index); 1243 1244 /** 1245 * 1246 * 1247 * <pre> 1248 * Optional. The self service update maintenance version. 1249 * The version is date based such as "20210712_00_00". 1250 * </pre> 1251 * 1252 * <code>string maintenance_version = 39 [(.google.api.field_behavior) = OPTIONAL];</code> 1253 * 1254 * @return The maintenanceVersion. 1255 */ getMaintenanceVersion()1256 java.lang.String getMaintenanceVersion(); 1257 /** 1258 * 1259 * 1260 * <pre> 1261 * Optional. The self service update maintenance version. 1262 * The version is date based such as "20210712_00_00". 1263 * </pre> 1264 * 1265 * <code>string maintenance_version = 39 [(.google.api.field_behavior) = OPTIONAL];</code> 1266 * 1267 * @return The bytes for maintenanceVersion. 1268 */ getMaintenanceVersionBytes()1269 com.google.protobuf.ByteString getMaintenanceVersionBytes(); 1270 1271 /** 1272 * 1273 * 1274 * <pre> 1275 * Optional. The available maintenance versions that an instance could update 1276 * to. 1277 * </pre> 1278 * 1279 * <code> 1280 * repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL]; 1281 * </code> 1282 * 1283 * @return A list containing the availableMaintenanceVersions. 1284 */ getAvailableMaintenanceVersionsList()1285 java.util.List<java.lang.String> getAvailableMaintenanceVersionsList(); 1286 /** 1287 * 1288 * 1289 * <pre> 1290 * Optional. The available maintenance versions that an instance could update 1291 * to. 1292 * </pre> 1293 * 1294 * <code> 1295 * repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL]; 1296 * </code> 1297 * 1298 * @return The count of availableMaintenanceVersions. 1299 */ getAvailableMaintenanceVersionsCount()1300 int getAvailableMaintenanceVersionsCount(); 1301 /** 1302 * 1303 * 1304 * <pre> 1305 * Optional. The available maintenance versions that an instance could update 1306 * to. 1307 * </pre> 1308 * 1309 * <code> 1310 * repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL]; 1311 * </code> 1312 * 1313 * @param index The index of the element to return. 1314 * @return The availableMaintenanceVersions at the given index. 1315 */ getAvailableMaintenanceVersions(int index)1316 java.lang.String getAvailableMaintenanceVersions(int index); 1317 /** 1318 * 1319 * 1320 * <pre> 1321 * Optional. The available maintenance versions that an instance could update 1322 * to. 1323 * </pre> 1324 * 1325 * <code> 1326 * repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL]; 1327 * </code> 1328 * 1329 * @param index The index of the value to return. 1330 * @return The bytes of the availableMaintenanceVersions at the given index. 1331 */ getAvailableMaintenanceVersionsBytes(int index)1332 com.google.protobuf.ByteString getAvailableMaintenanceVersionsBytes(int index); 1333 } 1334