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

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

Overview

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 client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the MigrationService client.

Yield Parameters:



144
145
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
187
188
189
190
191
192
193
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/client.rb', line 144

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/bigquery/migration/v2/migration_service_services_pb"

  # 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 = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Bigquery::Migration::V2::MigrationService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @migration_service_stub.stub_logger&.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::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
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
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/client.rb', line 63

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:



114
115
116
117
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/client.rb', line 114

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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/client.rb', line 253

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
  metadata = @config.rpcs.create_migration_workflow.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_migration_workflow.timeout,
                         metadata:     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.call_rpc :create_migration_workflow, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/client.rb', line 530

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
  metadata = @config.rpcs.delete_migration_workflow.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_migration_workflow.timeout,
                         metadata:     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.call_rpc :delete_migration_workflow, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/client.rb', line 707

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
  metadata = @config.rpcs.get_migration_subtask.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_migration_subtask.timeout,
                         metadata:     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.call_rpc :get_migration_subtask, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/client.rb', line 341

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
  metadata = @config.rpcs.get_migration_workflow.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_migration_workflow.timeout,
                         metadata:     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.call_rpc :get_migration_workflow, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_migration_subtasks(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask> #list_migration_subtasks(parent: nil, read_mask: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/client.rb', line 812

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
  metadata = @config.rpcs.list_migration_subtasks.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_migration_subtasks.timeout,
                         metadata:     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.call_rpc :list_migration_subtasks, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @migration_service_stub, :list_migration_subtasks, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_migration_workflows(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow> #list_migration_workflows(parent: nil, read_mask: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/client.rb', line 442

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
  metadata = @config.rpcs.list_migration_workflows.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_migration_workflows.timeout,
                         metadata:     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.call_rpc :list_migration_workflows, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @migration_service_stub, :list_migration_workflows, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


200
201
202
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/client.rb', line 200

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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/client.rb', line 619

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
  metadata = @config.rpcs.start_migration_workflow.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.start_migration_workflow.timeout,
                         metadata:     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.call_rpc :start_migration_workflow, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


124
125
126
 
# File 'lib/google/cloud/bigquery/migration/v2/migration_service/client.rb', line 124

def universe_domain
  @migration_service_stub.universe_domain
end