{ "revision": "20260716", "id": "vmmigration:v1alpha1", "basePath": "", "fullyEncodeReservedExpansion": true, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "name": "vmmigration", "version_module": true, "title": "VM Migration API", "parameters": { "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "key": { "type": "string", "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "access_token": { "type": "string", "location": "query", "description": "OAuth access token." }, "$.xgafv": { "enum": [ "1", "2" ], "location": "query", "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string" }, "alt": { "type": "string", "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "enum": [ "json", "media", "proto" ], "location": "query" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." } }, "schemas": { "VmUtilizationMetrics": { "description": "Utilization metrics values for a single VM.", "properties": { "networkThroughputAverageKbps": { "type": "string", "format": "int64", "description": "Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second." }, "memoryMax": { "type": "integer", "format": "int32", "deprecated": true, "description": "Max memory usage, percent." }, "diskIoRateAverage": { "description": "Average disk IO rate, in kilobytes per second.", "type": "string", "format": "int64", "deprecated": true }, "diskIoRateAverageKbps": { "type": "string", "format": "int64", "description": "Average disk IO rate, in kilobytes per second." }, "networkThroughputMax": { "deprecated": true, "type": "string", "format": "int64", "description": "Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second." }, "cpuMaxPercent": { "type": "integer", "format": "int32", "description": "Max CPU usage, percent." }, "cpuAveragePercent": { "type": "integer", "format": "int32", "description": "Average CPU usage, percent." }, "cpuMax": { "description": "Max CPU usage, percent.", "type": "integer", "format": "int32", "deprecated": true }, "memoryAverage": { "type": "integer", "format": "int32", "deprecated": true, "description": "Average memory usage, percent." }, "diskIoRateMaxKbps": { "type": "string", "format": "int64", "description": "Max disk IO rate, in kilobytes per second." }, "memoryMaxPercent": { "type": "integer", "format": "int32", "description": "Max memory usage, percent." }, "networkThroughputMaxKbps": { "description": "Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.", "type": "string", "format": "int64" }, "networkThroughputAverage": { "type": "string", "format": "int64", "deprecated": true, "description": "Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second." }, "memoryAveragePercent": { "type": "integer", "format": "int32", "description": "Average memory usage, percent." }, "cpuAverage": { "description": "Average CPU usage, percent.", "type": "integer", "format": "int32", "deprecated": true }, "diskIoRateMax": { "description": "Max disk IO rate, in kilobytes per second.", "deprecated": true, "type": "string", "format": "int64" } }, "id": "VmUtilizationMetrics", "type": "object" }, "ApplianceVersion": { "description": "Describes an appliance version.", "properties": { "uri": { "description": "A link for downloading the version.", "type": "string" }, "critical": { "type": "boolean", "description": "Determine whether it's critical to upgrade the appliance to this version." }, "releaseNotesUri": { "type": "string", "description": "Link to a page that contains the version release notes." }, "version": { "description": "The appliance version.", "type": "string" } }, "id": "ApplianceVersion", "type": "object" }, "CancelDiskMigrationJobRequest": { "properties": {}, "id": "CancelDiskMigrationJobRequest", "type": "object", "description": "Request message for 'CancelDiskMigrationJob' request." }, "CloneStep": { "id": "CloneStep", "type": "object", "properties": { "adaptingOs": { "description": "Adapting OS step.", "$ref": "AdaptingOSStep" }, "endTime": { "type": "string", "format": "google-datetime", "description": "The time the step has ended." }, "preparingVmDisks": { "description": "Preparing VM disks step.", "$ref": "PreparingVMDisksStep" }, "instantiatingMigratedVm": { "description": "Instantiating migrated VM step.", "$ref": "InstantiatingMigratedVMStep" }, "startTime": { "description": "The time the step has started.", "type": "string", "format": "google-datetime" } }, "description": "CloneStep holds information about the clone step progress." }, "AzureDiskDetails": { "description": "The details of an Azure VM disk.", "properties": { "diskNumber": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The ordinal number of the disk." }, "diskId": { "description": "Output only. Azure disk ID.", "type": "string", "readOnly": true }, "sizeGb": { "readOnly": true, "type": "string", "format": "int64", "description": "Output only. Size in GB." } }, "id": "AzureDiskDetails", "type": "object" }, "CancelImageImportJobRequest": { "description": "Request message for 'CancelImageImportJob' request.", "properties": {}, "id": "CancelImageImportJobRequest", "type": "object" }, "AccessKeyCredentials": { "id": "AccessKeyCredentials", "type": "object", "properties": { "sessionToken": { "description": "Input only. AWS session token. Used only when AWS security token service (STS) is responsible for creating the temporary credentials.", "type": "string" }, "secretAccessKey": { "type": "string", "description": "Input only. AWS secret access key." }, "accessKeyId": { "type": "string", "description": "AWS access key ID." } }, "description": "Message describing AWS Credentials using access key id and secret." }, "AwsSourceDetails": { "id": "AwsSourceDetails", "type": "object", "properties": { "inventorySecurityGroupNames": { "type": "array", "items": { "type": "string" }, "description": "AWS security group names to limit the scope of the source inventory." }, "state": { "type": "string", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "PENDING", "FAILED", "ACTIVE" ], "description": "Output only. State of the source as determined by the health check.", "enumDescriptions": [ "The state is unknown. This is used for API compatibility only and is not used by the system.", "The state was not sampled by the health checks yet.", "The source is available but might not be usable yet due to invalid credentials or another reason. The error message will contain further details.", "The source exists and its credentials were verified." ] }, "error": { "description": "Output only. Provides details on the state of the Source in case of an error.", "readOnly": true, "$ref": "Status" }, "awsRegion": { "type": "string", "description": "Immutable. The AWS region that the source VMs will be migrated from." }, "migrationResourcesUserTags": { "description": "User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`.", "type": "object", "additionalProperties": { "type": "string" } }, "publicIp": { "description": "Output only. The source's public IP. All communication initiated by this source will originate from this IP.", "type": "string", "readOnly": true }, "accessKeyCreds": { "description": "AWS Credentials using access key id and secret.", "$ref": "AccessKeyCredentials" }, "inventoryTagList": { "description": "AWS resource tags to limit the scope of the source inventory.", "type": "array", "items": { "$ref": "Tag" } } }, "description": "AwsSourceDetails message describes a specific source details for the AWS source type." }, "UpgradeStatus": { "description": "UpgradeStatus contains information about upgradeAppliance operation.", "properties": { "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "RUNNING", "FAILED", "SUCCEEDED" ], "description": "The state of the upgradeAppliance operation.", "enumDescriptions": [ "The state was not sampled by the health checks yet.", "The upgrade has started.", "The upgrade failed.", "The upgrade finished successfully." ] }, "error": { "description": "Output only. Provides details on the state of the upgrade operation in case of an error.", "readOnly": true, "$ref": "Status" }, "previousVersion": { "type": "string", "description": "The version from which we upgraded." }, "startTime": { "description": "The time the operation was started.", "type": "string", "format": "google-datetime" }, "version": { "description": "The version to upgrade to.", "type": "string" } }, "id": "UpgradeStatus", "type": "object" }, "DisksMigrationVmTargetDefaults": { "id": "DisksMigrationVmTargetDefaults", "type": "object", "properties": { "encryption": { "description": "Optional. The encryption to apply to the VM.", "$ref": "Encryption" }, "machineTypeSeries": { "type": "string", "description": "Optional. The machine type series to create the VM with. For presentation only." }, "hostname": { "description": "Optional. The hostname to assign to the VM.", "type": "string" }, "vmName": { "type": "string", "description": "Required. The name of the VM to create." }, "additionalLicenses": { "type": "array", "items": { "type": "string" }, "description": "Optional. Additional licenses to assign to the VM." }, "machineType": { "type": "string", "description": "Required. The machine type to create the VM with." }, "secureBoot": { "type": "boolean", "description": "Optional. Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI." }, "serviceAccount": { "type": "string", "description": "Optional. The service account to associate the VM with." }, "enableVtpm": { "description": "Optional. Defines whether the instance has vTPM enabled.", "type": "boolean" }, "networkInterfaces": { "description": "Optional. NICs to attach to the VM.", "type": "array", "items": { "$ref": "NetworkInterface" } }, "networkTags": { "type": "array", "items": { "type": "string" }, "description": "Optional. A list of network tags to associate with the VM." }, "labels": { "description": "Optional. A map of labels to associate with the VM.", "type": "object", "additionalProperties": { "type": "string" } }, "bootDiskDefaults": { "description": "Optional. Details of the boot disk of the VM.", "$ref": "BootDiskDefaults" }, "enableIntegrityMonitoring": { "description": "Optional. Defines whether the instance has integrity monitoring enabled.", "type": "boolean" }, "computeScheduling": { "description": "Optional. Compute instance scheduling information (if empty default is used).", "$ref": "ComputeScheduling" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. The metadata key/value pairs to assign to the VM." } }, "description": "Details for creation of a VM that migrated data disks will be attached to." }, "UpgradeApplianceRequest": { "description": "Request message for 'UpgradeAppliance' request.", "properties": { "requestId": { "type": "string", "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." } }, "id": "UpgradeApplianceRequest", "type": "object" }, "VmwareSourceVmDetails": { "description": "Represent the source Vmware VM details.", "id": "VmwareSourceVmDetails", "type": "object", "properties": { "architecture": { "readOnly": true, "type": "string", "description": "Output only. The VM architecture.", "enumDescriptions": [ "The architecture is unknown.", "The architecture is one of the x86 architectures.", "The architecture is ARM64." ], "enum": [ "VM_ARCHITECTURE_UNSPECIFIED", "VM_ARCHITECTURE_X86_FAMILY", "VM_ARCHITECTURE_ARM64" ] }, "firmware": { "readOnly": true, "type": "string", "description": "Output only. The firmware type of the source VM.", "enumDescriptions": [ "The firmware is unknown.", "The firmware is EFI.", "The firmware is BIOS." ], "enum": [ "FIRMWARE_UNSPECIFIED", "EFI", "BIOS" ] }, "disks": { "description": "Output only. The disks attached to the source VM.", "type": "array", "items": { "$ref": "VmwareDiskDetails" }, "readOnly": true }, "vmCapabilitiesInfo": { "readOnly": true, "$ref": "VmCapabilities", "description": "Output only. Information about VM capabilities needed for some Compute Engine features." }, "committedStorageBytes": { "readOnly": true, "type": "string", "format": "int64", "description": "Output only. The total size of the disks being migrated in bytes." } } }, "VmAttachmentDetails": { "id": "VmAttachmentDetails", "type": "object", "properties": { "deviceName": { "description": "Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.", "type": "string" } }, "description": "Details for attachment of the disk to a VM." }, "CancelCutoverJobRequest": { "description": "Request message for 'CancelCutoverJob' request.", "id": "CancelCutoverJobRequest", "type": "object", "properties": {} }, "DisksMigrationDisksTargetDefaults": { "description": "Details for a disk only migration.", "properties": {}, "id": "DisksMigrationDisksTargetDefaults", "type": "object" }, "CreatingSourceDiskSnapshotStep": { "properties": {}, "id": "CreatingSourceDiskSnapshotStep", "type": "object", "description": "CreatingSourceDiskSnapshotStep contains specific step details." }, "PostProcessingStep": { "properties": {}, "id": "PostProcessingStep", "type": "object", "description": "PostProcessingStep contains specific step details." }, "ComputeEngineDisk": { "description": "Compute Engine disk target details.", "properties": { "zone": { "type": "string", "description": "Required. The Compute Engine zone in which to create the disk. Should be of the form: projects/{target-project}/locations/{zone}" }, "diskId": { "type": "string", "description": "Optional. Target Compute Engine Disk ID. This is the resource ID segment of the Compute Engine Disk to create. In the resource name compute/v1/projects/{project}/zones/{zone}/disks/disk1 \"disk1\" is the resource ID for the disk." }, "replicaZones": { "type": "array", "items": { "type": "string" }, "description": "Optional. Replication zones of the regional disk. Should be of the form: projects/{target-project}/locations/{replica-zone} Currently only one replica zone is supported." }, "diskType": { "type": "string", "description": "Required. The disk type to use.", "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", "An alternative to SSD persistent disks that balance performance and cost.", "Hyperdisk balanced disk type.", "Hyperdisk balanced high availability disk type." ], "enum": [ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", "COMPUTE_ENGINE_DISK_TYPE_BALANCED", "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED", "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED_HIGH_AVAILABILITY" ] } }, "id": "ComputeEngineDisk", "type": "object" }, "ComputeEngineTargetDefaults": { "id": "ComputeEngineTargetDefaults", "type": "object", "properties": { "serviceAccount": { "description": "Optional. The service account to associate the VM with.", "type": "string" }, "diskReplicaZones": { "description": "Optional. Additional replica zones of the target regional disks. If this list is not empty a regional disk will be created. The first supported zone would be the one stated in the zone field. The rest are taken from this list. Please refer to the [regional disk creation API](https://cloud.google.com/compute/docs/regions-zones/global-regional-zonal-resources) for further details about regional vs zonal disks. If not specified, a zonal disk will be created in the same zone the VM is created.", "type": "array", "items": { "type": "string" } }, "bootOption": { "type": "string", "readOnly": true, "enum": [ "COMPUTE_ENGINE_BOOT_OPTION_UNSPECIFIED", "COMPUTE_ENGINE_BOOT_OPTION_EFI", "COMPUTE_ENGINE_BOOT_OPTION_BIOS" ], "description": "Output only. The VM Boot Option, as set in the source VM.", "enumDescriptions": [ "The boot option is unknown.", "The boot option is EFI.", "The boot option is BIOS." ] }, "bootConversion": { "description": "Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another.", "enumDescriptions": [ "Unspecified conversion type.", "No conversion.", "Convert from BIOS to EFI." ], "enum": [ "BOOT_CONVERSION_UNSPECIFIED", "NONE", "BIOS_TO_EFI" ], "type": "string" }, "additionalLicenses": { "type": "array", "items": { "type": "string" }, "description": "Additional licenses to assign to the VM." }, "disks": { "type": "array", "items": { "$ref": "PersistentDiskDefaults" }, "description": "Optional. The details of each disk to create." }, "licenseType": { "description": "The license type to use in OS adaptation.", "enumDescriptions": [ "The license type is the default for the OS.", "The license type is Pay As You Go license type.", "The license type is Bring Your Own License type." ], "enum": [ "COMPUTE_ENGINE_LICENSE_TYPE_DEFAULT", "COMPUTE_ENGINE_LICENSE_TYPE_PAYG", "COMPUTE_ENGINE_LICENSE_TYPE_BYOL" ], "type": "string" }, "encryption": { "description": "Optional. Immutable. The encryption to apply to the VM disks.", "$ref": "Encryption" }, "computeScheduling": { "description": "Compute instance scheduling information (if empty default is used).", "$ref": "ComputeScheduling" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The metadata key/value pairs to assign to the VM." }, "diskType": { "type": "string", "description": "The disk type to use in the VM.", "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", "An alternative to SSD persistent disks that balance performance and cost.", "Hyperdisk balanced disk type.", "Hyperdisk balanced high availability disk type." ], "enum": [ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", "COMPUTE_ENGINE_DISK_TYPE_BALANCED", "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED", "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED_HIGH_AVAILABILITY" ] }, "enableIntegrityMonitoring": { "description": "Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled.", "type": "boolean" }, "targetProject": { "type": "string", "description": "The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM." }, "networkInterfaces": { "type": "array", "items": { "$ref": "NetworkInterface" }, "description": "List of NICs connected to this VM." }, "enableVtpm": { "description": "Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI.", "type": "boolean" }, "appliedLicense": { "readOnly": true, "$ref": "AppliedLicense", "description": "Output only. The OS license returned from the adaptation module report." }, "secureBoot": { "description": "Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI.", "type": "boolean" }, "adaptationModifiers": { "description": "Optional. AdaptationModifiers are the set of modifiers used during OS adaptation.", "type": "array", "items": { "$ref": "AdaptationModifier" } }, "machineType": { "type": "string", "description": "The machine type to create the VM with." }, "machineTypeSeries": { "type": "string", "description": "The machine type series to create the VM with." }, "hostname": { "description": "The hostname to assign to the VM.", "type": "string" }, "vmName": { "type": "string", "description": "The name of the VM to create." }, "zone": { "type": "string", "description": "The zone in which to create the VM." }, "storagePool": { "type": "string", "description": "Optional. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: \"projects/my-project/zones/us-central1-a/storagePools/my-storage-pool\". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of labels to associate with the VM." }, "networkTags": { "description": "A list of network tags to associate with the VM.", "type": "array", "items": { "type": "string" } } }, "description": "ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project." }, "MigrationError": { "id": "MigrationError", "type": "object", "properties": { "errorMessage": { "description": "Output only. The localized error message.", "readOnly": true, "$ref": "LocalizedMessage" }, "actionItem": { "description": "Output only. Suggested action for solving the error.", "readOnly": true, "$ref": "LocalizedMessage" }, "errorTime": { "description": "Output only. The time the error occurred.", "type": "string", "format": "google-datetime", "readOnly": true }, "code": { "description": "Output only. The error code.", "enumDescriptions": [ "Default value. This value is not used.", "Migrate to Virtual Machines encountered an unknown error.", "Migrate to Virtual Machines encountered an error while validating replication source health.", "Migrate to Virtual Machines encountered an error during source data operation.", "Migrate to Virtual Machines encountered an error during target data operation.", "Migrate to Virtual Machines encountered an error during OS adaptation.", "Migrate to Virtual Machines encountered an error in clone operation.", "Migrate to Virtual Machines encountered an error in cutover operation.", "Migrate to Virtual Machines encountered an error during utilization report creation.", "Migrate to Virtual Machines encountered an error during appliance upgrade.", "Migrate to Virtual Machines encountered an error in image import operation.", "Migrate to Virtual Machines encountered an error in disk migration operation." ], "enum": [ "ERROR_CODE_UNSPECIFIED", "UNKNOWN_ERROR", "SOURCE_VALIDATION_ERROR", "SOURCE_REPLICATION_ERROR", "TARGET_REPLICATION_ERROR", "OS_ADAPTATION_ERROR", "CLONE_ERROR", "CUTOVER_ERROR", "UTILIZATION_REPORT_ERROR", "APPLIANCE_UPGRADE_ERROR", "IMAGE_IMPORT_ERROR", "DISK_MIGRATION_ERROR" ], "readOnly": true, "type": "string" }, "helpLinks": { "description": "Output only. URL(s) pointing to additional information on handling the current error.", "readOnly": true, "type": "array", "items": { "$ref": "Link" } } }, "description": "Represents migration resource error information that can be used with google.rpc.Status message. MigrationError is used to present the user with error information in migration operations." }, "AwsSourceDiskDetails": { "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true, "description": "Optional. Output only. A map of AWS volume tags." }, "volumeId": { "type": "string", "description": "Required. AWS volume ID." }, "sizeGib": { "type": "string", "format": "int64", "readOnly": true, "description": "Output only. Size in GiB." }, "diskType": { "type": "string", "readOnly": true, "enum": [ "TYPE_UNSPECIFIED", "GP2", "GP3", "IO1", "IO2", "ST1", "SC1", "STANDARD" ], "description": "Optional. Output only. Disk type.", "enumDescriptions": [ "Unspecified AWS disk type. Should not be used.", "GP2 disk type.", "GP3 disk type.", "IO1 disk type.", "IO2 disk type.", "ST1 disk type.", "SC1 disk type.", "Standard disk type." ] } }, "id": "AwsSourceDiskDetails", "type": "object", "description": "Represents the source AWS Disk details." }, "Empty": { "id": "Empty", "type": "object", "properties": {}, "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }" }, "CycleStep": { "properties": { "postProcessing": { "description": "Post processing step.", "$ref": "PostProcessingStep" }, "startTime": { "description": "The time the cycle step has started.", "type": "string", "format": "google-datetime" }, "replicating": { "description": "Replicating step.", "$ref": "ReplicatingStep" }, "initializingReplication": { "description": "Initializing replication step.", "$ref": "InitializingReplicationStep" }, "endTime": { "type": "string", "format": "google-datetime", "description": "The time the cycle step has ended." } }, "id": "CycleStep", "type": "object", "description": "CycleStep holds information about a step progress." }, "BootDiskDefaults": { "properties": { "diskType": { "description": "Optional. The type of disk provisioning to use for the VM.", "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", "An alternative to SSD persistent disks that balance performance and cost.", "Hyperdisk balanced disk type.", "Hyperdisk balanced high availability disk type." ], "enum": [ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", "COMPUTE_ENGINE_DISK_TYPE_BALANCED", "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED", "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED_HIGH_AVAILABILITY" ], "type": "string" }, "diskName": { "description": "Optional. The name of the disk.", "type": "string" }, "deviceName": { "type": "string", "description": "Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks." }, "encryption": { "description": "Optional. The encryption to apply to the boot disk.", "$ref": "Encryption" }, "image": { "description": "The image to use when creating the disk.", "$ref": "DiskImageDefaults" } }, "id": "BootDiskDefaults", "type": "object", "description": "BootDiskDefaults hold information about the boot disk of a VM." }, "ListGroupsResponse": { "id": "ListGroupsResponse", "type": "object", "properties": { "unreachable": { "description": "Output only. Locations that could not be reached.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "$ref": "Group" }, "readOnly": true, "description": "Output only. The list of groups response." }, "nextPageToken": { "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string", "readOnly": true } }, "description": "Response message for 'ListGroups' request." }, "ListLocationsResponse": { "id": "ListLocationsResponse", "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } } }, "description": "The response message for Locations.ListLocations." }, "CopyingSourceDiskSnapshotStep": { "description": "CopyingSourceDiskSnapshotStep contains specific step details.", "properties": {}, "id": "CopyingSourceDiskSnapshotStep", "type": "object" }, "SchedulingNodeAffinity": { "description": "Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. Based on https://cloud.google.com/compute/docs/reference/rest/v1/instances/setScheduling", "properties": { "values": { "description": "Corresponds to the label values of Node resource.", "type": "array", "items": { "type": "string" } }, "operator": { "enum": [ "OPERATOR_UNSPECIFIED", "IN", "NOT_IN" ], "description": "The operator to use for the node resources specified in the `values` parameter.", "enumDescriptions": [ "An unknown, unexpected behavior.", "The node resource group should be in these resources affinity.", "The node resource group should not be in these resources affinity." ], "type": "string" }, "key": { "type": "string", "description": "The label key of Node resource to reference." } }, "id": "SchedulingNodeAffinity", "type": "object" }, "SkipOsAdaptation": { "id": "SkipOsAdaptation", "type": "object", "properties": {}, "description": "Mentions that the machine image import is not using OS adaptation process." }, "VmwareSourceDetails": { "description": "VmwareSourceDetails message describes a specific source details for the vmware source type.", "id": "VmwareSourceDetails", "type": "object", "properties": { "resolvedVcenterHost": { "type": "string", "description": "The hostname of the vcenter." }, "password": { "description": "Input only. The credentials password. This is write only and can not be read in a GET operation.", "type": "string" }, "vcenterIp": { "type": "string", "description": "The ip address of the vcenter this Source represents." }, "username": { "description": "The credentials username.", "type": "string" }, "thumbprint": { "type": "string", "description": "The thumbprint representing the certificate for the vcenter." } } }, "CutoverForecast": { "description": "CutoverForecast holds information about future CutoverJobs of a MigratingVm.", "properties": { "estimatedCutoverJobDuration": { "type": "string", "format": "google-duration", "readOnly": true, "description": "Output only. Estimation of the CutoverJob duration." } }, "id": "CutoverForecast", "type": "object" }, "ShieldedInstanceConfig": { "id": "ShieldedInstanceConfig", "type": "object", "properties": { "secureBoot": { "type": "string", "enum": [ "SECURE_BOOT_UNSPECIFIED", "TRUE", "FALSE" ], "description": "Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI.", "enumDescriptions": [ "No explicit value is selected. Will use the configuration of the source (if exists, otherwise the default will be false).", "Use secure boot. This can be set to true only if the image boot option is EFI.", "Do not use secure boot." ] }, "enableVtpm": { "description": "Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI.", "type": "boolean" }, "enableIntegrityMonitoring": { "type": "boolean", "description": "Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled." } }, "description": "Shielded instance configuration." }, "VmwareVmDetails": { "id": "VmwareVmDetails", "type": "object", "properties": { "vmId": { "type": "string", "description": "The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM." }, "cpuCount": { "description": "The number of cpus in the VM.", "type": "integer", "format": "int32" }, "committedStorageMb": { "type": "string", "format": "int64", "description": "The total size of the storage allocated to the VM in MB." }, "datacenterId": { "description": "The id of the vCenter's datacenter this VM is contained in.", "type": "string" }, "datacenterDescription": { "type": "string", "description": "The descriptive name of the vCenter's datacenter this VM is contained in." }, "displayName": { "description": "The display name of the VM. Note that this is not necessarily unique.", "type": "string" }, "powerState": { "description": "The power state of the VM at the moment list was taken.", "enumDescriptions": [ "Power state is not specified.", "The VM is turned ON.", "The VM is turned OFF.", "The VM is suspended. This is similar to hibernation or sleep mode." ], "enum": [ "POWER_STATE_UNSPECIFIED", "ON", "OFF", "SUSPENDED" ], "type": "string" }, "diskCount": { "description": "The number of disks the VM has.", "type": "integer", "format": "int32" }, "uuid": { "type": "string", "description": "The unique identifier of the VM in vCenter." }, "committedStorage": { "description": "The total size of the storage allocated to the VM in MB.", "type": "string", "format": "int64", "deprecated": true }, "bootOption": { "readOnly": true, "type": "string", "description": "Output only. The VM Boot Option.", "enumDescriptions": [ "The boot option is unknown.", "The boot option is EFI.", "The boot option is BIOS." ], "enum": [ "BOOT_OPTION_UNSPECIFIED", "EFI", "BIOS" ] }, "memoryMb": { "description": "The size of the memory of the VM in MB.", "type": "integer", "format": "int32" }, "guestDescription": { "type": "string", "description": "The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold." }, "architecture": { "readOnly": true, "type": "string", "description": "Output only. The CPU architecture.", "enumDescriptions": [ "The architecture is unknown.", "The architecture is one of the x86 architectures.", "The architecture is ARM64." ], "enum": [ "VM_ARCHITECTURE_UNSPECIFIED", "VM_ARCHITECTURE_X86_FAMILY", "VM_ARCHITECTURE_ARM64" ] } }, "description": "VmwareVmDetails describes a VM in vCenter." }, "PauseMigrationRequest": { "description": "Request message for 'PauseMigration' request.", "id": "PauseMigrationRequest", "type": "object", "properties": {} }, "CloneJob": { "description": "CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone.", "id": "CloneJob", "type": "object", "properties": { "computeEngineVmDetails": { "description": "Output only. Details of the VM in Compute Engine. Deprecated: Use compute_engine_target_details instead.", "readOnly": true, "deprecated": true, "$ref": "TargetVMDetails" }, "computeEngineDisksTargetDetails": { "description": "Output only. Details of the target Persistent Disks in Compute Engine.", "readOnly": true, "$ref": "ComputeEngineDisksTargetDetails" }, "endTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the clone job was ended." }, "state": { "description": "Output only. State of the clone job.", "enumDescriptions": [ "The state is unknown. This is used for API compatibility only and is not used by the system.", "The clone job has not yet started.", "The clone job is active and running.", "The clone job finished with errors.", "The clone job finished successfully.", "The clone job was cancelled.", "The clone job is being cancelled.", "OS adaptation is running as part of the clone job to generate license." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "ACTIVE", "FAILED", "SUCCEEDED", "CANCELLED", "CANCELLING", "ADAPTING_OS" ], "readOnly": true, "type": "string" }, "error": { "description": "Output only. Provides details for the errors that led to the Clone Job's state.", "readOnly": true, "$ref": "Status" }, "steps": { "readOnly": true, "type": "array", "items": { "$ref": "CloneStep" }, "description": "Output only. The clone steps list representing its progress." }, "computeEngineTargetDetails": { "description": "Output only. Details of the target VM in Compute Engine.", "readOnly": true, "$ref": "ComputeEngineTargetDetails" }, "createTime": { "description": "Output only. The time the clone job was created (as an API call, not when it was actually created in the target).", "type": "string", "format": "google-datetime", "readOnly": true }, "targetDetails": { "description": "Output only. Details of the VM to create as the target of this clone job. Deprecated: Use compute_engine_target_details instead.", "readOnly": true, "deprecated": true, "$ref": "TargetVMDetails" }, "name": { "description": "Output only. The name of the clone.", "type": "string", "readOnly": true }, "stateTime": { "description": "Output only. The time the state was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "VmwareDiskDetails": { "description": "The details of a Vmware VM disk.", "id": "VmwareDiskDetails", "type": "object", "properties": { "diskNumber": { "description": "Output only. The ordinal number of the disk.", "readOnly": true, "type": "integer", "format": "int32" }, "sizeGb": { "type": "string", "format": "int64", "readOnly": true, "description": "Output only. Size in GB." }, "label": { "readOnly": true, "type": "string", "description": "Output only. The disk label." } } }, "ExtendMigrationRequest": { "description": "Request message for 'ExtendMigrationRequest' request.", "properties": {}, "id": "ExtendMigrationRequest", "type": "object" }, "ImageImportStep": { "properties": { "loadingSourceFiles": { "description": "Loading source files step.", "$ref": "LoadingImageSourceFilesStep" }, "startTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the step has started." }, "creatingImage": { "description": "Creating image step.", "$ref": "CreatingImageStep" }, "initializing": { "description": "Initializing step.", "$ref": "InitializingImageImportStep" }, "adaptingOs": { "description": "Adapting OS step.", "$ref": "AdaptingOSStep" }, "endTime": { "description": "Output only. The time the step has ended.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "id": "ImageImportStep", "type": "object", "description": "ImageImportStep holds information about the image import step progress." }, "ReplicatingStep": { "description": "ReplicatingStep contains specific step details.", "id": "ReplicatingStep", "type": "object", "properties": { "totalBytes": { "type": "string", "format": "int64", "description": "Total bytes to be handled in the step." }, "lastThirtyMinutesAverageBytesPerSecond": { "description": "The source disks replication rate for the last 30 minutes in bytes per second.", "type": "string", "format": "int64" }, "replicatedBytes": { "description": "Replicated bytes in the step.", "type": "string", "format": "int64" }, "lastTwoMinutesAverageBytesPerSecond": { "description": "The source disks replication rate for the last 2 minutes in bytes per second.", "type": "string", "format": "int64" } } }, "AddGroupMigrationRequest": { "description": "Request message for 'AddGroupMigration' request.", "id": "AddGroupMigrationRequest", "type": "object", "properties": { "migratingVm": { "type": "string", "description": "The full path name of the MigratingVm to add." } } }, "AdaptingOSStep": { "description": "AdaptingOSStep contains specific step details.", "properties": {}, "id": "AdaptingOSStep", "type": "object" }, "SourceStorageResource": { "properties": { "awsDiskDetails": { "description": "Source AWS volume details.", "$ref": "AwsSourceDiskDetails" } }, "id": "SourceStorageResource", "type": "object", "description": "SourceStorageResource describes a storage resource in the source." }, "PersistentDiskDefaults": { "description": "Details for creation of a Persistent Disk.", "id": "PersistentDiskDefaults", "type": "object", "properties": { "additionalLabels": { "description": "A map of labels to associate with the Persistent Disk.", "type": "object", "additionalProperties": { "type": "string" } }, "sourceDiskNumber": { "description": "Required. The ordinal number of the source VM disk.", "type": "integer", "format": "int32" }, "diskType": { "description": "The disk type to use.", "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", "An alternative to SSD persistent disks that balance performance and cost.", "Hyperdisk balanced disk type.", "Hyperdisk balanced high availability disk type." ], "enum": [ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", "COMPUTE_ENGINE_DISK_TYPE_BALANCED", "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED", "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED_HIGH_AVAILABILITY" ], "type": "string" }, "diskName": { "description": "Optional. The name of the Persistent Disk to create.", "type": "string" }, "encryption": { "description": "Optional. The encryption to apply to the disk.", "$ref": "Encryption" }, "vmAttachmentDetails": { "description": "Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM.", "$ref": "VmAttachmentDetails" } } }, "LocalizedMessage": { "id": "LocalizedMessage", "type": "object", "properties": { "locale": { "type": "string", "description": "The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: \"en-US\", \"fr-CH\", \"es-MX\"" }, "message": { "description": "The localized error message in the above locale.", "type": "string" } }, "description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error." }, "PreparingVMDisksStep": { "id": "PreparingVMDisksStep", "type": "object", "properties": {}, "description": "PreparingVMDisksStep contains specific step details." }, "AzureVmsDetails": { "properties": { "details": { "description": "The details of the Azure VMs.", "type": "array", "items": { "$ref": "AzureVmDetails" } } }, "id": "AzureVmsDetails", "type": "object", "description": "AzureVmsDetails describes VMs in Azure." }, "OSDescription": { "description": "A message describing the VM's OS. Including OS, Publisher, Offer and Plan if applicable.", "id": "OSDescription", "type": "object", "properties": { "offer": { "type": "string", "description": "OS offer." }, "type": { "type": "string", "description": "OS type." }, "plan": { "type": "string", "description": "OS plan." }, "publisher": { "description": "OS publisher.", "type": "string" } } }, "Status": { "properties": { "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "message": { "type": "string", "description": "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." } }, "id": "Status", "type": "object", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)." }, "InitializingImageImportStep": { "description": "InitializingImageImportStep contains specific step details.", "properties": {}, "id": "InitializingImageImportStep", "type": "object" }, "AzureSourceVmDetails": { "id": "AzureSourceVmDetails", "type": "object", "properties": { "architecture": { "readOnly": true, "type": "string", "description": "Output only. The VM architecture.", "enumDescriptions": [ "The architecture is unknown.", "The architecture is one of the x86 architectures.", "The architecture is ARM64." ], "enum": [ "VM_ARCHITECTURE_UNSPECIFIED", "VM_ARCHITECTURE_X86_FAMILY", "VM_ARCHITECTURE_ARM64" ] }, "firmware": { "readOnly": true, "type": "string", "description": "Output only. The firmware type of the source VM.", "enumDescriptions": [ "The firmware is unknown.", "The firmware is EFI.", "The firmware is BIOS." ], "enum": [ "FIRMWARE_UNSPECIFIED", "EFI", "BIOS" ] }, "disks": { "description": "Output only. The disks attached to the source VM.", "readOnly": true, "type": "array", "items": { "$ref": "AzureDiskDetails" } }, "vmCapabilitiesInfo": { "description": "Output only. Information about VM capabilities needed for some Compute Engine features.", "readOnly": true, "$ref": "VmCapabilities" }, "committedStorageBytes": { "description": "Output only. The total size of the disks being migrated in bytes.", "type": "string", "format": "int64", "readOnly": true } }, "description": "Represent the source Azure VM details." }, "AwsVmDetails": { "description": "AwsVmDetails describes a VM in AWS.", "properties": { "memoryMb": { "description": "The memory size of the VM in MB.", "type": "integer", "format": "int32" }, "bootOption": { "description": "The VM Boot Option.", "enumDescriptions": [ "The boot option is unknown.", "The boot option is UEFI.", "The boot option is LEGACY-BIOS." ], "enum": [ "BOOT_OPTION_UNSPECIFIED", "EFI", "BIOS" ], "type": "string" }, "osDescription": { "description": "The VM's OS.", "type": "string" }, "securityGroups": { "type": "array", "items": { "$ref": "AwsSecurityGroup" }, "description": "The security groups the VM belongs to." }, "sourceDescription": { "type": "string", "description": "The descriptive name of the AWS's source this VM is connected to." }, "architecture": { "type": "string", "description": "The CPU architecture.", "enumDescriptions": [ "The architecture is unknown.", "The architecture is I386.", "The architecture is X86_64.", "The architecture is ARM64.", "The architecture is X86_64_MAC." ], "enum": [ "VM_ARCHITECTURE_UNSPECIFIED", "I386", "X86_64", "ARM64", "X86_64_MAC" ] }, "tags": { "description": "The tags of the VM.", "type": "object", "additionalProperties": { "type": "string" } }, "instanceType": { "type": "string", "description": "The instance type of the VM." }, "vpcId": { "type": "string", "description": "The VPC ID the VM belongs to." }, "committedStorageMb": { "description": "The total size of the storage allocated to the VM in MB.", "type": "string", "format": "int64" }, "cpuCount": { "type": "integer", "format": "int32", "description": "The number of CPU cores the VM has." }, "vmId": { "type": "string", "description": "The VM ID in AWS." }, "vcpuCount": { "description": "The number of vCPUs the VM has. It is calculated as the number of CPU cores * threads per CPU the VM has.", "type": "integer", "format": "int32" }, "diskCount": { "type": "integer", "format": "int32", "description": "The number of disks the VM has." }, "zone": { "type": "string", "description": "The AWS zone of the VM." }, "displayName": { "description": "The display name of the VM. Note that this value is not necessarily unique.", "type": "string" }, "powerState": { "readOnly": true, "type": "string", "description": "Output only. The power state of the VM at the moment list was taken.", "enumDescriptions": [ "Power state is not specified.", "The VM is turned on.", "The VM is turned off.", "The VM is suspended. This is similar to hibernation or sleep mode.", "The VM is starting." ], "enum": [ "POWER_STATE_UNSPECIFIED", "ON", "OFF", "SUSPENDED", "PENDING" ] }, "sourceId": { "type": "string", "description": "The id of the AWS's source this VM is connected to." }, "virtualizationType": { "description": "The virtualization type.", "enumDescriptions": [ "The virtualization type is unknown.", "The virtualziation type is HVM.", "The virtualziation type is PARAVIRTUAL." ], "enum": [ "VM_VIRTUALIZATION_TYPE_UNSPECIFIED", "HVM", "PARAVIRTUAL" ], "type": "string" } }, "id": "AwsVmDetails", "type": "object" }, "AppliedLicense": { "id": "AppliedLicense", "type": "object", "properties": { "type": { "description": "The license type that was used in OS adaptation.", "enumDescriptions": [ "Unspecified license for the OS.", "No license available for the OS.", "The license type is Pay As You Go license type.", "The license type is Bring Your Own License type." ], "enum": [ "TYPE_UNSPECIFIED", "NONE", "PAYG", "BYOL" ], "type": "string" }, "osLicense": { "type": "string", "description": "The OS license returned from the adaptation module's report." } }, "description": "AppliedLicense holds the license data returned by adaptation module report." }, "ListImageImportsResponse": { "id": "ListImageImportsResponse", "type": "object", "properties": { "unreachable": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. Locations that could not be reached." }, "nextPageToken": { "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string", "readOnly": true }, "imageImports": { "type": "array", "items": { "$ref": "ImageImport" }, "readOnly": true, "description": "Output only. The list of target response." } }, "description": "Response message for 'ListImageImports' call." }, "ResumeMigrationRequest": { "properties": {}, "id": "ResumeMigrationRequest", "type": "object", "description": "Request message for 'ResumeMigration' request." }, "AwsSecurityGroup": { "id": "AwsSecurityGroup", "type": "object", "properties": { "id": { "description": "The AWS security group id.", "type": "string" }, "name": { "description": "The AWS security group name.", "type": "string" } }, "description": "AwsSecurityGroup describes a security group of an AWS VM." }, "ProvisioningTargetDiskStep": { "properties": {}, "id": "ProvisioningTargetDiskStep", "type": "object", "description": "ProvisioningTargetDiskStep contains specific step details." }, "DatacenterConnector": { "description": "DatacenterConnector message describes a connector between the Source and Google Cloud, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to Google Cloud and support vm migration data transfer.", "id": "DatacenterConnector", "type": "object", "properties": { "upgradeStatus": { "description": "Output only. The status of the current / last upgradeAppliance operation.", "readOnly": true, "$ref": "UpgradeStatus" }, "applianceInfrastructureVersion": { "readOnly": true, "type": "string", "description": "Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance." }, "serviceAccount": { "description": "The service account to use in the connector when communicating with the cloud.", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The last time the connector was updated with an API call." }, "error": { "description": "Output only. Provides details on the state of the Datacenter Connector in case of an error.", "readOnly": true, "$ref": "Status" }, "bucket": { "description": "Output only. The communication channel between the datacenter connector and Google Cloud.", "readOnly": true, "type": "string" }, "availableVersions": { "readOnly": true, "$ref": "AvailableUpdates", "description": "Output only. The available versions for updating this appliance." }, "stateTime": { "description": "Output only. The time the state was last set.", "type": "string", "format": "google-datetime", "readOnly": true }, "applianceSoftwareVersion": { "readOnly": true, "type": "string", "description": "Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance." }, "name": { "description": "Output only. The connector's name.", "readOnly": true, "type": "string" }, "registrationId": { "type": "string", "description": "Immutable. A unique key for this connector. This key is internal to the OVA connector and is supplied with its creation during the registration process and can not be modified." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the connector was created (as an API call, not when it was actually installed)." }, "version": { "description": "The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified.", "type": "string" }, "state": { "readOnly": true, "type": "string", "description": "Output only. State of the DatacenterConnector, as determined by the health checks.", "enumDescriptions": [ "The state is unknown. This is used for API compatibility only and is not used by the system.", "The state was not sampled by the health checks yet.", "The source was sampled by health checks and is not available.", "The source is available but might not be usable yet due to unvalidated credentials or another reason. The credentials referred to are the ones to the Source. The error message will contain further details.", "The source exists and its credentials were verified." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "OFFLINE", "FAILED", "ACTIVE" ] } } }, "AdaptationModifier": { "id": "AdaptationModifier", "type": "object", "properties": { "modifier": { "type": "string", "description": "Optional. The modifier name." }, "value": { "description": "Optional. The value of the modifier. The actual value depends on the modifier and can also be empty.", "type": "string" } }, "description": "AdaptationModifier a modifier to be used for configuration of the OS adaptation process." }, "ListCloneJobsResponse": { "id": "ListCloneJobsResponse", "type": "object", "properties": { "nextPageToken": { "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string", "readOnly": true }, "unreachable": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. Locations that could not be reached." }, "cloneJobs": { "type": "array", "items": { "$ref": "CloneJob" }, "readOnly": true, "description": "Output only. The list of clone jobs response." } }, "description": "Response message for 'ListCloneJobs' request." }, "DiskMigrationStep": { "description": "DiskMigrationStep holds information about the disk migration step progress.", "properties": { "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the step has ended." }, "creatingSourceDiskSnapshot": { "description": "Creating source disk snapshot step.", "$ref": "CreatingSourceDiskSnapshotStep" }, "copyingSourceDiskSnapshot": { "description": "Copying source disk snapshot step.", "$ref": "CopyingSourceDiskSnapshotStep" }, "startTime": { "description": "Output only. The time the step has started.", "readOnly": true, "type": "string", "format": "google-datetime" }, "provisioningTargetDisk": { "description": "Creating target disk step.", "$ref": "ProvisioningTargetDiskStep" } }, "id": "DiskMigrationStep", "type": "object" }, "DiskImageDefaults": { "properties": { "sourceImage": { "type": "string", "description": "Required. The Image resource used when creating the disk." } }, "id": "DiskImageDefaults", "type": "object", "description": "Contains details about the image source used to create the disk." }, "FetchInventoryResponse": { "properties": { "nextPageToken": { "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "readOnly": true, "type": "string" }, "vmwareVms": { "description": "The description of the VMs in a Source of type Vmware.", "$ref": "VmwareVmsDetails" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The timestamp when the source was last queried (if the result is from the cache)." }, "awsVms": { "description": "The description of the VMs in a Source of type AWS.", "$ref": "AwsVmsDetails" }, "azureVms": { "description": "The description of the VMs in a Source of type Azure.", "$ref": "AzureVmsDetails" } }, "id": "FetchInventoryResponse", "type": "object", "description": "Response message for fetchInventory." }, "Link": { "description": "Describes a URL link.", "properties": { "description": { "description": "Describes what the link offers.", "type": "string" }, "url": { "description": "The URL of the link.", "type": "string" } }, "id": "Link", "type": "object" }, "CutoverJob": { "id": "CutoverJob", "type": "object", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the cutover job was created (as an API call, not when it was actually created in the target)." }, "name": { "type": "string", "readOnly": true, "description": "Output only. The name of the cutover job." }, "progressPercent": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The current progress in percentage of the cutover job." }, "stateMessage": { "description": "Output only. A message providing possible extra details about the current state.", "readOnly": true, "type": "string" }, "stateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the state was last updated." }, "progress": { "type": "integer", "format": "int32", "readOnly": true, "deprecated": true, "description": "Output only. The current progress in percentage of the cutover job." }, "computeEngineVmDetails": { "description": "Output only. Details of the VM in Compute Engine. Deprecated: Use compute_engine_target_details instead.", "readOnly": true, "deprecated": true, "$ref": "TargetVMDetails" }, "state": { "enum": [ "STATE_UNSPECIFIED", "PENDING", "FAILED", "SUCCEEDED", "CANCELLED", "CANCELLING", "ACTIVE", "ADAPTING_OS" ], "description": "Output only. State of the cutover job.", "enumDescriptions": [ "The state is unknown. This is used for API compatibility only and is not used by the system.", "The cutover job has not yet started.", "The cutover job finished with errors.", "The cutover job finished successfully.", "The cutover job was cancelled.", "The cutover job is being cancelled.", "The cutover job is active and running.", "OS adaptation is running as part of the cutover job to generate license." ], "type": "string", "readOnly": true }, "computeEngineDisksTargetDetails": { "readOnly": true, "$ref": "ComputeEngineDisksTargetDetails", "description": "Output only. Details of the target Persistent Disks in Compute Engine." }, "steps": { "readOnly": true, "type": "array", "items": { "$ref": "CutoverStep" }, "description": "Output only. The cutover steps list representing its progress." }, "computeEngineTargetDetails": { "readOnly": true, "$ref": "ComputeEngineTargetDetails", "description": "Output only. Details of the target VM in Compute Engine." }, "targetDetails": { "readOnly": true, "deprecated": true, "$ref": "TargetVMDetails", "description": "Output only. Details of the VM to create as the target of this cutover job. Deprecated: Use compute_engine_target_details instead." }, "error": { "description": "Output only. Provides details for the errors that led to the Cutover Job's state.", "readOnly": true, "$ref": "Status" }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the cutover job had finished." } }, "description": "CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot." }, "DisksMigrationDisksTargetDetails": { "description": "Details for a disks-only migration.", "id": "DisksMigrationDisksTargetDetails", "type": "object", "properties": {} }, "DiskMigrationJobTargetDetails": { "description": "Details of the target disk in Compute Engine.", "properties": { "targetProject": { "description": "Required. The name of the resource of type TargetProject which represents the Compute Engine project in which to create the disk. Should be of the form: projects/{project}/locations/global/targetProjects/{target-project}", "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. A map of labels to associate with the disk." }, "targetDisk": { "description": "Required. The target disk.", "$ref": "ComputeEngineDisk" }, "encryption": { "description": "Optional. The encryption to apply to the disk. If the DiskMigrationJob parent Source resource has an encryption, this field must be set to the same encryption key.", "$ref": "Encryption" } }, "id": "DiskMigrationJobTargetDetails", "type": "object" }, "ListCutoverJobsResponse": { "description": "Response message for 'ListCutoverJobs' request.", "id": "ListCutoverJobsResponse", "type": "object", "properties": { "nextPageToken": { "readOnly": true, "type": "string", "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "cutoverJobs": { "readOnly": true, "type": "array", "items": { "$ref": "CutoverJob" }, "description": "Output only. The list of cutover jobs response." }, "unreachable": { "description": "Output only. Locations that could not be reached.", "type": "array", "items": { "type": "string" }, "readOnly": true } } }, "DiskImageTargetDetails": { "description": "The target details of the image resource that will be created by the import job.", "id": "DiskImageTargetDetails", "type": "object", "properties": { "description": { "type": "string", "description": "Optional. An optional description of the image." }, "familyName": { "type": "string", "description": "Optional. The name of the image family to which the new image belongs." }, "encryption": { "description": "Immutable. The encryption to apply to the image.", "$ref": "Encryption" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. A map of labels to associate with the image." }, "dataDiskImageImport": { "description": "Optional. Use to skip OS adaptation process.", "$ref": "DataDiskImageImport" }, "additionalLicenses": { "type": "array", "items": { "type": "string" }, "description": "Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME" }, "osAdaptationParameters": { "description": "Optional. Use to set the parameters relevant for the OS adaptation process.", "$ref": "ImageImportOsAdaptationParameters" }, "imageName": { "description": "Required. The name of the image to be created.", "type": "string" }, "targetProject": { "type": "string", "description": "Required. Reference to the TargetProject resource that represents the target project in which the imported image will be created." }, "singleRegionStorage": { "description": "Optional. Set to true to set the image storageLocations to the single region of the import job. When false, the closest multi-region is selected.", "type": "boolean" } } }, "MigrationWarning": { "properties": { "actionItem": { "readOnly": true, "$ref": "LocalizedMessage", "description": "Output only. Suggested action for solving the warning." }, "code": { "type": "string", "description": "The warning code.", "enumDescriptions": [ "Default value. This value is not used.", "A warning originated from OS Adaptation." ], "enum": [ "WARNING_CODE_UNSPECIFIED", "ADAPTATION_WARNING" ] }, "helpLinks": { "description": "Output only. URL(s) pointing to additional information on handling the current warning.", "type": "array", "items": { "$ref": "Link" }, "readOnly": true }, "warningTime": { "type": "string", "format": "google-datetime", "description": "The time the warning occurred." }, "warningMessage": { "readOnly": true, "$ref": "LocalizedMessage", "description": "Output only. The localized warning message." } }, "id": "MigrationWarning", "type": "object", "description": "Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations." }, "ListDiskMigrationJobsResponse": { "properties": { "unreachable": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Output only. Locations that could not be reached." }, "nextPageToken": { "type": "string", "readOnly": true, "description": "Optional. Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "diskMigrationJobs": { "type": "array", "items": { "$ref": "DiskMigrationJob" }, "readOnly": true, "description": "Output only. The list of the disk migration jobs." } }, "id": "ListDiskMigrationJobsResponse", "type": "object", "description": "Response message for 'ListDiskMigrationJobs' request." }, "ImageImport": { "properties": { "cloudStorageUri": { "description": "Immutable. The path to the Cloud Storage file from which the image should be imported.", "type": "string" }, "diskImageTargetDefaults": { "description": "Immutable. Target details for importing a disk image, will be used by ImageImportJob.", "$ref": "DiskImageTargetDetails" }, "recentImageImportJobs": { "description": "Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs.", "type": "array", "items": { "$ref": "ImageImportJob" }, "readOnly": true }, "machineImageTargetDefaults": { "description": "Immutable. Target details for importing a machine image, will be used by ImageImportJob.", "$ref": "MachineImageTargetDetails" }, "createTime": { "description": "Output only. The time the image import was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "encryption": { "description": "Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine.", "$ref": "Encryption" }, "name": { "description": "Output only. The resource path of the ImageImport.", "type": "string", "readOnly": true } }, "id": "ImageImport", "type": "object", "description": "ImageImport describes the configuration of the image import to run." }, "OperationMetadata": { "properties": { "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "verb": { "type": "string", "readOnly": true, "description": "Output only. Name of the verb executed by the operation." }, "statusMessage": { "type": "string", "readOnly": true, "description": "Output only. Human-readable status of the operation, if any." }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean", "readOnly": true }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true } }, "id": "OperationMetadata", "type": "object", "description": "Represents the metadata of the long-running operation." }, "ComputeScheduling": { "description": "Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. Options for instance behavior when the host machine undergoes maintenance that may temporarily impact instance performance.", "id": "ComputeScheduling", "type": "object", "properties": { "minNodeCpus": { "description": "The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.", "type": "integer", "format": "int32" }, "restartType": { "description": "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.", "enumDescriptions": [ "Unspecified behavior. This will use the default.", "The Instance should be automatically restarted whenever it is terminated by Compute Engine.", "The Instance isn't automatically restarted whenever it is terminated by Compute Engine." ], "enum": [ "RESTART_TYPE_UNSPECIFIED", "AUTOMATIC_RESTART", "NO_AUTOMATIC_RESTART" ], "type": "string" }, "automaticRestart": { "deprecated": true, "type": "boolean" }, "nodeAffinities": { "type": "array", "items": { "$ref": "SchedulingNodeAffinity" }, "description": "A set of node affinity and anti-affinity configurations for sole tenant nodes." }, "onHostMaintenance": { "type": "string", "enum": [ "ON_HOST_MAINTENANCE_UNSPECIFIED", "TERMINATE", "MIGRATE" ], "description": "How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.", "enumDescriptions": [ "An unknown, unexpected behavior.", "Terminate the instance when the host machine undergoes maintenance.", "Migrate the instance when the host machine undergoes maintenance." ] } } }, "ListMigratingVmsResponse": { "description": "Response message for 'ListMigratingVms' request.", "id": "ListMigratingVmsResponse", "type": "object", "properties": { "migratingVms": { "description": "Output only. The list of Migrating VMs response.", "readOnly": true, "type": "array", "items": { "$ref": "MigratingVm" } }, "nextPageToken": { "readOnly": true, "type": "string", "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "unreachable": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. Locations that could not be reached." } } }, "ImageImportOsAdaptationParameters": { "id": "ImageImportOsAdaptationParameters", "type": "object", "properties": { "adaptationModifiers": { "description": "Optional. Modifiers to be used as configuration of the OS adaptation process.", "type": "array", "items": { "$ref": "AdaptationModifier" } }, "licenseType": { "enum": [ "COMPUTE_ENGINE_LICENSE_TYPE_DEFAULT", "COMPUTE_ENGINE_LICENSE_TYPE_PAYG", "COMPUTE_ENGINE_LICENSE_TYPE_BYOL" ], "description": "Optional. Choose which type of license to apply to the imported image.", "enumDescriptions": [ "The license type is the default for the OS.", "The license type is Pay As You Go license type.", "The license type is Bring Your Own License type." ], "type": "string" }, "generalize": { "type": "boolean", "description": "Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID)." }, "bootConversion": { "description": "Optional. By default the image will keep its existing boot option. Setting this property will trigger an internal process which will convert the image from using the existing boot option to another. The size of the boot disk might be increased to allow the conversion", "enumDescriptions": [ "Unspecified conversion type.", "No conversion.", "Convert from BIOS to EFI." ], "enum": [ "BOOT_CONVERSION_UNSPECIFIED", "NONE", "BIOS_TO_EFI" ], "type": "string" } }, "description": "Parameters affecting the OS adaptation process." }, "ComputeEngineDisksTargetDetails": { "properties": { "vmTargetDetails": { "description": "Details for the VM the migrated data disks are attached to.", "$ref": "DisksMigrationVmTargetDetails" }, "disks": { "description": "The details of each created Persistent Disk.", "type": "array", "items": { "$ref": "PersistentDisk" } }, "disksTargetDetails": { "description": "Details of the disks-only migration target.", "$ref": "DisksMigrationDisksTargetDetails" } }, "id": "ComputeEngineDisksTargetDetails", "type": "object", "description": "ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details." }, "ImageImportJob": { "properties": { "cloudStorageUri": { "readOnly": true, "type": "string", "description": "Output only. The path to the Cloud Storage file from which the image should be imported." }, "name": { "readOnly": true, "type": "string", "description": "Output only. The resource path of the ImageImportJob." }, "errors": { "description": "Output only. Provides details on the error that led to the image import state in case of an error.", "readOnly": true, "type": "array", "items": { "$ref": "Status" } }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the image import was created (as an API call, not when it was actually created in the target)." }, "diskImageTargetDetails": { "description": "Output only. Target details used to import a disk image.", "readOnly": true, "$ref": "DiskImageTargetDetails" }, "createdResources": { "description": "Output only. The resource paths of the resources created by the image import job.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "steps": { "description": "Output only. The image import steps list representing its progress.", "type": "array", "items": { "$ref": "ImageImportStep" }, "readOnly": true }, "state": { "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED" ], "description": "Output only. The state of the image import.", "enumDescriptions": [ "The state is unknown.", "The image import has not yet started.", "The image import is active and running.", "The image import has finished successfully.", "The image import has finished with errors.", "The image import is being cancelled.", "The image import was cancelled." ], "type": "string", "readOnly": true }, "warnings": { "readOnly": true, "type": "array", "items": { "$ref": "MigrationWarning" }, "description": "Output only. Warnings that occurred during the image import." }, "endTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the image import was ended." }, "machineImageTargetDetails": { "description": "Output only. Target details used to import a machine image.", "readOnly": true, "$ref": "MachineImageTargetDetails" } }, "id": "ImageImportJob", "type": "object", "description": "ImageImportJob describes the progress and result of an image import." }, "Source": { "description": "Source message describes a specific vm migration Source resource. It contains the source environment information.", "id": "Source", "type": "object", "properties": { "azure": { "description": "Azure type source details.", "$ref": "AzureSourceDetails" }, "aws": { "description": "AWS type source details.", "$ref": "AwsSourceDetails" }, "name": { "description": "Output only. The Source name.", "readOnly": true, "type": "string" }, "description": { "type": "string", "description": "User-provided description of the source." }, "encryption": { "description": "Optional. Immutable. The encryption details of the source data stored by the service.", "$ref": "Encryption" }, "createTime": { "description": "Output only. The create time timestamp.", "type": "string", "format": "google-datetime", "readOnly": true }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The labels of the source." }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The update time timestamp." }, "error": { "readOnly": true, "deprecated": true, "$ref": "Status", "description": "Output only. Provides details on the state of the Source in case of an error." }, "vmware": { "description": "Vmware type source details.", "$ref": "VmwareSourceDetails" } } }, "InstantiatingMigratedVMStep": { "properties": {}, "id": "InstantiatingMigratedVMStep", "type": "object", "description": "InstantiatingMigratedVMStep contains specific step details." }, "Expiration": { "description": "Expiration holds information about the expiration of a MigratingVm.", "properties": { "extensionCount": { "description": "Output only. The number of times expiration was extended.", "type": "integer", "format": "int32", "readOnly": true }, "extendable": { "readOnly": true, "type": "boolean", "description": "Output only. Describes whether the expiration can be extended." }, "expireTime": { "description": "Output only. Timestamp of when this resource is considered expired.", "type": "string", "format": "google-datetime", "readOnly": true } }, "id": "Expiration", "type": "object" }, "UtilizationReport": { "description": "Utilization report details the utilization (CPU, memory, etc.) of selected source VMs.", "id": "UtilizationReport", "type": "object", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed)." }, "frameEndTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the \"frame_end_time\" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14." }, "vmsCount": { "description": "Output only. Total number of VMs included in the report.", "type": "integer", "format": "int32", "readOnly": true, "deprecated": true }, "name": { "description": "Output only. The report unique name.", "type": "string", "readOnly": true }, "vms": { "description": "List of utilization information per VM. When sent as part of the request, the \"vm_id\" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.", "type": "array", "items": { "$ref": "VmUtilizationInfo" } }, "stateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the state was last set." }, "vmCount": { "description": "Output only. Total number of VMs included in the report.", "readOnly": true, "type": "integer", "format": "int32" }, "displayName": { "description": "The report display name, as assigned by the user.", "type": "string" }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "SUCCEEDED", "FAILED" ], "description": "Output only. Current state of the report.", "enumDescriptions": [ "The state is unknown. This value is not in use.", "The report is in the making.", "Report creation completed successfully.", "Report creation failed." ], "type": "string", "readOnly": true }, "error": { "description": "Output only. Provides details on the state of the report in case of an error.", "readOnly": true, "$ref": "Status" }, "timeFrame": { "type": "string", "description": "Time frame of the report.", "enumDescriptions": [ "The time frame was not specified and will default to WEEK.", "One week.", "One month.", "One year." ], "enum": [ "TIME_FRAME_UNSPECIFIED", "WEEK", "MONTH", "YEAR" ] } } }, "ListDatacenterConnectorsResponse": { "description": "Response message for 'ListDatacenterConnectors' request.", "id": "ListDatacenterConnectorsResponse", "type": "object", "properties": { "nextPageToken": { "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "readOnly": true, "type": "string" }, "datacenterConnectors": { "type": "array", "items": { "$ref": "DatacenterConnector" }, "readOnly": true, "description": "Output only. The list of sources response." }, "unreachable": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Output only. Locations that could not be reached." } } }, "CutoverStep": { "description": "CutoverStep holds information about the cutover step progress.", "properties": { "finalSync": { "description": "Final sync step.", "$ref": "ReplicationCycle" }, "shuttingDownSourceVm": { "description": "Shutting down VM step.", "$ref": "ShuttingDownSourceVMStep" }, "startTime": { "type": "string", "format": "google-datetime", "description": "The time the step has started." }, "instantiatingMigratedVm": { "description": "Instantiating migrated VM step.", "$ref": "InstantiatingMigratedVMStep" }, "previousReplicationCycle": { "description": "A replication cycle prior cutover step.", "$ref": "ReplicationCycle" }, "preparingVmDisks": { "description": "Preparing VM disks step.", "$ref": "PreparingVMDisksStep" }, "endTime": { "description": "The time the step has ended.", "type": "string", "format": "google-datetime" } }, "id": "CutoverStep", "type": "object" }, "Operation": { "properties": { "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any." } }, "id": "Operation", "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call." }, "VmwareVmsDetails": { "description": "VmwareVmsDetails describes VMs in vCenter.", "properties": { "details": { "type": "array", "items": { "$ref": "VmwareVmDetails" }, "description": "The details of the vmware VMs." } }, "id": "VmwareVmsDetails", "type": "object" }, "LoadingImageSourceFilesStep": { "id": "LoadingImageSourceFilesStep", "type": "object", "properties": {}, "description": "LoadingImageSourceFilesStep contains specific step details." }, "OSDisk": { "description": "A message describing the OS disk.", "id": "OSDisk", "type": "object", "properties": { "type": { "type": "string", "description": "The disk's type." }, "name": { "description": "The disk's full name.", "type": "string" }, "sizeGb": { "description": "The disk's size in GB.", "type": "integer", "format": "int32" } } }, "Encryption": { "description": "Encryption message describes the details of the applied encryption.", "properties": { "kmsKey": { "type": "string", "description": "Required. The name of the encryption key that is stored in Google Cloud KMS." } }, "id": "Encryption", "type": "object" }, "InitializingReplicationStep": { "description": "InitializingReplicationStep contains specific step details.", "properties": {}, "id": "InitializingReplicationStep", "type": "object" }, "ShuttingDownSourceVMStep": { "id": "ShuttingDownSourceVMStep", "type": "object", "properties": {}, "description": "ShuttingDownSourceVMStep contains specific step details." }, "RemoveGroupMigrationRequest": { "description": "Request message for 'RemoveMigration' request.", "properties": { "migratingVm": { "type": "string", "description": "The MigratingVm to remove." } }, "id": "RemoveGroupMigrationRequest", "type": "object" }, "DisksMigrationVmTargetDetails": { "properties": { "vmUri": { "readOnly": true, "type": "string", "description": "Output only. The URI of the Compute Engine VM." } }, "id": "DisksMigrationVmTargetDetails", "type": "object", "description": "Details for the VM created VM as part of disks migration." }, "FetchStorageInventoryResponse": { "id": "FetchStorageInventoryResponse", "type": "object", "properties": { "resources": { "type": "array", "items": { "$ref": "SourceStorageResource" }, "description": "The list of storage resources in the source." }, "updateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The timestamp when the source was last queried (if the result is from the cache)." }, "nextPageToken": { "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "readOnly": true, "type": "string" } }, "description": "Response message for fetchStorageInventory." }, "ClientSecretCredentials": { "properties": { "tenantId": { "description": "Azure tenant ID.", "type": "string" }, "clientSecret": { "description": "Input only. Azure client secret.", "type": "string" }, "clientId": { "description": "Azure client ID.", "type": "string" } }, "id": "ClientSecretCredentials", "type": "object", "description": "Message describing Azure Credentials using tenant ID, client ID and secret." }, "NetworkInterface": { "description": "NetworkInterface represents a NIC of a VM.", "id": "NetworkInterface", "type": "object", "properties": { "network": { "type": "string", "description": "Optional. The network to connect the NIC to." }, "externalIp": { "type": "string", "description": "Optional. The external IP to define in the NIC." }, "internalIp": { "type": "string", "description": "Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \\ ipv4 address \\ a named address resource full path." }, "subnetwork": { "type": "string", "description": "Optional. The subnetwork to connect the NIC to." }, "networkTier": { "enum": [ "COMPUTE_ENGINE_NETWORK_TIER_UNSPECIFIED", "NETWORK_TIER_STANDARD", "NETWORK_TIER_PREMIUM" ], "description": "Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM.", "enumDescriptions": [ "An unspecified network tier. Will be used as PREMIUM.", "A standard network tier.", "A premium network tier." ], "type": "string" } } }, "MigratingVm": { "id": "MigratingVm", "type": "object", "properties": { "sourceVmId": { "description": "The unique ID of the VM in the source. The VM's name in vSphere can be changed, so this is not the VM's name but rather its moRef id. This id is of the form vm-.", "type": "string" }, "updateTime": { "description": "Output only. The last time the migrating VM resource was updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "error": { "readOnly": true, "$ref": "Status", "description": "Output only. Provides details on the state of the Migrating VM in case of an error in replication." }, "computeEngineTargetDefaults": { "description": "Details of the target VM in Compute Engine.", "$ref": "ComputeEngineTargetDefaults" }, "awsSourceVmDetails": { "readOnly": true, "$ref": "AwsSourceVmDetails", "description": "Output only. Details of the VM from an AWS source." }, "lastReplicationCycle": { "readOnly": true, "$ref": "ReplicationCycle", "description": "Output only. Details of the last replication cycle. This will be updated whenever a replication cycle is finished and is not to be confused with last_sync which is only updated on successful replication cycles." }, "policy": { "description": "The replication schedule policy.", "$ref": "SchedulePolicy" }, "expiration": { "description": "Output only. Provides details about the expiration state of the migrating VM.", "readOnly": true, "$ref": "Expiration" }, "cutoverForecast": { "readOnly": true, "$ref": "CutoverForecast", "description": "Output only. Provides details of future CutoverJobs of a MigratingVm. Set to empty when cutover forecast is unavailable." }, "targetDefaults": { "description": "The default configuration of the target VM that will be created in Google Cloud as a result of the migration. Deprecated: Use compute_engine_target_defaults instead.", "deprecated": true, "$ref": "TargetVMDetails" }, "stateTime": { "description": "Output only. The last time the migrating VM state was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "recentCutoverJobs": { "description": "Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the \"view\" parameter of the Get/List request.", "type": "array", "items": { "$ref": "CutoverJob" }, "readOnly": true }, "azureSourceVmDetails": { "description": "Output only. Details of the VM from an Azure source.", "readOnly": true, "$ref": "AzureSourceVmDetails" }, "description": { "type": "string", "description": "The description attached to the migrating VM by the user." }, "currentSyncInfo": { "description": "Output only. Details of the current running replication cycle.", "readOnly": true, "$ref": "ReplicationCycle" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The labels of the migrating VM." }, "lastSync": { "readOnly": true, "$ref": "ReplicationSync", "description": "Output only. The most updated snapshot created time in the source that finished replication." }, "computeEngineVmDefaults": { "description": "Details of the VM in Compute Engine. Deprecated: Use compute_engine_target_defaults instead.", "deprecated": true, "$ref": "TargetVMDetails" }, "recentCloneJobs": { "type": "array", "items": { "$ref": "CloneJob" }, "readOnly": true, "description": "Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the \"view\" parameter of the Get/List request." }, "vmwareSourceVmDetails": { "readOnly": true, "$ref": "VmwareSourceVmDetails", "description": "Output only. Details of the VM from a Vmware source." }, "computeEngineDisksTargetDefaults": { "description": "Details of the target Persistent Disks in Compute Engine.", "$ref": "ComputeEngineDisksTargetDefaults" }, "state": { "readOnly": true, "type": "string", "description": "Output only. State of the MigratingVm.", "enumDescriptions": [ "The state was not sampled by the health checks yet.", "The VM in the source is being verified.", "The source VM was verified, and it's ready to start replication.", "Migration is going through the first sync cycle.", "The replication is active, and it's running or scheduled to run.", "The source VM is being turned off, and a final replication is currently running.", "The source VM was stopped and replicated. The replication is currently paused.", "A cutover job is active and replication cycle is running the final sync.", "The replication was paused by the user and no cycles are scheduled to run.", "The migrating VM is being finalized and migration resources are being removed.", "The replication process is done. The migrating VM is finalized and no longer consumes billable resources.", "The replication process encountered an unrecoverable error and was aborted.", "The migrating VM has passed its expiration date. It might be possible to bring it back to \"Active\" state by updating the TTL field. For more information, see the documentation.", "The migrating VM's has been finalized and migration resources have been removed." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "READY", "FIRST_SYNC", "ACTIVE", "CUTTING_OVER", "CUTOVER", "FINAL_SYNC", "PAUSED", "FINALIZING", "FINALIZED", "ERROR", "EXPIRED", "FINALIZED_EXPIRED" ] }, "displayName": { "description": "The display name attached to the MigratingVm by the user.", "type": "string" }, "group": { "readOnly": true, "type": "string", "description": "Output only. The group this migrating vm is included in, if any. The group is represented by the full path of the appropriate Group resource." }, "name": { "type": "string", "readOnly": true, "description": "Output only. The identifier of the MigratingVm." }, "createTime": { "description": "Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source).", "type": "string", "format": "google-datetime", "readOnly": true } }, "description": "MigratingVm describes the VM that will be migrated from a Source environment and its replication state." }, "RunDiskMigrationJobRequest": { "id": "RunDiskMigrationJobRequest", "type": "object", "properties": {}, "description": "Request message for 'RunDiskMigrationJobRequest' request." }, "TargetVMDetails": { "description": "TargetVMDetails is a collection of details for creating a VM in a target Compute Engine project.", "properties": { "labels": { "description": "A map of labels to associate with the VM.", "type": "object", "additionalProperties": { "type": "string" } }, "project": { "type": "string", "readOnly": true, "deprecated": true, "description": "Output only. The project in which to create the VM." }, "networkTags": { "type": "array", "items": { "type": "string" }, "description": "A list of network tags to associate with the VM." }, "name": { "description": "The name of the VM to create.", "type": "string" }, "network": { "type": "string", "description": "The network to connect the VM to." }, "zone": { "type": "string", "description": "The zone in which to create the VM." }, "computeScheduling": { "description": "Compute instance scheduling information (if empty default is used).", "$ref": "ComputeScheduling" }, "metadata": { "description": "The metadata key/value pairs to assign to the VM.", "type": "object", "additionalProperties": { "type": "string" } }, "diskType": { "description": "The disk type to use in the VM.", "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "An alternative to SSD persistent disks that balance performance and cost.", "SSD hard disk type.", "Hyperdisk balanced disk type.", "Hyperdisk balanced high availability disk type." ], "enum": [ "DISK_TYPE_UNSPECIFIED", "STANDARD", "BALANCED", "SSD", "HYPERDISK_BALANCED", "HYPERDISK_BALANCED_HIGH_AVAILABILITY" ], "type": "string" }, "internalIp": { "description": "The internal IP to define in the VM. The formats accepted are: `ephemeral` \\ ipv4 address \\ a named address resource full path.", "type": "string" }, "licenseType": { "type": "string", "description": "The license type to use in OS adaptation.", "enumDescriptions": [ "The license type is the default for the OS.", "The license type is Pay As You Go license type.", "The license type is Bring Your Own License type." ], "enum": [ "DEFAULT", "PAYG", "BYOL" ] }, "subnetwork": { "description": "The subnetwork to connect the VM to.", "type": "string" }, "machineType": { "description": "The machine type to create the VM with.", "type": "string" }, "machineTypeSeries": { "type": "string", "description": "The machine type series to create the VM with." }, "bootOption": { "type": "string", "readOnly": true, "enum": [ "BOOT_OPTION_UNSPECIFIED", "EFI", "BIOS" ], "description": "Output only. The VM Boot Option, as set in the source VM.", "enumDescriptions": [ "The boot option is unknown.", "The boot option is EFI.", "The boot option is BIOS." ] }, "externalIp": { "type": "string", "description": "The external IP to define in the VM." }, "appliedLicense": { "readOnly": true, "$ref": "AppliedLicense", "description": "Output only. The OS license returned from the adaptation module report." }, "serviceAccount": { "description": "The service account to associate the VM with.", "type": "string" }, "secureBoot": { "description": "Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.", "type": "boolean" }, "targetProject": { "description": "The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.", "type": "string" }, "networkInterfaces": { "description": "List of NICs connected to this VM.", "type": "array", "items": { "$ref": "NetworkInterface" } } }, "deprecated": true, "id": "TargetVMDetails", "type": "object" }, "ListImageImportJobsResponse": { "properties": { "unreachable": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Output only. Locations that could not be reached." }, "imageImportJobs": { "description": "Output only. The list of target response.", "readOnly": true, "type": "array", "items": { "$ref": "ImageImportJob" } }, "nextPageToken": { "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string", "readOnly": true } }, "id": "ListImageImportJobsResponse", "type": "object", "description": "Response message for 'ListImageImportJobs' call." }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations." } } }, "ReplicationCycle": { "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "RUNNING", "PAUSED", "FAILED", "SUCCEEDED" ], "description": "State of the ReplicationCycle.", "enumDescriptions": [ "The state is unknown. This is used for API compatibility only and is not used by the system.", "The replication cycle is running.", "The replication cycle is paused.", "The replication cycle finished with errors.", "The replication cycle finished successfully." ], "type": "string" }, "error": { "readOnly": true, "$ref": "Status", "description": "Output only. Provides details on the state of the cycle in case of an error." }, "warnings": { "readOnly": true, "type": "array", "items": { "$ref": "MigrationWarning" }, "description": "Output only. Warnings that occurred during the cycle." }, "endTime": { "type": "string", "format": "google-datetime", "description": "The time the replication cycle has ended." }, "cycleNumber": { "description": "The cycle's ordinal number.", "type": "integer", "format": "int32" }, "steps": { "description": "The cycle's steps list representing its progress.", "type": "array", "items": { "$ref": "CycleStep" } }, "name": { "description": "The identifier of the ReplicationCycle.", "type": "string" }, "startTime": { "description": "The time the replication cycle has started.", "type": "string", "format": "google-datetime" }, "progress": { "description": "The current progress in percentage of this cycle.", "deprecated": true, "type": "integer", "format": "int32" }, "totalPauseDuration": { "type": "string", "format": "google-duration", "description": "The accumulated duration the replication cycle was paused." }, "progressPercent": { "description": "The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately.", "type": "integer", "format": "int32", "deprecated": true } }, "id": "ReplicationCycle", "type": "object", "description": "ReplicationCycle contains information about the current replication cycle status." }, "PersistentDisk": { "properties": { "sourceDiskNumber": { "description": "Output only. The ordinal number of the source VM disk.", "type": "integer", "format": "int32", "readOnly": true }, "diskUri": { "description": "Output only. The URI of the Persistent Disk.", "readOnly": true, "type": "string" } }, "id": "PersistentDisk", "type": "object", "description": "Details of a created Persistent Disk." }, "MachineImageParametersOverrides": { "description": "Parameters overriding decisions based on the source machine image configurations.", "id": "MachineImageParametersOverrides", "type": "object", "properties": { "machineType": { "description": "Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource.", "type": "string" } } }, "TargetProject": { "properties": { "project": { "type": "string", "description": "Required. The target project ID (number) or project name." }, "description": { "type": "string", "description": "The target project's description." }, "name": { "description": "Output only. The name of the target project.", "type": "string", "readOnly": true }, "updateTime": { "description": "Output only. The last time the target project resource was updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "description": "Output only. The time this target project resource was created (not related to when the Compute Engine project it points to was created).", "type": "string", "format": "google-datetime", "readOnly": true } }, "id": "TargetProject", "type": "object", "description": "TargetProject message represents a target Compute Engine project for a migration or a clone." }, "ComputeEngineTargetDetails": { "description": "ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project.", "id": "ComputeEngineTargetDetails", "type": "object", "properties": { "appliedLicense": { "description": "The OS license returned from the adaptation module report.", "$ref": "AppliedLicense" }, "secureBoot": { "description": "Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI.", "type": "boolean" }, "networkInterfaces": { "description": "List of NICs connected to this VM.", "type": "array", "items": { "$ref": "NetworkInterface" } }, "enableVtpm": { "description": "Optional. Defines whether the instance has vTPM enabled.", "type": "boolean" }, "machineType": { "type": "string", "description": "The machine type to create the VM with." }, "adaptationModifiers": { "description": "Optional. Modifiers to be used as configuration of the OS adaptation process.", "type": "array", "items": { "$ref": "AdaptationModifier" } }, "vmName": { "description": "The name of the VM to create.", "type": "string" }, "machineTypeSeries": { "description": "The machine type series to create the VM with.", "type": "string" }, "hostname": { "type": "string", "description": "The hostname to assign to the VM." }, "zone": { "description": "The zone in which to create the VM.", "type": "string" }, "storagePool": { "description": "Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: \"projects/my-project/zones/us-central1-a/storagePools/my-storage-pool\". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type.", "type": "string" }, "labels": { "description": "A map of labels to associate with the VM.", "type": "object", "additionalProperties": { "type": "string" } }, "networkTags": { "description": "A list of network tags to associate with the VM.", "type": "array", "items": { "type": "string" } }, "serviceAccount": { "description": "The service account to associate the VM with.", "type": "string" }, "diskReplicaZones": { "type": "array", "items": { "type": "string" }, "description": "Optional. Additional replica zones of the target regional disks. If this list is not empty a regional disk will be created. The first supported zone would be the one stated in the zone field. The rest are taken from this list. Please refer to the [regional disk creation API](https://cloud.google.com/compute/docs/regions-zones/global-regional-zonal-resources) for further details about regional vs zonal disks. If not specified, a zonal disk will be created in the same zone the VM is created." }, "licenseType": { "type": "string", "enum": [ "COMPUTE_ENGINE_LICENSE_TYPE_DEFAULT", "COMPUTE_ENGINE_LICENSE_TYPE_PAYG", "COMPUTE_ENGINE_LICENSE_TYPE_BYOL" ], "description": "The license type to use in OS adaptation.", "enumDescriptions": [ "The license type is the default for the OS.", "The license type is Pay As You Go license type.", "The license type is Bring Your Own License type." ] }, "encryption": { "description": "Optional. The encryption to apply to the VM disks.", "$ref": "Encryption" }, "additionalLicenses": { "description": "Additional licenses to assign to the VM.", "type": "array", "items": { "type": "string" } }, "bootOption": { "type": "string", "description": "The VM Boot Option, as set in the source VM.", "enumDescriptions": [ "The boot option is unknown.", "The boot option is EFI.", "The boot option is BIOS." ], "enum": [ "COMPUTE_ENGINE_BOOT_OPTION_UNSPECIFIED", "COMPUTE_ENGINE_BOOT_OPTION_EFI", "COMPUTE_ENGINE_BOOT_OPTION_BIOS" ] }, "bootConversion": { "description": "Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another.", "enumDescriptions": [ "Unspecified conversion type.", "No conversion.", "Convert from BIOS to EFI." ], "enum": [ "BOOT_CONVERSION_UNSPECIFIED", "NONE", "BIOS_TO_EFI" ], "type": "string" }, "computeScheduling": { "description": "Compute instance scheduling information (if empty default is used).", "$ref": "ComputeScheduling" }, "metadata": { "description": "The metadata key/value pairs to assign to the VM.", "type": "object", "additionalProperties": { "type": "string" } }, "diskType": { "enum": [ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", "COMPUTE_ENGINE_DISK_TYPE_BALANCED", "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED", "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED_HIGH_AVAILABILITY" ], "description": "The disk type to use in the VM.", "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", "An alternative to SSD persistent disks that balance performance and cost.", "Hyperdisk balanced disk type.", "Hyperdisk balanced high availability disk type." ], "type": "string" }, "enableIntegrityMonitoring": { "type": "boolean", "description": "Optional. Defines whether the instance has integrity monitoring enabled." }, "project": { "description": "The Google Cloud target project ID or project name.", "type": "string" } } }, "CancelCloneJobRequest": { "description": "Request message for 'CancelCloneJob' request.", "id": "CancelCloneJobRequest", "type": "object", "properties": {} }, "AzureSourceDetails": { "description": "AzureSourceDetails message describes a specific source details for the Azure source type.", "properties": { "migrationResourcesUserTags": { "description": "User specified tags to add to every M2VM generated resource in Azure. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m4ce` or `m2vm`.", "type": "object", "additionalProperties": { "type": "string" } }, "subscriptionId": { "type": "string", "description": "Immutable. Azure subscription ID." }, "azureLocation": { "description": "Immutable. The Azure location (region) that the source VMs will be migrated from.", "type": "string" }, "clientSecretCreds": { "description": "Azure Credentials using tenant ID, client ID and secret.", "$ref": "ClientSecretCredentials" }, "state": { "readOnly": true, "type": "string", "description": "Output only. State of the source as determined by the health check.", "enumDescriptions": [ "The state is unknown. This is used for API compatibility only and is not used by the system.", "The state was not sampled by the health checks yet.", "The source is available but might not be usable yet due to invalid credentials or another reason. The error message will contain further details.", "The source exists and its credentials were verified." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "FAILED", "ACTIVE" ] }, "error": { "readOnly": true, "$ref": "Status", "description": "Output only. Provides details on the state of the Source in case of an error." }, "resourceGroupId": { "readOnly": true, "type": "string", "description": "Output only. The ID of the Azure resource group that contains all resources related to the migration process of this source." } }, "id": "AzureSourceDetails", "type": "object" }, "ReplicationSync": { "description": "ReplicationSync contain information about the last replica sync to the cloud.", "properties": { "lastSyncTime": { "type": "string", "format": "google-datetime", "description": "The most updated snapshot created time in the source that finished replication." } }, "id": "ReplicationSync", "type": "object" }, "VmUtilizationInfo": { "id": "VmUtilizationInfo", "type": "object", "properties": { "vmwareVmDetails": { "description": "The description of the VM in a Source of type Vmware.", "$ref": "VmwareVmDetails" }, "vmId": { "description": "The VM's ID in the source.", "type": "string" }, "utilization": { "description": "Utilization metrics for this VM.", "$ref": "VmUtilizationMetrics" } }, "description": "Utilization information of a single VM." }, "AzureVmDetails": { "description": "AzureVmDetails describes a VM in Azure.", "id": "AzureVmDetails", "type": "object", "properties": { "committedStorageMb": { "description": "The total size of the storage allocated to the VM in MB.", "type": "string", "format": "int64" }, "vmId": { "description": "The VM full path in Azure.", "type": "string" }, "osDisk": { "description": "Description of the OS disk.", "$ref": "OSDisk" }, "cpuCount": { "description": "The number of cpus the VM has.", "type": "integer", "format": "int32" }, "computerName": { "description": "The VM's ComputerName.", "type": "string" }, "powerState": { "type": "string", "enum": [ "POWER_STATE_UNSPECIFIED", "STARTING", "RUNNING", "STOPPING", "STOPPED", "DEALLOCATING", "DEALLOCATED", "UNKNOWN" ], "description": "The power state of the VM at the moment list was taken.", "enumDescriptions": [ "Power state is not specified.", "The VM is starting.", "The VM is running.", "The VM is stopping.", "The VM is stopped.", "The VM is deallocating.", "The VM is deallocated.", "The VM's power state is unknown." ] }, "diskCount": { "type": "integer", "format": "int32", "description": "The number of disks the VM has, including OS disk." }, "memoryMb": { "type": "integer", "format": "int32", "description": "The memory size of the VM in MB." }, "osDescription": { "description": "Description of the OS.", "$ref": "OSDescription" }, "bootOption": { "description": "The VM Boot Option.", "enumDescriptions": [ "The boot option is unknown.", "The boot option is UEFI.", "The boot option is BIOS." ], "enum": [ "BOOT_OPTION_UNSPECIFIED", "EFI", "BIOS" ], "type": "string" }, "disks": { "description": "Description of the data disks.", "type": "array", "items": { "$ref": "Disk" } }, "tags": { "description": "The tags of the VM.", "type": "object", "additionalProperties": { "type": "string" } }, "architecture": { "type": "string", "enum": [ "VM_ARCHITECTURE_UNSPECIFIED", "VM_ARCHITECTURE_X86_FAMILY", "VM_ARCHITECTURE_ARM64" ], "description": "The CPU architecture.", "enumDescriptions": [ "The architecture is unknown.", "The architecture is one of the x86 architectures.", "The architecture is ARM64." ] }, "vmSize": { "type": "string", "description": "VM size as configured in Azure. Determines the VM's hardware spec." } } }, "AwsDiskDetails": { "description": "The details of an AWS instance disk.", "properties": { "volumeId": { "readOnly": true, "type": "string", "description": "Output only. AWS volume ID." }, "diskNumber": { "description": "Output only. The ordinal number of the disk.", "readOnly": true, "type": "integer", "format": "int32" }, "sizeGb": { "description": "Output only. Size in GB.", "type": "string", "format": "int64", "readOnly": true } }, "id": "AwsDiskDetails", "type": "object" }, "VmCapabilities": { "id": "VmCapabilities", "type": "object", "properties": { "lastOsCapabilitiesUpdateTime": { "description": "Output only. The last time OS capabilities list was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "osCapabilities": { "type": "array", "items": { "enum": [ "OS_CAPABILITY_UNSPECIFIED", "OS_CAPABILITY_NVME_STORAGE_ACCESS", "OS_CAPABILITY_GVNIC_NETWORK_INTERFACE", "OS_CAPABILITY_IDPF_NETWORK_INTERFACE" ], "enumDescriptions": [ "This is for API compatibility only and is not in use.", "NVMe driver installed and the VM can use NVMe PD or local SSD.", "gVNIC virtual NIC driver supported.", "IDPF virtual NIC driver supported." ], "type": "string" }, "readOnly": true, "description": "Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features." } }, "description": "Migrating VM source information about the VM capabilities needed for some Compute Engine features." }, "MachineImageTargetDetails": { "properties": { "osAdaptationParameters": { "description": "Optional. Use to set the parameters relevant for the OS adaptation process.", "$ref": "ImageImportOsAdaptationParameters" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. The labels to apply to the instance created by the machine image." }, "description": { "type": "string", "description": "Optional. An optional description of the machine image." }, "singleRegionStorage": { "type": "boolean", "description": "Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected." }, "machineImageParametersOverrides": { "description": "Optional. Parameters overriding decisions based on the source machine image configurations.", "$ref": "MachineImageParametersOverrides" }, "shieldedInstanceConfig": { "description": "Optional. Shielded instance configuration.", "$ref": "ShieldedInstanceConfig" }, "machineImageName": { "type": "string", "description": "Required. The name of the machine image to be created." }, "additionalLicenses": { "description": "Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME", "type": "array", "items": { "type": "string" } }, "encryption": { "description": "Immutable. The encryption to apply to the machine image. If the Image Import resource has an encryption, this field must be set to the same encryption key.", "$ref": "Encryption" }, "targetProject": { "type": "string", "description": "Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created." }, "networkInterfaces": { "type": "array", "items": { "$ref": "NetworkInterface" }, "description": "Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses, and network tiers are ignored for machine image import." }, "tags": { "description": "Optional. The tags to apply to the instance created by the machine image.", "type": "array", "items": { "type": "string" } }, "skipOsAdaptation": { "description": "Optional. Use to skip OS adaptation process.", "$ref": "SkipOsAdaptation" }, "serviceAccount": { "description": "Optional. The service account to assign to the instance created by the machine image.", "$ref": "ServiceAccount" } }, "id": "MachineImageTargetDetails", "type": "object", "description": "The target details of the machine image resource that will be created by the image import job." }, "FinalizeMigrationRequest": { "properties": {}, "id": "FinalizeMigrationRequest", "type": "object", "description": "Request message for 'FinalizeMigration' request." }, "ListUtilizationReportsResponse": { "description": "Response message for 'ListUtilizationReports' request.", "id": "ListUtilizationReportsResponse", "type": "object", "properties": { "unreachable": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. Locations that could not be reached." }, "nextPageToken": { "type": "string", "readOnly": true, "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "utilizationReports": { "description": "Output only. The list of reports.", "readOnly": true, "type": "array", "items": { "$ref": "UtilizationReport" } } } }, "Disk": { "description": "A message describing a data disk.", "id": "Disk", "type": "object", "properties": { "name": { "type": "string", "description": "The disk name." }, "sizeGb": { "description": "The disk size in GB.", "type": "integer", "format": "int32" }, "lun": { "description": "The disk's Logical Unit Number (LUN).", "type": "integer", "format": "int32" } } }, "CreatingImageStep": { "description": "CreatingImageStep contains specific step details.", "id": "CreatingImageStep", "type": "object", "properties": {} }, "SchedulePolicy": { "description": "A policy for scheduling replications.", "id": "SchedulePolicy", "type": "object", "properties": { "skipOsAdaptation": { "description": "A flag to indicate whether to skip OS adaptation during the replication sync. OS adaptation is a process where the VM's operating system undergoes changes and adaptations to fully function on Compute Engine.", "type": "boolean" }, "idleDuration": { "description": "The idle duration between replication stages.", "type": "string", "format": "google-duration" } } }, "StartMigrationRequest": { "description": "Request message for 'StartMigrationRequest' request.", "properties": {}, "id": "StartMigrationRequest", "type": "object" }, "AwsSourceVmDetails": { "properties": { "architecture": { "description": "Output only. The VM architecture.", "enumDescriptions": [ "The architecture is unknown.", "The architecture is one of the x86 architectures.", "The architecture is ARM64." ], "enum": [ "VM_ARCHITECTURE_UNSPECIFIED", "VM_ARCHITECTURE_X86_FAMILY", "VM_ARCHITECTURE_ARM64" ], "readOnly": true, "type": "string" }, "committedStorageBytes": { "description": "Output only. The total size of the disks being migrated in bytes.", "type": "string", "format": "int64", "readOnly": true }, "firmware": { "type": "string", "readOnly": true, "enum": [ "FIRMWARE_UNSPECIFIED", "EFI", "BIOS" ], "description": "Output only. The firmware type of the source VM.", "enumDescriptions": [ "The firmware is unknown.", "The firmware is EFI.", "The firmware is BIOS." ] }, "disks": { "description": "Output only. The disks attached to the source VM.", "type": "array", "items": { "$ref": "AwsDiskDetails" }, "readOnly": true }, "vmCapabilitiesInfo": { "readOnly": true, "$ref": "VmCapabilities", "description": "Output only. Information about VM capabilities needed for some Compute Engine features." } }, "id": "AwsSourceVmDetails", "type": "object", "description": "Represent the source AWS VM details." }, "Tag": { "id": "Tag", "type": "object", "properties": { "key": { "type": "string", "description": "Required. Key of tag." }, "value": { "description": "Required. Value of tag.", "type": "string" } }, "description": "Tag is an AWS tag representation." }, "ListTargetProjectsResponse": { "description": "Response message for 'ListTargetProjects' call.", "properties": { "nextPageToken": { "type": "string", "readOnly": true, "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "targetProjects": { "type": "array", "items": { "$ref": "TargetProject" }, "readOnly": true, "description": "Output only. The list of target response." }, "unreachable": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. Locations that could not be reached." } }, "id": "ListTargetProjectsResponse", "type": "object" }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "type": "object", "properties": {} }, "DiskMigrationJob": { "description": "Describes the disk which will be migrated from the source environment. The source disk has to be unattached.", "properties": { "awsSourceDiskDetails": { "description": "Details of the unattached AWS source disk.", "$ref": "AwsSourceDiskDetails" }, "steps": { "description": "Output only. The disk migration steps list representing its progress.", "type": "array", "items": { "$ref": "DiskMigrationStep" }, "readOnly": true }, "targetDetails": { "description": "Required. Details of the target Disk in Compute Engine.", "$ref": "DiskMigrationJobTargetDetails" }, "errors": { "readOnly": true, "type": "array", "items": { "$ref": "Status" }, "description": "Output only. Provides details on the errors that led to the disk migration job's state in case of an error." }, "name": { "readOnly": true, "type": "string", "description": "Output only. Identifier. The identifier of the DiskMigrationJob." }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The last time the DiskMigrationJob resource was updated." }, "state": { "enum": [ "STATE_UNSPECIFIED", "READY", "RUNNING", "SUCCEEDED", "CANCELLING", "CANCELLED", "FAILED" ], "description": "Output only. State of the DiskMigrationJob.", "enumDescriptions": [ "The state is unspecified. This is not in use.", "The initial state of the disk migration. In this state the customers can update the target details.", "The migration is active, and it's running or scheduled to run.", "The migration completed successfully.", "Migration cancellation was initiated.", "The migration was cancelled.", "The migration process encountered an unrecoverable error and was aborted." ], "type": "string", "readOnly": true }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the DiskMigrationJob resource was created." } }, "id": "DiskMigrationJob", "type": "object" }, "AvailableUpdates": { "properties": { "newDeployableAppliance": { "description": "The newest deployable version of the appliance. The current appliance can't be updated into this version, and the owner must manually deploy this OVA to a new appliance.", "$ref": "ApplianceVersion" }, "inPlaceUpdate": { "description": "The latest version for in place update. The current appliance can be updated to this version using the API or m4c CLI.", "$ref": "ApplianceVersion" } }, "id": "AvailableUpdates", "type": "object", "description": "Holds information about the available versions for upgrade." }, "ServiceAccount": { "description": "Service account to assign to the instance created by the machine image.", "id": "ServiceAccount", "type": "object", "properties": { "email": { "type": "string", "description": "Required. The email address of the service account." }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "Optional. The list of scopes to be made available for this service account." } } }, "AwsVmsDetails": { "description": "AWSVmsDetails describes VMs in AWS.", "id": "AwsVmsDetails", "type": "object", "properties": { "details": { "description": "The details of the AWS VMs.", "type": "array", "items": { "$ref": "AwsVmDetails" } } } }, "Group": { "description": "Describes message for 'Group' resource. The Group is a collections of several MigratingVms.", "id": "Group", "type": "object", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The create time timestamp." }, "migrationTargetType": { "type": "string", "enum": [ "MIGRATION_TARGET_TYPE_UNSPECIFIED", "MIGRATION_TARGET_TYPE_GCE", "MIGRATION_TARGET_TYPE_DISKS" ], "description": "Immutable. The target type of this group.", "enumDescriptions": [ "Group type is not specified. This defaults to Compute Engine targets.", "All MigratingVMs in the group must have Compute Engine targets.", "All MigratingVMs in the group must have Compute Engine Disks targets." ] }, "displayName": { "type": "string", "description": "Display name is a user defined name for this group which can be updated." }, "name": { "type": "string", "readOnly": true, "description": "Output only. The Group name." }, "updateTime": { "description": "Output only. The update time timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "description": { "type": "string", "description": "User-provided description of the group." } } }, "ListReplicationCyclesResponse": { "description": "Response message for 'ListReplicationCycles' request.", "id": "ListReplicationCyclesResponse", "type": "object", "properties": { "replicationCycles": { "description": "Output only. The list of replication cycles response.", "readOnly": true, "type": "array", "items": { "$ref": "ReplicationCycle" } }, "nextPageToken": { "type": "string", "readOnly": true, "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "unreachable": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. Locations that could not be reached." } } }, "DataDiskImageImport": { "properties": { "guestOsFeatures": { "description": "Optional. A list of guest OS features to apply to the imported image. These features are flags that are used by Compute Engine to enable certain capabilities for virtual machine instances that are created from the image. This field does not change the OS of the image; it only marks the image with the specified features. The user must ensure that the OS is compatible with the features. For a list of available features, see https://cloud.google.com/compute/docs/images/create-custom#guest-os-features.", "type": "array", "items": { "type": "string" } } }, "id": "DataDiskImageImport", "type": "object", "description": "Used when the image import is not using OS adaptation process." }, "ListSourcesResponse": { "id": "ListSourcesResponse", "type": "object", "properties": { "unreachable": { "description": "Output only. Locations that could not be reached.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "sources": { "description": "Output only. The list of sources response.", "type": "array", "items": { "$ref": "Source" }, "readOnly": true }, "nextPageToken": { "type": "string", "readOnly": true, "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "description": "Response message for 'ListSources' request." }, "ComputeEngineDisksTargetDefaults": { "properties": { "vmTargetDefaults": { "description": "Details of the VM migration target.", "$ref": "DisksMigrationVmTargetDefaults" }, "targetProject": { "description": "The full path of the resource of type TargetProject which represents the Compute Engine project in which to create the Persistent Disks.", "type": "string" }, "disksTargetDefaults": { "description": "Details of the disk only migration target.", "$ref": "DisksMigrationDisksTargetDefaults" }, "zone": { "type": "string", "description": "The zone in which to create the Persistent Disks." }, "disks": { "type": "array", "items": { "$ref": "PersistentDiskDefaults" }, "description": "The details of each Persistent Disk to create." } }, "id": "ComputeEngineDisksTargetDefaults", "type": "object", "description": "ComputeEngineDisksTargetDefaults is a collection of details for creating Persistent Disks in a target Compute Engine project." }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", "type": "object", "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location." }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" } } } }, "batchPath": "batch", "mtlsRootUrl": "https://vmmigration.mtls.googleapis.com/", "kind": "discovery#restDescription", "ownerName": "Google", "resources": { "projects": { "resources": { "locations": { "resources": { "sources": { "methods": { "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Sources in a given project and location.", "id": "vmmigration.projects.locations.sources.list", "httpMethod": "GET", "response": { "$ref": "ListSourcesResponse" }, "path": "v1alpha1/{+parent}/sources", "parameters": { "parent": { "description": "Required. The parent, which owns this collection of sources.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "Optional. The filter request." }, "orderBy": { "type": "string", "description": "Optional. the order by fields for the result.", "location": "query" }, "pageSize": { "description": "Optional. The maximum number of sources to return. The service may return fewer than this value. If unspecified, at most 500 sources will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "description": "Required. A page token, received from a previous `ListSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSources` must match the call that provided the page token.", "location": "query" } }, "parameterOrder": [ "parent" ] }, "delete": { "description": "Deletes a single Source.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "type": "string", "description": "Required. The Source name.", "location": "path" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.sources.delete", "httpMethod": "DELETE" }, "get": { "path": "v1alpha1/{+name}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "type": "string", "description": "Required. The Source name.", "location": "path" } }, "parameterOrder": [ "name" ], "id": "vmmigration.projects.locations.sources.get", "httpMethod": "GET", "response": { "$ref": "Source" }, "description": "Gets details of a single Source.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "fetchInventory": { "path": "v1alpha1/{+source}:fetchInventory", "parameters": { "source": { "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the Source.", "location": "path" }, "pageToken": { "type": "string", "location": "query", "description": "A page token, received from a previous `FetchInventory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchInventory` must match the call that provided the page token." }, "pageSize": { "location": "query", "description": "The maximum number of VMs to return. The service may return fewer than this value. For AWS source: If unspecified, at most 500 VMs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. For VMWare source: If unspecified, all VMs will be returned. There is no limit for maximum value.", "type": "integer", "format": "int32" }, "forceRefresh": { "type": "boolean", "description": "If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower.", "location": "query" } }, "parameterOrder": [ "source" ], "id": "vmmigration.projects.locations.sources.fetchInventory", "httpMethod": "GET", "response": { "$ref": "FetchInventoryResponse" }, "description": "List remote source's inventory of VMs. The remote source is the onprem vCenter (remote in the sense it's not in Compute Engine). The inventory describes the list of existing VMs in that source. Note that this operation lists the VMs on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}:fetchInventory", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "description": "Updates the parameters of a single Source.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "updateMask": { "location": "query", "description": "Field mask is used to specify the fields to be overwritten in the Source resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "type": "string", "format": "google-fieldmask" }, "requestId": { "type": "string", "location": "query", "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "location": "path", "description": "Output only. The Source name." } }, "parameterOrder": [ "name" ], "id": "vmmigration.projects.locations.sources.patch", "httpMethod": "PATCH", "request": { "$ref": "Source" }, "response": { "$ref": "Operation" } }, "fetchStorageInventory": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}:fetchStorageInventory", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List remote source's inventory of storage resources. The remote source is another cloud vendor (e.g. AWS, Azure). The inventory describes the list of existing storage resources in that source. Note that this operation lists the resources on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.", "id": "vmmigration.projects.locations.sources.fetchStorageInventory", "httpMethod": "GET", "response": { "$ref": "FetchStorageInventoryResponse" }, "path": "v1alpha1/{+source}:fetchStorageInventory", "parameters": { "pageToken": { "description": "Optional. A page token, received from a previous `FetchStorageInventory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchStorageInventory` must match the call that provided the page token.", "location": "query", "type": "string" }, "type": { "type": "string", "location": "query", "enum": [ "STORAGE_TYPE_UNSPECIFIED", "DISKS", "SNAPSHOTS" ], "description": "Required. The type of the storage inventory to fetch.", "enumDescriptions": [ "The type is unspecified.", "The type is disks.", "The type is snapshots." ] }, "forceRefresh": { "location": "query", "description": "Optional. If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower.", "type": "boolean" }, "source": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "type": "string", "description": "Required. The name of the Source.", "location": "path" }, "pageSize": { "description": "Optional. The maximum number of VMs to return. The service may return fewer than this value.", "location": "query", "type": "integer", "format": "int32" } }, "parameterOrder": [ "source" ] }, "create": { "id": "vmmigration.projects.locations.sources.create", "httpMethod": "POST", "request": { "$ref": "Source" }, "response": { "$ref": "Operation" }, "path": "v1alpha1/{+parent}/sources", "parameters": { "requestId": { "type": "string", "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" }, "parent": { "description": "Required. The Source's parent.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "sourceId": { "location": "query", "description": "Required. The source identifier.", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new Source in a given project and location." } }, "resources": { "datacenterConnectors": { "methods": { "create": { "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.sources.datacenterConnectors.create", "httpMethod": "POST", "request": { "$ref": "DatacenterConnector" }, "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/datacenterConnectors", "parameters": { "parent": { "location": "path", "description": "Required. The DatacenterConnector's parent. Required. The Source in where the new DatacenterConnector will be created. For example: `projects/my-project/locations/us-central1/sources/my-source`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "required": true }, "datacenterConnectorId": { "description": "Required. The datacenterConnector identifier.", "location": "query", "type": "string" }, "requestId": { "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/datacenterConnectors", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new DatacenterConnector in a given Source." }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/datacenterConnectors/{datacenterConnectorsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single DatacenterConnector.", "id": "vmmigration.projects.locations.sources.datacenterConnectors.get", "httpMethod": "GET", "response": { "$ref": "DatacenterConnector" }, "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "description": "Required. The name of the DatacenterConnector.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/datacenterConnectors/[^/]+$", "required": true } }, "parameterOrder": [ "name" ] }, "delete": { "id": "vmmigration.projects.locations.sources.datacenterConnectors.delete", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "path": "v1alpha1/{+name}", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/datacenterConnectors/[^/]+$", "required": true, "location": "path", "description": "Required. The DatacenterConnector name." }, "requestId": { "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/datacenterConnectors/{datacenterConnectorsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single DatacenterConnector." }, "list": { "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/datacenterConnectors", "parameters": { "parent": { "description": "Required. The parent, which owns this collection of connectors.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "type": "string" }, "filter": { "description": "Optional. The filter request.", "location": "query", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. the order by fields for the result.", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of connectors to return. The service may return fewer than this value. If unspecified, at most 500 sources will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "description": "Required. A page token, received from a previous `ListDatacenterConnectors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatacenterConnectors` must match the call that provided the page token." } }, "response": { "$ref": "ListDatacenterConnectorsResponse" }, "id": "vmmigration.projects.locations.sources.datacenterConnectors.list", "httpMethod": "GET", "description": "Lists DatacenterConnectors in a given Source.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/datacenterConnectors", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "upgradeAppliance": { "description": "Upgrades the appliance relate to this DatacenterConnector to the in-place updateable version.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/datacenterConnectors/{datacenterConnectorsId}:upgradeAppliance", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+datacenterConnector}:upgradeAppliance", "parameters": { "datacenterConnector": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/datacenterConnectors/[^/]+$", "required": true, "location": "path", "description": "Required. The DatacenterConnector name." } }, "parameterOrder": [ "datacenterConnector" ], "id": "vmmigration.projects.locations.sources.datacenterConnectors.upgradeAppliance", "httpMethod": "POST", "request": { "$ref": "UpgradeApplianceRequest" }, "response": { "$ref": "Operation" } } } }, "utilizationReports": { "methods": { "create": { "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.sources.utilizationReports.create", "httpMethod": "POST", "request": { "$ref": "UtilizationReport" }, "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/utilizationReports", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "type": "string", "required": true, "description": "Required. The Utilization Report's parent.", "location": "path" }, "utilizationReportId": { "description": "Required. The ID to use for the report, which will become the final component of the reports's resource name. This value maximum length is 63 characters, and valid characters are /a-z-/. It must start with an english letter and must not end with a hyphen.", "location": "query", "type": "string" }, "requestId": { "type": "string", "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/utilizationReports", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new UtilizationReport." }, "delete": { "description": "Deletes a single Utilization Report.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/utilizationReports/{utilizationReportsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/utilizationReports/[^/]+$", "type": "string", "required": true, "description": "Required. The Utilization Report name.", "location": "path" } }, "parameterOrder": [ "name" ], "id": "vmmigration.projects.locations.sources.utilizationReports.delete", "httpMethod": "DELETE", "response": { "$ref": "Operation" } }, "list": { "path": "v1alpha1/{+parent}/utilizationReports", "parameters": { "parent": { "description": "Required. The Utilization Reports parent.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "type": "string" }, "view": { "type": "string", "location": "query", "enum": [ "UTILIZATION_REPORT_VIEW_UNSPECIFIED", "BASIC", "FULL" ], "description": "Optional. The level of details of each report. Defaults to BASIC.", "enumDescriptions": [ "The default / unset value. The API will default to FULL on single report request and BASIC for multiple reports request.", "Get the report metadata, without the list of VMs and their utilization info.", "Include everything." ] }, "filter": { "type": "string", "location": "query", "description": "Optional. The filter request." }, "orderBy": { "location": "query", "description": "Optional. the order by fields for the result.", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 500 reports will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000." }, "pageToken": { "location": "query", "description": "Required. A page token, received from a previous `ListUtilizationReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUtilizationReports` must match the call that provided the page token.", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "vmmigration.projects.locations.sources.utilizationReports.list", "httpMethod": "GET", "response": { "$ref": "ListUtilizationReportsResponse" }, "description": "Lists Utilization Reports of the given Source.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/utilizationReports", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/utilizationReports/{utilizationReportsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a single Utilization Report.", "response": { "$ref": "UtilizationReport" }, "id": "vmmigration.projects.locations.sources.utilizationReports.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/utilizationReports/[^/]+$", "required": true, "location": "path", "description": "Required. The Utilization Report name." }, "view": { "type": "string", "description": "Optional. The level of details of the report. Defaults to FULL", "enumDescriptions": [ "The default / unset value. The API will default to FULL on single report request and BASIC for multiple reports request.", "Get the report metadata, without the list of VMs and their utilization info.", "Include everything." ], "location": "query", "enum": [ "UTILIZATION_REPORT_VIEW_UNSPECIFIED", "BASIC", "FULL" ] } } } } }, "migratingVms": { "methods": { "startMigration": { "id": "vmmigration.projects.locations.sources.migratingVms.startMigration", "httpMethod": "POST", "request": { "$ref": "StartMigrationRequest" }, "response": { "$ref": "Operation" }, "path": "v1alpha1/{+migratingVm}:startMigration", "parameters": { "migratingVm": { "location": "path", "description": "Required. The name of the MigratingVm.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$", "required": true } }, "parameterOrder": [ "migratingVm" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}:startMigration", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts migration for a VM. Starts the process of uploading data and creating snapshots, in replication cycles scheduled by the policy." }, "patch": { "id": "vmmigration.projects.locations.sources.migratingVms.patch", "httpMethod": "PATCH", "request": { "$ref": "MigratingVm" }, "response": { "$ref": "Operation" }, "path": "v1alpha1/{+name}", "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Field mask is used to specify the fields to be overwritten in the MigratingVm resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query" }, "requestId": { "type": "string", "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$", "required": true, "location": "path", "description": "Output only. The identifier of the MigratingVm." } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single MigratingVm." }, "get": { "response": { "$ref": "MigratingVm" }, "id": "vmmigration.projects.locations.sources.migratingVms.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "Required. The name of the MigratingVm.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$", "type": "string" }, "view": { "location": "query", "enum": [ "MIGRATING_VM_VIEW_UNSPECIFIED", "MIGRATING_VM_VIEW_BASIC", "MIGRATING_VM_VIEW_FULL" ], "description": "Optional. The level of details of the migrating VM.", "enumDescriptions": [ "View is unspecified. The API will fallback to the default value.", "Get the migrating VM basic details. The basic details do not include the recent clone jobs and recent cutover jobs lists.", "Include everything." ], "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single MigratingVm." }, "delete": { "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.sources.migratingVms.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "description": "Required. The name of the MigratingVm.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single MigratingVm." }, "resumeMigration": { "parameterOrder": [ "migratingVm" ], "path": "v1alpha1/{+migratingVm}:resumeMigration", "parameters": { "migratingVm": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the MigratingVm." } }, "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.sources.migratingVms.resumeMigration", "httpMethod": "POST", "request": { "$ref": "ResumeMigrationRequest" }, "description": "Resumes a migration for a VM. When called on a paused migration, will start the process of uploading data and creating snapshots; when called on a completed cut-over migration, will update the migration to active state and start the process of uploading data and creating snapshots.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}:resumeMigration", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "extendMigration": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}:extendMigration", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Extend the migrating VM time to live.", "id": "vmmigration.projects.locations.sources.migratingVms.extendMigration", "httpMethod": "POST", "request": { "$ref": "ExtendMigrationRequest" }, "response": { "$ref": "Operation" }, "path": "v1alpha1/{+migratingVm}:extendMigration", "parameters": { "migratingVm": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the MigratingVm." } }, "parameterOrder": [ "migratingVm" ] }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists MigratingVms in a given Source.", "id": "vmmigration.projects.locations.sources.migratingVms.list", "httpMethod": "GET", "response": { "$ref": "ListMigratingVmsResponse" }, "path": "v1alpha1/{+parent}/migratingVms", "parameters": { "pageSize": { "description": "Optional. The maximum number of migrating VMs to return. The service may return fewer than this value. If unspecified, at most 500 migrating VMs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "required": true, "location": "path", "description": "Required. The parent, which owns this collection of MigratingVms." }, "filter": { "location": "query", "description": "Optional. The filter request.", "type": "string" }, "orderBy": { "description": "Optional. the order by fields for the result.", "location": "query", "type": "string" }, "view": { "location": "query", "enum": [ "MIGRATING_VM_VIEW_UNSPECIFIED", "MIGRATING_VM_VIEW_BASIC", "MIGRATING_VM_VIEW_FULL" ], "description": "Optional. The level of details of each migrating VM.", "enumDescriptions": [ "View is unspecified. The API will fallback to the default value.", "Get the migrating VM basic details. The basic details do not include the recent clone jobs and recent cutover jobs lists.", "Include everything." ], "type": "string" }, "pageToken": { "type": "string", "description": "Required. A page token, received from a previous `ListMigratingVms` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMigratingVms` must match the call that provided the page token.", "location": "query" } }, "parameterOrder": [ "parent" ] }, "create": { "description": "Creates a new MigratingVm in a given Source.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/migratingVms", "parameters": { "parent": { "description": "Required. The MigratingVm's parent.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "type": "string", "required": true }, "migratingVmId": { "description": "Required. The migratingVm identifier.", "location": "query", "type": "string" }, "requestId": { "type": "string", "location": "query", "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." } }, "parameterOrder": [ "parent" ], "id": "vmmigration.projects.locations.sources.migratingVms.create", "httpMethod": "POST", "request": { "$ref": "MigratingVm" }, "response": { "$ref": "Operation" } }, "finalizeMigration": { "id": "vmmigration.projects.locations.sources.migratingVms.finalizeMigration", "httpMethod": "POST", "request": { "$ref": "FinalizeMigrationRequest" }, "response": { "$ref": "Operation" }, "path": "v1alpha1/{+migratingVm}:finalizeMigration", "parameters": { "migratingVm": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$", "location": "path", "description": "Required. The name of the MigratingVm." } }, "parameterOrder": [ "migratingVm" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}:finalizeMigration", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Marks a migration as completed, deleting migration resources that are no longer being used. Only applicable after cutover is done." }, "pauseMigration": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}:pauseMigration", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Pauses a migration for a VM. If cycle tasks are running they will be cancelled, preserving source task data. Further replication cycles will not be triggered while the VM is paused.", "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.sources.migratingVms.pauseMigration", "httpMethod": "POST", "request": { "$ref": "PauseMigrationRequest" }, "parameterOrder": [ "migratingVm" ], "path": "v1alpha1/{+migratingVm}:pauseMigration", "parameters": { "migratingVm": { "description": "Required. The name of the MigratingVm.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$", "type": "string" } } } }, "resources": { "replicationCycles": { "methods": { "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/replicationCycles", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists ReplicationCycles in a given MigratingVM.", "id": "vmmigration.projects.locations.sources.migratingVms.replicationCycles.list", "httpMethod": "GET", "response": { "$ref": "ListReplicationCyclesResponse" }, "path": "v1alpha1/{+parent}/replicationCycles", "parameters": { "pageToken": { "type": "string", "description": "Required. A page token, received from a previous `ListReplicationCycles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReplicationCycles` must match the call that provided the page token.", "location": "query" }, "parent": { "location": "path", "description": "Required. The parent, which owns this collection of ReplicationCycles.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$" }, "filter": { "type": "string", "location": "query", "description": "Optional. The filter request." }, "orderBy": { "description": "Optional. the order by fields for the result.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. The maximum number of replication cycles to return. The service may return fewer than this value. If unspecified, at most 100 migrating VMs will be returned. The maximum value is 100; values above 100 will be coerced to 100." } }, "parameterOrder": [ "parent" ] }, "get": { "path": "v1alpha1/{+name}", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+/replicationCycles/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the ReplicationCycle." } }, "parameterOrder": [ "name" ], "id": "vmmigration.projects.locations.sources.migratingVms.replicationCycles.get", "httpMethod": "GET", "response": { "$ref": "ReplicationCycle" }, "description": "Gets details of a single ReplicationCycle.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/replicationCycles/{replicationCyclesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "cloneJobs": { "methods": { "create": { "id": "vmmigration.projects.locations.sources.migratingVms.cloneJobs.create", "httpMethod": "POST", "request": { "$ref": "CloneJob" }, "response": { "$ref": "Operation" }, "path": "v1alpha1/{+parent}/cloneJobs", "parameters": { "parent": { "location": "path", "description": "Required. The Clone's parent.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$" }, "cloneJobId": { "location": "query", "description": "Required. The clone job identifier.", "type": "string" }, "requestId": { "type": "string", "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cloneJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Initiates a Clone of a specific migrating VM." }, "cancel": { "path": "v1alpha1/{+name}:cancel", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+/cloneJobs/[^/]+$", "type": "string", "description": "Required. The clone job id", "location": "path" } }, "parameterOrder": [ "name" ], "id": "vmmigration.projects.locations.sources.migratingVms.cloneJobs.cancel", "httpMethod": "POST", "request": { "$ref": "CancelCloneJobRequest" }, "response": { "$ref": "Operation" }, "description": "Initiates the cancellation of a running clone job.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cloneJobs/{cloneJobsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1alpha1/{+parent}/cloneJobs", "parameters": { "parent": { "location": "path", "description": "Required. The parent, which owns this collection of source VMs.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$" }, "filter": { "type": "string", "location": "query", "description": "Optional. The filter request." }, "orderBy": { "location": "query", "description": "Optional. the order by fields for the result.", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of clone jobs to return. The service may return fewer than this value. If unspecified, at most 500 clone jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Required. A page token, received from a previous `ListCloneJobs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCloneJobs` must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "vmmigration.projects.locations.sources.migratingVms.cloneJobs.list", "httpMethod": "GET", "response": { "$ref": "ListCloneJobsResponse" }, "description": "Lists the CloneJobs of a migrating VM. Only 25 most recent CloneJobs are listed.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cloneJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cloneJobs/{cloneJobsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single CloneJob.", "id": "vmmigration.projects.locations.sources.migratingVms.cloneJobs.get", "httpMethod": "GET", "response": { "$ref": "CloneJob" }, "path": "v1alpha1/{+name}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+/cloneJobs/[^/]+$", "type": "string", "description": "Required. The name of the CloneJob.", "location": "path" } }, "parameterOrder": [ "name" ] } } }, "cutoverJobs": { "methods": { "cancel": { "path": "v1alpha1/{+name}:cancel", "parameters": { "name": { "description": "Required. The cutover job id", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+/cutoverJobs/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "id": "vmmigration.projects.locations.sources.migratingVms.cutoverJobs.cancel", "httpMethod": "POST", "request": { "$ref": "CancelCutoverJobRequest" }, "response": { "$ref": "Operation" }, "description": "Initiates the cancellation of a running cutover job.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cutoverJobs/{cutoverJobsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists the CutoverJobs of a migrating VM. Only 25 most recent CutoverJobs are listed.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cutoverJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/cutoverJobs", "parameters": { "parent": { "location": "path", "description": "Required. The parent, which owns this collection of migrating VMs.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$", "required": true }, "filter": { "type": "string", "location": "query", "description": "Optional. The filter request." }, "orderBy": { "type": "string", "description": "Optional. the order by fields for the result.", "location": "query" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of cutover jobs to return. The service may return fewer than this value. If unspecified, at most 500 cutover jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "description": "Required. A page token, received from a previous `ListCutoverJobs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCutoverJobs` must match the call that provided the page token." } }, "parameterOrder": [ "parent" ], "id": "vmmigration.projects.locations.sources.migratingVms.cutoverJobs.list", "httpMethod": "GET", "response": { "$ref": "ListCutoverJobsResponse" } }, "get": { "id": "vmmigration.projects.locations.sources.migratingVms.cutoverJobs.get", "httpMethod": "GET", "response": { "$ref": "CutoverJob" }, "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "description": "Required. The name of the CutoverJob.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+/cutoverJobs/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cutoverJobs/{cutoverJobsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single CutoverJob." }, "create": { "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/cutoverJobs", "parameters": { "cutoverJobId": { "location": "query", "description": "Required. The cutover job identifier.", "type": "string" }, "requestId": { "type": "string", "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$", "type": "string", "description": "Required. The Cutover's parent.", "location": "path" } }, "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.sources.migratingVms.cutoverJobs.create", "httpMethod": "POST", "request": { "$ref": "CutoverJob" }, "description": "Initiates a Cutover of a specific migrating VM. The returned LRO is completed when the cutover job resource is created and the job is initiated.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cutoverJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "diskMigrationJobs": { "methods": { "create": { "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.sources.diskMigrationJobs.create", "httpMethod": "POST", "request": { "$ref": "DiskMigrationJob" }, "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/diskMigrationJobs", "parameters": { "requestId": { "location": "query", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "diskMigrationJobId": { "type": "string", "location": "query", "description": "Required. The DiskMigrationJob identifier. The maximum length of this value is 63 characters. Valid characters are lower case Latin letters, digits and hyphen. It must start with a Latin letter and must not end with a hyphen." }, "parent": { "description": "Required. The DiskMigrationJob's parent.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new disk migration job in a given Source." }, "patch": { "description": "Updates the parameters of a single DiskMigrationJob.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Optional. Field mask is used to specify the fields to be overwritten in the DiskMigrationJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, then a mask equivalent to all fields that are populated (have a non-empty value), will be implied." }, "requestId": { "type": "string", "location": "query", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "name": { "location": "path", "description": "Output only. Identifier. The identifier of the DiskMigrationJob.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$" } }, "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.sources.diskMigrationJobs.patch", "httpMethod": "PATCH", "request": { "$ref": "DiskMigrationJob" } }, "get": { "description": "Gets details of a single DiskMigrationJob.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", "type": "string", "description": "Required. The name of the DiskMigrationJob.", "location": "path" } }, "parameterOrder": [ "name" ], "id": "vmmigration.projects.locations.sources.diskMigrationJobs.get", "httpMethod": "GET", "response": { "$ref": "DiskMigrationJob" } }, "cancel": { "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:cancel", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the DiskMigrationJob." } }, "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.sources.diskMigrationJobs.cancel", "httpMethod": "POST", "request": { "$ref": "CancelDiskMigrationJobRequest" }, "description": "Cancels the disk migration job.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.sources.diskMigrationJobs.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "Required. The name of the DiskMigrationJob.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", "type": "string", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single DiskMigrationJob." }, "run": { "description": "Runs the disk migration job.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:run", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:run", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", "type": "string", "description": "Required. The name of the DiskMigrationJob.", "location": "path" } }, "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.sources.diskMigrationJobs.run", "httpMethod": "POST", "request": { "$ref": "RunDiskMigrationJobRequest" } }, "list": { "description": "Lists DiskMigrationJobs in a given Source.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/diskMigrationJobs", "parameters": { "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `ListDiskMigrationJobs` call. Provide this to retrieve the subsequent page. When paginating, all parameters provided to `ListDiskMigrationJobs` except `page_size` must match the call that provided the page token.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$", "type": "string", "required": true, "description": "Required. The parent, which owns this collection of DiskMigrationJobs.", "location": "path" }, "filter": { "description": "Optional. The filter request (according to AIP-160).", "location": "query", "type": "string" }, "orderBy": { "type": "string", "location": "query", "description": "Optional. Ordering of the result list." }, "pageSize": { "description": "Optional. The maximum number of disk migration jobs to return. The service may return fewer than this value. If unspecified, at most 500 disk migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" } }, "parameterOrder": [ "parent" ], "id": "vmmigration.projects.locations.sources.diskMigrationJobs.list", "httpMethod": "GET", "response": { "$ref": "ListDiskMigrationJobsResponse" } } } } } }, "operations": { "methods": { "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "vmmigration.projects.locations.operations.delete", "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ] }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}/operations", "parameters": { "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size.", "location": "query" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "The name of the operation's parent resource." }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" } }, "response": { "$ref": "ListOperationsResponse" }, "id": "vmmigration.projects.locations.operations.list", "httpMethod": "GET" }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.operations.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } } }, "cancel": { "id": "vmmigration.projects.locations.operations.cancel", "httpMethod": "POST", "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "Empty" }, "path": "v1alpha1/{+name}:cancel", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "location": "path", "description": "The name of the operation resource to be cancelled." } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." } } }, "targetProjects": { "methods": { "create": { "path": "v1alpha1/{+parent}/targetProjects", "parameters": { "parent": { "description": "Required. The TargetProject's parent.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true }, "targetProjectId": { "location": "query", "description": "Required. The target_project identifier.", "type": "string" }, "requestId": { "type": "string", "location": "query", "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." } }, "parameterOrder": [ "parent" ], "id": "vmmigration.projects.locations.targetProjects.create", "httpMethod": "POST", "request": { "$ref": "TargetProject" }, "response": { "$ref": "Operation" }, "description": "Creates a new TargetProject in a given project. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/targetProjects", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "description": "Updates the parameters of a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/targetProjects/{targetProjectsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "description": "Output only. The name of the target project.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/targetProjects/[^/]+$", "required": true }, "updateMask": { "location": "query", "description": "Field mask is used to specify the fields to be overwritten in the TargetProject resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "type": "string", "format": "google-fieldmask" }, "requestId": { "type": "string", "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "parameterOrder": [ "name" ], "id": "vmmigration.projects.locations.targetProjects.patch", "httpMethod": "PATCH", "request": { "$ref": "TargetProject" }, "response": { "$ref": "Operation" } }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/targetProjects/{targetProjectsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`.", "id": "vmmigration.projects.locations.targetProjects.get", "httpMethod": "GET", "response": { "$ref": "TargetProject" }, "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "Required. The TargetProject name.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/targetProjects/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ] }, "delete": { "description": "Deletes a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/targetProjects/{targetProjectsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "description": "Required. The TargetProject name.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/targetProjects/[^/]+$", "required": true }, "requestId": { "location": "query", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" } }, "parameterOrder": [ "name" ], "id": "vmmigration.projects.locations.targetProjects.delete", "httpMethod": "DELETE", "response": { "$ref": "Operation" } }, "list": { "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/targetProjects", "parameters": { "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. The maximum number of targets to return. The service may return fewer than this value. If unspecified, at most 500 targets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000." }, "parent": { "description": "Required. The parent, which owns this collection of targets.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true }, "filter": { "description": "Optional. The filter request.", "location": "query", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. the order by fields for the result.", "type": "string" }, "pageToken": { "description": "Required. A page token, received from a previous `ListTargets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargets` must match the call that provided the page token.", "location": "query", "type": "string" } }, "response": { "$ref": "ListTargetProjectsResponse" }, "id": "vmmigration.projects.locations.targetProjects.list", "httpMethod": "GET", "description": "Lists TargetProjects in a given project. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/targetProjects", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "imageImports": { "resources": { "imageImportJobs": { "methods": { "list": { "description": "Lists ImageImportJobs in a given project.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}/imageImportJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/imageImportJobs", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListImageImportJobs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListImageImportJobs` must match the call that provided the page token." }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of targets to return. The service may return fewer than this value. If unspecified, at most 500 targets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/imageImports/[^/]+$", "type": "string", "description": "Required. The parent, which owns this collection of targets.", "location": "path" }, "filter": { "location": "query", "description": "Optional. The filter request (according to AIP-160).", "type": "string" }, "orderBy": { "type": "string", "location": "query", "description": "Optional. The order by fields for the result (according to AIP-132). Currently ordering is only possible by \"name\" field." } }, "response": { "$ref": "ListImageImportJobsResponse" }, "id": "vmmigration.projects.locations.imageImports.imageImportJobs.list", "httpMethod": "GET" }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}/imageImportJobs/{imageImportJobsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single ImageImportJob.", "id": "vmmigration.projects.locations.imageImports.imageImportJobs.get", "httpMethod": "GET", "response": { "$ref": "ImageImportJob" }, "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "description": "Required. The ImageImportJob name.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/imageImports/[^/]+/imageImportJobs/[^/]+$", "required": true } }, "parameterOrder": [ "name" ] }, "cancel": { "id": "vmmigration.projects.locations.imageImports.imageImportJobs.cancel", "httpMethod": "POST", "request": { "$ref": "CancelImageImportJobRequest" }, "response": { "$ref": "Operation" }, "path": "v1alpha1/{+name}:cancel", "parameters": { "name": { "location": "path", "description": "Required. The image import job id.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/imageImports/[^/]+/imageImportJobs/[^/]+$" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}/imageImportJobs/{imageImportJobsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Initiates the cancellation of a running ImageImportJob." } } } }, "methods": { "list": { "path": "v1alpha1/{+parent}/imageImports", "parameters": { "pageSize": { "location": "query", "description": "Optional. The maximum number of targets to return. The service may return fewer than this value. If unspecified, at most 500 targets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The parent, which owns this collection of targets.", "location": "path" }, "filter": { "type": "string", "description": "Optional. The filter request (according to AIP-160).", "location": "query" }, "orderBy": { "description": "Optional. The order by fields for the result (according to AIP-132). Currently ordering is only possible by \"name\" field.", "location": "query", "type": "string" }, "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `ListImageImports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListImageImports` must match the call that provided the page token.", "location": "query" } }, "parameterOrder": [ "parent" ], "id": "vmmigration.projects.locations.imageImports.list", "httpMethod": "GET", "response": { "$ref": "ListImageImportsResponse" }, "description": "Lists ImageImports in a given project.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/imageImports", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "ImageImport" }, "id": "vmmigration.projects.locations.imageImports.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "Required. The ImageImport name.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/imageImports/[^/]+$", "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single ImageImport." }, "create": { "description": "Creates a new ImageImport in a given project.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/imageImports", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/imageImports", "parameters": { "parent": { "location": "path", "description": "Required. The ImageImport's parent.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "imageImportId": { "location": "query", "description": "Required. The image import identifier. This value maximum length is 63 characters, and valid characters are /a-z-/. It must start with an english letter and must not end with a hyphen.", "type": "string" }, "requestId": { "location": "query", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "vmmigration.projects.locations.imageImports.create", "httpMethod": "POST", "request": { "$ref": "ImageImport" }, "response": { "$ref": "Operation" } }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single ImageImport.", "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.imageImports.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "description": "Required. The ImageImport name.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/imageImports/[^/]+$", "required": true }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } } } } }, "groups": { "methods": { "list": { "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/groups", "parameters": { "pageToken": { "location": "query", "description": "Required. A page token, received from a previous `ListGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGroups` must match the call that provided the page token.", "type": "string" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 500 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "format": "int32" }, "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent, which owns this collection of groups." }, "filter": { "type": "string", "description": "Optional. The filter request.", "location": "query" }, "orderBy": { "type": "string", "description": "Optional. the order by fields for the result.", "location": "query" } }, "response": { "$ref": "ListGroupsResponse" }, "id": "vmmigration.projects.locations.groups.list", "httpMethod": "GET", "description": "Lists Groups in a given project and location.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/groups", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.groups.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "requestId": { "location": "query", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "name": { "description": "Required. The Group name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/groups/[^/]+$", "type": "string", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single Group." }, "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single Group.", "response": { "$ref": "Operation" }, "id": "vmmigration.projects.locations.groups.patch", "httpMethod": "PATCH", "request": { "$ref": "Group" }, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/groups/[^/]+$", "type": "string", "description": "Output only. The Group name.", "location": "path" }, "updateMask": { "description": "Field mask is used to specify the fields to be overwritten in the Group resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "type": "string", "format": "google-fieldmask" }, "requestId": { "type": "string", "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } } }, "get": { "description": "Gets details of a single Group.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "Required. The group name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/groups/[^/]+$", "type": "string", "required": true } }, "response": { "$ref": "Group" }, "id": "vmmigration.projects.locations.groups.get", "httpMethod": "GET" }, "addGroupMigration": { "id": "vmmigration.projects.locations.groups.addGroupMigration", "httpMethod": "POST", "request": { "$ref": "AddGroupMigrationRequest" }, "response": { "$ref": "Operation" }, "path": "v1alpha1/{+group}:addGroupMigration", "parameters": { "group": { "location": "path", "description": "Required. The full path name of the Group to add to.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/groups/[^/]+$" } }, "parameterOrder": [ "group" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}:addGroupMigration", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Adds a MigratingVm to a Group." }, "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/groups", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new Group in a given project and location.", "id": "vmmigration.projects.locations.groups.create", "httpMethod": "POST", "request": { "$ref": "Group" }, "response": { "$ref": "Operation" }, "path": "v1alpha1/{+parent}/groups", "parameters": { "groupId": { "description": "Required. The group identifier.", "location": "query", "type": "string" }, "requestId": { "type": "string", "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The Group's parent.", "location": "path" } }, "parameterOrder": [ "parent" ] }, "removeGroupMigration": { "id": "vmmigration.projects.locations.groups.removeGroupMigration", "httpMethod": "POST", "request": { "$ref": "RemoveGroupMigrationRequest" }, "response": { "$ref": "Operation" }, "path": "v1alpha1/{+group}:removeGroupMigration", "parameters": { "group": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/groups/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the Group." } }, "parameterOrder": [ "group" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}:removeGroupMigration", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Removes a MigratingVm from a Group." } } } }, "methods": { "list": { "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1alpha1/projects/{projectsId}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}/locations", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "name": { "required": true, "pattern": "^projects/[^/]+$", "type": "string", "description": "The resource that owns the locations collection, if applicable.", "location": "path" }, "filter": { "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string" }, "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" } }, "response": { "$ref": "ListLocationsResponse" }, "id": "vmmigration.projects.locations.list", "httpMethod": "GET" }, "get": { "description": "Gets information about a location.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "Resource name for the location.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "response": { "$ref": "Location" }, "id": "vmmigration.projects.locations.get", "httpMethod": "GET" } } } } } }, "protocol": "rest", "documentationLink": "https://cloud.google.com/migrate/virtual-machines", "baseUrl": "https://vmmigration.googleapis.com/", "description": "Use the Migrate to Virtual Machines API to programmatically migrate workloads. ", "version": "v1alpha1", "discoveryVersion": "v1", "canonicalName": "VM Migration Service", "rootUrl": "https://vmmigration.googleapis.com/", "ownerDomain": "google.com", "servicePath": "" }