googleapis
Version:
Google APIs Client Library for Node.js
1,363 lines • 289 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace vmmigration_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Migrate to Virtual Machines API
*
* Use the Migrate to Virtual Machines API to programmatically migrate workloads.
*
* @example
* ```js
* const {google} = require('googleapis');
* const vmmigration = google.vmmigration('v1');
* ```
*/
export class Vmmigration {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Request message for 'AddGroupMigration' request.
*/
export interface Schema$AddGroupMigrationRequest {
/**
* The full path name of the MigratingVm to add.
*/
migratingVm?: string | null;
}
/**
* Describes an appliance version.
*/
export interface Schema$ApplianceVersion {
/**
* Determine whether it's critical to upgrade the appliance to this version.
*/
critical?: boolean | null;
/**
* Link to a page that contains the version release notes.
*/
releaseNotesUri?: string | null;
/**
* A link for downloading the version.
*/
uri?: string | null;
/**
* The appliance version.
*/
version?: string | null;
}
/**
* AppliedLicense holds the license data returned by adaptation module report.
*/
export interface Schema$AppliedLicense {
/**
* The OS license returned from the adaptation module's report.
*/
osLicense?: string | null;
/**
* The license type that was used in OS adaptation.
*/
type?: string | null;
}
/**
* Holds informatiom about the available versions for upgrade.
*/
export interface Schema$AvailableUpdates {
/**
* The latest version for in place update. The current appliance can be updated to this version using the API or m4c CLI.
*/
inPlaceUpdate?: Schema$ApplianceVersion;
/**
* 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.
*/
newDeployableAppliance?: Schema$ApplianceVersion;
}
/**
* Request message for 'CancelCloneJob' request.
*/
export interface Schema$CancelCloneJobRequest {
}
/**
* Request message for 'CancelCutoverJob' request.
*/
export interface Schema$CancelCutoverJobRequest {
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* 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.
*/
export interface Schema$CloneJob {
/**
* Output only. Details of the target VM in Compute Engine.
*/
computeEngineTargetDetails?: Schema$ComputeEngineTargetDetails;
/**
* Output only. The time the clone job was created (as an API call, not when it was actually created in the target).
*/
createTime?: string | null;
/**
* Output only. The time the clone job was ended.
*/
endTime?: string | null;
/**
* Output only. Provides details for the errors that led to the Clone Job's state.
*/
error?: Schema$Status;
/**
* Output only. The name of the clone.
*/
name?: string | null;
/**
* Output only. State of the clone job.
*/
state?: string | null;
/**
* Output only. The time the state was last updated.
*/
stateTime?: string | null;
}
/**
* ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project.
*/
export interface Schema$ComputeEngineTargetDefaults {
/**
* Additional licenses to assign to the VM.
*/
additionalLicenses?: string[] | null;
/**
* Output only. The OS license returned from the adaptation module report.
*/
appliedLicense?: Schema$AppliedLicense;
/**
* Output only. The VM Boot Option, as set in the source vm.
*/
bootOption?: string | null;
/**
* Compute instance scheduling information (if empty default is used).
*/
computeScheduling?: Schema$ComputeScheduling;
/**
* The disk type to use in the VM.
*/
diskType?: string | null;
/**
* The hostname to assign to the VM.
*/
hostname?: string | null;
/**
* A map of labels to associate with the VM.
*/
labels?: {
[key: string]: string;
} | null;
/**
* The license type to use in OS adaptation.
*/
licenseType?: string | null;
/**
* The machine type to create the VM with.
*/
machineType?: string | null;
/**
* The machine type series to create the VM with.
*/
machineTypeSeries?: string | null;
/**
* The metadata key/value pairs to assign to the VM.
*/
metadata?: {
[key: string]: string;
} | null;
/**
* List of NICs connected to this VM.
*/
networkInterfaces?: Schema$NetworkInterface[];
/**
* A map of network tags to associate with the VM.
*/
networkTags?: string[] | null;
/**
* Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
*/
secureBoot?: boolean | null;
/**
* The service account to associate the VM with.
*/
serviceAccount?: string | null;
/**
* The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.
*/
targetProject?: string | null;
/**
* The name of the VM to create.
*/
vmName?: string | null;
/**
* The zone in which to create the VM.
*/
zone?: string | null;
}
/**
* ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project.
*/
export interface Schema$ComputeEngineTargetDetails {
/**
* Additional licenses to assign to the VM.
*/
additionalLicenses?: string[] | null;
/**
* The OS license returned from the adaptation module report.
*/
appliedLicense?: Schema$AppliedLicense;
/**
* The VM Boot Option, as set in the source vm.
*/
bootOption?: string | null;
/**
* Compute instance scheduling information (if empty default is used).
*/
computeScheduling?: Schema$ComputeScheduling;
/**
* The disk type to use in the VM.
*/
diskType?: string | null;
/**
* The hostname to assign to the VM.
*/
hostname?: string | null;
/**
* A map of labels to associate with the VM.
*/
labels?: {
[key: string]: string;
} | null;
/**
* The license type to use in OS adaptation.
*/
licenseType?: string | null;
/**
* The machine type to create the VM with.
*/
machineType?: string | null;
/**
* The machine type series to create the VM with.
*/
machineTypeSeries?: string | null;
/**
* The metadata key/value pairs to assign to the VM.
*/
metadata?: {
[key: string]: string;
} | null;
/**
* List of NICs connected to this VM.
*/
networkInterfaces?: Schema$NetworkInterface[];
/**
* A map of network tags to associate with the VM.
*/
networkTags?: string[] | null;
/**
* The GCP target project ID or project name.
*/
project?: string | null;
/**
* Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
*/
secureBoot?: boolean | null;
/**
* The service account to associate the VM with.
*/
serviceAccount?: string | null;
/**
* The name of the VM to create.
*/
vmName?: string | null;
/**
* The zone in which to create the VM.
*/
zone?: string | null;
}
/**
* Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes.
*/
export interface Schema$ComputeScheduling {
/**
* The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
*/
minNodeCpus?: number | null;
/**
* A set of node affinity and anti-affinity configurations for sole tenant nodes.
*/
nodeAffinities?: Schema$SchedulingNodeAffinity[];
/**
* How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
*/
onHostMaintenance?: string | null;
/**
* 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.
*/
restartType?: string | null;
}
/**
* CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.
*/
export interface Schema$CutoverJob {
/**
* Output only. Details of the target VM in Compute Engine.
*/
computeEngineTargetDetails?: Schema$ComputeEngineTargetDetails;
/**
* Output only. The time the cutover job was created (as an API call, not when it was actually created in the target).
*/
createTime?: string | null;
/**
* Output only. The time the cutover job had finished.
*/
endTime?: string | null;
/**
* Output only. Provides details for the errors that led to the Cutover Job's state.
*/
error?: Schema$Status;
/**
* Output only. The name of the cutover job.
*/
name?: string | null;
/**
* Output only. The current progress in percentage of the cutover job.
*/
progressPercent?: number | null;
/**
* Output only. State of the cutover job.
*/
state?: string | null;
/**
* Output only. A message providing possible extra details about the current state.
*/
stateMessage?: string | null;
/**
* Output only. The time the state was last updated.
*/
stateTime?: string | null;
}
/**
* DatacenterConnector message describes a connector between the Source and GCP, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to GCP and support vm migration data transfer.
*/
export interface Schema$DatacenterConnector {
/**
* 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.
*/
applianceInfrastructureVersion?: string | null;
/**
* Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance.
*/
applianceSoftwareVersion?: string | null;
/**
* Output only. The available versions for updating this appliance.
*/
availableVersions?: Schema$AvailableUpdates;
/**
* Output only. The communication channel between the datacenter connector and GCP.
*/
bucket?: string | null;
/**
* Output only. The time the connector was created (as an API call, not when it was actually installed).
*/
createTime?: string | null;
/**
* Output only. Provides details on the state of the Datacenter Connector in case of an error.
*/
error?: Schema$Status;
/**
* Output only. The connector's name.
*/
name?: string | null;
/**
* 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.
*/
registrationId?: string | null;
/**
* The service account to use in the connector when communicating with the cloud.
*/
serviceAccount?: string | null;
/**
* Output only. State of the DatacenterConnector, as determined by the health checks.
*/
state?: string | null;
/**
* Output only. The time the state was last set.
*/
stateTime?: string | null;
/**
* Output only. The last time the connector was updated with an API call.
*/
updateTime?: string | null;
/**
* Output only. The status of the current / last upgradeAppliance operation.
*/
upgradeStatus?: Schema$UpgradeStatus;
/**
* The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified.
*/
version?: string | null;
}
/**
* 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); \}
*/
export interface Schema$Empty {
}
/**
* Response message for fetchInventory.
*/
export interface Schema$FetchInventoryResponse {
/**
* 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.
*/
nextPageToken?: string | null;
/**
* Output only. The timestamp when the source was last queried (if the result is from the cache).
*/
updateTime?: string | null;
/**
* The description of the VMs in a Source of type Vmware.
*/
vmwareVms?: Schema$VmwareVmsDetails;
}
/**
* Request message for 'FinalizeMigration' request.
*/
export interface Schema$FinalizeMigrationRequest {
}
/**
* Describes message for 'Group' resource. The Group is a collections of several MigratingVms.
*/
export interface Schema$Group {
/**
* Output only. The create time timestamp.
*/
createTime?: string | null;
/**
* User-provided description of the group.
*/
description?: string | null;
/**
* Display name is a user defined name for this group which can be updated.
*/
displayName?: string | null;
/**
* Output only. The Group name.
*/
name?: string | null;
/**
* Output only. The update time timestamp.
*/
updateTime?: string | null;
}
/**
* Describes a URL link.
*/
export interface Schema$Link {
/**
* Describes what the link offers.
*/
description?: string | null;
/**
* The URL of the link.
*/
url?: string | null;
}
/**
* Response message for 'ListCloneJobs' request.
*/
export interface Schema$ListCloneJobsResponse {
/**
* Output only. The list of clone jobs response.
*/
cloneJobs?: Schema$CloneJob[];
/**
* 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.
*/
nextPageToken?: string | null;
/**
* Output only. Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for 'ListCutoverJobs' request.
*/
export interface Schema$ListCutoverJobsResponse {
/**
* Output only. The list of cutover jobs response.
*/
cutoverJobs?: Schema$CutoverJob[];
/**
* 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.
*/
nextPageToken?: string | null;
/**
* Output only. Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for 'ListDatacenterConnectors' request.
*/
export interface Schema$ListDatacenterConnectorsResponse {
/**
* Output only. The list of sources response.
*/
datacenterConnectors?: Schema$DatacenterConnector[];
/**
* 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.
*/
nextPageToken?: string | null;
/**
* Output only. Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for 'ListGroups' request.
*/
export interface Schema$ListGroupsResponse {
/**
* Output only. The list of groups response.
*/
groups?: Schema$Group[];
/**
* 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.
*/
nextPageToken?: string | null;
/**
* Output only. Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* Response message for 'ListMigratingVms' request.
*/
export interface Schema$ListMigratingVmsResponse {
/**
* Output only. The list of Migrating VMs response.
*/
migratingVms?: Schema$MigratingVm[];
/**
* 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.
*/
nextPageToken?: string | null;
/**
* Output only. Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* Response message for 'ListReplicationCycles' request.
*/
export interface Schema$ListReplicationCyclesResponse {
/**
* 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.
*/
nextPageToken?: string | null;
/**
* Output only. The list of replication cycles response.
*/
replicationCycles?: Schema$ReplicationCycle[];
/**
* Output only. Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for 'ListSources' request.
*/
export interface Schema$ListSourcesResponse {
/**
* 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.
*/
nextPageToken?: string | null;
/**
* Output only. The list of sources response.
*/
sources?: Schema$Source[];
/**
* Output only. Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for 'ListTargetProjects' call.
*/
export interface Schema$ListTargetProjectsResponse {
/**
* 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.
*/
nextPageToken?: string | null;
/**
* Output only. The list of target response.
*/
targetProjects?: Schema$TargetProject[];
/**
* Output only. Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for 'ListUtilizationReports' request.
*/
export interface Schema$ListUtilizationReportsResponse {
/**
* 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.
*/
nextPageToken?: string | null;
/**
* Output only. Locations that could not be reached.
*/
unreachable?: string[] | null;
/**
* Output only. The list of reports.
*/
utilizationReports?: Schema$UtilizationReport[];
}
/**
* Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
*/
export interface Schema$LocalizedMessage {
/**
* 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"
*/
locale?: string | null;
/**
* The localized error message in the above locale.
*/
message?: string | null;
}
/**
* A resource that represents Google Cloud Platform location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
*/
labels?: {
[key: string]: string;
} | null;
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string | null;
}
/**
* MigratingVm describes the VM that will be migrated from a Source environment and its replication state.
*/
export interface Schema$MigratingVm {
/**
* Details of the target VM in Compute Engine.
*/
computeEngineTargetDefaults?: Schema$ComputeEngineTargetDefaults;
/**
* 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).
*/
createTime?: string | null;
/**
* Output only. The percentage progress of the current running replication cycle.
*/
currentSyncInfo?: Schema$ReplicationCycle;
/**
* The description attached to the migrating VM by the user.
*/
description?: string | null;
/**
* The display name attached to the MigratingVm by the user.
*/
displayName?: string | null;
/**
* Output only. Provides details on the state of the Migrating VM in case of an error in replication.
*/
error?: Schema$Status;
/**
* 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.
*/
group?: string | null;
/**
* The labels of the migrating VM.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. The most updated snapshot created time in the source that finished replication.
*/
lastSync?: Schema$ReplicationSync;
/**
* Output only. The identifier of the MigratingVm.
*/
name?: string | null;
/**
* The replication schedule policy.
*/
policy?: Schema$SchedulePolicy;
/**
* 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.
*/
recentCloneJobs?: Schema$CloneJob[];
/**
* 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.
*/
recentCutoverJobs?: Schema$CutoverJob[];
/**
* 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-.
*/
sourceVmId?: string | null;
/**
* Output only. State of the MigratingVm.
*/
state?: string | null;
/**
* Output only. The last time the migrating VM state was updated.
*/
stateTime?: string | null;
/**
* Output only. The last time the migrating VM resource was updated.
*/
updateTime?: string | null;
}
/**
* 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.
*/
export interface Schema$MigrationError {
/**
* Output only. Suggested action for solving the error.
*/
actionItem?: Schema$LocalizedMessage;
/**
* Output only. The error code.
*/
code?: string | null;
/**
* Output only. The localized error message.
*/
errorMessage?: Schema$LocalizedMessage;
/**
* Output only. The time the error occurred.
*/
errorTime?: string | null;
/**
* Output only. URL(s) pointing to additional information on handling the current error.
*/
helpLinks?: Schema$Link[];
}
/**
* NetworkInterface represents a NIC of a VM.
*/
export interface Schema$NetworkInterface {
/**
* The external IP to define in the NIC.
*/
externalIp?: string | null;
/**
* The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
*/
internalIp?: string | null;
/**
* The network to connect the NIC to.
*/
network?: string | null;
/**
* The subnetwork to connect the NIC to.
*/
subnetwork?: string | null;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* 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.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* 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.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* 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\}`.
*/
name?: string | null;
/**
* The normal response of the operation in case of success. 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`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$OperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* 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`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* Request message for 'PauseMigration' request.
*/
export interface Schema$PauseMigrationRequest {
}
/**
* Request message for 'RemoveMigration' request.
*/
export interface Schema$RemoveGroupMigrationRequest {
/**
* The MigratingVm to remove.
*/
migratingVm?: string | null;
}
/**
* ReplicationCycle contains information about the current replication cycle status.
*/
export interface Schema$ReplicationCycle {
/**
* The current progress in percentage of this cycle.
*/
progressPercent?: number | null;
/**
* The time the replication cycle has started.
*/
startTime?: string | null;
}
/**
* ReplicationSync contain information about the last replica sync to the cloud.
*/
export interface Schema$ReplicationSync {
/**
* The most updated snapshot created time in the source that finished replication.
*/
lastSyncTime?: string | null;
}
/**
* Request message for 'ResumeMigration' request.
*/
export interface Schema$ResumeMigrationRequest {
}
/**
* A policy for scheduling replications.
*/
export interface Schema$SchedulePolicy {
/**
* The idle duration between replication stages.
*/
idleDuration?: string | null;
/**
* 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.
*/
skipOsAdaptation?: boolean | null;
}
/**
* 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
*/
export interface Schema$SchedulingNodeAffinity {
/**
* The label key of Node resource to reference.
*/
key?: string | null;
/**
* The operator to use for the node resources specified in the `values` parameter.
*/
operator?: string | null;
/**
* Corresponds to the label values of Node resource.
*/
values?: string[] | null;
}
/**
* Source message describes a specific vm migration Source resource. It contains the source environment information.
*/
export interface Schema$Source {
/**
* Output only. The create time timestamp.
*/
createTime?: string | null;
/**
* User-provided description of the source.
*/
description?: string | null;
/**
* The labels of the source.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. The Source name.
*/
name?: string | null;
/**
* Output only. The update time timestamp.
*/
updateTime?: string | null;
/**
* Vmware type source details.
*/
vmware?: Schema$VmwareSourceDetails;
}
/**
* Request message for 'StartMigrationRequest' request.
*/
export interface Schema$StartMigrationRequest {
}
/**
* 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).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* 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.
*/
message?: string | null;
}
/**
* TargetProject message represents a target Compute Engine project for a migration or a clone.
*/
export interface Schema$TargetProject {
/**
* Output only. The time this target project resource was created (not related to when the Compute Engine project it points to was created).
*/
createTime?: string | null;
/**
* The target project's description.
*/
description?: string | null;
/**
* Output only. The name of the target project.
*/
name?: string | null;
/**
* The target project ID (number) or project name.
*/
project?: string | null;
/**
* Output only. The last time the target project resource was updated.
*/
updateTime?: string | null;
}
/**
* Request message for 'UpgradeAppliance' request.
*/
export interface Schema$UpgradeApplianceRequest {
/**
* 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).
*/
requestId?: string | null;
}
/**
* UpgradeStatus contains information about upgradeAppliance operation.
*/
export interface Schema$UpgradeStatus {
/**
* Provides details on the state of the upgrade operation in case of an error.
*/
error?: Schema$Status;
/**
* The version from which we upgraded.
*/
previousVersion?: string | null;
/**
* The time the operation was started.
*/
startTime?: string | null;
/**
* The state of the upgradeAppliance operation.
*/
state?: string | null;
/**
* The version to upgrade to.
*/
version?: string | null;
}
/**
* Utilization report details the utilization (CPU, memory, etc.) of selected source VMs.
*/
export interface Schema$UtilizationReport {
/**
* Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed).
*/
createTime?: string | null;
/**
* The report display name, as assigned by the user.
*/
displayName?: string | null;
/**
* Output only. Provides details on the state of the report in case of an error.
*/
error?: Schema$Status;
/**
* 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.
*/
frameEndTime?: string | null;
/**
* Output only. The report unique name.
*/
name?: string | null;
/**
* Output only. Current state of the report.
*/
state?: string | null;
/**
* Output only. The time the state was last set.
*/
stateTime?: string | null;
/**
* Time frame of the report.
*/
timeFrame?: string | null;
/**
* Output only. Total number of VMs included in the report.
*/
vmCount?: number | null;
/**
* 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.
*/
vms?: Schema$VmUtilizationInfo[];
}
/**
* Utilization information of a single VM.
*/
export interface Schema$VmUtilizationInfo {
/**
* Utilization metrics for this VM.
*/
utilization?: Schema$VmUtilizationMetrics;
/**
* The VM's ID in the source.
*/
vmId?: string | null;
/**
* The description of the VM in a Source of type Vmware.
*/
vmwareVmDetails?: Schema$VmwareVmDetails;
}
/**
* Utilization metrics values for a single VM.
*/
export interface Schema$VmUtilizationMetrics {
/**
* Average CPU usage, percent.
*/
cpuAveragePercent?: number | null;
/**
* Max CPU usage, percent.
*/
cpuMaxPercent?: number | null;
/**
* Average disk IO rate, in kilobytes per second.
*/
diskIoRateAverageKbps?: string | null;
/**
* Max disk IO rate, in kilobytes per second.
*/
diskIoRateMaxKbps?: string | null;
/**
* Average memory usage, percent.
*/
memoryAveragePercent?: number | null;
/**
* Max memory usage, percent.
*/
memoryMaxPercent?: number | null;
/**
* Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
*/
networkThroughputAverageKbps?: string | null;
/**
* Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
*/
networkThroughputMaxKbps?: string | null;
}
/**
* VmwareSourceDetails message describes a specific source details for the vmware source type.
*/
export interface Schema$VmwareSourceDetails {
/**
* Input only. The credentials password. This is write only and can not be read in a GET operation.
*/
password?: string | null;
/**
* The thumbprint representing the certificate for the vcenter.
*/
thumbprint?: string | null;
/**
* The credentials username.
*/
username?: string | null;
/**
* The ip address of the vcenter this Source represents.
*/
vcenterIp?: string | null;
}
/**
* VmwareVmDetails describes a VM in vCenter.
*/
export interface Schema$VmwareVmDetails {
/**
* Output only. The VM Boot Option.
*/
bootOption?: string | null;
/**
* The total size of the storage allocated to the VM in MB.
*/
committedStorageMb?: string | null;
/**
* The number of cpus in the VM.
*/
cpuCount?: number | null;
/**
* The descriptive name of the vCenter's datacenter this VM is contained in.
*/
datacenterDescription?: string | null;
/**
* The id of the vCenter's datacenter this VM is contained in.
*/
datacenterId?: string | null;
/**
* The number of disks the VM has.
*/
diskCount?: number | null;
/**
* The display name of the VM. Note that this is not necessarily unique.
*/
displayName?: string | null;
/**
* 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.
*/
guestDescription?: string | null;
/**
* The size of the memory of the VM in MB.
*/
memoryMb?: number | null;
/**
* The power state of the VM at the moment list was taken.
*/
powerState?: string | null;
/**
* The unique identifier of the VM in vCenter.
*/
uuid?: string | null;
/**
* The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.
*/
vmId?: string | null;
}
/**
* VmwareVmsDetails describes VMs in vCenter.
*/
export interface Schema$VmwareVmsDetails {
/**
* The details of the vmware VMs.
*/
details?: Schema$VmwareVmDetails[];
}
export class Resource$Projects {
context: APIRequestContext;
locations: Resource$Projects$Locations;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Locations {
context: APIRequestContext;
groups: Resource$Projects$Locations$Groups;
operations: Resource$Projects$Locations$Operations;
sources: Resource$Projects$Locations$Sources;
targetProjects: Resource$Projects$Locations$Targetprojects;
constructor(context: APIRequestContext);
/**
* Gets information about a location.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/vmmigration.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const vmmigration = google.vmmigration('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await vmmigration.projects.locations.get({
* // Resource name for the location.
* name: 'projects/my-project/locations/my-location',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "displayName": "my_displayName",
* // "labels": {},
* // "locationId": "my_locationId",
* // "metadata": {},
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with asyn