Class: Google::Cloud::Bigquery::Migration::V2::MigrationService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb

Overview

REST client for the MigrationService service.

Service to handle EDW migrations.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#location_path, #migration_subtask_path, #migration_workflow_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new MigrationService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Bigquery::Migration::V2::MigrationService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Bigquery::Migration::V2::MigrationService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the MigrationService client.

Yield Parameters:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb', line 146

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @migration_service_stub = ::Google::Cloud::Bigquery::Migration::V2::MigrationService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @migration_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the MigrationService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all MigrationService clients
::Google::Cloud::Bigquery::Migration::V2::MigrationService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Bigquery", "Migration", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.create_migration_workflow.timeout = 60.0

    default_config.rpcs.get_migration_workflow.timeout = 60.0
    default_config.rpcs.get_migration_workflow.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_migration_workflows.timeout = 60.0
    default_config.rpcs.list_migration_workflows.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_migration_workflow.timeout = 60.0

    default_config.rpcs.start_migration_workflow.timeout = 60.0
    default_config.rpcs.start_migration_workflow.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the MigrationService 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



116
117
118
119
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb', line 116

def configure
  yield @config if block_given?
  @config
end

#create_migration_workflow(request, options = nil) ⇒ ::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow #create_migration_workflow(parent: nil, migration_workflow: nil) ⇒ ::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow

Creates a migration workflow.

Examples:

Basic example

require "google/cloud/bigquery/migration/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Migration::V2::MigrationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::Migration::V2::CreateMigrationWorkflowRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb', line 245

def create_migration_workflow request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::Migration::V2::CreateMigrationWorkflowRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_migration_workflow.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::Migration::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_migration_workflow.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_migration_workflow.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @migration_service_stub.create_migration_workflow request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_migration_workflow(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_migration_workflow(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a migration workflow by name.

Examples:

Basic example

require "google/cloud/bigquery/migration/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Migration::V2::MigrationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::Migration::V2::DeleteMigrationWorkflowRequest.new

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

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

Overloads:

  • #delete_migration_workflow(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • request (::Google::Cloud::Bigquery::Migration::V2::DeleteMigrationWorkflowRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_migration_workflow(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_migration_workflow 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) (defaults to: nil) —

      Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb', line 501

def delete_migration_workflow request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::Migration::V2::DeleteMigrationWorkflowRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_migration_workflow.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::Migration::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_migration_workflow.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_migration_workflow.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @migration_service_stub.delete_migration_workflow request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_migration_subtask(request, options = nil) ⇒ ::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask #get_migration_subtask(name: nil, read_mask: nil) ⇒ ::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask

Gets a previously created migration subtask.

Examples:

Basic example

require "google/cloud/bigquery/migration/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Migration::V2::MigrationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::Migration::V2::GetMigrationSubtaskRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::Migration::V2::MigrationSubtask.
p result

Overloads:

  • #get_migration_subtask(request, options = nil) ⇒ ::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask

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

    Parameters:

    • request (::Google::Cloud::Bigquery::Migration::V2::GetMigrationSubtaskRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_migration_subtask(name: nil, read_mask: nil) ⇒ ::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask

    Pass arguments to get_migration_subtask 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) (defaults to: nil) —

      Required. The unique identifier for the migration subtask. Example: projects/123/locations/us/workflows/1234/subtasks/543

    • read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. The list of fields to be retrieved.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb', line 664

def get_migration_subtask request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::Migration::V2::GetMigrationSubtaskRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_migration_subtask.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::Migration::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_migration_subtask.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_migration_subtask.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @migration_service_stub.get_migration_subtask request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_migration_workflow(request, options = nil) ⇒ ::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow #get_migration_workflow(name: nil, read_mask: nil) ⇒ ::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow

Gets a previously created migration workflow.

Examples:

Basic example

require "google/cloud/bigquery/migration/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Migration::V2::MigrationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::Migration::V2::GetMigrationWorkflowRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow.
p result

Overloads:

  • #get_migration_workflow(request, options = nil) ⇒ ::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow

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

    Parameters:

    • request (::Google::Cloud::Bigquery::Migration::V2::GetMigrationWorkflowRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_migration_workflow(name: nil, read_mask: nil) ⇒ ::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow

    Pass arguments to get_migration_workflow 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) (defaults to: nil) —

      Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

    • read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      The list of fields to be retrieved.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb', line 326

def get_migration_workflow request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::Migration::V2::GetMigrationWorkflowRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_migration_workflow.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::Migration::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_migration_workflow.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_migration_workflow.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @migration_service_stub.get_migration_workflow request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_migration_subtasks(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask> #list_migration_subtasks(parent: nil, read_mask: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask>

Lists previously created migration subtasks.

Examples:

Basic example

require "google/cloud/bigquery/migration/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Migration::V2::MigrationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::Migration::V2::ListMigrationSubtasksRequest.new

# Call the list_migration_subtasks method.
result = client.list_migration_subtasks 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::Bigquery::Migration::V2::MigrationSubtask.
  p item
end

Overloads:

  • #list_migration_subtasks(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask>

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

    Parameters:

    • request (::Google::Cloud::Bigquery::Migration::V2::ListMigrationSubtasksRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_migration_subtasks(parent: nil, read_mask: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask>

    Pass arguments to list_migration_subtasks 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) (defaults to: nil) —

      Required. The migration task of the subtasks to list. Example: projects/123/locations/us/workflows/1234

    • read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. The list of fields to be retrieved.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of migration tasks to return. The service may return fewer than this number.

    • page_token (::String) (defaults to: nil) —

      Optional. A page token, received from previous ListMigrationSubtasks call. Provide this to retrieve the subsequent page.

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

    • filter (::String) (defaults to: nil) —

      Optional. The filter to apply. This can be used to get the subtasks of a specific tasks in a workflow, e.g. migration_task = "ab012" where "ab012" is the task ID (not the name in the named map).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb', line 762

def list_migration_subtasks request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::Migration::V2::ListMigrationSubtasksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_migration_subtasks.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::Migration::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_migration_subtasks.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_migration_subtasks.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @migration_service_stub.list_migration_subtasks request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @migration_service_stub, :list_migration_subtasks, "migration_subtasks", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_migration_workflows(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow> #list_migration_workflows(parent: nil, read_mask: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow>

Lists previously created migration workflow.

Examples:

Basic example

require "google/cloud/bigquery/migration/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Migration::V2::MigrationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::Migration::V2::ListMigrationWorkflowsRequest.new

# Call the list_migration_workflows method.
result = client.list_migration_workflows 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::Bigquery::Migration::V2::MigrationWorkflow.
  p item
end

Overloads:

  • #list_migration_workflows(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow>

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

    Parameters:

    • request (::Google::Cloud::Bigquery::Migration::V2::ListMigrationWorkflowsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_migration_workflows(parent: nil, read_mask: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow>

    Pass arguments to list_migration_workflows 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) (defaults to: nil) —

      Required. The project and location of the migration workflows to list. Example: projects/123/locations/us

    • read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      The list of fields to be retrieved.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of migration workflows to return. The service may return fewer than this number.

    • page_token (::String) (defaults to: nil) —

      A page token, received from previous ListMigrationWorkflows call. Provide this to retrieve the subsequent page.

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb', line 420

def list_migration_workflows request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::Migration::V2::ListMigrationWorkflowsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_migration_workflows.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::Migration::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_migration_workflows.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_migration_workflows.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @migration_service_stub.list_migration_workflows request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @migration_service_stub, :list_migration_workflows, "migration_workflows", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


193
194
195
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb', line 193

def logger
  @migration_service_stub.logger
end

#start_migration_workflow(request, options = nil) ⇒ ::Google::Protobuf::Empty #start_migration_workflow(name: nil) ⇒ ::Google::Protobuf::Empty

Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING.

Examples:

Basic example

require "google/cloud/bigquery/migration/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Migration::V2::MigrationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::Migration::V2::StartMigrationWorkflowRequest.new

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

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

Overloads:

  • #start_migration_workflow(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • request (::Google::Cloud::Bigquery::Migration::V2::StartMigrationWorkflowRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #start_migration_workflow(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to start_migration_workflow 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) (defaults to: nil) —

      Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb', line 583

def start_migration_workflow request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::Migration::V2::StartMigrationWorkflowRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.start_migration_workflow.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::Migration::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.start_migration_workflow.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.start_migration_workflow.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @migration_service_stub.start_migration_workflow request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


126
127
128
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/rest/client.rb', line 126

def universe_domain
  @migration_service_stub.universe_domain
end