Migration Center V1 API - Class Google::Cloud::MigrationCenter::V1::MigrationCenter::Rest::Client (v1.1.0)

Reference documentation and code samples for the Migration Center V1 API class Google::Cloud::MigrationCenter::V1::MigrationCenter::Rest::Client.

REST client for the MigrationCenter service.

Service describing handlers for resources.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the MigrationCenter Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all MigrationCenter clients
::Google::Cloud::MigrationCenter::V1::MigrationCenter::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#add_assets_to_group

def add_assets_to_group(request, options = nil) -> ::Gapic::Operation
def add_assets_to_group(group: nil, request_id: nil, assets: nil, allow_existing: nil) -> ::Gapic::Operation

Adds assets to a group.

Overloads 
def add_assets_to_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to add_assets_to_group via a request object, either of type AddAssetsToGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::AddAssetsToGroupRequest, ::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_assets_to_group(group: nil, request_id: nil, assets: nil, allow_existing: nil) -> ::Gapic::Operation
Pass arguments to add_assets_to_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
  • group (::String) — Required. Group reference.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • assets (::Google::Cloud::MigrationCenter::V1::AssetList, ::Hash) — Required. List of assets to be added. The maximum number of assets that can be added in a single request is 1000.
  • allow_existing (::Boolean) — Optional. When this value is set to false and one of the given assets is already an existing member of the group, the operation fails with an Already Exists error. When set to true this situation is silently ignored by the server.

    Default value is false.

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/migration_center/v1"

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

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

# Call the add_assets_to_group method.
result = client.add_assets_to_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

#aggregate_assets_values

def aggregate_assets_values(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::AggregateAssetsValuesResponse
def aggregate_assets_values(parent: nil, aggregations: nil, filter: nil) -> ::Google::Cloud::MigrationCenter::V1::AggregateAssetsValuesResponse

Aggregates the requested fields based on provided function.

Overloads 
def aggregate_assets_values(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::AggregateAssetsValuesResponse
Pass arguments to aggregate_assets_values via a request object, either of type AggregateAssetsValuesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::AggregateAssetsValuesRequest, ::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 aggregate_assets_values(parent: nil, aggregations: nil, filter: nil) -> ::Google::Cloud::MigrationCenter::V1::AggregateAssetsValuesResponse
Pass arguments to aggregate_assets_values 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. Parent value for AggregateAssetsValuesRequest.
  • aggregations (::Array<::Google::Cloud::MigrationCenter::V1::Aggregation, ::Hash>) — Array of aggregations to perform. Up to 25 aggregations can be defined.
  • filter (::String) — The aggregation will be performed on assets that match the provided filter.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Cloud::MigrationCenter::V1::AggregateAssetsValuesResponse.
p result

#batch_delete_assets

def batch_delete_assets(request, options = nil) -> ::Google::Protobuf::Empty
def batch_delete_assets(parent: nil, names: nil, allow_missing: nil) -> ::Google::Protobuf::Empty

Deletes list of Assets.

Overloads 
def batch_delete_assets(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to batch_delete_assets via a request object, either of type BatchDeleteAssetsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::BatchDeleteAssetsRequest, ::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 batch_delete_assets(parent: nil, names: nil, allow_missing: nil) -> ::Google::Protobuf::Empty
Pass arguments to batch_delete_assets 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. Parent value for batch asset delete.
  • names (::Array<::String>) — Required. The IDs of the assets to delete. A maximum of 1000 assets can be deleted in a batch. Format: projects/{project}/locations/{location}/assets/{name}.
  • allow_missing (::Boolean) — Optional. When this value is set to true the request is a no-op for non-existing assets. See https://google.aip.dev/135#delete-if-existing for additional details. Default value is false.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Protobuf::Empty.
p result

#batch_update_assets

def batch_update_assets(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::BatchUpdateAssetsResponse
def batch_update_assets(parent: nil, requests: nil) -> ::Google::Cloud::MigrationCenter::V1::BatchUpdateAssetsResponse

Updates the parameters of a list of assets.

Overloads 
def batch_update_assets(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::BatchUpdateAssetsResponse
Pass arguments to batch_update_assets via a request object, either of type BatchUpdateAssetsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::BatchUpdateAssetsRequest, ::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 batch_update_assets(parent: nil, requests: nil) -> ::Google::Cloud::MigrationCenter::V1::BatchUpdateAssetsResponse
Pass arguments to batch_update_assets 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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Cloud::MigrationCenter::V1::BatchUpdateAssetsResponse.
p result

#configure

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

Configure the MigrationCenter 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
Returns

#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::MigrationCenter::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. Value for parent.
  • group_id (::String) — Required. User specified ID for the group. It will become the last component of the group name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
  • group (::Google::Cloud::MigrationCenter::V1::Group, ::Hash) — Required. The group resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::MigrationCenter::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_import_data_file

def create_import_data_file(request, options = nil) -> ::Gapic::Operation
def create_import_data_file(parent: nil, import_data_file_id: nil, import_data_file: nil, request_id: nil) -> ::Gapic::Operation

Creates an import data file.

Overloads 
def create_import_data_file(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_import_data_file via a request object, either of type CreateImportDataFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::CreateImportDataFileRequest, ::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_import_data_file(parent: nil, import_data_file_id: nil, import_data_file: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_import_data_file 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. Name of the parent of the ImportDataFile.
  • import_data_file_id (::String) — Required. The ID of the new data file.
  • import_data_file (::Google::Cloud::MigrationCenter::V1::ImportDataFile, ::Hash) — Required. The resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the create_import_data_file method.
result = client.create_import_data_file 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_import_job

def create_import_job(request, options = nil) -> ::Gapic::Operation
def create_import_job(parent: nil, import_job_id: nil, import_job: nil, request_id: nil) -> ::Gapic::Operation

Creates an import job.

Overloads 
def create_import_job(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_import_job via a request object, either of type CreateImportJobRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::CreateImportJobRequest, ::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_import_job(parent: nil, import_job_id: nil, import_job: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_import_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. Value for parent.
  • import_job_id (::String) — Required. ID of the import job.
  • import_job (::Google::Cloud::MigrationCenter::V1::ImportJob, ::Hash) — Required. The resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the create_import_job method.
result = client.create_import_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_preference_set

def create_preference_set(request, options = nil) -> ::Gapic::Operation
def create_preference_set(parent: nil, preference_set_id: nil, preference_set: nil, request_id: nil) -> ::Gapic::Operation

Creates a new preference set in a given project and location.

Overloads 
def create_preference_set(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_preference_set via a request object, either of type CreatePreferenceSetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::CreatePreferenceSetRequest, ::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_preference_set(parent: nil, preference_set_id: nil, preference_set: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_preference_set 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. Value for parent.
  • preference_set_id (::String) — Required. User specified ID for the preference set. It will become the last component of the preference set name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
  • preference_set (::Google::Cloud::MigrationCenter::V1::PreferenceSet, ::Hash) — Required. The preference set resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the create_preference_set method.
result = client.create_preference_set 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_report

def create_report(request, options = nil) -> ::Gapic::Operation
def create_report(parent: nil, report_id: nil, report: nil, request_id: nil) -> ::Gapic::Operation

Creates a report.

Overloads 
def create_report(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_report via a request object, either of type CreateReportRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::CreateReportRequest, ::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_report(parent: nil, report_id: nil, report: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_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. Value for parent.
  • report_id (::String) — Required. User specified id for the report. It will become the last component of the report name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The id must match the regular expression: a-z?.
  • report (::Google::Cloud::MigrationCenter::V1::Report, ::Hash) — Required. The report resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the create_report method.
result = client.create_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

#create_report_config

def create_report_config(request, options = nil) -> ::Gapic::Operation
def create_report_config(parent: nil, report_config_id: nil, report_config: nil, request_id: nil) -> ::Gapic::Operation

Creates a report configuration.

Overloads 
def create_report_config(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_report_config via a request object, either of type CreateReportConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::CreateReportConfigRequest, ::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_report_config(parent: nil, report_config_id: nil, report_config: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_report_config 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. Value for parent.
  • report_config_id (::String) — Required. User specified ID for the report config. It will become the last component of the report config name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: a-z?.
  • report_config (::Google::Cloud::MigrationCenter::V1::ReportConfig, ::Hash) — Required. The report config set resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the create_report_config method.
result = client.create_report_config 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::MigrationCenter::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. Value for parent.
  • source_id (::String) — Required. User specified ID for the source. It will become the last component of the source name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
  • source (::Google::Cloud::MigrationCenter::V1::Source, ::Hash) — Required. The resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::MigrationCenter::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

#delete_asset

def delete_asset(request, options = nil) -> ::Google::Protobuf::Empty
def delete_asset(name: nil, request_id: nil) -> ::Google::Protobuf::Empty

Deletes an asset.

Overloads 
def delete_asset(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_asset via a request object, either of type DeleteAssetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::DeleteAssetRequest, ::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_asset(name: nil, request_id: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_asset 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. Name of the resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_group

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

Deletes a 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::MigrationCenter::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. Name of the group resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::MigrationCenter::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_import_data_file

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

Delete an import data file.

Overloads 
def delete_import_data_file(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_import_data_file via a request object, either of type DeleteImportDataFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::DeleteImportDataFileRequest, ::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_import_data_file(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_import_data_file 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. Name of the ImportDataFile to delete.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the delete_import_data_file method.
result = client.delete_import_data_file 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_import_job

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

Deletes an import job.

Overloads 
def delete_import_job(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_import_job via a request object, either of type DeleteImportJobRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::DeleteImportJobRequest, ::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_import_job(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_import_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
  • name (::String) — Required. Name of the resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • force (::Boolean) — Optional. If set to true, any ImportDataFiles of this job will also be deleted If set to false, the request only works if the job has no data files.
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/migration_center/v1"

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

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

# Call the delete_import_job method.
result = client.delete_import_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

#delete_preference_set

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

Deletes a preference set.

Overloads 
def delete_preference_set(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_preference_set via a request object, either of type DeletePreferenceSetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::DeletePreferenceSetRequest, ::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_preference_set(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_preference_set 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. Name of the group resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the delete_preference_set method.
result = client.delete_preference_set 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_report

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

Deletes a Report.

Overloads 
def delete_report(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_report via a request object, either of type DeleteReportRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::DeleteReportRequest, ::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_report(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_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. Name of the resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the delete_report method.
result = client.delete_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_report_config

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

Deletes a ReportConfig.

Overloads 
def delete_report_config(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_report_config via a request object, either of type DeleteReportConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::DeleteReportConfigRequest, ::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_report_config(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_report_config 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. Name of the resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • force (::Boolean) — Optional. If set to true, any child Reports of this entity will also be deleted. If set to false, the request only works if the resource has no children.
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/migration_center/v1"

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

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

# Call the delete_report_config method.
result = client.delete_report_config 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 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::MigrationCenter::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. Name of the resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::MigrationCenter::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

#get_asset

def get_asset(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::Asset
def get_asset(name: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::Asset

Gets the details of an asset.

Overloads 
def get_asset(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::Asset
Pass arguments to get_asset via a request object, either of type GetAssetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::GetAssetRequest, ::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_asset(name: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::Asset
Pass arguments to get_asset 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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Cloud::MigrationCenter::V1::Asset.
p result

#get_error_frame

def get_error_frame(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ErrorFrame
def get_error_frame(name: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::ErrorFrame

Gets the details of an error frame.

Overloads 
def get_error_frame(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ErrorFrame
Pass arguments to get_error_frame via a request object, either of type GetErrorFrameRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::GetErrorFrameRequest, ::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_error_frame(name: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::ErrorFrame
Pass arguments to get_error_frame 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 frame to retrieve. Format: projects/{project}/locations/{location}/sources/{source}/errorFrames/{error_frame}
  • view (::Google::Cloud::MigrationCenter::V1::ErrorFrameView) — Optional. An optional view mode to control the level of details for the frame. The default is a basic frame view.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Cloud::MigrationCenter::V1::ErrorFrame.
p result

#get_group

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

Gets the details of a group.

Overloads 
def get_group(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::Group
Pass arguments to get_group via a request object, either of type GetGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::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::MigrationCenter::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. Name of the resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

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

#get_import_data_file

def get_import_data_file(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ImportDataFile
def get_import_data_file(name: nil) -> ::Google::Cloud::MigrationCenter::V1::ImportDataFile

Gets an import data file.

Overloads 
def get_import_data_file(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ImportDataFile
Pass arguments to get_import_data_file via a request object, either of type GetImportDataFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::GetImportDataFileRequest, ::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_import_data_file(name: nil) -> ::Google::Cloud::MigrationCenter::V1::ImportDataFile
Pass arguments to get_import_data_file 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. Name of the ImportDataFile.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Cloud::MigrationCenter::V1::ImportDataFile.
p result

#get_import_job

def get_import_job(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ImportJob
def get_import_job(name: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::ImportJob

Gets the details of an import job.

Overloads 
def get_import_job(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ImportJob
Pass arguments to get_import_job via a request object, either of type GetImportJobRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::GetImportJobRequest, ::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_import_job(name: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::ImportJob
Pass arguments to get_import_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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Cloud::MigrationCenter::V1::ImportJob.
p result

#get_preference_set

def get_preference_set(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::PreferenceSet
def get_preference_set(name: nil) -> ::Google::Cloud::MigrationCenter::V1::PreferenceSet

Gets the details of a preference set.

Overloads 
def get_preference_set(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::PreferenceSet
Pass arguments to get_preference_set via a request object, either of type GetPreferenceSetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::GetPreferenceSetRequest, ::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_preference_set(name: nil) -> ::Google::Cloud::MigrationCenter::V1::PreferenceSet
Pass arguments to get_preference_set 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. Name of the resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Cloud::MigrationCenter::V1::PreferenceSet.
p result

#get_report

def get_report(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::Report
def get_report(name: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::Report

Gets details of a single Report.

Overloads 
def get_report(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::Report
Pass arguments to get_report via a request object, either of type GetReportRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::GetReportRequest, ::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_report(name: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::Report
Pass arguments to get_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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Cloud::MigrationCenter::V1::Report.
p result

#get_report_config

def get_report_config(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ReportConfig
def get_report_config(name: nil) -> ::Google::Cloud::MigrationCenter::V1::ReportConfig

Gets details of a single ReportConfig.

Overloads 
def get_report_config(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ReportConfig
Pass arguments to get_report_config via a request object, either of type GetReportConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::GetReportConfigRequest, ::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_report_config(name: nil) -> ::Google::Cloud::MigrationCenter::V1::ReportConfig
Pass arguments to get_report_config 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. Name of the resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Cloud::MigrationCenter::V1::ReportConfig.
p result

#get_settings

def get_settings(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::Settings
def get_settings(name: nil) -> ::Google::Cloud::MigrationCenter::V1::Settings

Gets the details of regional settings.

Overloads 
def get_settings(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::Settings
Pass arguments to get_settings via a request object, either of type GetSettingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::GetSettingsRequest, ::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_settings(name: nil) -> ::Google::Cloud::MigrationCenter::V1::Settings
Pass arguments to get_settings 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. Name of the resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Cloud::MigrationCenter::V1::Settings.
p result

#get_source

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

Gets the details of a source.

Overloads 
def get_source(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::Source
Pass arguments to get_source via a request object, either of type GetSourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::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::MigrationCenter::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. Name of the resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

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

#initialize

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

Create a new MigrationCenter REST client object.

Yields
  • (config) — Configure the MigrationCenter client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::MigrationCenter::V1::MigrationCenter::Rest::Client.new

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

#list_assets

def list_assets(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListAssetsResponse
def list_assets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::ListAssetsResponse

Lists all the assets in a given project and location.

Overloads 
def list_assets(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListAssetsResponse
Pass arguments to list_assets via a request object, either of type ListAssetsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::ListAssetsRequest, ::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_assets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::ListAssetsResponse
Pass arguments to list_assets 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. Parent value for ListAssetsRequest.
  • page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — A token identifying a page of results the server should return.
  • filter (::String) — Filtering results.
  • order_by (::String) — Field to sort by. See https://google.aip.dev/132#ordering for more details.
  • view (::Google::Cloud::MigrationCenter::V1::AssetView) — View of the assets. Defaults to BASIC.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

# Call the list_assets method.
result = client.list_assets 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::MigrationCenter::V1::Asset.
  p item
end

#list_error_frames

def list_error_frames(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListErrorFramesResponse
def list_error_frames(parent: nil, page_size: nil, page_token: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::ListErrorFramesResponse

Lists all error frames in a given source and location.

Overloads 
def list_error_frames(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListErrorFramesResponse
Pass arguments to list_error_frames via a request object, either of type ListErrorFramesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::ListErrorFramesRequest, ::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_error_frames(parent: nil, page_size: nil, page_token: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::ListErrorFramesResponse
Pass arguments to list_error_frames 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. Parent value (the source) for ListErrorFramesRequest.
  • page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — A token identifying a page of results the server should return.
  • view (::Google::Cloud::MigrationCenter::V1::ErrorFrameView) — Optional. An optional view mode to control the level of details of each error frame. The default is a BASIC frame view.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

# Call the list_error_frames method.
result = client.list_error_frames 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::MigrationCenter::V1::ErrorFrame.
  p item
end

#list_groups

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

Lists all groups in a given project and location.

Overloads 
def list_groups(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListGroupsResponse
Pass arguments to list_groups via a request object, either of type ListGroupsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::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::MigrationCenter::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. Parent value for ListGroupsRequest.
  • page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — A token identifying a page of results the server should return.
  • filter (::String) — Filtering results.
  • order_by (::String) — Field to sort by. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::MigrationCenter::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::MigrationCenter::V1::Group.
  p item
end

#list_import_data_files

def list_import_data_files(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListImportDataFilesResponse
def list_import_data_files(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::MigrationCenter::V1::ListImportDataFilesResponse

List import data files.

Overloads 
def list_import_data_files(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListImportDataFilesResponse
Pass arguments to list_import_data_files via a request object, either of type ListImportDataFilesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::ListImportDataFilesRequest, ::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_import_data_files(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::MigrationCenter::V1::ListImportDataFilesResponse
Pass arguments to list_import_data_files 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. Name of the parent of the ImportDataFiles resource.
  • page_size (::Integer) — The maximum number of data files to return. The service may return fewer than this value. If unspecified, at most 500 data files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListImportDataFiles call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListImportDataFiles must match the call that provided the page token.

  • filter (::String) — Filtering results.
  • order_by (::String) — Field to sort by. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

# Call the list_import_data_files method.
result = client.list_import_data_files 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::MigrationCenter::V1::ImportDataFile.
  p item
end

#list_import_jobs

def list_import_jobs(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListImportJobsResponse
def list_import_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::ListImportJobsResponse

Lists all import jobs.

Overloads 
def list_import_jobs(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListImportJobsResponse
Pass arguments to list_import_jobs via a request object, either of type ListImportJobsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::ListImportJobsRequest, ::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_import_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::ListImportJobsResponse
Pass arguments to list_import_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. Parent value for ListImportJobsRequest.
  • page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — A token identifying a page of results the server should return.
  • filter (::String) — Filtering results.
  • order_by (::String) — Field to sort by. See https://google.aip.dev/132#ordering for more details.
  • view (::Google::Cloud::MigrationCenter::V1::ImportJobView) — Optional. The level of details of each import job. Default value is BASIC.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

# Call the list_import_jobs method.
result = client.list_import_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::MigrationCenter::V1::ImportJob.
  p item
end

#list_preference_sets

def list_preference_sets(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListPreferenceSetsResponse
def list_preference_sets(parent: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Google::Cloud::MigrationCenter::V1::ListPreferenceSetsResponse

Lists all the preference sets in a given project and location.

Overloads 
def list_preference_sets(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListPreferenceSetsResponse
Pass arguments to list_preference_sets via a request object, either of type ListPreferenceSetsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::ListPreferenceSetsRequest, ::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_preference_sets(parent: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Google::Cloud::MigrationCenter::V1::ListPreferenceSetsResponse
Pass arguments to list_preference_sets 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. Parent value for ListPreferenceSetsRequest.
  • page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, at most 500 preference sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A token identifying a page of results the server should return.
  • order_by (::String) — Field to sort by. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

# Call the list_preference_sets method.
result = client.list_preference_sets 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::MigrationCenter::V1::PreferenceSet.
  p item
end

#list_report_configs

def list_report_configs(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListReportConfigsResponse
def list_report_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::MigrationCenter::V1::ListReportConfigsResponse

Lists ReportConfigs in a given project and location.

Overloads 
def list_report_configs(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListReportConfigsResponse
Pass arguments to list_report_configs via a request object, either of type ListReportConfigsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::ListReportConfigsRequest, ::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_report_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::MigrationCenter::V1::ListReportConfigsResponse
Pass arguments to list_report_configs 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. Parent value for ListReportConfigsRequest.
  • page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — A token identifying a page of results the server should return.
  • filter (::String) — Filtering results.
  • order_by (::String) — Field to sort by. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

# Call the list_report_configs method.
result = client.list_report_configs 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::MigrationCenter::V1::ReportConfig.
  p item
end

#list_reports

def list_reports(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListReportsResponse
def list_reports(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::ListReportsResponse

Lists Reports in a given ReportConfig.

Overloads 
def list_reports(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListReportsResponse
Pass arguments to list_reports via a request object, either of type ListReportsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::ListReportsRequest, ::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_reports(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Google::Cloud::MigrationCenter::V1::ListReportsResponse
Pass arguments to list_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. Parent value for ListReportsRequest.
  • page_size (::Integer) — Requested page size. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default value.
  • page_token (::String) — A token identifying a page of results that the server should return.
  • filter (::String) — Filtering results.
  • order_by (::String) — Field to sort by. See https://google.aip.dev/132#ordering for more details.
  • view (::Google::Cloud::MigrationCenter::V1::ReportView) — Determines what information to retrieve for each Report.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

# Call the list_reports method.
result = client.list_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::MigrationCenter::V1::Report.
  p item
end

#list_sources

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

Lists all the sources in a given project and location.

Overloads 
def list_sources(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ListSourcesResponse
Pass arguments to list_sources via a request object, either of type ListSourcesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::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::MigrationCenter::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. Parent value for ListSourcesRequest.
  • page_size (::Integer) — Requested page size. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default value.
  • page_token (::String) — A token identifying a page of results that the server should return.
  • filter (::String) — Filtering results.
  • order_by (::String) — Field to sort by. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::MigrationCenter::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::MigrationCenter::V1::Source.
  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)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

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

Get the associated client for long-running operations.

Returns

#remove_assets_from_group

def remove_assets_from_group(request, options = nil) -> ::Gapic::Operation
def remove_assets_from_group(group: nil, request_id: nil, assets: nil, allow_missing: nil) -> ::Gapic::Operation

Removes assets from a group.

Overloads 
def remove_assets_from_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to remove_assets_from_group via a request object, either of type RemoveAssetsFromGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::RemoveAssetsFromGroupRequest, ::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_assets_from_group(group: nil, request_id: nil, assets: nil, allow_missing: nil) -> ::Gapic::Operation
Pass arguments to remove_assets_from_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
  • group (::String) — Required. Group reference.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • assets (::Google::Cloud::MigrationCenter::V1::AssetList, ::Hash) — Required. List of assets to be removed. The maximum number of assets that can be removed in a single request is 1000.
  • allow_missing (::Boolean) — Optional. When this value is set to false and one of the given assets is not an existing member of the group, the operation fails with a Not Found error. When set to true this situation is silently ignored by the server.

    Default value is false.

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/migration_center/v1"

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

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

# Call the remove_assets_from_group method.
result = client.remove_assets_from_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

#report_asset_frames

def report_asset_frames(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ReportAssetFramesResponse
def report_asset_frames(parent: nil, frames: nil, source: nil) -> ::Google::Cloud::MigrationCenter::V1::ReportAssetFramesResponse

Reports a set of frames.

Overloads 
def report_asset_frames(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::ReportAssetFramesResponse
Pass arguments to report_asset_frames via a request object, either of type ReportAssetFramesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::ReportAssetFramesRequest, ::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 report_asset_frames(parent: nil, frames: nil, source: nil) -> ::Google::Cloud::MigrationCenter::V1::ReportAssetFramesResponse
Pass arguments to report_asset_frames 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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Cloud::MigrationCenter::V1::ReportAssetFramesResponse.
p result

#run_import_job

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

Runs an import job.

Overloads 
def run_import_job(request, options = nil) -> ::Gapic::Operation
Pass arguments to run_import_job via a request object, either of type RunImportJobRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::RunImportJobRequest, ::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 run_import_job(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to run_import_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
  • name (::String) — Required. The name of the import job to run.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the run_import_job method.
result = client.run_import_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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_asset

def update_asset(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::Asset
def update_asset(update_mask: nil, asset: nil, request_id: nil) -> ::Google::Cloud::MigrationCenter::V1::Asset

Updates the parameters of an asset.

Overloads 
def update_asset(request, options = nil) -> ::Google::Cloud::MigrationCenter::V1::Asset
Pass arguments to update_asset via a request object, either of type UpdateAssetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::UpdateAssetRequest, ::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_asset(update_mask: nil, asset: nil, request_id: nil) -> ::Google::Cloud::MigrationCenter::V1::Asset
Pass arguments to update_asset 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) — Required. Field mask is used to specify the fields to be overwritten in the Asset resource by the update. The values specified in the update_mask field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.
  • asset (::Google::Cloud::MigrationCenter::V1::Asset, ::Hash) — Required. The resource being updated.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/migration_center/v1"

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

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

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

# The returned object is of type Google::Cloud::MigrationCenter::V1::Asset.
p result

#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 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::MigrationCenter::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) — Required. Field mask is used to specify the fields to be overwritten in the Group resource by the update. The values 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. A single * value in the mask lets you to overwrite all fields.
  • group (::Google::Cloud::MigrationCenter::V1::Group, ::Hash) — Required. The group resource being updated.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::MigrationCenter::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_import_job

def update_import_job(request, options = nil) -> ::Gapic::Operation
def update_import_job(update_mask: nil, import_job: nil, request_id: nil) -> ::Gapic::Operation

Updates an import job.

Overloads 
def update_import_job(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_import_job via a request object, either of type UpdateImportJobRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::UpdateImportJobRequest, ::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_import_job(update_mask: nil, import_job: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_import_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
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the Asset resource by the update. The values specified in the update_mask field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.
  • import_job (::Google::Cloud::MigrationCenter::V1::ImportJob, ::Hash) — Required. The resource being updated
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the update_import_job method.
result = client.update_import_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

#update_preference_set

def update_preference_set(request, options = nil) -> ::Gapic::Operation
def update_preference_set(update_mask: nil, preference_set: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a preference set.

Overloads 
def update_preference_set(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_preference_set via a request object, either of type UpdatePreferenceSetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::UpdatePreferenceSetRequest, ::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_preference_set(update_mask: nil, preference_set: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_preference_set 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) — Required. Field mask is used to specify the fields to be overwritten in the PreferenceSet resource by the update. The values specified in the update_mask field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.
  • preference_set (::Google::Cloud::MigrationCenter::V1::PreferenceSet, ::Hash) — Required. The preference set resource being updated.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the update_preference_set method.
result = client.update_preference_set 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_settings

def update_settings(request, options = nil) -> ::Gapic::Operation
def update_settings(update_mask: nil, settings: nil, request_id: nil) -> ::Gapic::Operation

Updates the regional-level project settings.

Overloads 
def update_settings(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_settings via a request object, either of type UpdateSettingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::UpdateSettingsRequest, ::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_settings(update_mask: nil, settings: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_settings 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) — Required. Field mask is used to specify the fields to be overwritten in the Settings resource by the update. The values specified in the update_mask field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.
  • settings (::Google::Cloud::MigrationCenter::V1::Settings, ::Hash) — Required. The project settings resource being updated.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the update_settings method.
result = client.update_settings 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 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::MigrationCenter::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) — Required. Field mask is used to specify the fields to be overwritten in the Source resource by the update. The values specified in the update_mask field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.
  • source (::Google::Cloud::MigrationCenter::V1::Source, ::Hash) — Required. The resource being updated
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::MigrationCenter::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

#validate_import_job

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

Validates an import job.

Overloads 
def validate_import_job(request, options = nil) -> ::Gapic::Operation
Pass arguments to validate_import_job via a request object, either of type ValidateImportJobRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::MigrationCenter::V1::ValidateImportJobRequest, ::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 validate_import_job(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to validate_import_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
  • name (::String) — Required. The name of the import job to validate.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/migration_center/v1"

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

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

# Call the validate_import_job method.
result = client.validate_import_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