Migrate for Compute Engine V1 API - Class Google::Cloud::VMMigration::V1::VMMigration::Rest::Client (v0.9.0)

Reference documentation and code samples for the Migrate for Compute Engine V1 API class Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.

REST client for the VmMigration service.

VM Migration Service

Inherits

Object

Includes

Google::Cloud::VMMigration::V1::VMMigration::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the VmMigration Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all VmMigration clients
::Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#add_group_migration

def add_group_migration(request, options = nil) -> ::Gapic::Operation
def add_group_migration(group: nil, migrating_vm: nil) -> ::Gapic::Operation

Adds a MigratingVm to a Group.

Overloads

def add_group_migration(request, options = nil) -> ::Gapic::Operation

Pass arguments to add_group_migration via a request object, either of type AddGroupMigrationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::AddGroupMigrationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def add_group_migration(group: nil, migrating_vm: nil) -> ::Gapic::Operation

Pass arguments to add_group_migration via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

group (::String) — Required. The full path name of the Group to add to.
migrating_vm (::String) — The full path name of the MigratingVm to add.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::AddGroupMigrationRequest.new

# Call the add_group_migration method.
result = client.add_group_migration request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#cancel_clone_job

def cancel_clone_job(request, options = nil) -> ::Gapic::Operation
def cancel_clone_job(name: nil) -> ::Gapic::Operation

Initiates the cancellation of a running clone job.

Overloads

def cancel_clone_job(request, options = nil) -> ::Gapic::Operation

Pass arguments to cancel_clone_job via a request object, either of type CancelCloneJobRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::CancelCloneJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def cancel_clone_job(name: nil) -> ::Gapic::Operation

Pass arguments to cancel_clone_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The clone job id

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::CancelCloneJobRequest.new

# Call the cancel_clone_job method.
result = client.cancel_clone_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#cancel_cutover_job

def cancel_cutover_job(request, options = nil) -> ::Gapic::Operation
def cancel_cutover_job(name: nil) -> ::Gapic::Operation

Initiates the cancellation of a running cutover job.

Overloads

def cancel_cutover_job(request, options = nil) -> ::Gapic::Operation

Pass arguments to cancel_cutover_job via a request object, either of type CancelCutoverJobRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::CancelCutoverJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def cancel_cutover_job(name: nil) -> ::Gapic::Operation

Pass arguments to cancel_cutover_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The cutover job id

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::CancelCutoverJobRequest.new

# Call the cancel_cutover_job method.
result = client.cancel_cutover_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the VmMigration Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_clone_job

def create_clone_job(request, options = nil) -> ::Gapic::Operation
def create_clone_job(parent: nil, clone_job_id: nil, clone_job: nil, request_id: nil) -> ::Gapic::Operation

Initiates a Clone of a specific migrating VM.

Overloads

def create_clone_job(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_clone_job via a request object, either of type CreateCloneJobRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::CreateCloneJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_clone_job(parent: nil, clone_job_id: nil, clone_job: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_clone_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The Clone's parent.
clone_job_id (::String) — Required. The clone job identifier.
clone_job (::Google::Cloud::VMMigration::V1::CloneJob, ::Hash) — Required. The clone request body.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::CreateCloneJobRequest.new

# Call the create_clone_job method.
result = client.create_clone_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_cutover_job

def create_cutover_job(request, options = nil) -> ::Gapic::Operation
def create_cutover_job(parent: nil, cutover_job_id: nil, cutover_job: nil, request_id: nil) -> ::Gapic::Operation

Initiates a Cutover of a specific migrating VM. The returned LRO is completed when the cutover job resource is created and the job is initiated.

Overloads

def create_cutover_job(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_cutover_job via a request object, either of type CreateCutoverJobRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::CreateCutoverJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_cutover_job(parent: nil, cutover_job_id: nil, cutover_job: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_cutover_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The Cutover's parent.
cutover_job_id (::String) — Required. The cutover job identifier.
cutover_job (::Google::Cloud::VMMigration::V1::CutoverJob, ::Hash) — Required. The cutover request body.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::CreateCutoverJobRequest.new

# Call the create_cutover_job method.
result = client.create_cutover_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_datacenter_connector

def create_datacenter_connector(request, options = nil) -> ::Gapic::Operation
def create_datacenter_connector(parent: nil, datacenter_connector_id: nil, datacenter_connector: nil, request_id: nil) -> ::Gapic::Operation

Creates a new DatacenterConnector in a given Source.

Overloads

def create_datacenter_connector(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_datacenter_connector via a request object, either of type CreateDatacenterConnectorRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::CreateDatacenterConnectorRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_datacenter_connector(parent: nil, datacenter_connector_id: nil, datacenter_connector: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_datacenter_connector via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — 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
datacenter_connector_id (::String) — Required. The datacenterConnector identifier.
datacenter_connector (::Google::Cloud::VMMigration::V1::DatacenterConnector, ::Hash) — Required. The create request body.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::CreateDatacenterConnectorRequest.new

# Call the create_datacenter_connector method.
result = client.create_datacenter_connector request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_group

def create_group(request, options = nil) -> ::Gapic::Operation
def create_group(parent: nil, group_id: nil, group: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Group in a given project and location.

Overloads

def create_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_group via a request object, either of type CreateGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::CreateGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_group(parent: nil, group_id: nil, group: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The Group's parent.
group_id (::String) — Required. The group identifier.
group (::Google::Cloud::VMMigration::V1::Group, ::Hash) — Required. The create request body.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::CreateGroupRequest.new

# Call the create_group method.
result = client.create_group request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_migrating_vm

def create_migrating_vm(request, options = nil) -> ::Gapic::Operation
def create_migrating_vm(parent: nil, migrating_vm_id: nil, migrating_vm: nil, request_id: nil) -> ::Gapic::Operation

Creates a new MigratingVm in a given Source.

Overloads

def create_migrating_vm(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_migrating_vm via a request object, either of type CreateMigratingVmRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::CreateMigratingVmRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_migrating_vm(parent: nil, migrating_vm_id: nil, migrating_vm: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_migrating_vm via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The MigratingVm's parent.
migrating_vm_id (::String) — Required. The migratingVm identifier.
migrating_vm (::Google::Cloud::VMMigration::V1::MigratingVm, ::Hash) — Required. The create request body.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::CreateMigratingVmRequest.new

# Call the create_migrating_vm method.
result = client.create_migrating_vm request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_source

def create_source(request, options = nil) -> ::Gapic::Operation
def create_source(parent: nil, source_id: nil, source: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Source in a given project and location.

Overloads

def create_source(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_source via a request object, either of type CreateSourceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::CreateSourceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_source(parent: nil, source_id: nil, source: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_source via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The Source's parent.
source_id (::String) — Required. The source identifier.
source (::Google::Cloud::VMMigration::V1::Source, ::Hash) — Required. The create request body.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::CreateSourceRequest.new

# Call the create_source method.
result = client.create_source request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_target_project

def create_target_project(request, options = nil) -> ::Gapic::Operation
def create_target_project(parent: nil, target_project_id: nil, target_project: nil, request_id: nil) -> ::Gapic::Operation

Creates a new TargetProject in a given project.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Overloads

def create_target_project(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_target_project via a request object, either of type CreateTargetProjectRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::CreateTargetProjectRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_target_project(parent: nil, target_project_id: nil, target_project: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_target_project via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The TargetProject's parent.
target_project_id (::String) — Required. The target_project identifier.
target_project (::Google::Cloud::VMMigration::V1::TargetProject, ::Hash) — Required. The create request body.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::CreateTargetProjectRequest.new

# Call the create_target_project method.
result = client.create_target_project request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_utilization_report

def create_utilization_report(request, options = nil) -> ::Gapic::Operation
def create_utilization_report(parent: nil, utilization_report: nil, utilization_report_id: nil, request_id: nil) -> ::Gapic::Operation

Creates a new UtilizationReport.

Overloads

def create_utilization_report(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_utilization_report via a request object, either of type CreateUtilizationReportRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::CreateUtilizationReportRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_utilization_report(parent: nil, utilization_report: nil, utilization_report_id: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_utilization_report via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The Utilization Report's parent.
utilization_report (::Google::Cloud::VMMigration::V1::UtilizationReport, ::Hash) — Required. The report to create.
utilization_report_id (::String) — 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.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::CreateUtilizationReportRequest.new

# Call the create_utilization_report method.
result = client.create_utilization_report request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_datacenter_connector

def delete_datacenter_connector(request, options = nil) -> ::Gapic::Operation
def delete_datacenter_connector(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single DatacenterConnector.

Overloads

def delete_datacenter_connector(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_datacenter_connector via a request object, either of type DeleteDatacenterConnectorRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::DeleteDatacenterConnectorRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_datacenter_connector(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_datacenter_connector via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The DatacenterConnector name.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::DeleteDatacenterConnectorRequest.new

# Call the delete_datacenter_connector method.
result = client.delete_datacenter_connector request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_group

def delete_group(request, options = nil) -> ::Gapic::Operation
def delete_group(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single Group.

Overloads

def delete_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_group via a request object, either of type DeleteGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::DeleteGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_group(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The Group name.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::DeleteGroupRequest.new

# Call the delete_group method.
result = client.delete_group request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_migrating_vm

def delete_migrating_vm(request, options = nil) -> ::Gapic::Operation
def delete_migrating_vm(name: nil) -> ::Gapic::Operation

Deletes a single MigratingVm.

Overloads

def delete_migrating_vm(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_migrating_vm via a request object, either of type DeleteMigratingVmRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::DeleteMigratingVmRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_migrating_vm(name: nil) -> ::Gapic::Operation

Pass arguments to delete_migrating_vm via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the MigratingVm.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::DeleteMigratingVmRequest.new

# Call the delete_migrating_vm method.
result = client.delete_migrating_vm request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_source

def delete_source(request, options = nil) -> ::Gapic::Operation
def delete_source(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single Source.

Overloads

def delete_source(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_source via a request object, either of type DeleteSourceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::DeleteSourceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_source(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_source via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The Source name.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::DeleteSourceRequest.new

# Call the delete_source method.
result = client.delete_source request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_target_project

def delete_target_project(request, options = nil) -> ::Gapic::Operation
def delete_target_project(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Overloads

def delete_target_project(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_target_project via a request object, either of type DeleteTargetProjectRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::DeleteTargetProjectRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_target_project(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_target_project via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The TargetProject name.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::DeleteTargetProjectRequest.new

# Call the delete_target_project method.
result = client.delete_target_project request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_utilization_report

def delete_utilization_report(request, options = nil) -> ::Gapic::Operation
def delete_utilization_report(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single Utilization Report.

Overloads

def delete_utilization_report(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_utilization_report via a request object, either of type DeleteUtilizationReportRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::DeleteUtilizationReportRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_utilization_report(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_utilization_report via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The Utilization Report name.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::DeleteUtilizationReportRequest.new

# Call the delete_utilization_report method.
result = client.delete_utilization_report request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#fetch_inventory

def fetch_inventory(request, options = nil) -> ::Google::Cloud::VMMigration::V1::FetchInventoryResponse
def fetch_inventory(source: nil, force_refresh: nil) -> ::Google::Cloud::VMMigration::V1::FetchInventoryResponse

List remote source's inventory of VMs. The remote source is the onprem vCenter (remote in the sense it's not in Compute Engine). The inventory describes the list of existing VMs in that source. Note that this operation lists the VMs on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.

Overloads

def fetch_inventory(request, options = nil) -> ::Google::Cloud::VMMigration::V1::FetchInventoryResponse

Pass arguments to fetch_inventory via a request object, either of type FetchInventoryRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::FetchInventoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def fetch_inventory(source: nil, force_refresh: nil) -> ::Google::Cloud::VMMigration::V1::FetchInventoryResponse

Pass arguments to fetch_inventory via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

source (::String) — Required. The name of the Source.
force_refresh (::Boolean) — If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::FetchInventoryResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::FetchInventoryResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::FetchInventoryRequest.new

# Call the fetch_inventory method.
result = client.fetch_inventory request

# The returned object is of type Google::Cloud::VMMigration::V1::FetchInventoryResponse.
p result

#finalize_migration

def finalize_migration(request, options = nil) -> ::Gapic::Operation
def finalize_migration(migrating_vm: nil) -> ::Gapic::Operation

Marks a migration as completed, deleting migration resources that are no longer being used. Only applicable after cutover is done.

Overloads

def finalize_migration(request, options = nil) -> ::Gapic::Operation

Pass arguments to finalize_migration via a request object, either of type FinalizeMigrationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::FinalizeMigrationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def finalize_migration(migrating_vm: nil) -> ::Gapic::Operation

Pass arguments to finalize_migration via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

migrating_vm (::String) — Required. The name of the MigratingVm.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::FinalizeMigrationRequest.new

# Call the finalize_migration method.
result = client.finalize_migration request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_clone_job

def get_clone_job(request, options = nil) -> ::Google::Cloud::VMMigration::V1::CloneJob
def get_clone_job(name: nil) -> ::Google::Cloud::VMMigration::V1::CloneJob

Gets details of a single CloneJob.

Overloads

def get_clone_job(request, options = nil) -> ::Google::Cloud::VMMigration::V1::CloneJob

Pass arguments to get_clone_job via a request object, either of type GetCloneJobRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::GetCloneJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_clone_job(name: nil) -> ::Google::Cloud::VMMigration::V1::CloneJob

Pass arguments to get_clone_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the CloneJob.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::CloneJob)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::CloneJob)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::GetCloneJobRequest.new

# Call the get_clone_job method.
result = client.get_clone_job request

# The returned object is of type Google::Cloud::VMMigration::V1::CloneJob.
p result

#get_cutover_job

def get_cutover_job(request, options = nil) -> ::Google::Cloud::VMMigration::V1::CutoverJob
def get_cutover_job(name: nil) -> ::Google::Cloud::VMMigration::V1::CutoverJob

Gets details of a single CutoverJob.

Overloads

def get_cutover_job(request, options = nil) -> ::Google::Cloud::VMMigration::V1::CutoverJob

Pass arguments to get_cutover_job via a request object, either of type GetCutoverJobRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::GetCutoverJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_cutover_job(name: nil) -> ::Google::Cloud::VMMigration::V1::CutoverJob

Pass arguments to get_cutover_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the CutoverJob.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::CutoverJob)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::CutoverJob)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::GetCutoverJobRequest.new

# Call the get_cutover_job method.
result = client.get_cutover_job request

# The returned object is of type Google::Cloud::VMMigration::V1::CutoverJob.
p result

#get_datacenter_connector

def get_datacenter_connector(request, options = nil) -> ::Google::Cloud::VMMigration::V1::DatacenterConnector
def get_datacenter_connector(name: nil) -> ::Google::Cloud::VMMigration::V1::DatacenterConnector

Gets details of a single DatacenterConnector.

Overloads

def get_datacenter_connector(request, options = nil) -> ::Google::Cloud::VMMigration::V1::DatacenterConnector

Pass arguments to get_datacenter_connector via a request object, either of type GetDatacenterConnectorRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::GetDatacenterConnectorRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_datacenter_connector(name: nil) -> ::Google::Cloud::VMMigration::V1::DatacenterConnector

Pass arguments to get_datacenter_connector via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the DatacenterConnector.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::DatacenterConnector)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::DatacenterConnector)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::GetDatacenterConnectorRequest.new

# Call the get_datacenter_connector method.
result = client.get_datacenter_connector request

# The returned object is of type Google::Cloud::VMMigration::V1::DatacenterConnector.
p result

#get_group

def get_group(request, options = nil) -> ::Google::Cloud::VMMigration::V1::Group
def get_group(name: nil) -> ::Google::Cloud::VMMigration::V1::Group

Gets details of a single Group.

Overloads

def get_group(request, options = nil) -> ::Google::Cloud::VMMigration::V1::Group

Pass arguments to get_group via a request object, either of type GetGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::GetGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_group(name: nil) -> ::Google::Cloud::VMMigration::V1::Group

Pass arguments to get_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The group name.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::Group)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::Group)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::GetGroupRequest.new

# Call the get_group method.
result = client.get_group request

# The returned object is of type Google::Cloud::VMMigration::V1::Group.
p result

#get_migrating_vm

def get_migrating_vm(request, options = nil) -> ::Google::Cloud::VMMigration::V1::MigratingVm
def get_migrating_vm(name: nil, view: nil) -> ::Google::Cloud::VMMigration::V1::MigratingVm

Gets details of a single MigratingVm.

Overloads

def get_migrating_vm(request, options = nil) -> ::Google::Cloud::VMMigration::V1::MigratingVm

Pass arguments to get_migrating_vm via a request object, either of type GetMigratingVmRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::GetMigratingVmRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_migrating_vm(name: nil, view: nil) -> ::Google::Cloud::VMMigration::V1::MigratingVm

Pass arguments to get_migrating_vm via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The name of the MigratingVm.
view (::Google::Cloud::VMMigration::V1::MigratingVmView) — Optional. The level of details of the migrating VM.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::MigratingVm)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::MigratingVm)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::GetMigratingVmRequest.new

# Call the get_migrating_vm method.
result = client.get_migrating_vm request

# The returned object is of type Google::Cloud::VMMigration::V1::MigratingVm.
p result

#get_replication_cycle

def get_replication_cycle(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ReplicationCycle
def get_replication_cycle(name: nil) -> ::Google::Cloud::VMMigration::V1::ReplicationCycle

Gets details of a single ReplicationCycle.

Overloads

def get_replication_cycle(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ReplicationCycle

Pass arguments to get_replication_cycle via a request object, either of type GetReplicationCycleRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::GetReplicationCycleRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_replication_cycle(name: nil) -> ::Google::Cloud::VMMigration::V1::ReplicationCycle

Pass arguments to get_replication_cycle via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the ReplicationCycle.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::ReplicationCycle)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::ReplicationCycle)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::GetReplicationCycleRequest.new

# Call the get_replication_cycle method.
result = client.get_replication_cycle request

# The returned object is of type Google::Cloud::VMMigration::V1::ReplicationCycle.
p result

#get_source

def get_source(request, options = nil) -> ::Google::Cloud::VMMigration::V1::Source
def get_source(name: nil) -> ::Google::Cloud::VMMigration::V1::Source

Gets details of a single Source.

Overloads

def get_source(request, options = nil) -> ::Google::Cloud::VMMigration::V1::Source

Pass arguments to get_source via a request object, either of type GetSourceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::GetSourceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_source(name: nil) -> ::Google::Cloud::VMMigration::V1::Source

Pass arguments to get_source via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The Source name.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::Source)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::Source)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::GetSourceRequest.new

# Call the get_source method.
result = client.get_source request

# The returned object is of type Google::Cloud::VMMigration::V1::Source.
p result

#get_target_project

def get_target_project(request, options = nil) -> ::Google::Cloud::VMMigration::V1::TargetProject
def get_target_project(name: nil) -> ::Google::Cloud::VMMigration::V1::TargetProject

Gets details of a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Overloads

def get_target_project(request, options = nil) -> ::Google::Cloud::VMMigration::V1::TargetProject

Pass arguments to get_target_project via a request object, either of type GetTargetProjectRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::GetTargetProjectRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_target_project(name: nil) -> ::Google::Cloud::VMMigration::V1::TargetProject

Pass arguments to get_target_project via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The TargetProject name.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::TargetProject)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::TargetProject)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::GetTargetProjectRequest.new

# Call the get_target_project method.
result = client.get_target_project request

# The returned object is of type Google::Cloud::VMMigration::V1::TargetProject.
p result

#get_utilization_report

def get_utilization_report(request, options = nil) -> ::Google::Cloud::VMMigration::V1::UtilizationReport
def get_utilization_report(name: nil, view: nil) -> ::Google::Cloud::VMMigration::V1::UtilizationReport

Gets a single Utilization Report.

Overloads

def get_utilization_report(request, options = nil) -> ::Google::Cloud::VMMigration::V1::UtilizationReport

Pass arguments to get_utilization_report via a request object, either of type GetUtilizationReportRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::GetUtilizationReportRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_utilization_report(name: nil, view: nil) -> ::Google::Cloud::VMMigration::V1::UtilizationReport

Pass arguments to get_utilization_report via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The Utilization Report name.
view (::Google::Cloud::VMMigration::V1::UtilizationReportView) — Optional. The level of details of the report. Defaults to FULL

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::UtilizationReport)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::UtilizationReport)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::GetUtilizationReportRequest.new

# Call the get_utilization_report method.
result = client.get_utilization_report request

# The returned object is of type Google::Cloud::VMMigration::V1::UtilizationReport.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Rest::Client

Get the associated client for mix-in of the IAMPolicy.

Returns

(Google::Iam::V1::IAMPolicy::Rest::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new VmMigration REST client object.

Yields

(config) — Configure the VmMigration client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_clone_jobs

def list_clone_jobs(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListCloneJobsResponse
def list_clone_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListCloneJobsResponse

Lists CloneJobs of a given migrating VM.

Overloads

def list_clone_jobs(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListCloneJobsResponse

Pass arguments to list_clone_jobs via a request object, either of type ListCloneJobsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::ListCloneJobsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_clone_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListCloneJobsResponse

Pass arguments to list_clone_jobs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of source VMs.
page_size (::Integer) — 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.
page_token (::String) — Required. A page token, received from a previous ListCloneJobs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCloneJobs must match the call that provided the page token.
filter (::String) — Optional. The filter request.
order_by (::String) — Optional. the order by fields for the result.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::ListCloneJobsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::ListCloneJobsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::ListCloneJobsRequest.new

# Call the list_clone_jobs method.
result = client.list_clone_jobs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VMMigration::V1::CloneJob.
  p item
end

#list_cutover_jobs

def list_cutover_jobs(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListCutoverJobsResponse
def list_cutover_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListCutoverJobsResponse

Lists CutoverJobs of a given migrating VM.

Overloads

def list_cutover_jobs(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListCutoverJobsResponse

Pass arguments to list_cutover_jobs via a request object, either of type ListCutoverJobsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::ListCutoverJobsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_cutover_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListCutoverJobsResponse

Pass arguments to list_cutover_jobs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of migrating VMs.
page_size (::Integer) — 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.
page_token (::String) — Required. A page token, received from a previous ListCutoverJobs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCutoverJobs must match the call that provided the page token.
filter (::String) — Optional. The filter request.
order_by (::String) — Optional. the order by fields for the result.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::ListCutoverJobsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::ListCutoverJobsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::ListCutoverJobsRequest.new

# Call the list_cutover_jobs method.
result = client.list_cutover_jobs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VMMigration::V1::CutoverJob.
  p item
end

#list_datacenter_connectors

def list_datacenter_connectors(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListDatacenterConnectorsResponse
def list_datacenter_connectors(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListDatacenterConnectorsResponse

Lists DatacenterConnectors in a given Source.

Overloads

def list_datacenter_connectors(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListDatacenterConnectorsResponse

Pass arguments to list_datacenter_connectors via a request object, either of type ListDatacenterConnectorsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::ListDatacenterConnectorsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_datacenter_connectors(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListDatacenterConnectorsResponse

Pass arguments to list_datacenter_connectors via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of connectors.
page_size (::Integer) — 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.
page_token (::String) — Required. A page token, received from a previous ListDatacenterConnectors call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDatacenterConnectors must match the call that provided the page token.
filter (::String) — Optional. The filter request.
order_by (::String) — Optional. the order by fields for the result.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::ListDatacenterConnectorsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::ListDatacenterConnectorsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::ListDatacenterConnectorsRequest.new

# Call the list_datacenter_connectors method.
result = client.list_datacenter_connectors request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VMMigration::V1::DatacenterConnector.
  p item
end

#list_groups

def list_groups(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListGroupsResponse
def list_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListGroupsResponse

Lists Groups in a given project and location.

Overloads

def list_groups(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListGroupsResponse

Pass arguments to list_groups via a request object, either of type ListGroupsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::ListGroupsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListGroupsResponse

Pass arguments to list_groups via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of groups.
page_size (::Integer) — 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.
page_token (::String) — Required. A page token, received from a previous ListGroups call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListGroups must match the call that provided the page token.
filter (::String) — Optional. The filter request.
order_by (::String) — Optional. the order by fields for the result.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::ListGroupsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::ListGroupsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::ListGroupsRequest.new

# Call the list_groups method.
result = client.list_groups request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VMMigration::V1::Group.
  p item
end

#list_migrating_vms

def list_migrating_vms(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListMigratingVmsResponse
def list_migrating_vms(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Google::Cloud::VMMigration::V1::ListMigratingVmsResponse

Lists MigratingVms in a given Source.

Overloads

def list_migrating_vms(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListMigratingVmsResponse

Pass arguments to list_migrating_vms via a request object, either of type ListMigratingVmsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::ListMigratingVmsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_migrating_vms(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Google::Cloud::VMMigration::V1::ListMigratingVmsResponse

Pass arguments to list_migrating_vms via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of MigratingVms.
page_size (::Integer) — 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.
page_token (::String) — Required. A page token, received from a previous ListMigratingVms call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListMigratingVms must match the call that provided the page token.
filter (::String) — Optional. The filter request.
order_by (::String) — Optional. the order by fields for the result.
view (::Google::Cloud::VMMigration::V1::MigratingVmView) — Optional. The level of details of each migrating VM.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::ListMigratingVmsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::ListMigratingVmsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::ListMigratingVmsRequest.new

# Call the list_migrating_vms method.
result = client.list_migrating_vms request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VMMigration::V1::MigratingVm.
  p item
end

#list_replication_cycles

def list_replication_cycles(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListReplicationCyclesResponse
def list_replication_cycles(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListReplicationCyclesResponse

Lists ReplicationCycles in a given MigratingVM.

Overloads

def list_replication_cycles(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListReplicationCyclesResponse

Pass arguments to list_replication_cycles via a request object, either of type ListReplicationCyclesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::ListReplicationCyclesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_replication_cycles(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListReplicationCyclesResponse

Pass arguments to list_replication_cycles via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of ReplicationCycles.
page_size (::Integer) — 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.
page_token (::String) — Required. A page token, received from a previous ListReplicationCycles call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListReplicationCycles must match the call that provided the page token.
filter (::String) — Optional. The filter request.
order_by (::String) — Optional. the order by fields for the result.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::ListReplicationCyclesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::ListReplicationCyclesResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::ListReplicationCyclesRequest.new

# Call the list_replication_cycles method.
result = client.list_replication_cycles request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VMMigration::V1::ReplicationCycle.
  p item
end

#list_sources

def list_sources(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListSourcesResponse
def list_sources(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListSourcesResponse

Lists Sources in a given project and location.

Overloads

def list_sources(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListSourcesResponse

Pass arguments to list_sources via a request object, either of type ListSourcesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::ListSourcesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_sources(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListSourcesResponse

Pass arguments to list_sources via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of sources.
page_size (::Integer) — 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.
page_token (::String) — Required. A page token, received from a previous ListSources call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListSources must match the call that provided the page token.
filter (::String) — Optional. The filter request.
order_by (::String) — Optional. the order by fields for the result.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::ListSourcesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::ListSourcesResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::ListSourcesRequest.new

# Call the list_sources method.
result = client.list_sources request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VMMigration::V1::Source.
  p item
end

#list_target_projects

def list_target_projects(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListTargetProjectsResponse
def list_target_projects(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListTargetProjectsResponse

Lists TargetProjects in a given project.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Overloads

def list_target_projects(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListTargetProjectsResponse

Pass arguments to list_target_projects via a request object, either of type ListTargetProjectsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::ListTargetProjectsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_target_projects(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListTargetProjectsResponse

Pass arguments to list_target_projects via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of targets.
page_size (::Integer) — 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.
page_token (::String) — Required. A page token, received from a previous ListTargets call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTargets must match the call that provided the page token.
filter (::String) — Optional. The filter request.
order_by (::String) — Optional. the order by fields for the result.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::ListTargetProjectsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::ListTargetProjectsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::ListTargetProjectsRequest.new

# Call the list_target_projects method.
result = client.list_target_projects request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VMMigration::V1::TargetProject.
  p item
end

#list_utilization_reports

def list_utilization_reports(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListUtilizationReportsResponse
def list_utilization_reports(parent: nil, view: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListUtilizationReportsResponse

Lists Utilization Reports of the given Source.

Overloads

def list_utilization_reports(request, options = nil) -> ::Google::Cloud::VMMigration::V1::ListUtilizationReportsResponse

Pass arguments to list_utilization_reports via a request object, either of type ListUtilizationReportsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::ListUtilizationReportsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_utilization_reports(parent: nil, view: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::VMMigration::V1::ListUtilizationReportsResponse

Pass arguments to list_utilization_reports via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The Utilization Reports parent.
view (::Google::Cloud::VMMigration::V1::UtilizationReportView) — Optional. The level of details of each report. Defaults to BASIC.
page_size (::Integer) — 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.
page_token (::String) — Required. A page token, received from a previous ListUtilizationReports call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUtilizationReports must match the call that provided the page token.
filter (::String) — Optional. The filter request.
order_by (::String) — Optional. the order by fields for the result.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::VMMigration::V1::ListUtilizationReportsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::VMMigration::V1::ListUtilizationReportsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::ListUtilizationReportsRequest.new

# Call the list_utilization_reports method.
result = client.list_utilization_reports request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VMMigration::V1::UtilizationReport.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns

(Google::Cloud::Location::Locations::Rest::Client)

#operations_client

def operations_client() -> ::Google::Cloud::VMMigration::V1::VMMigration::Rest::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::VMMigration::V1::VMMigration::Rest::Operations)

#pause_migration

def pause_migration(request, options = nil) -> ::Gapic::Operation
def pause_migration(migrating_vm: nil) -> ::Gapic::Operation

Pauses a migration for a VM. If cycle tasks are running they will be cancelled, preserving source task data. Further replication cycles will not be triggered while the VM is paused.

Overloads

def pause_migration(request, options = nil) -> ::Gapic::Operation

Pass arguments to pause_migration via a request object, either of type PauseMigrationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::PauseMigrationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def pause_migration(migrating_vm: nil) -> ::Gapic::Operation

Pass arguments to pause_migration via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

migrating_vm (::String) — Required. The name of the MigratingVm.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::PauseMigrationRequest.new

# Call the pause_migration method.
result = client.pause_migration request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#remove_group_migration

def remove_group_migration(request, options = nil) -> ::Gapic::Operation
def remove_group_migration(group: nil, migrating_vm: nil) -> ::Gapic::Operation

Removes a MigratingVm from a Group.

Overloads

def remove_group_migration(request, options = nil) -> ::Gapic::Operation

Pass arguments to remove_group_migration via a request object, either of type RemoveGroupMigrationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::RemoveGroupMigrationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def remove_group_migration(group: nil, migrating_vm: nil) -> ::Gapic::Operation

Pass arguments to remove_group_migration via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

group (::String) — Required. The name of the Group.
migrating_vm (::String) — The MigratingVm to remove.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::RemoveGroupMigrationRequest.new

# Call the remove_group_migration method.
result = client.remove_group_migration request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#resume_migration

def resume_migration(request, options = nil) -> ::Gapic::Operation
def resume_migration(migrating_vm: nil) -> ::Gapic::Operation

Resumes a migration for a VM. When called on a paused migration, will start the process of uploading data and creating snapshots; when called on a completed cut-over migration, will update the migration to active state and start the process of uploading data and creating snapshots.

Overloads

def resume_migration(request, options = nil) -> ::Gapic::Operation

Pass arguments to resume_migration via a request object, either of type ResumeMigrationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::ResumeMigrationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def resume_migration(migrating_vm: nil) -> ::Gapic::Operation

Pass arguments to resume_migration via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

migrating_vm (::String) — Required. The name of the MigratingVm.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::ResumeMigrationRequest.new

# Call the resume_migration method.
result = client.resume_migration request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#start_migration

def start_migration(request, options = nil) -> ::Gapic::Operation
def start_migration(migrating_vm: nil) -> ::Gapic::Operation

Starts migration for a VM. Starts the process of uploading data and creating snapshots, in replication cycles scheduled by the policy.

Overloads

def start_migration(request, options = nil) -> ::Gapic::Operation

Pass arguments to start_migration via a request object, either of type StartMigrationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::StartMigrationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def start_migration(migrating_vm: nil) -> ::Gapic::Operation

Pass arguments to start_migration via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

migrating_vm (::String) — Required. The name of the MigratingVm.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::StartMigrationRequest.new

# Call the start_migration method.
result = client.start_migration request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_group

def update_group(request, options = nil) -> ::Gapic::Operation
def update_group(update_mask: nil, group: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single Group.

Overloads

def update_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_group via a request object, either of type UpdateGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::UpdateGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_group(update_mask: nil, group: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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 (::Google::Cloud::VMMigration::V1::Group, ::Hash) — Required. The update request body.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::UpdateGroupRequest.new

# Call the update_group method.
result = client.update_group request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_migrating_vm

def update_migrating_vm(request, options = nil) -> ::Gapic::Operation
def update_migrating_vm(update_mask: nil, migrating_vm: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single MigratingVm.

Overloads

def update_migrating_vm(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_migrating_vm via a request object, either of type UpdateMigratingVmRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::UpdateMigratingVmRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_migrating_vm(update_mask: nil, migrating_vm: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_migrating_vm via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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 (::Google::Cloud::VMMigration::V1::MigratingVm, ::Hash) — Required. The update request body.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::UpdateMigratingVmRequest.new

# Call the update_migrating_vm method.
result = client.update_migrating_vm request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_source

def update_source(request, options = nil) -> ::Gapic::Operation
def update_source(update_mask: nil, source: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single Source.

Overloads

def update_source(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_source via a request object, either of type UpdateSourceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::UpdateSourceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_source(update_mask: nil, source: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_source via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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 (::Google::Cloud::VMMigration::V1::Source, ::Hash) — Required. The update request body.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::UpdateSourceRequest.new

# Call the update_source method.
result = client.update_source request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_target_project

def update_target_project(request, options = nil) -> ::Gapic::Operation
def update_target_project(update_mask: nil, target_project: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Overloads

def update_target_project(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_target_project via a request object, either of type UpdateTargetProjectRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::UpdateTargetProjectRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_target_project(update_mask: nil, target_project: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_target_project via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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 (::Google::Cloud::VMMigration::V1::TargetProject, ::Hash) — Required. The update request body.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::UpdateTargetProjectRequest.new

# Call the update_target_project method.
result = client.update_target_project request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#upgrade_appliance

def upgrade_appliance(request, options = nil) -> ::Gapic::Operation
def upgrade_appliance(datacenter_connector: nil, request_id: nil) -> ::Gapic::Operation

Upgrades the appliance relate to this DatacenterConnector to the in-place updateable version.

Overloads

def upgrade_appliance(request, options = nil) -> ::Gapic::Operation

Pass arguments to upgrade_appliance via a request object, either of type UpgradeApplianceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::VMMigration::V1::UpgradeApplianceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def upgrade_appliance(datacenter_connector: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to upgrade_appliance via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

datacenter_connector (::String) — Required. The DatacenterConnector name.
request_id (::String) — 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).

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/vm_migration/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VMMigration::V1::VMMigration::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VMMigration::V1::UpgradeApplianceRequest.new

# Call the upgrade_appliance method.
result = client.upgrade_appliance request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end