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/clouddms/v1/clouddms_resources.proto 18 19 package com.google.cloud.clouddms.v1; 20 21 public interface MigrationJobOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.clouddms.v1.MigrationJob) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The name (URI) of this migration job resource, in the form of: 31 * projects/{project}/locations/{location}/instances/{instance}. 32 * </pre> 33 * 34 * <code>string name = 1;</code> 35 * 36 * @return The name. 37 */ getName()38 java.lang.String getName(); 39 /** 40 * 41 * 42 * <pre> 43 * The name (URI) of this migration job resource, in the form of: 44 * projects/{project}/locations/{location}/instances/{instance}. 45 * </pre> 46 * 47 * <code>string name = 1;</code> 48 * 49 * @return The bytes for name. 50 */ getNameBytes()51 com.google.protobuf.ByteString getNameBytes(); 52 53 /** 54 * 55 * 56 * <pre> 57 * Output only. The timestamp when the migration job resource was created. 58 * A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. 59 * Example: "2014-10-02T15:01:23.045123456Z". 60 * </pre> 61 * 62 * <code>.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; 63 * </code> 64 * 65 * @return Whether the createTime field is set. 66 */ hasCreateTime()67 boolean hasCreateTime(); 68 /** 69 * 70 * 71 * <pre> 72 * Output only. The timestamp when the migration job resource was created. 73 * A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. 74 * Example: "2014-10-02T15:01:23.045123456Z". 75 * </pre> 76 * 77 * <code>.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; 78 * </code> 79 * 80 * @return The createTime. 81 */ getCreateTime()82 com.google.protobuf.Timestamp getCreateTime(); 83 /** 84 * 85 * 86 * <pre> 87 * Output only. The timestamp when the migration job resource was created. 88 * A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. 89 * Example: "2014-10-02T15:01:23.045123456Z". 90 * </pre> 91 * 92 * <code>.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; 93 * </code> 94 */ getCreateTimeOrBuilder()95 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 96 97 /** 98 * 99 * 100 * <pre> 101 * Output only. The timestamp when the migration job resource was last updated. 102 * A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. 103 * Example: "2014-10-02T15:01:23.045123456Z". 104 * </pre> 105 * 106 * <code>.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; 107 * </code> 108 * 109 * @return Whether the updateTime field is set. 110 */ hasUpdateTime()111 boolean hasUpdateTime(); 112 /** 113 * 114 * 115 * <pre> 116 * Output only. The timestamp when the migration job resource was last updated. 117 * A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. 118 * Example: "2014-10-02T15:01:23.045123456Z". 119 * </pre> 120 * 121 * <code>.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; 122 * </code> 123 * 124 * @return The updateTime. 125 */ getUpdateTime()126 com.google.protobuf.Timestamp getUpdateTime(); 127 /** 128 * 129 * 130 * <pre> 131 * Output only. The timestamp when the migration job resource was last updated. 132 * A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. 133 * Example: "2014-10-02T15:01:23.045123456Z". 134 * </pre> 135 * 136 * <code>.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; 137 * </code> 138 */ getUpdateTimeOrBuilder()139 com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); 140 141 /** 142 * 143 * 144 * <pre> 145 * The resource labels for migration job to use to annotate any related 146 * underlying resources such as Compute Engine VMs. An object containing a 147 * list of "key": "value" pairs. 148 * Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. 149 * </pre> 150 * 151 * <code>map<string, string> labels = 4;</code> 152 */ getLabelsCount()153 int getLabelsCount(); 154 /** 155 * 156 * 157 * <pre> 158 * The resource labels for migration job to use to annotate any related 159 * underlying resources such as Compute Engine VMs. An object containing a 160 * list of "key": "value" pairs. 161 * Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. 162 * </pre> 163 * 164 * <code>map<string, string> labels = 4;</code> 165 */ containsLabels(java.lang.String key)166 boolean containsLabels(java.lang.String key); 167 /** Use {@link #getLabelsMap()} instead. */ 168 @java.lang.Deprecated getLabels()169 java.util.Map<java.lang.String, java.lang.String> getLabels(); 170 /** 171 * 172 * 173 * <pre> 174 * The resource labels for migration job to use to annotate any related 175 * underlying resources such as Compute Engine VMs. An object containing a 176 * list of "key": "value" pairs. 177 * Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. 178 * </pre> 179 * 180 * <code>map<string, string> labels = 4;</code> 181 */ getLabelsMap()182 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 183 /** 184 * 185 * 186 * <pre> 187 * The resource labels for migration job to use to annotate any related 188 * underlying resources such as Compute Engine VMs. An object containing a 189 * list of "key": "value" pairs. 190 * Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. 191 * </pre> 192 * 193 * <code>map<string, string> labels = 4;</code> 194 */ 195 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)196 java.lang.String getLabelsOrDefault( 197 java.lang.String key, 198 /* nullable */ 199 java.lang.String defaultValue); 200 /** 201 * 202 * 203 * <pre> 204 * The resource labels for migration job to use to annotate any related 205 * underlying resources such as Compute Engine VMs. An object containing a 206 * list of "key": "value" pairs. 207 * Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. 208 * </pre> 209 * 210 * <code>map<string, string> labels = 4;</code> 211 */ getLabelsOrThrow(java.lang.String key)212 java.lang.String getLabelsOrThrow(java.lang.String key); 213 214 /** 215 * 216 * 217 * <pre> 218 * The migration job display name. 219 * </pre> 220 * 221 * <code>string display_name = 5;</code> 222 * 223 * @return The displayName. 224 */ getDisplayName()225 java.lang.String getDisplayName(); 226 /** 227 * 228 * 229 * <pre> 230 * The migration job display name. 231 * </pre> 232 * 233 * <code>string display_name = 5;</code> 234 * 235 * @return The bytes for displayName. 236 */ getDisplayNameBytes()237 com.google.protobuf.ByteString getDisplayNameBytes(); 238 239 /** 240 * 241 * 242 * <pre> 243 * The current migration job state. 244 * </pre> 245 * 246 * <code>.google.cloud.clouddms.v1.MigrationJob.State state = 6;</code> 247 * 248 * @return The enum numeric value on the wire for state. 249 */ getStateValue()250 int getStateValue(); 251 /** 252 * 253 * 254 * <pre> 255 * The current migration job state. 256 * </pre> 257 * 258 * <code>.google.cloud.clouddms.v1.MigrationJob.State state = 6;</code> 259 * 260 * @return The state. 261 */ getState()262 com.google.cloud.clouddms.v1.MigrationJob.State getState(); 263 264 /** 265 * 266 * 267 * <pre> 268 * Output only. The current migration job phase. 269 * </pre> 270 * 271 * <code> 272 * .google.cloud.clouddms.v1.MigrationJob.Phase phase = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 273 * </code> 274 * 275 * @return The enum numeric value on the wire for phase. 276 */ getPhaseValue()277 int getPhaseValue(); 278 /** 279 * 280 * 281 * <pre> 282 * Output only. The current migration job phase. 283 * </pre> 284 * 285 * <code> 286 * .google.cloud.clouddms.v1.MigrationJob.Phase phase = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 287 * </code> 288 * 289 * @return The phase. 290 */ getPhase()291 com.google.cloud.clouddms.v1.MigrationJob.Phase getPhase(); 292 293 /** 294 * 295 * 296 * <pre> 297 * Required. The migration job type. 298 * </pre> 299 * 300 * <code> 301 * .google.cloud.clouddms.v1.MigrationJob.Type type = 8 [(.google.api.field_behavior) = REQUIRED]; 302 * </code> 303 * 304 * @return The enum numeric value on the wire for type. 305 */ getTypeValue()306 int getTypeValue(); 307 /** 308 * 309 * 310 * <pre> 311 * Required. The migration job type. 312 * </pre> 313 * 314 * <code> 315 * .google.cloud.clouddms.v1.MigrationJob.Type type = 8 [(.google.api.field_behavior) = REQUIRED]; 316 * </code> 317 * 318 * @return The type. 319 */ getType()320 com.google.cloud.clouddms.v1.MigrationJob.Type getType(); 321 322 /** 323 * 324 * 325 * <pre> 326 * The path to the dump file in Google Cloud Storage, 327 * in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). 328 * </pre> 329 * 330 * <code>string dump_path = 9;</code> 331 * 332 * @return The dumpPath. 333 */ getDumpPath()334 java.lang.String getDumpPath(); 335 /** 336 * 337 * 338 * <pre> 339 * The path to the dump file in Google Cloud Storage, 340 * in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). 341 * </pre> 342 * 343 * <code>string dump_path = 9;</code> 344 * 345 * @return The bytes for dumpPath. 346 */ getDumpPathBytes()347 com.google.protobuf.ByteString getDumpPathBytes(); 348 349 /** 350 * 351 * 352 * <pre> 353 * Required. The resource name (URI) of the source connection profile. 354 * </pre> 355 * 356 * <code>string source = 10 [(.google.api.field_behavior) = REQUIRED];</code> 357 * 358 * @return The source. 359 */ getSource()360 java.lang.String getSource(); 361 /** 362 * 363 * 364 * <pre> 365 * Required. The resource name (URI) of the source connection profile. 366 * </pre> 367 * 368 * <code>string source = 10 [(.google.api.field_behavior) = REQUIRED];</code> 369 * 370 * @return The bytes for source. 371 */ getSourceBytes()372 com.google.protobuf.ByteString getSourceBytes(); 373 374 /** 375 * 376 * 377 * <pre> 378 * Required. The resource name (URI) of the destination connection profile. 379 * </pre> 380 * 381 * <code>string destination = 11 [(.google.api.field_behavior) = REQUIRED];</code> 382 * 383 * @return The destination. 384 */ getDestination()385 java.lang.String getDestination(); 386 /** 387 * 388 * 389 * <pre> 390 * Required. The resource name (URI) of the destination connection profile. 391 * </pre> 392 * 393 * <code>string destination = 11 [(.google.api.field_behavior) = REQUIRED];</code> 394 * 395 * @return The bytes for destination. 396 */ getDestinationBytes()397 com.google.protobuf.ByteString getDestinationBytes(); 398 399 /** 400 * 401 * 402 * <pre> 403 * The details needed to communicate to the source over Reverse SSH 404 * tunnel connectivity. 405 * </pre> 406 * 407 * <code>.google.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;</code> 408 * 409 * @return Whether the reverseSshConnectivity field is set. 410 */ hasReverseSshConnectivity()411 boolean hasReverseSshConnectivity(); 412 /** 413 * 414 * 415 * <pre> 416 * The details needed to communicate to the source over Reverse SSH 417 * tunnel connectivity. 418 * </pre> 419 * 420 * <code>.google.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;</code> 421 * 422 * @return The reverseSshConnectivity. 423 */ getReverseSshConnectivity()424 com.google.cloud.clouddms.v1.ReverseSshConnectivity getReverseSshConnectivity(); 425 /** 426 * 427 * 428 * <pre> 429 * The details needed to communicate to the source over Reverse SSH 430 * tunnel connectivity. 431 * </pre> 432 * 433 * <code>.google.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;</code> 434 */ getReverseSshConnectivityOrBuilder()435 com.google.cloud.clouddms.v1.ReverseSshConnectivityOrBuilder getReverseSshConnectivityOrBuilder(); 436 437 /** 438 * 439 * 440 * <pre> 441 * The details of the VPC network that the source database is located in. 442 * </pre> 443 * 444 * <code>.google.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;</code> 445 * 446 * @return Whether the vpcPeeringConnectivity field is set. 447 */ hasVpcPeeringConnectivity()448 boolean hasVpcPeeringConnectivity(); 449 /** 450 * 451 * 452 * <pre> 453 * The details of the VPC network that the source database is located in. 454 * </pre> 455 * 456 * <code>.google.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;</code> 457 * 458 * @return The vpcPeeringConnectivity. 459 */ getVpcPeeringConnectivity()460 com.google.cloud.clouddms.v1.VpcPeeringConnectivity getVpcPeeringConnectivity(); 461 /** 462 * 463 * 464 * <pre> 465 * The details of the VPC network that the source database is located in. 466 * </pre> 467 * 468 * <code>.google.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;</code> 469 */ getVpcPeeringConnectivityOrBuilder()470 com.google.cloud.clouddms.v1.VpcPeeringConnectivityOrBuilder getVpcPeeringConnectivityOrBuilder(); 471 472 /** 473 * 474 * 475 * <pre> 476 * static ip connectivity data (default, no additional details needed). 477 * </pre> 478 * 479 * <code>.google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;</code> 480 * 481 * @return Whether the staticIpConnectivity field is set. 482 */ hasStaticIpConnectivity()483 boolean hasStaticIpConnectivity(); 484 /** 485 * 486 * 487 * <pre> 488 * static ip connectivity data (default, no additional details needed). 489 * </pre> 490 * 491 * <code>.google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;</code> 492 * 493 * @return The staticIpConnectivity. 494 */ getStaticIpConnectivity()495 com.google.cloud.clouddms.v1.StaticIpConnectivity getStaticIpConnectivity(); 496 /** 497 * 498 * 499 * <pre> 500 * static ip connectivity data (default, no additional details needed). 501 * </pre> 502 * 503 * <code>.google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;</code> 504 */ getStaticIpConnectivityOrBuilder()505 com.google.cloud.clouddms.v1.StaticIpConnectivityOrBuilder getStaticIpConnectivityOrBuilder(); 506 507 /** 508 * 509 * 510 * <pre> 511 * Output only. The duration of the migration job (in seconds). A duration in seconds 512 * with up to nine fractional digits, terminated by 's'. Example: "3.5s". 513 * </pre> 514 * 515 * <code>.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 516 * </code> 517 * 518 * @return Whether the duration field is set. 519 */ hasDuration()520 boolean hasDuration(); 521 /** 522 * 523 * 524 * <pre> 525 * Output only. The duration of the migration job (in seconds). A duration in seconds 526 * with up to nine fractional digits, terminated by 's'. Example: "3.5s". 527 * </pre> 528 * 529 * <code>.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 530 * </code> 531 * 532 * @return The duration. 533 */ getDuration()534 com.google.protobuf.Duration getDuration(); 535 /** 536 * 537 * 538 * <pre> 539 * Output only. The duration of the migration job (in seconds). A duration in seconds 540 * with up to nine fractional digits, terminated by 's'. Example: "3.5s". 541 * </pre> 542 * 543 * <code>.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 544 * </code> 545 */ getDurationOrBuilder()546 com.google.protobuf.DurationOrBuilder getDurationOrBuilder(); 547 548 /** 549 * 550 * 551 * <pre> 552 * Output only. The error details in case of state FAILED. 553 * </pre> 554 * 555 * <code>.google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 556 * 557 * @return Whether the error field is set. 558 */ hasError()559 boolean hasError(); 560 /** 561 * 562 * 563 * <pre> 564 * Output only. The error details in case of state FAILED. 565 * </pre> 566 * 567 * <code>.google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 568 * 569 * @return The error. 570 */ getError()571 com.google.rpc.Status getError(); 572 /** 573 * 574 * 575 * <pre> 576 * Output only. The error details in case of state FAILED. 577 * </pre> 578 * 579 * <code>.google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 580 */ getErrorOrBuilder()581 com.google.rpc.StatusOrBuilder getErrorOrBuilder(); 582 583 /** 584 * 585 * 586 * <pre> 587 * The database engine type and provider of the source. 588 * </pre> 589 * 590 * <code>.google.cloud.clouddms.v1.DatabaseType source_database = 14;</code> 591 * 592 * @return Whether the sourceDatabase field is set. 593 */ hasSourceDatabase()594 boolean hasSourceDatabase(); 595 /** 596 * 597 * 598 * <pre> 599 * The database engine type and provider of the source. 600 * </pre> 601 * 602 * <code>.google.cloud.clouddms.v1.DatabaseType source_database = 14;</code> 603 * 604 * @return The sourceDatabase. 605 */ getSourceDatabase()606 com.google.cloud.clouddms.v1.DatabaseType getSourceDatabase(); 607 /** 608 * 609 * 610 * <pre> 611 * The database engine type and provider of the source. 612 * </pre> 613 * 614 * <code>.google.cloud.clouddms.v1.DatabaseType source_database = 14;</code> 615 */ getSourceDatabaseOrBuilder()616 com.google.cloud.clouddms.v1.DatabaseTypeOrBuilder getSourceDatabaseOrBuilder(); 617 618 /** 619 * 620 * 621 * <pre> 622 * The database engine type and provider of the destination. 623 * </pre> 624 * 625 * <code>.google.cloud.clouddms.v1.DatabaseType destination_database = 15;</code> 626 * 627 * @return Whether the destinationDatabase field is set. 628 */ hasDestinationDatabase()629 boolean hasDestinationDatabase(); 630 /** 631 * 632 * 633 * <pre> 634 * The database engine type and provider of the destination. 635 * </pre> 636 * 637 * <code>.google.cloud.clouddms.v1.DatabaseType destination_database = 15;</code> 638 * 639 * @return The destinationDatabase. 640 */ getDestinationDatabase()641 com.google.cloud.clouddms.v1.DatabaseType getDestinationDatabase(); 642 /** 643 * 644 * 645 * <pre> 646 * The database engine type and provider of the destination. 647 * </pre> 648 * 649 * <code>.google.cloud.clouddms.v1.DatabaseType destination_database = 15;</code> 650 */ getDestinationDatabaseOrBuilder()651 com.google.cloud.clouddms.v1.DatabaseTypeOrBuilder getDestinationDatabaseOrBuilder(); 652 653 /** 654 * 655 * 656 * <pre> 657 * Output only. If the migration job is completed, the time when it was completed. 658 * </pre> 659 * 660 * <code>.google.protobuf.Timestamp end_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; 661 * </code> 662 * 663 * @return Whether the endTime field is set. 664 */ hasEndTime()665 boolean hasEndTime(); 666 /** 667 * 668 * 669 * <pre> 670 * Output only. If the migration job is completed, the time when it was completed. 671 * </pre> 672 * 673 * <code>.google.protobuf.Timestamp end_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; 674 * </code> 675 * 676 * @return The endTime. 677 */ getEndTime()678 com.google.protobuf.Timestamp getEndTime(); 679 /** 680 * 681 * 682 * <pre> 683 * Output only. If the migration job is completed, the time when it was completed. 684 * </pre> 685 * 686 * <code>.google.protobuf.Timestamp end_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; 687 * </code> 688 */ getEndTimeOrBuilder()689 com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder(); 690 getConnectivityCase()691 public com.google.cloud.clouddms.v1.MigrationJob.ConnectivityCase getConnectivityCase(); 692 } 693