Types for Google Cloud Vmmigration v1 API¶
- class google.cloud.vmmigration_v1.types.AdaptingOSStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAdaptingOSStep contains specific step details.
- class google.cloud.vmmigration_v1.types.AddGroupMigrationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘AddGroupMigration’ request.
- class google.cloud.vmmigration_v1.types.AddGroupMigrationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘AddGroupMigration’ request.
- class google.cloud.vmmigration_v1.types.ApplianceVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes an appliance version.
- class google.cloud.vmmigration_v1.types.AppliedLicense(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAppliedLicense holds the license data returned by adaptation module report.
- type_¶
The license type that was used in OS adaptation.
- class Type(value)[source]¶
Bases:
proto.enums.EnumLicense types used in OS adaptation.
- Values:
- TYPE_UNSPECIFIED (0):
Unspecified license for the OS.
- NONE (1):
No license available for the OS.
- PAYG (2):
The license type is Pay As You Go license type.
- BYOL (3):
The license type is Bring Your Own License type.
- class google.cloud.vmmigration_v1.types.AvailableUpdates(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHolds informatiom about the available versions for upgrade.
- new_deployable_appliance¶
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.
- in_place_update¶
The latest version for in place update. The current appliance can be updated to this version using the API or m4c CLI.
- class google.cloud.vmmigration_v1.types.AwsSecurityGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAwsSecurityGroup describes a security group of an AWS VM.
- class google.cloud.vmmigration_v1.types.AwsSourceDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAwsSourceDetails message describes a specific source details for the AWS source type.
- access_key_creds¶
AWS Credentials using access key id and secret.
This field is a member of oneof
credentials_type.
- state¶
Output only. State of the source as determined by the health check.
- error¶
Output only. Provides details on the state of the Source in case of an error.
- Type
google.rpc.status_pb2.Status
- inventory_tag_list¶
AWS resource tags to limit the scope of the source inventory.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.AwsSourceDetails.Tag]
- inventory_security_group_names¶
AWS security group names to limit the scope of the source inventory.
- Type
MutableSequence[str]
- migration_resources_user_tags¶
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.
- public_ip¶
Output only. The source’s public IP. All communication initiated by this source will originate from this IP.
- Type
- class AccessKeyCredentials(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage describing AWS Credentials using access key id and secret.
- class MigrationResourcesUserTagsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class State(value)[source]¶
Bases:
proto.enums.EnumThe possible values of the state.
- Values:
- STATE_UNSPECIFIED (0):
The state is unknown. This is used for API compatibility only and is not used by the system.
- PENDING (1):
The state was not sampled by the health checks yet.
- FAILED (2):
The source is available but might not be usable yet due to invalid credentials or another reason. The error message will contain further details.
- ACTIVE (3):
The source exists and its credentials were verified.
- class google.cloud.vmmigration_v1.types.AwsSourceVmDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresent the source AWS VM details.
- firmware¶
The firmware type of the source VM.
- class Firmware(value)[source]¶
Bases:
proto.enums.EnumPossible values for AWS VM firmware.
- Values:
- FIRMWARE_UNSPECIFIED (0):
The firmware is unknown.
- EFI (1):
The firmware is EFI.
- BIOS (2):
The firmware is BIOS.
- class google.cloud.vmmigration_v1.types.AwsVmDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAwsVmDetails describes a VM in AWS.
- power_state¶
Output only. The power state of the VM at the moment list was taken.
- boot_option¶
The VM Boot Option.
- security_groups¶
The security groups the VM belongs to.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.AwsSecurityGroup]
- virtualization_type¶
The virtualization type.
- architecture¶
The CPU architecture.
- class BootOption(value)[source]¶
Bases:
proto.enums.EnumThe possible values for the vm boot option.
- Values:
- BOOT_OPTION_UNSPECIFIED (0):
The boot option is unknown.
- EFI (1):
The boot option is UEFI.
- BIOS (2):
The boot option is LEGACY-BIOS.
- class PowerState(value)[source]¶
Bases:
proto.enums.EnumPossible values for the power state of the VM.
- Values:
- POWER_STATE_UNSPECIFIED (0):
Power state is not specified.
- ON (1):
The VM is turned on.
- OFF (2):
The VM is turned off.
- SUSPENDED (3):
The VM is suspended. This is similar to hibernation or sleep mode.
- PENDING (4):
The VM is starting.
- class TagsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class VmArchitecture(value)[source]¶
Bases:
proto.enums.EnumPossible values for the architectures of the VM.
- Values:
- VM_ARCHITECTURE_UNSPECIFIED (0):
The architecture is unknown.
- I386 (1):
The architecture is I386.
- X86_64 (2):
The architecture is X86_64.
- ARM64 (3):
The architecture is ARM64.
- X86_64_MAC (4):
The architecture is X86_64_MAC.
- class VmVirtualizationType(value)[source]¶
Bases:
proto.enums.EnumPossible values for the virtualization types of the VM.
- Values:
- VM_VIRTUALIZATION_TYPE_UNSPECIFIED (0):
The virtualization type is unknown.
- HVM (1):
The virtualziation type is HVM.
- PARAVIRTUAL (2):
The virtualziation type is PARAVIRTUAL.
- class google.cloud.vmmigration_v1.types.AwsVmsDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAWSVmsDetails describes VMs in AWS.
- details¶
The details of the AWS VMs.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.AwsVmDetails]
- class google.cloud.vmmigration_v1.types.CancelCloneJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CancelCloneJob’ request.
- class google.cloud.vmmigration_v1.types.CancelCloneJobResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘CancelCloneJob’ request.
- class google.cloud.vmmigration_v1.types.CancelCutoverJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CancelCutoverJob’ request.
- class google.cloud.vmmigration_v1.types.CancelCutoverJobResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘CancelCutoverJob’ request.
- class google.cloud.vmmigration_v1.types.CloneJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCloneJob describes the process of creating a clone of a [MigratingVM][google.cloud.vmmigration.v1.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.
- compute_engine_target_details¶
Output only. Details of the target VM in Compute Engine.
This field is a member of oneof
target_vm_details.
- create_time¶
Output only. The time the clone job was created (as an API call, not when it was actually created in the target).
- end_time¶
Output only. The time the clone job was ended.
- state¶
Output only. State of the clone job.
- state_time¶
Output only. The time the state was last updated.
- error¶
Output only. Provides details for the errors that led to the Clone Job’s state.
- Type
google.rpc.status_pb2.Status
- steps¶
Output only. The clone steps list representing its progress.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.CloneStep]
- class State(value)[source]¶
Bases:
proto.enums.EnumPossible states of the clone job.
- Values:
- STATE_UNSPECIFIED (0):
The state is unknown. This is used for API compatibility only and is not used by the system.
- PENDING (1):
The clone job has not yet started.
- ACTIVE (2):
The clone job is active and running.
- FAILED (3):
The clone job finished with errors.
- SUCCEEDED (4):
The clone job finished successfully.
- CANCELLED (5):
The clone job was cancelled.
- CANCELLING (6):
The clone job is being cancelled.
- ADAPTING_OS (7):
OS adaptation is running as part of the clone job to generate license.
- class google.cloud.vmmigration_v1.types.CloneStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCloneStep holds information about the clone step progress.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- start_time¶
The time the step has started.
- end_time¶
The time the step has ended.
- class google.cloud.vmmigration_v1.types.ComputeEngineBootOption(value)[source]¶
Bases:
proto.enums.EnumPossible values for vm boot option.
- Values:
- COMPUTE_ENGINE_BOOT_OPTION_UNSPECIFIED (0):
The boot option is unknown.
- COMPUTE_ENGINE_BOOT_OPTION_EFI (1):
The boot option is EFI.
- COMPUTE_ENGINE_BOOT_OPTION_BIOS (2):
The boot option is BIOS.
- class google.cloud.vmmigration_v1.types.ComputeEngineDiskType(value)[source]¶
Bases:
proto.enums.EnumTypes of disks supported for Compute Engine VM.
- Values:
- COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED (0):
An unspecified disk type. Will be used as STANDARD.
- COMPUTE_ENGINE_DISK_TYPE_STANDARD (1):
A Standard disk type.
- COMPUTE_ENGINE_DISK_TYPE_SSD (2):
SSD hard disk type.
- COMPUTE_ENGINE_DISK_TYPE_BALANCED (3):
An alternative to SSD persistent disks that balance performance and cost.
- class google.cloud.vmmigration_v1.types.ComputeEngineLicenseType(value)[source]¶
Bases:
proto.enums.EnumTypes of licenses used in OS adaptation.
- Values:
- COMPUTE_ENGINE_LICENSE_TYPE_DEFAULT (0):
The license type is the default for the OS.
- COMPUTE_ENGINE_LICENSE_TYPE_PAYG (1):
The license type is Pay As You Go license type.
- COMPUTE_ENGINE_LICENSE_TYPE_BYOL (2):
The license type is Bring Your Own License type.
- class google.cloud.vmmigration_v1.types.ComputeEngineTargetDefaults(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project.
- target_project¶
The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.
- Type
- network_interfaces¶
List of NICs connected to this VM.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.NetworkInterface]
- disk_type¶
The disk type to use in the VM.
- license_type¶
The license type to use in OS adaptation.
- applied_license¶
Output only. The OS license returned from the adaptation module report.
- compute_scheduling¶
Compute instance scheduling information (if empty default is used).
- secure_boot¶
Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
- Type
- boot_option¶
Output only. The VM Boot Option, as set in the source vm.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.vmmigration_v1.types.ComputeEngineTargetDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project.
- network_interfaces¶
List of NICs connected to this VM.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.NetworkInterface]
- disk_type¶
The disk type to use in the VM.
- license_type¶
The license type to use in OS adaptation.
- applied_license¶
The OS license returned from the adaptation module report.
- compute_scheduling¶
Compute instance scheduling information (if empty default is used).
- secure_boot¶
Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
- Type
- boot_option¶
The VM Boot Option, as set in the source vm.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.vmmigration_v1.types.ComputeScheduling(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageScheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes.
- on_host_maintenance¶
How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
- restart_type¶
Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to
automaticRestartfield 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.
- node_affinities¶
A set of node affinity and anti-affinity configurations for sole tenant nodes.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.SchedulingNodeAffinity]
- min_node_cpus¶
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
- class OnHostMaintenance(value)[source]¶
Bases:
proto.enums.Enum- Values:
- ON_HOST_MAINTENANCE_UNSPECIFIED (0):
An unknown, unexpected behavior.
- TERMINATE (1):
Terminate the instance when the host machine undergoes maintenance.
- MIGRATE (2):
Migrate the instance when the host machine undergoes maintenance.
- class RestartType(value)[source]¶
Bases:
proto.enums.EnumDefines whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- Values:
- RESTART_TYPE_UNSPECIFIED (0):
Unspecified behavior. This will use the default.
- AUTOMATIC_RESTART (1):
The Instance should be automatically restarted whenever it is terminated by Compute Engine.
- NO_AUTOMATIC_RESTART (2):
The Instance isn’t automatically restarted whenever it is terminated by Compute Engine.
- class google.cloud.vmmigration_v1.types.CreateCloneJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CreateCloneJob’ request.
- clone_job¶
Required. The clone request body.
- request_id¶
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 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).
- Type
- class google.cloud.vmmigration_v1.types.CreateCutoverJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CreateCutoverJob’ request.
- cutover_job¶
Required. The cutover request body.
- request_id¶
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 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).
- Type
- class google.cloud.vmmigration_v1.types.CreateDatacenterConnectorRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CreateDatacenterConnector’ request.
- parent¶
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
- datacenter_connector¶
Required. The create request body.
- request_id¶
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 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).
- Type
- class google.cloud.vmmigration_v1.types.CreateGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CreateGroup’ request.
- group¶
Required. The create request body.
- request_id¶
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 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).
- Type
- class google.cloud.vmmigration_v1.types.CreateMigratingVmRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CreateMigratingVm’ request.
- migrating_vm¶
Required. The create request body.
- request_id¶
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 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).
- Type
- class google.cloud.vmmigration_v1.types.CreateSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CreateSource’ request.
- source¶
Required. The create request body.
- request_id¶
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 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).
- Type
- class google.cloud.vmmigration_v1.types.CreateTargetProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CreateTargetProject’ request.
- target_project¶
Required. The create request body.
- request_id¶
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 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).
- Type
- class google.cloud.vmmigration_v1.types.CreateUtilizationReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CreateUtilizationReport’ request.
- utilization_report¶
Required. The report to create.
- utilization_report_id¶
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][0-9]-/. It must start with an english letter and must not end with a hyphen.
- Type
- request_id¶
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 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).
- Type
- class google.cloud.vmmigration_v1.types.CutoverJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCutoverJob 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.
- compute_engine_target_details¶
Output only. Details of the target VM in Compute Engine.
This field is a member of oneof
target_vm_details.
- create_time¶
Output only. The time the cutover job was created (as an API call, not when it was actually created in the target).
- end_time¶
Output only. The time the cutover job had finished.
- state¶
Output only. State of the cutover job.
- state_time¶
Output only. The time the state was last updated.
- error¶
Output only. Provides details for the errors that led to the Cutover Job’s state.
- Type
google.rpc.status_pb2.Status
- state_message¶
Output only. A message providing possible extra details about the current state.
- Type
- steps¶
Output only. The cutover steps list representing its progress.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.CutoverStep]
- class State(value)[source]¶
Bases:
proto.enums.EnumPossible states of the cutover job.
- Values:
- STATE_UNSPECIFIED (0):
The state is unknown. This is used for API compatibility only and is not used by the system.
- PENDING (1):
The cutover job has not yet started.
- FAILED (2):
The cutover job finished with errors.
- SUCCEEDED (3):
The cutover job finished successfully.
- CANCELLED (4):
The cutover job was cancelled.
- CANCELLING (5):
The cutover job is being cancelled.
- ACTIVE (6):
The cutover job is active and running.
- ADAPTING_OS (7):
OS adaptation is running as part of the cutover job to generate license.
- class google.cloud.vmmigration_v1.types.CutoverStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCutoverStep holds information about the cutover step progress.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- previous_replication_cycle¶
A replication cycle prior cutover step.
This field is a member of oneof
step.
- start_time¶
The time the step has started.
- end_time¶
The time the step has ended.
- class google.cloud.vmmigration_v1.types.CycleStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCycleStep holds information about a step progress.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- start_time¶
The time the cycle step has started.
- end_time¶
The time the cycle step has ended.
- class google.cloud.vmmigration_v1.types.DatacenterConnector(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDatacenterConnector 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.
- create_time¶
Output only. The time the connector was created (as an API call, not when it was actually installed).
- update_time¶
Output only. The last time the connector was updated with an API call.
- registration_id¶
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.
- Type
- service_account¶
The service account to use in the connector when communicating with the cloud.
- Type
- version¶
The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified.
- Type
- bucket¶
Output only. The communication channel between the datacenter connector and Google Cloud.
- Type
- state¶
Output only. State of the DatacenterConnector, as determined by the health checks.
- state_time¶
Output only. The time the state was last set.
- error¶
Output only. Provides details on the state of the Datacenter Connector in case of an error.
- Type
google.rpc.status_pb2.Status
- appliance_infrastructure_version¶
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.
- Type
- appliance_software_version¶
Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance.
- Type
- available_versions¶
Output only. The available versions for updating this appliance.
- upgrade_status¶
Output only. The status of the current / last upgradeAppliance operation.
- class State(value)[source]¶
Bases:
proto.enums.EnumThe possible values of the state.
- Values:
- STATE_UNSPECIFIED (0):
The state is unknown. This is used for API compatibility only and is not used by the system.
- PENDING (1):
The state was not sampled by the health checks yet.
- OFFLINE (2):
The source was sampled by health checks and is not available.
- FAILED (3):
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.
- ACTIVE (4):
The source exists and its credentials were verified.
- class google.cloud.vmmigration_v1.types.DeleteDatacenterConnectorRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘DeleteDatacenterConnector’ request.
- request_id¶
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).
- Type
- class google.cloud.vmmigration_v1.types.DeleteGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘DeleteGroup’ request.
- request_id¶
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).
- Type
- class google.cloud.vmmigration_v1.types.DeleteMigratingVmRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘DeleteMigratingVm’ request.
- class google.cloud.vmmigration_v1.types.DeleteSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘DeleteSource’ request.
- request_id¶
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).
- Type
- class google.cloud.vmmigration_v1.types.DeleteTargetProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘DeleteTargetProject’ request.
- request_id¶
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).
- Type
- class google.cloud.vmmigration_v1.types.DeleteUtilizationReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘DeleteUtilizationReport’ request.
- request_id¶
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).
- Type
- class google.cloud.vmmigration_v1.types.FetchInventoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [fetchInventory][google.cloud.vmmigration.v1.VmMigration.FetchInventory].
- class google.cloud.vmmigration_v1.types.FetchInventoryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [fetchInventory][google.cloud.vmmigration.v1.VmMigration.FetchInventory].
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- vmware_vms¶
The description of the VMs in a Source of type Vmware.
This field is a member of oneof
SourceVms.
- aws_vms¶
The description of the VMs in a Source of type AWS.
This field is a member of oneof
SourceVms.
- update_time¶
Output only. The timestamp when the source was last queried (if the result is from the cache).
- class google.cloud.vmmigration_v1.types.FinalizeMigrationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘FinalizeMigration’ request.
- class google.cloud.vmmigration_v1.types.FinalizeMigrationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘FinalizeMigration’ request.
- class google.cloud.vmmigration_v1.types.GetCloneJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetCloneJob’ request.
- class google.cloud.vmmigration_v1.types.GetCutoverJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetCutoverJob’ request.
- class google.cloud.vmmigration_v1.types.GetDatacenterConnectorRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetDatacenterConnector’ request.
- class google.cloud.vmmigration_v1.types.GetGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetGroup’ request.
- class google.cloud.vmmigration_v1.types.GetMigratingVmRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetMigratingVm’ request.
- view¶
Optional. The level of details of the migrating VM.
- class google.cloud.vmmigration_v1.types.GetReplicationCycleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetReplicationCycle’ request.
- class google.cloud.vmmigration_v1.types.GetSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetSource’ request.
- class google.cloud.vmmigration_v1.types.GetTargetProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetTargetProject’ call.
- class google.cloud.vmmigration_v1.types.GetUtilizationReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetUtilizationReport’ request.
- view¶
Optional. The level of details of the report. Defaults to FULL
- class google.cloud.vmmigration_v1.types.Group(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes message for ‘Group’ resource. The Group is a collections of several MigratingVms.
- create_time¶
Output only. The create time timestamp.
- update_time¶
Output only. The update time timestamp.
- class google.cloud.vmmigration_v1.types.InitializingReplicationStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInitializingReplicationStep contains specific step details.
- class google.cloud.vmmigration_v1.types.InstantiatingMigratedVMStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInstantiatingMigratedVMStep contains specific step details.
- class google.cloud.vmmigration_v1.types.ListCloneJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ListCloneJobsRequest’ request.
- page_size¶
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.
- Type
- page_token¶
Required. A page token, received from a previous
ListCloneJobscall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListCloneJobsmust match the call that provided the page token.- Type
- class google.cloud.vmmigration_v1.types.ListCloneJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListCloneJobs’ request.
- clone_jobs¶
Output only. The list of clone jobs response.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.CloneJob]
- next_page_token¶
Output only. A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.vmmigration_v1.types.ListCutoverJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ListCutoverJobsRequest’ request.
- page_size¶
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
- page_token¶
Required. A page token, received from a previous
ListCutoverJobscall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListCutoverJobsmust match the call that provided the page token.- Type
- class google.cloud.vmmigration_v1.types.ListCutoverJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListCutoverJobs’ request.
- cutover_jobs¶
Output only. The list of cutover jobs response.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.CutoverJob]
- next_page_token¶
Output only. A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.vmmigration_v1.types.ListDatacenterConnectorsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ListDatacenterConnectors’ request.
- page_size¶
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.
- Type
- page_token¶
Required. A page token, received from a previous
ListDatacenterConnectorscall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListDatacenterConnectorsmust match the call that provided the page token.- Type
- class google.cloud.vmmigration_v1.types.ListDatacenterConnectorsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListDatacenterConnectors’ request.
- datacenter_connectors¶
Output only. The list of sources response.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.DatacenterConnector]
- next_page_token¶
Output only. A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.vmmigration_v1.types.ListGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ListGroups’ request.
- page_size¶
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
- page_token¶
Required. A page token, received from a previous
ListGroupscall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListGroupsmust match the call that provided the page token.- Type
- class google.cloud.vmmigration_v1.types.ListGroupsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListGroups’ request.
- groups¶
Output only. The list of groups response.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.Group]
- next_page_token¶
Output only. A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.vmmigration_v1.types.ListMigratingVmsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘LisMigratingVmsRequest’ request.
- page_size¶
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.
- Type
- page_token¶
Required. A page token, received from a previous
ListMigratingVmscall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListMigratingVmsmust match the call that provided the page token.- Type
- view¶
Optional. The level of details of each migrating VM.
- class google.cloud.vmmigration_v1.types.ListMigratingVmsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListMigratingVms’ request.
- migrating_vms¶
Output only. The list of Migrating VMs response.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.MigratingVm]
- next_page_token¶
Output only. A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.vmmigration_v1.types.ListReplicationCyclesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘LisReplicationCyclesRequest’ request.
- page_size¶
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.
- Type
- page_token¶
Required. A page token, received from a previous
ListReplicationCyclescall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListReplicationCyclesmust match the call that provided the page token.- Type
- class google.cloud.vmmigration_v1.types.ListReplicationCyclesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListReplicationCycles’ request.
- replication_cycles¶
Output only. The list of replication cycles response.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.ReplicationCycle]
- next_page_token¶
Output only. A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.vmmigration_v1.types.ListSourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ListSources’ request.
- page_size¶
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.
- Type
- page_token¶
Required. A page token, received from a previous
ListSourcescall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListSourcesmust match the call that provided the page token.- Type
- class google.cloud.vmmigration_v1.types.ListSourcesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListSources’ request.
- sources¶
Output only. The list of sources response.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.Source]
- next_page_token¶
Output only. A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.vmmigration_v1.types.ListTargetProjectsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ListTargetProjects’ call.
- page_size¶
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
- page_token¶
Required. A page token, received from a previous
ListTargetscall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListTargetsmust match the call that provided the page token.- Type
- class google.cloud.vmmigration_v1.types.ListTargetProjectsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListTargetProjects’ call.
- target_projects¶
Output only. The list of target response.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.TargetProject]
- next_page_token¶
Output only. A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.vmmigration_v1.types.ListUtilizationReportsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ListUtilizationReports’ request.
- view¶
Optional. The level of details of each report. Defaults to BASIC.
- page_size¶
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.
- Type
- page_token¶
Required. A page token, received from a previous
ListUtilizationReportscall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListUtilizationReportsmust match the call that provided the page token.- Type
- class google.cloud.vmmigration_v1.types.ListUtilizationReportsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListUtilizationReports’ request.
- utilization_reports¶
Output only. The list of reports.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.UtilizationReport]
- next_page_token¶
Output only. A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.vmmigration_v1.types.MigratingVm(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMigratingVm describes the VM that will be migrated from a Source environment and its replication state.
- compute_engine_target_defaults¶
Details of the target VM in Compute Engine.
This field is a member of oneof
target_vm_defaults.
- aws_source_vm_details¶
Output only. Details of the VM from an AWS source.
This field is a member of oneof
source_vm_details.
- source_vm_id¶
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-<num>.
- Type
- policy¶
The replication schedule policy.
- create_time¶
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).
- update_time¶
Output only. The last time the migrating VM resource was updated.
- last_sync¶
Output only. The most updated snapshot created time in the source that finished replication.
- state¶
Output only. State of the MigratingVm.
- state_time¶
Output only. The last time the migrating VM state was updated.
- current_sync_info¶
Output only. The percentage progress of the current running replication cycle.
- group¶
Output only. The group this migrating vm is included in, if any. The group is represented by the full path of the appropriate [Group][google.cloud.vmmigration.v1.Group] resource.
- Type
- recent_clone_jobs¶
Output only. The recent [clone jobs][google.cloud.vmmigration.v1.CloneJob] 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.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.CloneJob]
- error¶
Output only. Provides details on the state of the Migrating VM in case of an error in replication.
- Type
google.rpc.status_pb2.Status
- recent_cutover_jobs¶
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
MutableSequence[google.cloud.vmmigration_v1.types.CutoverJob]
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class State(value)[source]¶
Bases:
proto.enums.EnumThe possible values of the state/health of source VM.
- Values:
- STATE_UNSPECIFIED (0):
The state was not sampled by the health checks yet.
- PENDING (1):
The VM in the source is being verified.
- READY (2):
The source VM was verified, and it’s ready to start replication.
- FIRST_SYNC (3):
Migration is going through the first sync cycle.
- ACTIVE (4):
The replication is active, and it’s running or scheduled to run.
- CUTTING_OVER (7):
The source VM is being turned off, and a final replication is currently running.
- CUTOVER (8):
The source VM was stopped and replicated. The replication is currently paused.
- FINAL_SYNC (9):
A cutover job is active and replication cycle is running the final sync.
- PAUSED (10):
The replication was paused by the user and no cycles are scheduled to run.
- FINALIZING (11):
The migrating VM is being finalized and migration resources are being removed.
- FINALIZED (12):
The replication process is done. The migrating VM is finalized and no longer consumes billable resources.
- ERROR (13):
The replication process encountered an unrecoverable error and was aborted.
- class google.cloud.vmmigration_v1.types.MigratingVmView(value)[source]¶
Bases:
proto.enums.EnumControls the level of details of a Migrating VM.
- Values:
- MIGRATING_VM_VIEW_UNSPECIFIED (0):
View is unspecified. The API will fallback to the default value.
- MIGRATING_VM_VIEW_BASIC (1):
Get the migrating VM basic details. The basic details do not include the recent clone jobs and recent cutover jobs lists.
- MIGRATING_VM_VIEW_FULL (2):
Include everything.
- class google.cloud.vmmigration_v1.types.MigrationError(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents 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.
- code¶
Output only. The error code.
- error_message¶
Output only. The localized error message.
- Type
google.rpc.error_details_pb2.LocalizedMessage
- action_item¶
Output only. Suggested action for solving the error.
- Type
google.rpc.error_details_pb2.LocalizedMessage
- help_links¶
Output only. URL(s) pointing to additional information on handling the current error.
- Type
MutableSequence[google.rpc.error_details_pb2.Link]
- error_time¶
Output only. The time the error occurred.
- class ErrorCode(value)[source]¶
Bases:
proto.enums.EnumRepresents resource error codes.
- Values:
- ERROR_CODE_UNSPECIFIED (0):
Default value. This value is not used.
- UNKNOWN_ERROR (1):
Migrate for Compute encountered an unknown error.
- SOURCE_VALIDATION_ERROR (2):
Migrate for Compute encountered an error while validating replication source health.
- SOURCE_REPLICATION_ERROR (3):
Migrate for Compute encountered an error during source data operation.
- TARGET_REPLICATION_ERROR (4):
Migrate for Compute encountered an error during target data operation.
- OS_ADAPTATION_ERROR (5):
Migrate for Compute encountered an error during OS adaptation.
- CLONE_ERROR (6):
Migrate for Compute encountered an error in clone operation.
- CUTOVER_ERROR (7):
Migrate for Compute encountered an error in cutover operation.
- UTILIZATION_REPORT_ERROR (8):
Migrate for Compute encountered an error during utilization report creation.
- APPLIANCE_UPGRADE_ERROR (9):
Migrate for Compute encountered an error during appliance upgrade.
- class google.cloud.vmmigration_v1.types.NetworkInterface(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNetworkInterface represents a NIC of a VM.
- internal_ip¶
The internal IP to define in the NIC. The formats accepted are:
ephemeral\ ipv4 address \ a named address resource full path.- Type
- class google.cloud.vmmigration_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the metadata of the long-running operation.
- create_time¶
Output only. The time the operation was created.
- end_time¶
Output only. The time the operation finished running.
- requested_cancellation¶
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][google.rpc.Status.code] of 1, corresponding to
Code.CANCELLED.- Type
- class google.cloud.vmmigration_v1.types.PauseMigrationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘PauseMigration’ request.
- class google.cloud.vmmigration_v1.types.PauseMigrationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘PauseMigration’ request.
- class google.cloud.vmmigration_v1.types.PostProcessingStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePostProcessingStep contains specific step details.
- class google.cloud.vmmigration_v1.types.PreparingVMDisksStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePreparingVMDisksStep contains specific step details.
- class google.cloud.vmmigration_v1.types.RemoveGroupMigrationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘RemoveMigration’ request.
- class google.cloud.vmmigration_v1.types.RemoveGroupMigrationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘RemoveMigration’ request.
- class google.cloud.vmmigration_v1.types.ReplicatingStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReplicatingStep contains specific step details.
- last_two_minutes_average_bytes_per_second¶
The source disks replication rate for the last 2 minutes in bytes per second.
- Type
- class google.cloud.vmmigration_v1.types.ReplicationCycle(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReplicationCycle contains information about the current replication cycle status.
- start_time¶
The time the replication cycle has started.
- end_time¶
The time the replication cycle has ended.
- total_pause_duration¶
The accumulated duration the replication cycle was paused.
- progress_percent¶
The current progress in percentage of this cycle. Was replaced by ‘steps’ field, which breaks down the cycle progression more accurately.
- Type
- steps¶
The cycle’s steps list representing its progress.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.CycleStep]
- state¶
State of the ReplicationCycle.
- error¶
Provides details on the state of the cycle in case of an error.
- Type
google.rpc.status_pb2.Status
- class State(value)[source]¶
Bases:
proto.enums.EnumPossible states of a replication cycle.
- Values:
- STATE_UNSPECIFIED (0):
The state is unknown. This is used for API compatibility only and is not used by the system.
- RUNNING (1):
The replication cycle is running.
- PAUSED (2):
The replication cycle is paused.
- FAILED (3):
The replication cycle finished with errors.
- SUCCEEDED (4):
The replication cycle finished successfully.
- class google.cloud.vmmigration_v1.types.ReplicationSync(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReplicationSync contain information about the last replica sync to the cloud.
- last_sync_time¶
The most updated snapshot created time in the source that finished replication.
- class google.cloud.vmmigration_v1.types.ResumeMigrationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ResumeMigration’ request.
- class google.cloud.vmmigration_v1.types.ResumeMigrationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ResumeMigration’ request.
- class google.cloud.vmmigration_v1.types.SchedulePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA policy for scheduling replications.
- idle_duration¶
The idle duration between replication stages.
- class google.cloud.vmmigration_v1.types.SchedulingNodeAffinity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNode 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
- operator¶
The operator to use for the node resources specified in the
valuesparameter.
- class Operator(value)[source]¶
Bases:
proto.enums.EnumPossible types of node selection operators. Valid operators are IN for affinity and NOT_IN for anti-affinity.
- Values:
- OPERATOR_UNSPECIFIED (0):
An unknown, unexpected behavior.
- IN (1):
The node resource group should be in these resources affinity.
- NOT_IN (2):
The node resource group should not be in these resources affinity.
- class google.cloud.vmmigration_v1.types.ShuttingDownSourceVMStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageShuttingDownSourceVMStep contains specific step details.
- class google.cloud.vmmigration_v1.types.Source(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSource message describes a specific vm migration Source resource. It contains the source environment information.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- create_time¶
Output only. The create time timestamp.
- update_time¶
Output only. The update time timestamp.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.vmmigration_v1.types.StartMigrationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘StartMigrationRequest’ request.
- class google.cloud.vmmigration_v1.types.StartMigrationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘StartMigration’ request.
- class google.cloud.vmmigration_v1.types.TargetProject(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTargetProject message represents a target Compute Engine project for a migration or a clone.
- create_time¶
Output only. The time this target project resource was created (not related to when the Compute Engine project it points to was created).
- update_time¶
Output only. The last time the target project resource was updated.
- class google.cloud.vmmigration_v1.types.UpdateGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdate message for ‘UpdateGroups’ request.
- update_mask¶
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.
- group¶
Required. The update request body.
- request_id¶
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 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).
- Type
- class google.cloud.vmmigration_v1.types.UpdateMigratingVmRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘UpdateMigratingVm’ request.
- update_mask¶
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.
- migrating_vm¶
Required. The update request body.
- request_id¶
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 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).
- Type
- class google.cloud.vmmigration_v1.types.UpdateSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdate message for ‘UpdateSources’ request.
- update_mask¶
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.
- source¶
Required. The update request body.
- request_id¶
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 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).
- Type
- class google.cloud.vmmigration_v1.types.UpdateTargetProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdate message for ‘UpdateTargetProject’ request.
- update_mask¶
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.
- target_project¶
Required. The update request body.
- request_id¶
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 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).
- Type
- class google.cloud.vmmigration_v1.types.UpgradeApplianceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘UpgradeAppliance’ request.
- request_id¶
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).
- Type
- class google.cloud.vmmigration_v1.types.UpgradeApplianceResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘UpgradeAppliance’ request.
- class google.cloud.vmmigration_v1.types.UpgradeStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpgradeStatus contains information about upgradeAppliance operation.
- state¶
The state of the upgradeAppliance operation.
- error¶
Provides details on the state of the upgrade operation in case of an error.
- Type
google.rpc.status_pb2.Status
- start_time¶
The time the operation was started.
- class State(value)[source]¶
Bases:
proto.enums.EnumThe possible values of the state.
- Values:
- STATE_UNSPECIFIED (0):
The state was not sampled by the health checks yet.
- RUNNING (1):
The upgrade has started.
- FAILED (2):
The upgrade failed.
- SUCCEEDED (3):
The upgrade finished successfully.
- class google.cloud.vmmigration_v1.types.UtilizationReport(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUtilization report details the utilization (CPU, memory, etc.) of selected source VMs.
- state¶
Output only. Current state of the report.
- state_time¶
Output only. The time the state was last set.
- error¶
Output only. Provides details on the state of the report in case of an error.
- Type
google.rpc.status_pb2.Status
- create_time¶
Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed).
- time_frame¶
Time frame of the report.
- frame_end_time¶
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.
- vms¶
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
MutableSequence[google.cloud.vmmigration_v1.types.VmUtilizationInfo]
- class State(value)[source]¶
Bases:
proto.enums.EnumUtilization report state.
- Values:
- STATE_UNSPECIFIED (0):
The state is unknown. This value is not in use.
- CREATING (1):
The report is in the making.
- SUCCEEDED (2):
Report creation completed successfully.
- FAILED (3):
Report creation failed.
- class TimeFrame(value)[source]¶
Bases:
proto.enums.EnumReport time frame options.
- Values:
- TIME_FRAME_UNSPECIFIED (0):
The time frame was not specified and will default to WEEK.
- WEEK (1):
One week.
- MONTH (2):
One month.
- YEAR (3):
One year.
- class google.cloud.vmmigration_v1.types.UtilizationReportView(value)[source]¶
Bases:
proto.enums.EnumControls the level of details of a Utilization Report.
- Values:
- UTILIZATION_REPORT_VIEW_UNSPECIFIED (0):
The default / unset value. The API will default to FULL on single report request and BASIC for multiple reports request.
- BASIC (1):
Get the report metadata, without the list of VMs and their utilization info.
- FULL (2):
Include everything.
- class google.cloud.vmmigration_v1.types.VmUtilizationInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUtilization information of a single VM.
- vmware_vm_details¶
The description of the VM in a Source of type Vmware.
This field is a member of oneof
VmDetails.
- utilization¶
Utilization metrics for this VM.
- class google.cloud.vmmigration_v1.types.VmUtilizationMetrics(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUtilization metrics values for a single VM.
- network_throughput_max_kbps¶
Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
- Type
- class google.cloud.vmmigration_v1.types.VmwareSourceDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVmwareSourceDetails message describes a specific source details for the vmware source type.
- password¶
Input only. The credentials password. This is write only and can not be read in a GET operation.
- Type
- class google.cloud.vmmigration_v1.types.VmwareVmDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVmwareVmDetails describes a VM in vCenter.
- vm_id¶
The VM’s id in the source (note that this is not the MigratingVm’s id). This is the moref id of the VM.
- Type
- datacenter_description¶
The descriptive name of the vCenter’s datacenter this VM is contained in.
- Type
- power_state¶
The power state of the VM at the moment list was taken.
- guest_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.
- Type
- boot_option¶
Output only. The VM Boot Option.
- class BootOption(value)[source]¶
Bases:
proto.enums.EnumPossible values for vm boot option.
- Values:
- BOOT_OPTION_UNSPECIFIED (0):
The boot option is unknown.
- EFI (1):
The boot option is EFI.
- BIOS (2):
The boot option is BIOS.
- class PowerState(value)[source]¶
Bases:
proto.enums.EnumPossible values for the power state of the VM.
- Values:
- POWER_STATE_UNSPECIFIED (0):
Power state is not specified.
- ON (1):
The VM is turned ON.
- OFF (2):
The VM is turned OFF.
- SUSPENDED (3):
The VM is suspended. This is similar to hibernation or sleep mode.
- class google.cloud.vmmigration_v1.types.VmwareVmsDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVmwareVmsDetails describes VMs in vCenter.
- details¶
The details of the vmware VMs.
- Type
MutableSequence[google.cloud.vmmigration_v1.types.VmwareVmDetails]
