google-cloud-bigquery-migration-v2 0.1.0

data/proto_docs/google/cloud/bigquery/migration/v2/migration_entities.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Bigquery
+      module Migration
+        module V2
+          # A migration workflow which specifies what needs to be done for an EDW
+          # migration.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. Immutable. The unique identifier for the migration workflow.
+          #     The ID is server-generated.
+          #
+          #     Example: `projects/123/locations/us/workflows/345`
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     The display name of the workflow. This can be set to give a workflow
+          #     a descriptive name. There is no guarantee or enforcement of uniqueness.
+          # @!attribute [rw] tasks
+          #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Bigquery::Migration::V2::MigrationTask}]
+          #     The tasks in a workflow in a named map. The name (i.e. key) has no
+          #     meaning and is merely a convenient way to address a specific task
+          #     in a workflow.
+          # @!attribute [r] state
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow::State]
+          #     Output only. That status of the workflow.
+          # @!attribute [rw] create_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Time when the workflow was created.
+          # @!attribute [rw] last_update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Time when the workflow was last updated.
+          class MigrationWorkflow
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::Google::Cloud::Bigquery::Migration::V2::MigrationTask]
+            class TasksEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Possible migration workflow states.
+            module State
+              # Workflow state is unspecified.
+              STATE_UNSPECIFIED = 0
+
+              # Workflow is in draft status, i.e. tasks are not yet eligible for
+              # execution.
+              DRAFT = 1
+
+              # Workflow is running (i.e. tasks are eligible for execution).
+              RUNNING = 2
+
+              # Workflow is paused. Tasks currently in progress may continue, but no
+              # further tasks will be scheduled.
+              PAUSED = 3
+
+              # Workflow is complete. There should not be any task in a non-terminal
+              # state, but if they are (e.g. forced termination), they will not be
+              # scheduled.
+              COMPLETED = 4
+            end
+          end
+
+          # A single task for a migration which has details about the configuration of
+          # the task.
+          # @!attribute [rw] translation_config_details
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::TranslationConfigDetails]
+          #     Task configuration for Batch SQL Translation.
+          # @!attribute [r] id
+          #   @return [::String]
+          #     Output only. Immutable. The unique identifier for the migration task. The
+          #     ID is server-generated.
+          # @!attribute [rw] type
+          #   @return [::String]
+          #     The type of the task. This must be one of the supported task types:
+          #     Translation_Teradata2BQ, Translation_Redshift2BQ, Translation_Bteq2BQ,
+          #     Translation_Oracle2BQ, Translation_HiveQL2BQ, Translation_SparkSQL2BQ,
+          #     Translation_Snowflake2BQ, Translation_Netezza2BQ.
+          # @!attribute [r] state
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::MigrationTask::State]
+          #     Output only. The current state of the task.
+          # @!attribute [r] processing_error
+          #   @return [::Google::Rpc::ErrorInfo]
+          #     Output only. An explanation that may be populated when the task is in
+          #     FAILED state.
+          # @!attribute [rw] create_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Time when the task was created.
+          # @!attribute [rw] last_update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Time when the task was last updated.
+          class MigrationTask
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Possible states of a migration task.
+            module State
+              # The state is unspecified.
+              STATE_UNSPECIFIED = 0
+
+              # The task is waiting for orchestration.
+              PENDING = 1
+
+              # The task is assigned to an orchestrator.
+              ORCHESTRATING = 2
+
+              # The task is running, i.e. its subtasks are ready for execution.
+              RUNNING = 3
+
+              # Tha task is paused. Assigned subtasks can continue, but no new subtasks
+              # will be scheduled.
+              PAUSED = 4
+
+              # The task finished successfully.
+              SUCCEEDED = 5
+
+              # The task finished unsuccessfully.
+              FAILED = 6
+            end
+          end
+
+          # A subtask for a migration which carries details about the configuration of
+          # the subtask. The content of the details should not matter to the end user,
+          # but is a contract between the subtask creator and subtask worker.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. Immutable. The resource name for the migration subtask. The ID
+          #     is server-generated.
+          #
+          #     Example: `projects/123/locations/us/workflows/345/subtasks/678`
+          # @!attribute [rw] task_id
+          #   @return [::String]
+          #     The unique ID of the task to which this subtask belongs.
+          # @!attribute [rw] type
+          #   @return [::String]
+          #     The type of the Subtask. The migration service does not check whether this
+          #     is a known type. It is up to the task creator (i.e. orchestrator or worker)
+          #     to ensure it only creates subtasks for which there are compatible workers
+          #     polling for Subtasks.
+          # @!attribute [r] state
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask::State]
+          #     Output only. The current state of the subtask.
+          # @!attribute [r] processing_error
+          #   @return [::Google::Rpc::ErrorInfo]
+          #     Output only. An explanation that may be populated when the task is in
+          #     FAILED state.
+          # @!attribute [r] resource_error_details
+          #   @return [::Array<::Google::Cloud::Bigquery::Migration::V2::ResourceErrorDetail>]
+          #     Output only. Provides details to errors and issues encountered while
+          #     processing the subtask. Presence of error details does not mean that the
+          #     subtask failed.
+          # @!attribute [rw] resource_error_count
+          #   @return [::Integer]
+          #     The number or resources with errors. Note: This is not the total
+          #     number of errors as each resource can have more than one error.
+          #     This is used to indicate truncation by having a `resource_error_count`
+          #     that is higher than the size of `resource_error_details`.
+          # @!attribute [rw] create_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Time when the subtask was created.
+          # @!attribute [rw] last_update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Time when the subtask was last updated.
+          # @!attribute [rw] metrics
+          #   @return [::Array<::Google::Cloud::Bigquery::Migration::V2::TimeSeries>]
+          #     The metrics for the subtask.
+          class MigrationSubtask
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Possible states of a migration subtask.
+            module State
+              # The state is unspecified.
+              STATE_UNSPECIFIED = 0
+
+              # The subtask is ready, i.e. it is ready for execution.
+              ACTIVE = 1
+
+              # The subtask is running, i.e. it is assigned to a worker for execution.
+              RUNNING = 2
+
+              # The subtask finished successfully.
+              SUCCEEDED = 3
+
+              # The subtask finished unsuccessfully.
+              FAILED = 4
+
+              # The subtask is paused, i.e., it will not be scheduled. If it was already
+              # assigned,it might still finish but no new lease renewals will be granted.
+              PAUSED = 5
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/bigquery/migration/v2/migration_error_details.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Bigquery
+      module Migration
+        module V2
+          # Provides details for errors and the corresponding resources.
+          # @!attribute [rw] resource_info
+          #   @return [::Google::Rpc::ResourceInfo]
+          #     Required. Information about the resource where the error is located.
+          # @!attribute [rw] error_details
+          #   @return [::Array<::Google::Cloud::Bigquery::Migration::V2::ErrorDetail>]
+          #     Required. The error details for the resource.
+          # @!attribute [rw] error_count
+          #   @return [::Integer]
+          #     Required. How many errors there are in total for the resource. Truncation can be
+          #     indicated by having an `error_count` that is higher than the size of
+          #     `error_details`.
+          class ResourceErrorDetail
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Provides details for errors, e.g. issues that where encountered when
+          # processing a subtask.
+          # @!attribute [rw] location
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::ErrorLocation]
+          #     Optional. The exact location within the resource (if applicable).
+          # @!attribute [rw] error_info
+          #   @return [::Google::Rpc::ErrorInfo]
+          #     Required. Describes the cause of the error with structured detail.
+          class ErrorDetail
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Holds information about where the error is located.
+          # @!attribute [rw] line
+          #   @return [::Integer]
+          #     Optional. If applicable, denotes the line where the error occurred. A zero value
+          #     means that there is no line information.
+          # @!attribute [rw] column
+          #   @return [::Integer]
+          #     Optional. If applicable, denotes the column where the error occurred. A zero value
+          #     means that there is no columns information.
+          class ErrorLocation
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/bigquery/migration/v2/migration_metrics.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Bigquery
+      module Migration
+        module V2
+          # The metrics object for a SubTask.
+          # @!attribute [rw] metric
+          #   @return [::String]
+          #     Required. The name of the metric.
+          #
+          #     If the metric is not known by the service yet, it will be auto-created.
+          # @!attribute [rw] value_type
+          #   @return [::Google::Api::MetricDescriptor::ValueType]
+          #     Required. The value type of the time series.
+          # @!attribute [rw] metric_kind
+          #   @return [::Google::Api::MetricDescriptor::MetricKind]
+          #     Optional. The metric kind of the time series.
+          #
+          #     If present, it must be the same as the metric kind of the associated
+          #     metric. If the associated metric's descriptor must be auto-created, then
+          #     this field specifies the metric kind of the new descriptor and must be
+          #     either `GAUGE` (the default) or `CUMULATIVE`.
+          # @!attribute [rw] points
+          #   @return [::Array<::Google::Cloud::Bigquery::Migration::V2::Point>]
+          #     Required. The data points of this time series. When listing time series, points are
+          #     returned in reverse time order.
+          #
+          #     When creating a time series, this field must contain exactly one point and
+          #     the point's type must be the same as the value type of the associated
+          #     metric. If the associated metric's descriptor must be auto-created, then
+          #     the value type of the descriptor is determined by the point's type, which
+          #     must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.
+          class TimeSeries
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A single data point in a time series.
+          # @!attribute [rw] interval
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::TimeInterval]
+          #     The time interval to which the data point applies.  For `GAUGE` metrics,
+          #     the start time does not need to be supplied, but if it is supplied, it must
+          #     equal the end time.  For `DELTA` metrics, the start and end time should
+          #     specify a non-zero interval, with subsequent points specifying contiguous
+          #     and non-overlapping intervals.  For `CUMULATIVE` metrics, the start and end
+          #     time should specify a non-zero interval, with subsequent points specifying
+          #     the same start time and increasing end times, until an event resets the
+          #     cumulative value to zero and sets a new start time for the following
+          #     points.
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::TypedValue]
+          #     The value of the data point.
+          class Point
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A time interval extending just after a start time through an end time.
+          # If the start time is the same as the end time, then the interval
+          # represents a single point in time.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Optional. The beginning of the time interval.  The default value
+          #     for the start time is the end time. The start time must not be
+          #     later than the end time.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Required. The end of the time interval.
+          class TimeInterval
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A single strongly-typed value.
+          # @!attribute [rw] bool_value
+          #   @return [::Boolean]
+          #     A Boolean value: `true` or `false`.
+          # @!attribute [rw] int64_value
+          #   @return [::Integer]
+          #     A 64-bit integer. Its range is approximately `+/-9.2x10^18`.
+          # @!attribute [rw] double_value
+          #   @return [::Float]
+          #     A 64-bit double-precision floating-point number. Its magnitude
+          #     is approximately `+/-10^(+/-300)` and it has 16 significant digits of
+          #     precision.
+          # @!attribute [rw] string_value
+          #   @return [::String]
+          #     A variable-length string value.
+          # @!attribute [rw] distribution_value
+          #   @return [::Google::Api::Distribution]
+          #     A distribution value.
+          class TypedValue
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/bigquery/migration/v2/migration_service.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Bigquery
+      module Migration
+        module V2
+          # Request to create a migration workflow resource.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The name of the project to which this migration workflow belongs.
+          #     Example: `projects/foo/locations/bar`
+          # @!attribute [rw] migration_workflow
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow]
+          #     Required. The migration workflow to create.
+          class CreateMigrationWorkflowRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A request to get a previously created migration workflow.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The unique identifier for the migration workflow.
+          #     Example: `projects/123/locations/us/workflows/1234`
+          # @!attribute [rw] read_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     The list of fields to be retrieved.
+          class GetMigrationWorkflowRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A request to list previously created migration workflows.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The project and location of the migration workflows to list.
+          #     Example: `projects/123/locations/us`
+          # @!attribute [rw] read_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     The list of fields to be retrieved.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of migration workflows to return. The service may return
+          #     fewer than this number.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     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.
+          class ListMigrationWorkflowsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response object for a `ListMigrationWorkflows` call.
+          # @!attribute [rw] migration_workflows
+          #   @return [::Array<::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow>]
+          #     The migration workflows for the specified project / location.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     A token, which can be sent as `page_token` to retrieve the next page.
+          #     If this field is omitted, there are no subsequent pages.
+          class ListMigrationWorkflowsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A request to delete a previously created migration workflow.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The unique identifier for the migration workflow.
+          #     Example: `projects/123/locations/us/workflows/1234`
+          class DeleteMigrationWorkflowRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A request to start a previously created migration workflow.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The unique identifier for the migration workflow.
+          #     Example: `projects/123/locations/us/workflows/1234`
+          class StartMigrationWorkflowRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A request to get a previously created migration subtasks.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The unique identifier for the migration subtask.
+          #     Example: `projects/123/locations/us/workflows/1234/subtasks/543`
+          # @!attribute [rw] read_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Optional. The list of fields to be retrieved.
+          class GetMigrationSubtaskRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A request to list previously created migration subtasks.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The migration task of the subtasks to list.
+          #     Example: `projects/123/locations/us/workflows/1234`
+          # @!attribute [rw] read_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Optional. The list of fields to be retrieved.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     Optional. The maximum number of migration tasks to return. The service may return
+          #     fewer than this number.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     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.
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     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).
+          class ListMigrationSubtasksRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response object for a `ListMigrationSubtasks` call.
+          # @!attribute [rw] migration_subtasks
+          #   @return [::Array<::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask>]
+          #     The migration subtasks for the specified task.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     A token, which can be sent as `page_token` to retrieve the next page.
+          #     If this field is omitted, there are no subsequent pages.
+          class ListMigrationSubtasksResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end