Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getMigrationJob

Gets details of a single migration job.

Using getMigrationJob

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMigrationJob(args: GetMigrationJobArgs, opts?: InvokeOptions): Promise<GetMigrationJobResult>
function getMigrationJobOutput(args: GetMigrationJobOutputArgs, opts?: InvokeOptions): Output<GetMigrationJobResult>

def get_migration_job(location: Optional[str] = None,
                      migration_job_id: Optional[str] = None,
                      project: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetMigrationJobResult
def get_migration_job_output(location: Optional[pulumi.Input[str]] = None,
                      migration_job_id: Optional[pulumi.Input[str]] = None,
                      project: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetMigrationJobResult]

func LookupMigrationJob(ctx *Context, args *LookupMigrationJobArgs, opts ...InvokeOption) (*LookupMigrationJobResult, error)
func LookupMigrationJobOutput(ctx *Context, args *LookupMigrationJobOutputArgs, opts ...InvokeOption) LookupMigrationJobResultOutput

> Note: This function is named LookupMigrationJob in the Go SDK.

public static class GetMigrationJob 
{
    public static Task<GetMigrationJobResult> InvokeAsync(GetMigrationJobArgs args, InvokeOptions? opts = null)
    public static Output<GetMigrationJobResult> Invoke(GetMigrationJobInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMigrationJobResult> getMigrationJob(GetMigrationJobArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:datamigration/v1:getMigrationJob
  arguments:
    # arguments dictionary

The following arguments are supported:

Location string
MigrationJobId string
Project string

Location string
MigrationJobId string
Project string

location String
migrationJobId String
project String

location string
migrationJobId string
project string

location str
migration_job_id str
project str

location String
migrationJobId String
project String

getMigrationJob Result

The following output properties are available:

CreateTime string: 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".
Destination string: The resource name (URI) of the destination connection profile.
DestinationDatabase Pulumi.GoogleNative.Datamigration.V1.Outputs.DatabaseTypeResponse: The database engine type and provider of the destination.
DisplayName string: The migration job display name.
DumpFlags Pulumi.GoogleNative.Datamigration.V1.Outputs.DumpFlagsResponse: The initial dump flags. This field and the "dump_path" field are mutually exclusive.
DumpPath string: 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.
Duration string: The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
EndTime string: If the migration job is completed, the time when it was completed.
Error Pulumi.GoogleNative.Datamigration.V1.Outputs.StatusResponse: The error details in case of state FAILED.
Labels Dictionary<string, string>: 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" }.
Name string: The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
Phase string: The current migration job phase.
ReverseSshConnectivity Pulumi.GoogleNative.Datamigration.V1.Outputs.ReverseSshConnectivityResponse: The details needed to communicate to the source over Reverse SSH tunnel connectivity.
Source string: The resource name (URI) of the source connection profile.
SourceDatabase Pulumi.GoogleNative.Datamigration.V1.Outputs.DatabaseTypeResponse: The database engine type and provider of the source.
State string: The current migration job state.
StaticIpConnectivity Pulumi.GoogleNative.Datamigration.V1.Outputs.StaticIpConnectivityResponse: static ip connectivity data (default, no additional details needed).
Type string: The migration job type.
UpdateTime string: 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".
VpcPeeringConnectivity Pulumi.GoogleNative.Datamigration.V1.Outputs.VpcPeeringConnectivityResponse: The details of the VPC network that the source database is located in.

CreateTime string: 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".
Destination string: The resource name (URI) of the destination connection profile.
DestinationDatabase DatabaseTypeResponse: The database engine type and provider of the destination.
DisplayName string: The migration job display name.
DumpFlags DumpFlagsResponse: The initial dump flags. This field and the "dump_path" field are mutually exclusive.
DumpPath string: 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.
Duration string: The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
EndTime string: If the migration job is completed, the time when it was completed.
Error StatusResponse: The error details in case of state FAILED.
Labels map[string]string: 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" }.
Name string: The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
Phase string: The current migration job phase.
ReverseSshConnectivity ReverseSshConnectivityResponse: The details needed to communicate to the source over Reverse SSH tunnel connectivity.
Source string: The resource name (URI) of the source connection profile.
SourceDatabase DatabaseTypeResponse: The database engine type and provider of the source.
State string: The current migration job state.
StaticIpConnectivity StaticIpConnectivityResponse: static ip connectivity data (default, no additional details needed).
Type string: The migration job type.
UpdateTime string: 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".
VpcPeeringConnectivity VpcPeeringConnectivityResponse: The details of the VPC network that the source database is located in.

createTime String: 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".
destination String: The resource name (URI) of the destination connection profile.
destinationDatabase DatabaseTypeResponse: The database engine type and provider of the destination.
displayName String: The migration job display name.
dumpFlags DumpFlagsResponse: The initial dump flags. This field and the "dump_path" field are mutually exclusive.
dumpPath String: 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.
duration String: The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
endTime String: If the migration job is completed, the time when it was completed.
error StatusResponse: The error details in case of state FAILED.
labels Map<String,String>: 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" }.
name String: The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
phase String: The current migration job phase.
reverseSshConnectivity ReverseSshConnectivityResponse: The details needed to communicate to the source over Reverse SSH tunnel connectivity.
source String: The resource name (URI) of the source connection profile.
sourceDatabase DatabaseTypeResponse: The database engine type and provider of the source.
state String: The current migration job state.
staticIpConnectivity StaticIpConnectivityResponse: static ip connectivity data (default, no additional details needed).
type String: The migration job type.
updateTime String: 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".
vpcPeeringConnectivity VpcPeeringConnectivityResponse: The details of the VPC network that the source database is located in.

createTime string: 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".
destination string: The resource name (URI) of the destination connection profile.
destinationDatabase DatabaseTypeResponse: The database engine type and provider of the destination.
displayName string: The migration job display name.
dumpFlags DumpFlagsResponse: The initial dump flags. This field and the "dump_path" field are mutually exclusive.
dumpPath string: 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.
duration string: The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
endTime string: If the migration job is completed, the time when it was completed.
error StatusResponse: The error details in case of state FAILED.
labels {[key: string]: string}: 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" }.
name string: The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
phase string: The current migration job phase.
reverseSshConnectivity ReverseSshConnectivityResponse: The details needed to communicate to the source over Reverse SSH tunnel connectivity.
source string: The resource name (URI) of the source connection profile.
sourceDatabase DatabaseTypeResponse: The database engine type and provider of the source.
state string: The current migration job state.
staticIpConnectivity StaticIpConnectivityResponse: static ip connectivity data (default, no additional details needed).
type string: The migration job type.
updateTime string: 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".
vpcPeeringConnectivity VpcPeeringConnectivityResponse: The details of the VPC network that the source database is located in.

create_time str: 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".
destination str: The resource name (URI) of the destination connection profile.
destination_database DatabaseTypeResponse: The database engine type and provider of the destination.
display_name str: The migration job display name.
dump_flags DumpFlagsResponse: The initial dump flags. This field and the "dump_path" field are mutually exclusive.
dump_path str: 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.
duration str: The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
end_time str: If the migration job is completed, the time when it was completed.
error StatusResponse: The error details in case of state FAILED.
labels Mapping[str, str]: 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" }.
name str: The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
phase str: The current migration job phase.
reverse_ssh_connectivity ReverseSshConnectivityResponse: The details needed to communicate to the source over Reverse SSH tunnel connectivity.
source str: The resource name (URI) of the source connection profile.
source_database DatabaseTypeResponse: The database engine type and provider of the source.
state str: The current migration job state.
static_ip_connectivity StaticIpConnectivityResponse: static ip connectivity data (default, no additional details needed).
type str: The migration job type.
update_time str: 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".
vpc_peering_connectivity VpcPeeringConnectivityResponse: The details of the VPC network that the source database is located in.

createTime String: 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".
destination String: The resource name (URI) of the destination connection profile.
destinationDatabase Property Map: The database engine type and provider of the destination.
displayName String: The migration job display name.
dumpFlags Property Map: The initial dump flags. This field and the "dump_path" field are mutually exclusive.
dumpPath String: 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.
duration String: The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
endTime String: If the migration job is completed, the time when it was completed.
error Property Map: The error details in case of state FAILED.
labels Map<String>: 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" }.
name String: The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
phase String: The current migration job phase.
reverseSshConnectivity Property Map: The details needed to communicate to the source over Reverse SSH tunnel connectivity.
source String: The resource name (URI) of the source connection profile.
sourceDatabase Property Map: The database engine type and provider of the source.
state String: The current migration job state.
staticIpConnectivity Property Map: static ip connectivity data (default, no additional details needed).
type String: The migration job type.
updateTime String: 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".
vpcPeeringConnectivity Property Map: The details of the VPC network that the source database is located in.

Supporting Types

DatabaseTypeResponse

Engine string: The database engine.
Provider string: The database provider.

Engine string: The database engine.
Provider string: The database provider.

engine String: The database engine.
provider String: The database provider.

engine string: The database engine.
provider string: The database provider.

engine str: The database engine.
provider str: The database provider.

engine String: The database engine.
provider String: The database provider.

DumpFlagResponse

Name string: The name of the flag
Value string: The value of the flag.

Name string: The name of the flag
Value string: The value of the flag.

name String: The name of the flag
value String: The value of the flag.

name string: The name of the flag
value string: The value of the flag.

name str: The name of the flag
value str: The value of the flag.

name String: The name of the flag
value String: The value of the flag.

DumpFlagsResponse

DumpFlags List<Pulumi.GoogleNative.Datamigration.V1.Inputs.DumpFlagResponse>: The flags for the initial dump.

DumpFlags []DumpFlagResponse: The flags for the initial dump.

dumpFlags List<DumpFlagResponse>: The flags for the initial dump.

dumpFlags DumpFlagResponse[]: The flags for the initial dump.

dump_flags Sequence[DumpFlagResponse]: The flags for the initial dump.

dumpFlags List<Property Map>: The flags for the initial dump.

ReverseSshConnectivityResponse

Vm string: The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
VmIp string: The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
VmPort int: The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
Vpc string: The name of the VPC to peer with the Cloud SQL private network.

Vm string: The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
VmIp string: The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
VmPort int: The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
Vpc string: The name of the VPC to peer with the Cloud SQL private network.

vm String: The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
vmIp String: The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
vmPort Integer: The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
vpc String: The name of the VPC to peer with the Cloud SQL private network.

vm string: The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
vmIp string: The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
vmPort number: The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
vpc string: The name of the VPC to peer with the Cloud SQL private network.

vm str: The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
vm_ip str: The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
vm_port int: The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
vpc str: The name of the VPC to peer with the Cloud SQL private network.

vm String: The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
vmIp String: The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
vmPort Number: The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
vpc String: The name of the VPC to peer with the Cloud SQL private network.

StatusResponse

Code int: The status code, which should be an enum value of google.rpc.Code.
Details List<ImmutableDictionary<string, string>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Code int: The status code, which should be an enum value of google.rpc.Code.
Details []map[string]string: A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code Integer: The status code, which should be an enum value of google.rpc.Code.
details List<Map<String,String>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message String: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code number: The status code, which should be an enum value of google.rpc.Code.
details {[key: string]: string}[]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code int: The status code, which should be an enum value of google.rpc.Code.
details Sequence[Mapping[str, str]]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message str: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code Number: The status code, which should be an enum value of google.rpc.Code.
details List<Map<String>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message String: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

VpcPeeringConnectivityResponse

Vpc string: The name of the VPC network to peer with the Cloud SQL private network.

Vpc string: The name of the VPC network to peer with the Cloud SQL private network.

vpc String: The name of the VPC network to peer with the Cloud SQL private network.

vpc string: The name of the VPC network to peer with the Cloud SQL private network.

vpc str: The name of the VPC network to peer with the Cloud SQL private network.

vpc String: The name of the VPC network to peer with the Cloud SQL private network.

Package Details

Repository: https://github.com/pulumi/pulumi-google-native
License: Apache-2.0