Google Cloud Native v0.28.0, Feb 2 23

google-native.vmmigration/v1.getCloneJob

Gets details of a single CloneJob.

Using getCloneJob

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 getCloneJob(args: GetCloneJobArgs, opts?: InvokeOptions): Promise<GetCloneJobResult>
function getCloneJobOutput(args: GetCloneJobOutputArgs, opts?: InvokeOptions): Output<GetCloneJobResult>

def get_clone_job(clone_job_id: Optional[str] = None,
                  location: Optional[str] = None,
                  migrating_vm_id: Optional[str] = None,
                  project: Optional[str] = None,
                  source_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetCloneJobResult
def get_clone_job_output(clone_job_id: Optional[pulumi.Input[str]] = None,
                  location: Optional[pulumi.Input[str]] = None,
                  migrating_vm_id: Optional[pulumi.Input[str]] = None,
                  project: Optional[pulumi.Input[str]] = None,
                  source_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetCloneJobResult]

func LookupCloneJob(ctx *Context, args *LookupCloneJobArgs, opts ...InvokeOption) (*LookupCloneJobResult, error)
func LookupCloneJobOutput(ctx *Context, args *LookupCloneJobOutputArgs, opts ...InvokeOption) LookupCloneJobResultOutput

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

public static class GetCloneJob 
{
    public static Task<GetCloneJobResult> InvokeAsync(GetCloneJobArgs args, InvokeOptions? opts = null)
    public static Output<GetCloneJobResult> Invoke(GetCloneJobInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCloneJobResult> getCloneJob(GetCloneJobArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:vmmigration/v1:getCloneJob
  arguments:
    # arguments dictionary

The following arguments are supported:

CloneJobId string
Location string
MigratingVmId string
SourceId string
Project string

CloneJobId string
Location string
MigratingVmId string
SourceId string
Project string

cloneJobId String
location String
migratingVmId String
sourceId String
project String

cloneJobId string
location string
migratingVmId string
sourceId string
project string

clone_job_id str
location str
migrating_vm_id str
source_id str
project str

cloneJobId String
location String
migratingVmId String
sourceId String
project String

getCloneJob Result

The following output properties are available:

ComputeEngineTargetDetails Pulumi.GoogleNative.VMMigration.V1.Outputs.ComputeEngineTargetDetailsResponse: Details of the target VM in Compute Engine.
CreateTime string: The time the clone job was created (as an API call, not when it was actually created in the target).
EndTime string: The time the clone job was ended.
Error Pulumi.GoogleNative.VMMigration.V1.Outputs.StatusResponse: Provides details for the errors that led to the Clone Job's state.
Name string: The name of the clone.
State string: State of the clone job.
StateTime string: The time the state was last updated.
Steps List<Pulumi.GoogleNative.VMMigration.V1.Outputs.CloneStepResponse>: The clone steps list representing its progress.

ComputeEngineTargetDetails ComputeEngineTargetDetailsResponse: Details of the target VM in Compute Engine.
CreateTime string: The time the clone job was created (as an API call, not when it was actually created in the target).
EndTime string: The time the clone job was ended.
Error StatusResponse: Provides details for the errors that led to the Clone Job's state.
Name string: The name of the clone.
State string: State of the clone job.
StateTime string: The time the state was last updated.
Steps []CloneStepResponse: The clone steps list representing its progress.

computeEngineTargetDetails ComputeEngineTargetDetailsResponse: Details of the target VM in Compute Engine.
createTime String: The time the clone job was created (as an API call, not when it was actually created in the target).
endTime String: The time the clone job was ended.
error StatusResponse: Provides details for the errors that led to the Clone Job's state.
name String: The name of the clone.
state String: State of the clone job.
stateTime String: The time the state was last updated.
steps List<CloneStepResponse>: The clone steps list representing its progress.

computeEngineTargetDetails ComputeEngineTargetDetailsResponse: Details of the target VM in Compute Engine.
createTime string: The time the clone job was created (as an API call, not when it was actually created in the target).
endTime string: The time the clone job was ended.
error StatusResponse: Provides details for the errors that led to the Clone Job's state.
name string: The name of the clone.
state string: State of the clone job.
stateTime string: The time the state was last updated.
steps CloneStepResponse[]: The clone steps list representing its progress.

compute_engine_target_details ComputeEngineTargetDetailsResponse: Details of the target VM in Compute Engine.
create_time str: The time the clone job was created (as an API call, not when it was actually created in the target).
end_time str: The time the clone job was ended.
error StatusResponse: Provides details for the errors that led to the Clone Job's state.
name str: The name of the clone.
state str: State of the clone job.
state_time str: The time the state was last updated.
steps Sequence[CloneStepResponse]: The clone steps list representing its progress.

computeEngineTargetDetails Property Map: Details of the target VM in Compute Engine.
createTime String: The time the clone job was created (as an API call, not when it was actually created in the target).
endTime String: The time the clone job was ended.
error Property Map: Provides details for the errors that led to the Clone Job's state.
name String: The name of the clone.
state String: State of the clone job.
stateTime String: The time the state was last updated.
steps List<Property Map>: The clone steps list representing its progress.

Supporting Types

AppliedLicenseResponse

OsLicense string: The OS license returned from the adaptation module's report.
Type string: The license type that was used in OS adaptation.

OsLicense string: The OS license returned from the adaptation module's report.
Type string: The license type that was used in OS adaptation.

osLicense String: The OS license returned from the adaptation module's report.
type String: The license type that was used in OS adaptation.

osLicense string: The OS license returned from the adaptation module's report.
type string: The license type that was used in OS adaptation.

os_license str: The OS license returned from the adaptation module's report.
type str: The license type that was used in OS adaptation.

osLicense String: The OS license returned from the adaptation module's report.
type String: The license type that was used in OS adaptation.

CloneStepResponse

AdaptingOs Pulumi.GoogleNative.VMMigration.V1.Inputs.AdaptingOSStepResponse: Adapting OS step.
EndTime string: The time the step has ended.
InstantiatingMigratedVm Pulumi.GoogleNative.VMMigration.V1.Inputs.InstantiatingMigratedVMStepResponse: Instantiating migrated VM step.
PreparingVmDisks Pulumi.GoogleNative.VMMigration.V1.Inputs.PreparingVMDisksStepResponse: Preparing VM disks step.
StartTime string: The time the step has started.

AdaptingOs AdaptingOSStepResponse: Adapting OS step.
EndTime string: The time the step has ended.
InstantiatingMigratedVm InstantiatingMigratedVMStepResponse: Instantiating migrated VM step.
PreparingVmDisks PreparingVMDisksStepResponse: Preparing VM disks step.
StartTime string: The time the step has started.

adaptingOs AdaptingOSStepResponse: Adapting OS step.
endTime String: The time the step has ended.
instantiatingMigratedVm InstantiatingMigratedVMStepResponse: Instantiating migrated VM step.
preparingVmDisks PreparingVMDisksStepResponse: Preparing VM disks step.
startTime String: The time the step has started.

adaptingOs AdaptingOSStepResponse: Adapting OS step.
endTime string: The time the step has ended.
instantiatingMigratedVm InstantiatingMigratedVMStepResponse: Instantiating migrated VM step.
preparingVmDisks PreparingVMDisksStepResponse: Preparing VM disks step.
startTime string: The time the step has started.

adapting_os AdaptingOSStepResponse: Adapting OS step.
end_time str: The time the step has ended.
instantiating_migrated_vm InstantiatingMigratedVMStepResponse: Instantiating migrated VM step.
preparing_vm_disks PreparingVMDisksStepResponse: Preparing VM disks step.
start_time str: The time the step has started.

adaptingOs Property Map: Adapting OS step.
endTime String: The time the step has ended.
instantiatingMigratedVm Property Map: Instantiating migrated VM step.
preparingVmDisks Property Map: Preparing VM disks step.
startTime String: The time the step has started.

ComputeEngineTargetDetailsResponse

AdditionalLicenses List<string>: Additional licenses to assign to the VM.
AppliedLicense Pulumi.GoogleNative.VMMigration.V1.Inputs.AppliedLicenseResponse: The OS license returned from the adaptation module report.
BootOption string: The VM Boot Option, as set in the source vm.
ComputeScheduling Pulumi.GoogleNative.VMMigration.V1.Inputs.ComputeSchedulingResponse: Compute instance scheduling information (if empty default is used).
DiskType string: The disk type to use in the VM.
Hostname string: The hostname to assign to the VM.
Labels Dictionary<string, string>: A map of labels to associate with the VM.
LicenseType string: The license type to use in OS adaptation.
MachineType string: The machine type to create the VM with.
MachineTypeSeries string: The machine type series to create the VM with.
Metadata Dictionary<string, string>: The metadata key/value pairs to assign to the VM.
NetworkInterfaces List<Pulumi.GoogleNative.VMMigration.V1.Inputs.NetworkInterfaceResponse>: List of NICs connected to this VM.
NetworkTags List<string>: A map of network tags to associate with the VM.
Project string: The Google Cloud target project ID or project name.
SecureBoot bool: Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
ServiceAccount string: The service account to associate the VM with.
VmName string: The name of the VM to create.
Zone string: The zone in which to create the VM.

AdditionalLicenses []string: Additional licenses to assign to the VM.
AppliedLicense AppliedLicenseResponse: The OS license returned from the adaptation module report.
BootOption string: The VM Boot Option, as set in the source vm.
ComputeScheduling ComputeSchedulingResponse: Compute instance scheduling information (if empty default is used).
DiskType string: The disk type to use in the VM.
Hostname string: The hostname to assign to the VM.
Labels map[string]string: A map of labels to associate with the VM.
LicenseType string: The license type to use in OS adaptation.
MachineType string: The machine type to create the VM with.
MachineTypeSeries string: The machine type series to create the VM with.
Metadata map[string]string: The metadata key/value pairs to assign to the VM.
NetworkInterfaces []NetworkInterfaceResponse: List of NICs connected to this VM.
NetworkTags []string: A map of network tags to associate with the VM.
Project string: The Google Cloud target project ID or project name.
SecureBoot bool: Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
ServiceAccount string: The service account to associate the VM with.
VmName string: The name of the VM to create.
Zone string: The zone in which to create the VM.

additionalLicenses List<String>: Additional licenses to assign to the VM.
appliedLicense AppliedLicenseResponse: The OS license returned from the adaptation module report.
bootOption String: The VM Boot Option, as set in the source vm.
computeScheduling ComputeSchedulingResponse: Compute instance scheduling information (if empty default is used).
diskType String: The disk type to use in the VM.
hostname String: The hostname to assign to the VM.
labels Map<String,String>: A map of labels to associate with the VM.
licenseType String: The license type to use in OS adaptation.
machineType String: The machine type to create the VM with.
machineTypeSeries String: The machine type series to create the VM with.
metadata Map<String,String>: The metadata key/value pairs to assign to the VM.
networkInterfaces List<NetworkInterfaceResponse>: List of NICs connected to this VM.
networkTags List<String>: A map of network tags to associate with the VM.
project String: The Google Cloud target project ID or project name.
secureBoot Boolean: Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
serviceAccount String: The service account to associate the VM with.
vmName String: The name of the VM to create.
zone String: The zone in which to create the VM.

additionalLicenses string[]: Additional licenses to assign to the VM.
appliedLicense AppliedLicenseResponse: The OS license returned from the adaptation module report.
bootOption string: The VM Boot Option, as set in the source vm.
computeScheduling ComputeSchedulingResponse: Compute instance scheduling information (if empty default is used).
diskType string: The disk type to use in the VM.
hostname string: The hostname to assign to the VM.
labels {[key: string]: string}: A map of labels to associate with the VM.
licenseType string: The license type to use in OS adaptation.
machineType string: The machine type to create the VM with.
machineTypeSeries string: The machine type series to create the VM with.
metadata {[key: string]: string}: The metadata key/value pairs to assign to the VM.
networkInterfaces NetworkInterfaceResponse[]: List of NICs connected to this VM.
networkTags string[]: A map of network tags to associate with the VM.
project string: The Google Cloud target project ID or project name.
secureBoot boolean: Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
serviceAccount string: The service account to associate the VM with.
vmName string: The name of the VM to create.
zone string: The zone in which to create the VM.

additional_licenses Sequence[str]: Additional licenses to assign to the VM.
applied_license AppliedLicenseResponse: The OS license returned from the adaptation module report.
boot_option str: The VM Boot Option, as set in the source vm.
compute_scheduling ComputeSchedulingResponse: Compute instance scheduling information (if empty default is used).
disk_type str: The disk type to use in the VM.
hostname str: The hostname to assign to the VM.
labels Mapping[str, str]: A map of labels to associate with the VM.
license_type str: The license type to use in OS adaptation.
machine_type str: The machine type to create the VM with.
machine_type_series str: The machine type series to create the VM with.
metadata Mapping[str, str]: The metadata key/value pairs to assign to the VM.
network_interfaces Sequence[NetworkInterfaceResponse]: List of NICs connected to this VM.
network_tags Sequence[str]: A map of network tags to associate with the VM.
project str: The Google Cloud target project ID or project name.
secure_boot bool: Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
service_account str: The service account to associate the VM with.
vm_name str: The name of the VM to create.
zone str: The zone in which to create the VM.

additionalLicenses List<String>: Additional licenses to assign to the VM.
appliedLicense Property Map: The OS license returned from the adaptation module report.
bootOption String: The VM Boot Option, as set in the source vm.
computeScheduling Property Map: Compute instance scheduling information (if empty default is used).
diskType String: The disk type to use in the VM.
hostname String: The hostname to assign to the VM.
labels Map<String>: A map of labels to associate with the VM.
licenseType String: The license type to use in OS adaptation.
machineType String: The machine type to create the VM with.
machineTypeSeries String: The machine type series to create the VM with.
metadata Map<String>: The metadata key/value pairs to assign to the VM.
networkInterfaces List<Property Map>: List of NICs connected to this VM.
networkTags List<String>: A map of network tags to associate with the VM.
project String: The Google Cloud target project ID or project name.
secureBoot Boolean: Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
serviceAccount String: The service account to associate the VM with.
vmName String: The name of the VM to create.
zone String: The zone in which to create the VM.

ComputeSchedulingResponse

MinNodeCpus int: The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
NodeAffinities List<Pulumi.GoogleNative.VMMigration.V1.Inputs.SchedulingNodeAffinityResponse>: A set of node affinity and anti-affinity configurations for sole tenant nodes.
OnHostMaintenance string: How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
RestartType string: Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to automaticRestart field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.

MinNodeCpus int: The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
NodeAffinities []SchedulingNodeAffinityResponse: A set of node affinity and anti-affinity configurations for sole tenant nodes.
OnHostMaintenance string: How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
RestartType string: Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to automaticRestart field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.

minNodeCpus Integer: The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
nodeAffinities List<SchedulingNodeAffinityResponse>: A set of node affinity and anti-affinity configurations for sole tenant nodes.
onHostMaintenance String: How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
restartType String: Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to automaticRestart field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.

minNodeCpus number: The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
nodeAffinities SchedulingNodeAffinityResponse[]: A set of node affinity and anti-affinity configurations for sole tenant nodes.
onHostMaintenance string: How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
restartType string: Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to automaticRestart field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.

min_node_cpus int: The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
node_affinities Sequence[SchedulingNodeAffinityResponse]: A set of node affinity and anti-affinity configurations for sole tenant nodes.
on_host_maintenance str: How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
restart_type str: Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to automaticRestart field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.

minNodeCpus Number: The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
nodeAffinities List<Property Map>: A set of node affinity and anti-affinity configurations for sole tenant nodes.
onHostMaintenance String: How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
restartType String: Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to automaticRestart field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.

NetworkInterfaceResponse

ExternalIp string: The external IP to define in the NIC.
InternalIp string: The internal IP to define in the NIC. The formats accepted are: ephemeral \ ipv4 address \ a named address resource full path.
Network string: The network to connect the NIC to.
Subnetwork string: The subnetwork to connect the NIC to.

ExternalIp string: The external IP to define in the NIC.
InternalIp string: The internal IP to define in the NIC. The formats accepted are: ephemeral \ ipv4 address \ a named address resource full path.
Network string: The network to connect the NIC to.
Subnetwork string: The subnetwork to connect the NIC to.

externalIp String: The external IP to define in the NIC.
internalIp String: The internal IP to define in the NIC. The formats accepted are: ephemeral \ ipv4 address \ a named address resource full path.
network String: The network to connect the NIC to.
subnetwork String: The subnetwork to connect the NIC to.

externalIp string: The external IP to define in the NIC.
internalIp string: The internal IP to define in the NIC. The formats accepted are: ephemeral \ ipv4 address \ a named address resource full path.
network string: The network to connect the NIC to.
subnetwork string: The subnetwork to connect the NIC to.

external_ip str: The external IP to define in the NIC.
internal_ip str: The internal IP to define in the NIC. The formats accepted are: ephemeral \ ipv4 address \ a named address resource full path.
network str: The network to connect the NIC to.
subnetwork str: The subnetwork to connect the NIC to.

externalIp String: The external IP to define in the NIC.
internalIp String: The internal IP to define in the NIC. The formats accepted are: ephemeral \ ipv4 address \ a named address resource full path.
network String: The network to connect the NIC to.
subnetwork String: The subnetwork to connect the NIC to.

SchedulingNodeAffinityResponse

Key string: The label key of Node resource to reference.
Operator string: The operator to use for the node resources specified in the values parameter.
Values List<string>: Corresponds to the label values of Node resource.

Key string: The label key of Node resource to reference.
Operator string: The operator to use for the node resources specified in the values parameter.
Values []string: Corresponds to the label values of Node resource.

key String: The label key of Node resource to reference.
operator String: The operator to use for the node resources specified in the values parameter.
values List<String>: Corresponds to the label values of Node resource.

key string: The label key of Node resource to reference.
operator string: The operator to use for the node resources specified in the values parameter.
values string[]: Corresponds to the label values of Node resource.

key str: The label key of Node resource to reference.
operator str: The operator to use for the node resources specified in the values parameter.
values Sequence[str]: Corresponds to the label values of Node resource.

key String: The label key of Node resource to reference.
operator String: The operator to use for the node resources specified in the values parameter.
values List<String>: Corresponds to the label values of Node resource.

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.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0