- 2.54.0 (latest)
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.8
- 2.1.9
public interface MigrationJobOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCmekKeyName()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The cmekKeyName. |
getCmekKeyNameBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for cmekKeyName. |
getConnectivityCase()
public abstract MigrationJob.ConnectivityCase getConnectivityCase()| Returns | |
|---|---|
| Type | Description |
MigrationJob.ConnectivityCase |
|
getConversionWorkspace()
public abstract ConversionWorkspaceInfo getConversionWorkspace()The conversion workspace used by the migration.
.google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;
| Returns | |
|---|---|
| Type | Description |
ConversionWorkspaceInfo |
The conversionWorkspace. |
getConversionWorkspaceOrBuilder()
public abstract ConversionWorkspaceInfoOrBuilder getConversionWorkspaceOrBuilder()The conversion workspace used by the migration.
.google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;
| Returns | |
|---|---|
| Type | Description |
ConversionWorkspaceInfoOrBuilder |
|
getCreateTime()
public abstract 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 | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDestination()
public abstract String getDestination()Required. The resource name (URI) of the destination connection profile.
string destination = 11 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The destination. |
getDestinationBytes()
public abstract ByteString getDestinationBytes()Required. The resource name (URI) of the destination connection profile.
string destination = 11 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for destination. |
getDestinationDatabase()
public abstract DatabaseType getDestinationDatabase()The database engine type and provider of the destination.
.google.cloud.clouddms.v1.DatabaseType destination_database = 15;
| Returns | |
|---|---|
| Type | Description |
DatabaseType |
The destinationDatabase. |
getDestinationDatabaseOrBuilder()
public abstract DatabaseTypeOrBuilder getDestinationDatabaseOrBuilder()The database engine type and provider of the destination.
.google.cloud.clouddms.v1.DatabaseType destination_database = 15;
| Returns | |
|---|---|
| Type | Description |
DatabaseTypeOrBuilder |
|
getDisplayName()
public abstract String getDisplayName()The migration job display name.
string display_name = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()The migration job display name.
string display_name = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getDumpFlags()
public abstract 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 | |
|---|---|
| Type | Description |
MigrationJob.DumpFlags |
The dumpFlags. |
getDumpFlagsOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
MigrationJob.DumpFlagsOrBuilder |
|
getDumpPath()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The dumpPath. |
getDumpPathBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for dumpPath. |
getDuration()
public abstract 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 | |
|---|---|
| Type | Description |
Duration |
The duration. |
getDurationOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getEndTime()
public abstract 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 | |
|---|---|
| Type | Description |
Timestamp |
The endTime. |
getEndTimeOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getError()
public abstract Status getError()Output only. The error details in case of state FAILED.
.google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status |
The error. |
getErrorOrBuilder()
public abstract StatusOrBuilder getErrorOrBuilder()Output only. The error details in case of state FAILED.
.google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder |
|
getFilter()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getLabels() (deprecated)
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public abstract 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;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getName()
public abstract String getName()The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getPerformanceConfig()
public abstract 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 | |
|---|---|
| Type | Description |
MigrationJob.PerformanceConfig |
The performanceConfig. |
getPerformanceConfigOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
MigrationJob.PerformanceConfigOrBuilder |
|
getPhase()
public abstract 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 | |
|---|---|
| Type | Description |
MigrationJob.Phase |
The phase. |
getPhaseValue()
public abstract int getPhaseValue()Output only. The current migration job phase.
.google.cloud.clouddms.v1.MigrationJob.Phase phase = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for phase. |
getReverseSshConnectivity()
public abstract 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 | |
|---|---|
| Type | Description |
ReverseSshConnectivity |
The reverseSshConnectivity. |
getReverseSshConnectivityOrBuilder()
public abstract ReverseSshConnectivityOrBuilder getReverseSshConnectivityOrBuilder()The details needed to communicate to the source over Reverse SSH tunnel connectivity.
.google.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;
| Returns | |
|---|---|
| Type | Description |
ReverseSshConnectivityOrBuilder |
|
getSource()
public abstract String getSource()Required. The resource name (URI) of the source connection profile.
string source = 10 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The source. |
getSourceBytes()
public abstract ByteString getSourceBytes()Required. The resource name (URI) of the source connection profile.
string source = 10 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for source. |
getSourceDatabase()
public abstract DatabaseType getSourceDatabase()The database engine type and provider of the source.
.google.cloud.clouddms.v1.DatabaseType source_database = 14;
| Returns | |
|---|---|
| Type | Description |
DatabaseType |
The sourceDatabase. |
getSourceDatabaseOrBuilder()
public abstract DatabaseTypeOrBuilder getSourceDatabaseOrBuilder()The database engine type and provider of the source.
.google.cloud.clouddms.v1.DatabaseType source_database = 14;
| Returns | |
|---|---|
| Type | Description |
DatabaseTypeOrBuilder |
|
getState()
public abstract MigrationJob.State getState()The current migration job state.
.google.cloud.clouddms.v1.MigrationJob.State state = 6;
| Returns | |
|---|---|
| Type | Description |
MigrationJob.State |
The state. |
getStateValue()
public abstract int getStateValue()The current migration job state.
.google.cloud.clouddms.v1.MigrationJob.State state = 6;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getStaticIpConnectivity()
public abstract StaticIpConnectivity getStaticIpConnectivity()static ip connectivity data (default, no additional details needed).
.google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;
| Returns | |
|---|---|
| Type | Description |
StaticIpConnectivity |
The staticIpConnectivity. |
getStaticIpConnectivityOrBuilder()
public abstract StaticIpConnectivityOrBuilder getStaticIpConnectivityOrBuilder()static ip connectivity data (default, no additional details needed).
.google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;
| Returns | |
|---|---|
| Type | Description |
StaticIpConnectivityOrBuilder |
|
getType()
public abstract MigrationJob.Type getType()Required. The migration job type.
.google.cloud.clouddms.v1.MigrationJob.Type type = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Type |
The type. |
getTypeValue()
public abstract int getTypeValue()Required. The migration job type.
.google.cloud.clouddms.v1.MigrationJob.Type type = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for type. |
getUpdateTime()
public abstract 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 | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getVpcPeeringConnectivity()
public abstract 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 | |
|---|---|
| Type | Description |
VpcPeeringConnectivity |
The vpcPeeringConnectivity. |
getVpcPeeringConnectivityOrBuilder()
public abstract VpcPeeringConnectivityOrBuilder getVpcPeeringConnectivityOrBuilder()The details of the VPC network that the source database is located in.
.google.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;
| Returns | |
|---|---|
| Type | Description |
VpcPeeringConnectivityOrBuilder |
|
hasConversionWorkspace()
public abstract boolean hasConversionWorkspace()The conversion workspace used by the migration.
.google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the conversionWorkspace field is set. |
hasCreateTime()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasDestinationDatabase()
public abstract boolean hasDestinationDatabase()The database engine type and provider of the destination.
.google.cloud.clouddms.v1.DatabaseType destination_database = 15;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the destinationDatabase field is set. |
hasDumpFlags()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the dumpFlags field is set. |
hasDuration()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the duration field is set. |
hasEndTime()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the endTime field is set. |
hasError()
public abstract boolean hasError()Output only. The error details in case of state FAILED.
.google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the error field is set. |
hasPerformanceConfig()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the performanceConfig field is set. |
hasReverseSshConnectivity()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the reverseSshConnectivity field is set. |
hasSourceDatabase()
public abstract boolean hasSourceDatabase()The database engine type and provider of the source.
.google.cloud.clouddms.v1.DatabaseType source_database = 14;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the sourceDatabase field is set. |
hasStaticIpConnectivity()
public abstract boolean hasStaticIpConnectivity()static ip connectivity data (default, no additional details needed).
.google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the staticIpConnectivity field is set. |
hasUpdateTime()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |
hasVpcPeeringConnectivity()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the vpcPeeringConnectivity field is set. |