Package com.google.cloud.clouddms.v1

Interface MigrationJobOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    MigrationJob, MigrationJob.Builder
    public interface MigrationJobOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         The name (URI) of this migration job resource, in the form of:
 projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The name (URI) of this migration job resource, in the form of:
 projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
        string name = 1;
        Returns:
        The bytes for name.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. The timestamp when the migration job resource was created.
 A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
 Example: "2014-10-02T15:01:23.045123456Z".
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. The timestamp when the migration job resource was created.
 A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
 Example: "2014-10-02T15:01:23.045123456Z".
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The timestamp when the migration job resource was created.
 A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
 Example: "2014-10-02T15:01:23.045123456Z".
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. The timestamp when the migration job resource was last
 updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
 Example: "2014-10-02T15:01:23.045123456Z".
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         Output only. The timestamp when the migration job resource was last
 updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
 Example: "2014-10-02T15:01:23.045123456Z".
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The timestamp when the migration job resource was last
 updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
 Example: "2014-10-02T15:01:23.045123456Z".
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsCount

        int getLabelsCount()
         The resource labels for migration job to use to annotate any related
 underlying resources such as Compute Engine VMs. An object containing a
 list of "key": "value" pairs.

 Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
        map<string, string> labels = 4;

      • containsLabels

        boolean containsLabels​(String key)
         The resource labels for migration job to use to annotate any related
 underlying resources such as Compute Engine VMs. An object containing a
 list of "key": "value" pairs.

 Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
        map<string, string> labels = 4;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         The resource labels for migration job to use to annotate any related
 underlying resources such as Compute Engine VMs. An object containing a
 list of "key": "value" pairs.

 Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
        map<string, string> labels = 4;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         The resource labels for migration job to use to annotate any related
 underlying resources such as Compute Engine VMs. An object containing a
 list of "key": "value" pairs.

 Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
        map<string, string> labels = 4;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         The resource labels for migration job to use to annotate any related
 underlying resources such as Compute Engine VMs. An object containing a
 list of "key": "value" pairs.

 Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
        map<string, string> labels = 4;

      • getDisplayName

        String getDisplayName()
         The migration job display name.
        string display_name = 5;
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         The migration job display name.
        string display_name = 5;
        Returns:
        The bytes for displayName.

      • getStateValue

        int getStateValue()
         The current migration job state.
        .google.cloud.clouddms.v1.MigrationJob.State state = 6;
        Returns:
        The enum numeric value on the wire for state.

      • getState

        MigrationJob.State getState()
         The current migration job state.
        .google.cloud.clouddms.v1.MigrationJob.State state = 6;
        Returns:
        The state.

      • getPhaseValue

        int getPhaseValue()
         Output only. The current migration job phase.
        .google.cloud.clouddms.v1.MigrationJob.Phase phase = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for phase.

      • getPhase

        MigrationJob.Phase getPhase()
         Output only. The current migration job phase.
        .google.cloud.clouddms.v1.MigrationJob.Phase phase = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The phase.

      • getTypeValue

        int getTypeValue()
         Required. The migration job type.
        .google.cloud.clouddms.v1.MigrationJob.Type type = 8 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The enum numeric value on the wire for type.

      • getType

        MigrationJob.Type getType()
         Required. The migration job type.
        .google.cloud.clouddms.v1.MigrationJob.Type type = 8 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The type.

      • getDumpPath

        String getDumpPath()
         The path to the dump file in Google Cloud Storage,
 in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]).
 This field and the "dump_flags" field are mutually exclusive.
        string dump_path = 9;
        Returns:
        The dumpPath.

      • getDumpPathBytes

        com.google.protobuf.ByteString getDumpPathBytes()
         The path to the dump file in Google Cloud Storage,
 in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]).
 This field and the "dump_flags" field are mutually exclusive.
        string dump_path = 9;
        Returns:
        The bytes for dumpPath.

      • hasDumpFlags

        boolean hasDumpFlags()
         The initial dump flags.
 This field and the "dump_path" field are mutually exclusive.
        .google.cloud.clouddms.v1.MigrationJob.DumpFlags dump_flags = 17;
        Returns:
        Whether the dumpFlags field is set.

      • getDumpFlags

        MigrationJob.DumpFlags getDumpFlags()
         The initial dump flags.
 This field and the "dump_path" field are mutually exclusive.
        .google.cloud.clouddms.v1.MigrationJob.DumpFlags dump_flags = 17;
        Returns:
        The dumpFlags.

      • getDumpFlagsOrBuilder

        MigrationJob.DumpFlagsOrBuilder getDumpFlagsOrBuilder()
         The initial dump flags.
 This field and the "dump_path" field are mutually exclusive.
        .google.cloud.clouddms.v1.MigrationJob.DumpFlags dump_flags = 17;

      • getSource

        String getSource()
         Required. The resource name (URI) of the source connection profile.
        string source = 10 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The source.

      • getSourceBytes

        com.google.protobuf.ByteString getSourceBytes()
         Required. The resource name (URI) of the source connection profile.
        string source = 10 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for source.

      • getDestination

        String getDestination()
         Required. The resource name (URI) of the destination connection profile.
        string destination = 11 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The destination.

      • getDestinationBytes

        com.google.protobuf.ByteString getDestinationBytes()
         Required. The resource name (URI) of the destination connection profile.
        string destination = 11 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for destination.

      • hasReverseSshConnectivity

        boolean hasReverseSshConnectivity()
         The details needed to communicate to the source over Reverse SSH
 tunnel connectivity.
        .google.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;
        Returns:
        Whether the reverseSshConnectivity field is set.

      • getReverseSshConnectivity

        ReverseSshConnectivity getReverseSshConnectivity()
         The details needed to communicate to the source over Reverse SSH
 tunnel connectivity.
        .google.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;
        Returns:
        The reverseSshConnectivity.

      • getReverseSshConnectivityOrBuilder

        ReverseSshConnectivityOrBuilder getReverseSshConnectivityOrBuilder()
         The details needed to communicate to the source over Reverse SSH
 tunnel connectivity.
        .google.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;

      • hasVpcPeeringConnectivity

        boolean hasVpcPeeringConnectivity()
         The details of the VPC network that the source database is located in.
        .google.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;
        Returns:
        Whether the vpcPeeringConnectivity field is set.

      • getVpcPeeringConnectivity

        VpcPeeringConnectivity getVpcPeeringConnectivity()
         The details of the VPC network that the source database is located in.
        .google.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;
        Returns:
        The vpcPeeringConnectivity.

      • getVpcPeeringConnectivityOrBuilder

        VpcPeeringConnectivityOrBuilder getVpcPeeringConnectivityOrBuilder()
         The details of the VPC network that the source database is located in.
        .google.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;

      • hasStaticIpConnectivity

        boolean hasStaticIpConnectivity()
         static ip connectivity data (default, no additional details needed).
        .google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;
        Returns:
        Whether the staticIpConnectivity field is set.

      • getStaticIpConnectivity

        StaticIpConnectivity getStaticIpConnectivity()
         static ip connectivity data (default, no additional details needed).
        .google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;
        Returns:
        The staticIpConnectivity.

      • getStaticIpConnectivityOrBuilder

        StaticIpConnectivityOrBuilder getStaticIpConnectivityOrBuilder()
         static ip connectivity data (default, no additional details needed).
        .google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;

      • hasDuration

        boolean hasDuration()
         Output only. The duration of the migration job (in seconds). A duration in
 seconds with up to nine fractional digits, terminated by 's'. Example:
 "3.5s".
        .google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the duration field is set.

      • getDuration

        com.google.protobuf.Duration getDuration()
         Output only. The duration of the migration job (in seconds). A duration in
 seconds with up to nine fractional digits, terminated by 's'. Example:
 "3.5s".
        .google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The duration.

      • getDurationOrBuilder

        com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
         Output only. The duration of the migration job (in seconds). A duration in
 seconds with up to nine fractional digits, terminated by 's'. Example:
 "3.5s".
        .google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasError

        boolean hasError()
         Output only. The error details in case of state FAILED.
        .google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the error field is set.

      • getError

        com.google.rpc.Status getError()
         Output only. The error details in case of state FAILED.
        .google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The error.

      • getErrorOrBuilder

        com.google.rpc.StatusOrBuilder getErrorOrBuilder()
         Output only. The error details in case of state FAILED.
        .google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasSourceDatabase

        boolean hasSourceDatabase()
         The database engine type and provider of the source.
        .google.cloud.clouddms.v1.DatabaseType source_database = 14;
        Returns:
        Whether the sourceDatabase field is set.

      • getSourceDatabase

        DatabaseType getSourceDatabase()
         The database engine type and provider of the source.
        .google.cloud.clouddms.v1.DatabaseType source_database = 14;
        Returns:
        The sourceDatabase.

      • getSourceDatabaseOrBuilder

        DatabaseTypeOrBuilder getSourceDatabaseOrBuilder()
         The database engine type and provider of the source.
        .google.cloud.clouddms.v1.DatabaseType source_database = 14;

      • hasDestinationDatabase

        boolean hasDestinationDatabase()
         The database engine type and provider of the destination.
        .google.cloud.clouddms.v1.DatabaseType destination_database = 15;
        Returns:
        Whether the destinationDatabase field is set.

      • getDestinationDatabase

        DatabaseType getDestinationDatabase()
         The database engine type and provider of the destination.
        .google.cloud.clouddms.v1.DatabaseType destination_database = 15;
        Returns:
        The destinationDatabase.

      • getDestinationDatabaseOrBuilder

        DatabaseTypeOrBuilder getDestinationDatabaseOrBuilder()
         The database engine type and provider of the destination.
        .google.cloud.clouddms.v1.DatabaseType destination_database = 15;

      • hasEndTime

        boolean hasEndTime()
         Output only. If the migration job is completed, the time when it was
 completed.
        .google.protobuf.Timestamp end_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the endTime field is set.

      • getEndTime

        com.google.protobuf.Timestamp getEndTime()
         Output only. If the migration job is completed, the time when it was
 completed.
        .google.protobuf.Timestamp end_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         Output only. If the migration job is completed, the time when it was
 completed.
        .google.protobuf.Timestamp end_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasConversionWorkspace

        boolean hasConversionWorkspace()
         The conversion workspace used by the migration.
        .google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;
        Returns:
        Whether the conversionWorkspace field is set.

      • getConversionWorkspace

        ConversionWorkspaceInfo getConversionWorkspace()
         The conversion workspace used by the migration.
        .google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;
        Returns:
        The conversionWorkspace.

      • getConversionWorkspaceOrBuilder

        ConversionWorkspaceInfoOrBuilder getConversionWorkspaceOrBuilder()
         The conversion workspace used by the migration.
        .google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;

      • getFilter

        String getFilter()
         This field can be used to select the entities to migrate as part of
 the migration job. It uses AIP-160 notation to select a subset of the
 entities configured on the associated conversion-workspace. This field
 should not be set on migration-jobs that are not associated with a
 conversion workspace.
        string filter = 20;
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         This field can be used to select the entities to migrate as part of
 the migration job. It uses AIP-160 notation to select a subset of the
 entities configured on the associated conversion-workspace. This field
 should not be set on migration-jobs that are not associated with a
 conversion workspace.
        string filter = 20;
        Returns:
        The bytes for filter.

      • getCmekKeyName

        String getCmekKeyName()
         The CMEK (customer-managed encryption key) fully qualified key name used
 for the migration job.
 This field supports all migration jobs types except for:
 * Mysql to Mysql (use the cmek field in the cloudsql connection profile
 instead).
 * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql
 connection profile instead).
 * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb
 connection profile instead).
 Each Cloud CMEK key has the following format:
 projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
        string cmek_key_name = 21;
        Returns:
        The cmekKeyName.

      • getCmekKeyNameBytes

        com.google.protobuf.ByteString getCmekKeyNameBytes()
         The CMEK (customer-managed encryption key) fully qualified key name used
 for the migration job.
 This field supports all migration jobs types except for:
 * Mysql to Mysql (use the cmek field in the cloudsql connection profile
 instead).
 * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql
 connection profile instead).
 * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb
 connection profile instead).
 Each Cloud CMEK key has the following format:
 projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
        string cmek_key_name = 21;
        Returns:
        The bytes for cmekKeyName.

      • hasPerformanceConfig

        boolean hasPerformanceConfig()
         Optional. Data dump parallelism settings used by the migration.
 Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
        .google.cloud.clouddms.v1.MigrationJob.PerformanceConfig performance_config = 22 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the performanceConfig field is set.

      • getPerformanceConfig

        MigrationJob.PerformanceConfig getPerformanceConfig()
         Optional. Data dump parallelism settings used by the migration.
 Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
        .google.cloud.clouddms.v1.MigrationJob.PerformanceConfig performance_config = 22 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The performanceConfig.

      • getPerformanceConfigOrBuilder

        MigrationJob.PerformanceConfigOrBuilder getPerformanceConfigOrBuilder()
         Optional. Data dump parallelism settings used by the migration.
 Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
        .google.cloud.clouddms.v1.MigrationJob.PerformanceConfig performance_config = 22 [(.google.api.field_behavior) = OPTIONAL];