- 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 static final class MigrationJob.Builder extends GeneratedMessageV3.Builder<MigrationJob.Builder> implements MigrationJobOrBuilderRepresents a Database Migration Service migration job object.
Protobuf type google.cloud.clouddms.v1.MigrationJob
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > MigrationJob.BuilderImplements
MigrationJobOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public MigrationJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
build()
public MigrationJob build()| Returns | |
|---|---|
| Type | Description |
MigrationJob |
|
buildPartial()
public MigrationJob buildPartial()| Returns | |
|---|---|
| Type | Description |
MigrationJob |
|
clear()
public MigrationJob.Builder clear()| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
clearCmekKeyName()
public MigrationJob.Builder clearCmekKeyName()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 |
MigrationJob.Builder |
This builder for chaining. |
clearConnectivity()
public MigrationJob.Builder clearConnectivity()| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
clearConversionWorkspace()
public MigrationJob.Builder clearConversionWorkspace()The conversion workspace used by the migration.
.google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
clearCreateTime()
public MigrationJob.Builder clearCreateTime()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 |
MigrationJob.Builder |
|
clearDestination()
public MigrationJob.Builder clearDestination()Required. The resource name (URI) of the destination connection profile.
string destination = 11 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
clearDestinationDatabase()
public MigrationJob.Builder clearDestinationDatabase()The database engine type and provider of the destination.
.google.cloud.clouddms.v1.DatabaseType destination_database = 15;
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
clearDisplayName()
public MigrationJob.Builder clearDisplayName()The migration job display name.
string display_name = 5;
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
clearDumpFlags()
public MigrationJob.Builder clearDumpFlags()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.Builder |
|
clearDumpPath()
public MigrationJob.Builder clearDumpPath()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 |
MigrationJob.Builder |
This builder for chaining. |
clearDuration()
public MigrationJob.Builder clearDuration()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 |
MigrationJob.Builder |
|
clearEndTime()
public MigrationJob.Builder clearEndTime()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 |
MigrationJob.Builder |
|
clearError()
public MigrationJob.Builder clearError()Output only. The error details in case of state FAILED.
.google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public MigrationJob.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
clearFilter()
public MigrationJob.Builder clearFilter()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 |
MigrationJob.Builder |
This builder for chaining. |
clearLabels()
public MigrationJob.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
clearName()
public MigrationJob.Builder clearName()The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public MigrationJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
clearPerformanceConfig()
public MigrationJob.Builder clearPerformanceConfig()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.Builder |
|
clearPhase()
public MigrationJob.Builder clearPhase()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.Builder |
This builder for chaining. |
clearReverseSshConnectivity()
public MigrationJob.Builder clearReverseSshConnectivity()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 |
MigrationJob.Builder |
|
clearSource()
public MigrationJob.Builder clearSource()Required. The resource name (URI) of the source connection profile.
string source = 10 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
clearSourceDatabase()
public MigrationJob.Builder clearSourceDatabase()The database engine type and provider of the source.
.google.cloud.clouddms.v1.DatabaseType source_database = 14;
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
clearState()
public MigrationJob.Builder clearState()The current migration job state.
.google.cloud.clouddms.v1.MigrationJob.State state = 6;
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
clearStaticIpConnectivity()
public MigrationJob.Builder clearStaticIpConnectivity()static ip connectivity data (default, no additional details needed).
.google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
clearType()
public MigrationJob.Builder clearType()Required. The migration job type.
.google.cloud.clouddms.v1.MigrationJob.Type type = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
clearUpdateTime()
public MigrationJob.Builder clearUpdateTime()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 |
MigrationJob.Builder |
|
clearVpcPeeringConnectivity()
public MigrationJob.Builder clearVpcPeeringConnectivity()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 |
MigrationJob.Builder |
|
clone()
public MigrationJob.Builder clone()| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
containsLabels(String key)
public 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 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 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 MigrationJob.ConnectivityCase getConnectivityCase()| Returns | |
|---|---|
| Type | Description |
MigrationJob.ConnectivityCase |
|
getConversionWorkspace()
public ConversionWorkspaceInfo getConversionWorkspace()The conversion workspace used by the migration.
.google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;
| Returns | |
|---|---|
| Type | Description |
ConversionWorkspaceInfo |
The conversionWorkspace. |
getConversionWorkspaceBuilder()
public ConversionWorkspaceInfo.Builder getConversionWorkspaceBuilder()The conversion workspace used by the migration.
.google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;
| Returns | |
|---|---|
| Type | Description |
ConversionWorkspaceInfo.Builder |
|
getConversionWorkspaceOrBuilder()
public ConversionWorkspaceInfoOrBuilder getConversionWorkspaceOrBuilder()The conversion workspace used by the migration.
.google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;
| Returns | |
|---|---|
| Type | Description |
ConversionWorkspaceInfoOrBuilder |
|
getCreateTime()
public 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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()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 |
Builder |
|
getCreateTimeOrBuilder()
public 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 |
|
getDefaultInstanceForType()
public MigrationJob getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
MigrationJob |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDestination()
public 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 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 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. |
getDestinationDatabaseBuilder()
public DatabaseType.Builder getDestinationDatabaseBuilder()The database engine type and provider of the destination.
.google.cloud.clouddms.v1.DatabaseType destination_database = 15;
| Returns | |
|---|---|
| Type | Description |
DatabaseType.Builder |
|
getDestinationDatabaseOrBuilder()
public 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 String getDisplayName()The migration job display name.
string display_name = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()The migration job display name.
string display_name = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getDumpFlags()
public 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. |
getDumpFlagsBuilder()
public MigrationJob.DumpFlags.Builder getDumpFlagsBuilder()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.Builder |
|
getDumpFlagsOrBuilder()
public 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 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 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 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. |
getDurationBuilder()
public Duration.Builder getDurationBuilder()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 |
Builder |
|
getDurationOrBuilder()
public 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 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. |
getEndTimeBuilder()
public Timestamp.Builder getEndTimeBuilder()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 |
Builder |
|
getEndTimeOrBuilder()
public 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 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. |
getErrorBuilder()
public Status.Builder getErrorBuilder()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.Builder |
|
getErrorOrBuilder()
public 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 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 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 Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public 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 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 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 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 |
|
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
public 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 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 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. |
getPerformanceConfigBuilder()
public MigrationJob.PerformanceConfig.Builder getPerformanceConfigBuilder()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.Builder |
|
getPerformanceConfigOrBuilder()
public 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 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 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 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. |
getReverseSshConnectivityBuilder()
public ReverseSshConnectivity.Builder getReverseSshConnectivityBuilder()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.Builder |
|
getReverseSshConnectivityOrBuilder()
public 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 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 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 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. |
getSourceDatabaseBuilder()
public DatabaseType.Builder getSourceDatabaseBuilder()The database engine type and provider of the source.
.google.cloud.clouddms.v1.DatabaseType source_database = 14;
| Returns | |
|---|---|
| Type | Description |
DatabaseType.Builder |
|
getSourceDatabaseOrBuilder()
public 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 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 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 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. |
getStaticIpConnectivityBuilder()
public StaticIpConnectivity.Builder getStaticIpConnectivityBuilder()static ip connectivity data (default, no additional details needed).
.google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;
| Returns | |
|---|---|
| Type | Description |
StaticIpConnectivity.Builder |
|
getStaticIpConnectivityOrBuilder()
public 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 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 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 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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()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 |
Builder |
|
getUpdateTimeOrBuilder()
public 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 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. |
getVpcPeeringConnectivityBuilder()
public VpcPeeringConnectivity.Builder getVpcPeeringConnectivityBuilder()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.Builder |
|
getVpcPeeringConnectivityOrBuilder()
public 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 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 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 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 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 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 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 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeConversionWorkspace(ConversionWorkspaceInfo value)
public MigrationJob.Builder mergeConversionWorkspace(ConversionWorkspaceInfo value)The conversion workspace used by the migration.
.google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;
| Parameter | |
|---|---|
| Name | Description |
value |
ConversionWorkspaceInfo |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeCreateTime(Timestamp value)
public MigrationJob.Builder mergeCreateTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeDestinationDatabase(DatabaseType value)
public MigrationJob.Builder mergeDestinationDatabase(DatabaseType value)The database engine type and provider of the destination.
.google.cloud.clouddms.v1.DatabaseType destination_database = 15;
| Parameter | |
|---|---|
| Name | Description |
value |
DatabaseType |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeDumpFlags(MigrationJob.DumpFlags value)
public MigrationJob.Builder mergeDumpFlags(MigrationJob.DumpFlags value)The initial dump flags. This field and the "dump_path" field are mutually exclusive.
.google.cloud.clouddms.v1.MigrationJob.DumpFlags dump_flags = 17;
| Parameter | |
|---|---|
| Name | Description |
value |
MigrationJob.DumpFlags |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeDuration(Duration value)
public MigrationJob.Builder mergeDuration(Duration value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeEndTime(Timestamp value)
public MigrationJob.Builder mergeEndTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeError(Status value)
public MigrationJob.Builder mergeError(Status value)Output only. The error details in case of state FAILED.
.google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeFrom(MigrationJob other)
public MigrationJob.Builder mergeFrom(MigrationJob other)| Parameter | |
|---|---|
| Name | Description |
other |
MigrationJob |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public MigrationJob.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public MigrationJob.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergePerformanceConfig(MigrationJob.PerformanceConfig value)
public MigrationJob.Builder mergePerformanceConfig(MigrationJob.PerformanceConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
MigrationJob.PerformanceConfig |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeReverseSshConnectivity(ReverseSshConnectivity value)
public MigrationJob.Builder mergeReverseSshConnectivity(ReverseSshConnectivity value)The details needed to communicate to the source over Reverse SSH tunnel connectivity.
.google.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;
| Parameter | |
|---|---|
| Name | Description |
value |
ReverseSshConnectivity |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeSourceDatabase(DatabaseType value)
public MigrationJob.Builder mergeSourceDatabase(DatabaseType value)The database engine type and provider of the source.
.google.cloud.clouddms.v1.DatabaseType source_database = 14;
| Parameter | |
|---|---|
| Name | Description |
value |
DatabaseType |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeStaticIpConnectivity(StaticIpConnectivity value)
public MigrationJob.Builder mergeStaticIpConnectivity(StaticIpConnectivity value)static ip connectivity data (default, no additional details needed).
.google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;
| Parameter | |
|---|---|
| Name | Description |
value |
StaticIpConnectivity |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final MigrationJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeUpdateTime(Timestamp value)
public MigrationJob.Builder mergeUpdateTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
mergeVpcPeeringConnectivity(VpcPeeringConnectivity value)
public MigrationJob.Builder mergeVpcPeeringConnectivity(VpcPeeringConnectivity value)The details of the VPC network that the source database is located in.
.google.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;
| Parameter | |
|---|---|
| Name | Description |
value |
VpcPeeringConnectivity |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
putAllLabels(Map<String,String> values)
public MigrationJob.Builder putAllLabels(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
putLabels(String key, String value)
public MigrationJob.Builder putLabels(String key, String value)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 |
value |
String |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
removeLabels(String key)
public MigrationJob.Builder removeLabels(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 |
MigrationJob.Builder |
|
setCmekKeyName(String value)
public MigrationJob.Builder setCmekKeyName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe cmekKeyName to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setCmekKeyNameBytes(ByteString value)
public MigrationJob.Builder setCmekKeyNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for cmekKeyName to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setConversionWorkspace(ConversionWorkspaceInfo value)
public MigrationJob.Builder setConversionWorkspace(ConversionWorkspaceInfo value)The conversion workspace used by the migration.
.google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;
| Parameter | |
|---|---|
| Name | Description |
value |
ConversionWorkspaceInfo |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setConversionWorkspace(ConversionWorkspaceInfo.Builder builderForValue)
public MigrationJob.Builder setConversionWorkspace(ConversionWorkspaceInfo.Builder builderForValue)The conversion workspace used by the migration.
.google.cloud.clouddms.v1.ConversionWorkspaceInfo conversion_workspace = 18;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ConversionWorkspaceInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setCreateTime(Timestamp value)
public MigrationJob.Builder setCreateTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public MigrationJob.Builder setCreateTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setDestination(String value)
public MigrationJob.Builder setDestination(String value)Required. The resource name (URI) of the destination connection profile.
string destination = 11 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe destination to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setDestinationBytes(ByteString value)
public MigrationJob.Builder setDestinationBytes(ByteString value)Required. The resource name (URI) of the destination connection profile.
string destination = 11 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for destination to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setDestinationDatabase(DatabaseType value)
public MigrationJob.Builder setDestinationDatabase(DatabaseType value)The database engine type and provider of the destination.
.google.cloud.clouddms.v1.DatabaseType destination_database = 15;
| Parameter | |
|---|---|
| Name | Description |
value |
DatabaseType |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setDestinationDatabase(DatabaseType.Builder builderForValue)
public MigrationJob.Builder setDestinationDatabase(DatabaseType.Builder builderForValue)The database engine type and provider of the destination.
.google.cloud.clouddms.v1.DatabaseType destination_database = 15;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DatabaseType.Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setDisplayName(String value)
public MigrationJob.Builder setDisplayName(String value)The migration job display name.
string display_name = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public MigrationJob.Builder setDisplayNameBytes(ByteString value)The migration job display name.
string display_name = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setDumpFlags(MigrationJob.DumpFlags value)
public MigrationJob.Builder setDumpFlags(MigrationJob.DumpFlags value)The initial dump flags. This field and the "dump_path" field are mutually exclusive.
.google.cloud.clouddms.v1.MigrationJob.DumpFlags dump_flags = 17;
| Parameter | |
|---|---|
| Name | Description |
value |
MigrationJob.DumpFlags |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setDumpFlags(MigrationJob.DumpFlags.Builder builderForValue)
public MigrationJob.Builder setDumpFlags(MigrationJob.DumpFlags.Builder builderForValue)The initial dump flags. This field and the "dump_path" field are mutually exclusive.
.google.cloud.clouddms.v1.MigrationJob.DumpFlags dump_flags = 17;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
MigrationJob.DumpFlags.Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setDumpPath(String value)
public MigrationJob.Builder setDumpPath(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe dumpPath to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setDumpPathBytes(ByteString value)
public MigrationJob.Builder setDumpPathBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for dumpPath to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setDuration(Duration value)
public MigrationJob.Builder setDuration(Duration value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setDuration(Duration.Builder builderForValue)
public MigrationJob.Builder setDuration(Duration.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setEndTime(Timestamp value)
public MigrationJob.Builder setEndTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setEndTime(Timestamp.Builder builderForValue)
public MigrationJob.Builder setEndTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setError(Status value)
public MigrationJob.Builder setError(Status value)Output only. The error details in case of state FAILED.
.google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setError(Status.Builder builderForValue)
public MigrationJob.Builder setError(Status.Builder builderForValue)Output only. The error details in case of state FAILED.
.google.rpc.Status error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public MigrationJob.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setFilter(String value)
public MigrationJob.Builder setFilter(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public MigrationJob.Builder setFilterBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setName(String value)
public MigrationJob.Builder setName(String value)The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public MigrationJob.Builder setNameBytes(ByteString value)The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setPerformanceConfig(MigrationJob.PerformanceConfig value)
public MigrationJob.Builder setPerformanceConfig(MigrationJob.PerformanceConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
MigrationJob.PerformanceConfig |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setPerformanceConfig(MigrationJob.PerformanceConfig.Builder builderForValue)
public MigrationJob.Builder setPerformanceConfig(MigrationJob.PerformanceConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
MigrationJob.PerformanceConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setPhase(MigrationJob.Phase value)
public MigrationJob.Builder setPhase(MigrationJob.Phase value)Output only. The current migration job phase.
.google.cloud.clouddms.v1.MigrationJob.Phase phase = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
MigrationJob.PhaseThe phase to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setPhaseValue(int value)
public MigrationJob.Builder setPhaseValue(int value)Output only. The current migration job phase.
.google.cloud.clouddms.v1.MigrationJob.Phase phase = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for phase to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public MigrationJob.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setReverseSshConnectivity(ReverseSshConnectivity value)
public MigrationJob.Builder setReverseSshConnectivity(ReverseSshConnectivity value)The details needed to communicate to the source over Reverse SSH tunnel connectivity.
.google.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;
| Parameter | |
|---|---|
| Name | Description |
value |
ReverseSshConnectivity |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setReverseSshConnectivity(ReverseSshConnectivity.Builder builderForValue)
public MigrationJob.Builder setReverseSshConnectivity(ReverseSshConnectivity.Builder builderForValue)The details needed to communicate to the source over Reverse SSH tunnel connectivity.
.google.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ReverseSshConnectivity.Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setSource(String value)
public MigrationJob.Builder setSource(String value)Required. The resource name (URI) of the source connection profile.
string source = 10 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe source to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setSourceBytes(ByteString value)
public MigrationJob.Builder setSourceBytes(ByteString value)Required. The resource name (URI) of the source connection profile.
string source = 10 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for source to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setSourceDatabase(DatabaseType value)
public MigrationJob.Builder setSourceDatabase(DatabaseType value)The database engine type and provider of the source.
.google.cloud.clouddms.v1.DatabaseType source_database = 14;
| Parameter | |
|---|---|
| Name | Description |
value |
DatabaseType |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setSourceDatabase(DatabaseType.Builder builderForValue)
public MigrationJob.Builder setSourceDatabase(DatabaseType.Builder builderForValue)The database engine type and provider of the source.
.google.cloud.clouddms.v1.DatabaseType source_database = 14;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DatabaseType.Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setState(MigrationJob.State value)
public MigrationJob.Builder setState(MigrationJob.State value)The current migration job state.
.google.cloud.clouddms.v1.MigrationJob.State state = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
MigrationJob.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setStateValue(int value)
public MigrationJob.Builder setStateValue(int value)The current migration job state.
.google.cloud.clouddms.v1.MigrationJob.State state = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setStaticIpConnectivity(StaticIpConnectivity value)
public MigrationJob.Builder setStaticIpConnectivity(StaticIpConnectivity value)static ip connectivity data (default, no additional details needed).
.google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;
| Parameter | |
|---|---|
| Name | Description |
value |
StaticIpConnectivity |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setStaticIpConnectivity(StaticIpConnectivity.Builder builderForValue)
public MigrationJob.Builder setStaticIpConnectivity(StaticIpConnectivity.Builder builderForValue)static ip connectivity data (default, no additional details needed).
.google.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
StaticIpConnectivity.Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setType(MigrationJob.Type value)
public MigrationJob.Builder setType(MigrationJob.Type value)Required. The migration job type.
.google.cloud.clouddms.v1.MigrationJob.Type type = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
MigrationJob.TypeThe type to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setTypeValue(int value)
public MigrationJob.Builder setTypeValue(int value)Required. The migration job type.
.google.cloud.clouddms.v1.MigrationJob.Type type = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for type to set. |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final MigrationJob.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setUpdateTime(Timestamp value)
public MigrationJob.Builder setUpdateTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public MigrationJob.Builder setUpdateTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setVpcPeeringConnectivity(VpcPeeringConnectivity value)
public MigrationJob.Builder setVpcPeeringConnectivity(VpcPeeringConnectivity value)The details of the VPC network that the source database is located in.
.google.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;
| Parameter | |
|---|---|
| Name | Description |
value |
VpcPeeringConnectivity |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|
setVpcPeeringConnectivity(VpcPeeringConnectivity.Builder builderForValue)
public MigrationJob.Builder setVpcPeeringConnectivity(VpcPeeringConnectivity.Builder builderForValue)The details of the VPC network that the source database is located in.
.google.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
VpcPeeringConnectivity.Builder |
| Returns | |
|---|---|
| Type | Description |
MigrationJob.Builder |
|