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/container/v1/cluster_service.proto 18 19 package com.google.container.v1; 20 21 public interface OperationOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.container.v1.Operation) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The server-assigned ID for the operation. 31 * </pre> 32 * 33 * <code>string name = 1;</code> 34 * 35 * @return The name. 36 */ getName()37 java.lang.String getName(); 38 /** 39 * 40 * 41 * <pre> 42 * The server-assigned ID for the operation. 43 * </pre> 44 * 45 * <code>string name = 1;</code> 46 * 47 * @return The bytes for name. 48 */ getNameBytes()49 com.google.protobuf.ByteString getNameBytes(); 50 51 /** 52 * 53 * 54 * <pre> 55 * The name of the Google Compute Engine 56 * [zone](https://cloud.google.com/compute/docs/zones#available) in which the 57 * operation is taking place. This field is deprecated, use location instead. 58 * </pre> 59 * 60 * <code>string zone = 2 [deprecated = true];</code> 61 * 62 * @deprecated google.container.v1.Operation.zone is deprecated. See 63 * google/container/v1/cluster_service.proto;l=2240 64 * @return The zone. 65 */ 66 @java.lang.Deprecated getZone()67 java.lang.String getZone(); 68 /** 69 * 70 * 71 * <pre> 72 * The name of the Google Compute Engine 73 * [zone](https://cloud.google.com/compute/docs/zones#available) in which the 74 * operation is taking place. This field is deprecated, use location instead. 75 * </pre> 76 * 77 * <code>string zone = 2 [deprecated = true];</code> 78 * 79 * @deprecated google.container.v1.Operation.zone is deprecated. See 80 * google/container/v1/cluster_service.proto;l=2240 81 * @return The bytes for zone. 82 */ 83 @java.lang.Deprecated getZoneBytes()84 com.google.protobuf.ByteString getZoneBytes(); 85 86 /** 87 * 88 * 89 * <pre> 90 * The operation type. 91 * </pre> 92 * 93 * <code>.google.container.v1.Operation.Type operation_type = 3;</code> 94 * 95 * @return The enum numeric value on the wire for operationType. 96 */ getOperationTypeValue()97 int getOperationTypeValue(); 98 /** 99 * 100 * 101 * <pre> 102 * The operation type. 103 * </pre> 104 * 105 * <code>.google.container.v1.Operation.Type operation_type = 3;</code> 106 * 107 * @return The operationType. 108 */ getOperationType()109 com.google.container.v1.Operation.Type getOperationType(); 110 111 /** 112 * 113 * 114 * <pre> 115 * The current status of the operation. 116 * </pre> 117 * 118 * <code>.google.container.v1.Operation.Status status = 4;</code> 119 * 120 * @return The enum numeric value on the wire for status. 121 */ getStatusValue()122 int getStatusValue(); 123 /** 124 * 125 * 126 * <pre> 127 * The current status of the operation. 128 * </pre> 129 * 130 * <code>.google.container.v1.Operation.Status status = 4;</code> 131 * 132 * @return The status. 133 */ getStatus()134 com.google.container.v1.Operation.Status getStatus(); 135 136 /** 137 * 138 * 139 * <pre> 140 * Detailed operation progress, if available. 141 * </pre> 142 * 143 * <code>string detail = 8;</code> 144 * 145 * @return The detail. 146 */ getDetail()147 java.lang.String getDetail(); 148 /** 149 * 150 * 151 * <pre> 152 * Detailed operation progress, if available. 153 * </pre> 154 * 155 * <code>string detail = 8;</code> 156 * 157 * @return The bytes for detail. 158 */ getDetailBytes()159 com.google.protobuf.ByteString getDetailBytes(); 160 161 /** 162 * 163 * 164 * <pre> 165 * Output only. If an error has occurred, a textual description of the error. 166 * Deprecated. Use the field error instead. 167 * </pre> 168 * 169 * <code> 170 * string status_message = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; 171 * </code> 172 * 173 * @deprecated google.container.v1.Operation.status_message is deprecated. See 174 * google/container/v1/cluster_service.proto;l=2253 175 * @return The statusMessage. 176 */ 177 @java.lang.Deprecated getStatusMessage()178 java.lang.String getStatusMessage(); 179 /** 180 * 181 * 182 * <pre> 183 * Output only. If an error has occurred, a textual description of the error. 184 * Deprecated. Use the field error instead. 185 * </pre> 186 * 187 * <code> 188 * string status_message = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; 189 * </code> 190 * 191 * @deprecated google.container.v1.Operation.status_message is deprecated. See 192 * google/container/v1/cluster_service.proto;l=2253 193 * @return The bytes for statusMessage. 194 */ 195 @java.lang.Deprecated getStatusMessageBytes()196 com.google.protobuf.ByteString getStatusMessageBytes(); 197 198 /** 199 * 200 * 201 * <pre> 202 * Server-defined URI for the operation. Example: 203 * `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. 204 * </pre> 205 * 206 * <code>string self_link = 6;</code> 207 * 208 * @return The selfLink. 209 */ getSelfLink()210 java.lang.String getSelfLink(); 211 /** 212 * 213 * 214 * <pre> 215 * Server-defined URI for the operation. Example: 216 * `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. 217 * </pre> 218 * 219 * <code>string self_link = 6;</code> 220 * 221 * @return The bytes for selfLink. 222 */ getSelfLinkBytes()223 com.google.protobuf.ByteString getSelfLinkBytes(); 224 225 /** 226 * 227 * 228 * <pre> 229 * Server-defined URI for the target of the operation. The format of this is a 230 * URI to the resource being modified (such as a cluster, node pool, or node). 231 * For node pool repairs, there may be multiple nodes being repaired, but only 232 * one will be the target. 233 * Examples: 234 * - 235 * `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` 236 * - 237 * `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` 238 * - 239 * `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` 240 * </pre> 241 * 242 * <code>string target_link = 7;</code> 243 * 244 * @return The targetLink. 245 */ getTargetLink()246 java.lang.String getTargetLink(); 247 /** 248 * 249 * 250 * <pre> 251 * Server-defined URI for the target of the operation. The format of this is a 252 * URI to the resource being modified (such as a cluster, node pool, or node). 253 * For node pool repairs, there may be multiple nodes being repaired, but only 254 * one will be the target. 255 * Examples: 256 * - 257 * `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` 258 * - 259 * `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` 260 * - 261 * `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` 262 * </pre> 263 * 264 * <code>string target_link = 7;</code> 265 * 266 * @return The bytes for targetLink. 267 */ getTargetLinkBytes()268 com.google.protobuf.ByteString getTargetLinkBytes(); 269 270 /** 271 * 272 * 273 * <pre> 274 * [Output only] The name of the Google Compute Engine 275 * [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) 276 * or 277 * [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) 278 * in which the cluster resides. 279 * </pre> 280 * 281 * <code>string location = 9;</code> 282 * 283 * @return The location. 284 */ getLocation()285 java.lang.String getLocation(); 286 /** 287 * 288 * 289 * <pre> 290 * [Output only] The name of the Google Compute Engine 291 * [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) 292 * or 293 * [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) 294 * in which the cluster resides. 295 * </pre> 296 * 297 * <code>string location = 9;</code> 298 * 299 * @return The bytes for location. 300 */ getLocationBytes()301 com.google.protobuf.ByteString getLocationBytes(); 302 303 /** 304 * 305 * 306 * <pre> 307 * [Output only] The time the operation started, in 308 * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 309 * </pre> 310 * 311 * <code>string start_time = 10;</code> 312 * 313 * @return The startTime. 314 */ getStartTime()315 java.lang.String getStartTime(); 316 /** 317 * 318 * 319 * <pre> 320 * [Output only] The time the operation started, in 321 * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 322 * </pre> 323 * 324 * <code>string start_time = 10;</code> 325 * 326 * @return The bytes for startTime. 327 */ getStartTimeBytes()328 com.google.protobuf.ByteString getStartTimeBytes(); 329 330 /** 331 * 332 * 333 * <pre> 334 * [Output only] The time the operation completed, in 335 * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 336 * </pre> 337 * 338 * <code>string end_time = 11;</code> 339 * 340 * @return The endTime. 341 */ getEndTime()342 java.lang.String getEndTime(); 343 /** 344 * 345 * 346 * <pre> 347 * [Output only] The time the operation completed, in 348 * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 349 * </pre> 350 * 351 * <code>string end_time = 11;</code> 352 * 353 * @return The bytes for endTime. 354 */ getEndTimeBytes()355 com.google.protobuf.ByteString getEndTimeBytes(); 356 357 /** 358 * 359 * 360 * <pre> 361 * Output only. [Output only] Progress information for an operation. 362 * </pre> 363 * 364 * <code> 365 * .google.container.v1.OperationProgress progress = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 366 * </code> 367 * 368 * @return Whether the progress field is set. 369 */ hasProgress()370 boolean hasProgress(); 371 /** 372 * 373 * 374 * <pre> 375 * Output only. [Output only] Progress information for an operation. 376 * </pre> 377 * 378 * <code> 379 * .google.container.v1.OperationProgress progress = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 380 * </code> 381 * 382 * @return The progress. 383 */ getProgress()384 com.google.container.v1.OperationProgress getProgress(); 385 /** 386 * 387 * 388 * <pre> 389 * Output only. [Output only] Progress information for an operation. 390 * </pre> 391 * 392 * <code> 393 * .google.container.v1.OperationProgress progress = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 394 * </code> 395 */ getProgressOrBuilder()396 com.google.container.v1.OperationProgressOrBuilder getProgressOrBuilder(); 397 398 /** 399 * 400 * 401 * <pre> 402 * Which conditions caused the current cluster state. 403 * Deprecated. Use field error instead. 404 * </pre> 405 * 406 * <code> 407 * repeated .google.container.v1.StatusCondition cluster_conditions = 13 [deprecated = true]; 408 * </code> 409 */ 410 @java.lang.Deprecated getClusterConditionsList()411 java.util.List<com.google.container.v1.StatusCondition> getClusterConditionsList(); 412 /** 413 * 414 * 415 * <pre> 416 * Which conditions caused the current cluster state. 417 * Deprecated. Use field error instead. 418 * </pre> 419 * 420 * <code> 421 * repeated .google.container.v1.StatusCondition cluster_conditions = 13 [deprecated = true]; 422 * </code> 423 */ 424 @java.lang.Deprecated getClusterConditions(int index)425 com.google.container.v1.StatusCondition getClusterConditions(int index); 426 /** 427 * 428 * 429 * <pre> 430 * Which conditions caused the current cluster state. 431 * Deprecated. Use field error instead. 432 * </pre> 433 * 434 * <code> 435 * repeated .google.container.v1.StatusCondition cluster_conditions = 13 [deprecated = true]; 436 * </code> 437 */ 438 @java.lang.Deprecated getClusterConditionsCount()439 int getClusterConditionsCount(); 440 /** 441 * 442 * 443 * <pre> 444 * Which conditions caused the current cluster state. 445 * Deprecated. Use field error instead. 446 * </pre> 447 * 448 * <code> 449 * repeated .google.container.v1.StatusCondition cluster_conditions = 13 [deprecated = true]; 450 * </code> 451 */ 452 @java.lang.Deprecated 453 java.util.List<? extends com.google.container.v1.StatusConditionOrBuilder> getClusterConditionsOrBuilderList()454 getClusterConditionsOrBuilderList(); 455 /** 456 * 457 * 458 * <pre> 459 * Which conditions caused the current cluster state. 460 * Deprecated. Use field error instead. 461 * </pre> 462 * 463 * <code> 464 * repeated .google.container.v1.StatusCondition cluster_conditions = 13 [deprecated = true]; 465 * </code> 466 */ 467 @java.lang.Deprecated getClusterConditionsOrBuilder(int index)468 com.google.container.v1.StatusConditionOrBuilder getClusterConditionsOrBuilder(int index); 469 470 /** 471 * 472 * 473 * <pre> 474 * Which conditions caused the current node pool state. 475 * Deprecated. Use field error instead. 476 * </pre> 477 * 478 * <code> 479 * repeated .google.container.v1.StatusCondition nodepool_conditions = 14 [deprecated = true]; 480 * </code> 481 */ 482 @java.lang.Deprecated getNodepoolConditionsList()483 java.util.List<com.google.container.v1.StatusCondition> getNodepoolConditionsList(); 484 /** 485 * 486 * 487 * <pre> 488 * Which conditions caused the current node pool state. 489 * Deprecated. Use field error instead. 490 * </pre> 491 * 492 * <code> 493 * repeated .google.container.v1.StatusCondition nodepool_conditions = 14 [deprecated = true]; 494 * </code> 495 */ 496 @java.lang.Deprecated getNodepoolConditions(int index)497 com.google.container.v1.StatusCondition getNodepoolConditions(int index); 498 /** 499 * 500 * 501 * <pre> 502 * Which conditions caused the current node pool state. 503 * Deprecated. Use field error instead. 504 * </pre> 505 * 506 * <code> 507 * repeated .google.container.v1.StatusCondition nodepool_conditions = 14 [deprecated = true]; 508 * </code> 509 */ 510 @java.lang.Deprecated getNodepoolConditionsCount()511 int getNodepoolConditionsCount(); 512 /** 513 * 514 * 515 * <pre> 516 * Which conditions caused the current node pool state. 517 * Deprecated. Use field error instead. 518 * </pre> 519 * 520 * <code> 521 * repeated .google.container.v1.StatusCondition nodepool_conditions = 14 [deprecated = true]; 522 * </code> 523 */ 524 @java.lang.Deprecated 525 java.util.List<? extends com.google.container.v1.StatusConditionOrBuilder> getNodepoolConditionsOrBuilderList()526 getNodepoolConditionsOrBuilderList(); 527 /** 528 * 529 * 530 * <pre> 531 * Which conditions caused the current node pool state. 532 * Deprecated. Use field error instead. 533 * </pre> 534 * 535 * <code> 536 * repeated .google.container.v1.StatusCondition nodepool_conditions = 14 [deprecated = true]; 537 * </code> 538 */ 539 @java.lang.Deprecated getNodepoolConditionsOrBuilder(int index)540 com.google.container.v1.StatusConditionOrBuilder getNodepoolConditionsOrBuilder(int index); 541 542 /** 543 * 544 * 545 * <pre> 546 * The error result of the operation in case of failure. 547 * </pre> 548 * 549 * <code>.google.rpc.Status error = 15;</code> 550 * 551 * @return Whether the error field is set. 552 */ hasError()553 boolean hasError(); 554 /** 555 * 556 * 557 * <pre> 558 * The error result of the operation in case of failure. 559 * </pre> 560 * 561 * <code>.google.rpc.Status error = 15;</code> 562 * 563 * @return The error. 564 */ getError()565 com.google.rpc.Status getError(); 566 /** 567 * 568 * 569 * <pre> 570 * The error result of the operation in case of failure. 571 * </pre> 572 * 573 * <code>.google.rpc.Status error = 15;</code> 574 */ getErrorOrBuilder()575 com.google.rpc.StatusOrBuilder getErrorOrBuilder(); 576 } 577