google-cloud-dataplex-v1 0.5.1 → 0.6.1

data/proto_docs/google/cloud/dataplex/v1/datascans.rb

@@ -0,0 +1,426 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 Dataplex
+      module V1
+        # Create dataScan request.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the parent location:
+        #     `projects/{project}/locations/{location_id}`
+        #     where `project` refers to a *project_id* or *project_number* and
+        #     `location_id` refers to a GCP region.
+        # @!attribute [rw] data_scan
+        #   @return [::Google::Cloud::Dataplex::V1::DataScan]
+        #     Required. DataScan resource.
+        # @!attribute [rw] data_scan_id
+        #   @return [::String]
+        #     Required. DataScan identifier.
+        #
+        #     * Must contain only lowercase letters, numbers and hyphens.
+        #     * Must start with a letter.
+        #     * Must end with a number or a letter.
+        #     * Must be between 1-63 characters.
+        #     * Must be unique within the customer project / location.
+        class CreateDataScanRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Update dataScan request.
+        # @!attribute [rw] data_scan
+        #   @return [::Google::Cloud::Dataplex::V1::DataScan]
+        #     Required. DataScan resource to be updated.
+        #
+        #     Only fields specified in `update_mask` are updated.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. Mask of fields to update.
+        class UpdateDataScanRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Delete dataScan request.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the dataScan:
+        #     `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
+        #     where `project` refers to a *project_id* or *project_number* and
+        #     `location_id` refers to a GCP region.
+        class DeleteDataScanRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Get dataScan request.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the dataScan:
+        #     `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
+        #     where `project` refers to a *project_id* or *project_number* and
+        #     `location_id` refers to a GCP region.
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::Dataplex::V1::GetDataScanRequest::DataScanView]
+        #     Optional. Select the DataScan view to return. Defaults to `BASIC`.
+        class GetDataScanRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # DataScan view options.
+          module DataScanView
+            # The API will default to the `BASIC` view.
+            DATA_SCAN_VIEW_UNSPECIFIED = 0
+
+            # Basic view that does not include *spec* and *result*.
+            BASIC = 1
+
+            # Include everything.
+            FULL = 10
+          end
+        end
+
+        # List dataScans request.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the parent location:
+        #     `projects/{project}/locations/{location_id}`
+        #     where `project` refers to a *project_id* or *project_number* and
+        #     `location_id` refers to a GCP region.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Maximum number of dataScans to return. The service may return
+        #     fewer than this value. If unspecified, at most 10 scans will be returned.
+        #     The maximum value is 1000; values above 1000 will be coerced to 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. Page token received from a previous `ListDataScans` call. Provide
+        #     this to retrieve the subsequent page. When paginating, all other parameters
+        #     provided to `ListDataScans` must match the call that provided the
+        #     page token.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filter request.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Order by fields (`name` or `create_time`) for the result.
+        #     If not specified, the ordering is undefined.
+        class ListDataScansRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # List dataScans response.
+        # @!attribute [rw] data_scans
+        #   @return [::Array<::Google::Cloud::Dataplex::V1::DataScan>]
+        #     DataScans (`BASIC` view only) under the given parent location.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Token to retrieve the next page of results, or empty if there are no more
+        #     results in the list.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Locations that could not be reached.
+        class ListDataScansResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Run DataScan Request
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the DataScan:
+        #     `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`.
+        #     where `project` refers to a *project_id* or *project_number* and
+        #     `location_id` refers to a GCP region.
+        #
+        #     Only **OnDemand** data scans are allowed.
+        class RunDataScanRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Run DataScan Response.
+        # @!attribute [rw] job
+        #   @return [::Google::Cloud::Dataplex::V1::DataScanJob]
+        #     DataScanJob created by RunDataScan request.
+        class RunDataScanResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Get DataScanJob request.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the DataScanJob:
+        #     `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id}`
+        #     where `project` refers to a *project_id* or *project_number* and
+        #     `location_id` refers to a GCP region.
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::Dataplex::V1::GetDataScanJobRequest::DataScanJobView]
+        #     Optional. Select the DataScanJob view to return. Defaults to `BASIC`.
+        class GetDataScanJobRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # DataScanJob view options.
+          module DataScanJobView
+            # The API will default to the `BASIC` view.
+            DATA_SCAN_JOB_VIEW_UNSPECIFIED = 0
+
+            # Basic view that does not include *spec* and *result*.
+            BASIC = 1
+
+            # Include everything.
+            FULL = 10
+          end
+        end
+
+        # List DataScanJobs request.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the parent environment:
+        #     `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
+        #     where `project` refers to a *project_id* or *project_number* and
+        #     `location_id` refers to a GCP region.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Maximum number of DataScanJobs to return. The service may return
+        #     fewer than this value. If unspecified, at most 10 DataScanJobs will be
+        #     returned. The maximum value is 1000; values above 1000 will be coerced to
+        #     1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. Page token received from a previous `ListDataScanJobs` call.
+        #     Provide this to retrieve the subsequent page. When paginating, all other
+        #     parameters provided to `ListDataScanJobs` must match the call that provided
+        #     the page token.
+        class ListDataScanJobsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # List DataScanJobs response.
+        # @!attribute [rw] data_scan_jobs
+        #   @return [::Array<::Google::Cloud::Dataplex::V1::DataScanJob>]
+        #     DataScanJobs (`BASIC` view only) under a given dataScan.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Token to retrieve the next page of results, or empty if there are no more
+        #     results in the list.
+        class ListDataScanJobsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents a user-visible job which provides the insights for the related
+        # data source.
+        #
+        # For example:
+        #
+        # * Data Quality: generates queries based on the rules and runs against the
+        #   data to get data quality check results.
+        # * Data Profile: analyzes the data in table(s) and generates insights about
+        #   the structure, content and relationships (such as null percent,
+        #   cardinality, min/max/mean, etc).
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The relative resource name of the scan, of the form:
+        #     `projects/{project}/locations/{location_id}/dataScans/{datascan_id}`,
+        #     where `project` refers to a *project_id* or *project_number* and
+        #     `location_id` refers to a GCP region.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. System generated globally unique ID for the scan. This ID will
+        #     be different if the scan is deleted and re-created with the same name.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. Description of the scan.
+        #
+        #     * Must be between 1-1024 characters.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. User friendly display name.
+        #
+        #     * Must be between 1-256 characters.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. User-defined labels for the scan.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Dataplex::V1::State]
+        #     Output only. Current state of the DataScan.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the scan was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the scan was last updated.
+        # @!attribute [rw] data
+        #   @return [::Google::Cloud::Dataplex::V1::DataSource]
+        #     Required. The data source for DataScan.
+        # @!attribute [rw] execution_spec
+        #   @return [::Google::Cloud::Dataplex::V1::DataScan::ExecutionSpec]
+        #     Optional. DataScan execution settings.
+        #
+        #     If not specified, the fields in it will use their default values.
+        # @!attribute [r] execution_status
+        #   @return [::Google::Cloud::Dataplex::V1::DataScan::ExecutionStatus]
+        #     Output only. Status of the data scan execution.
+        # @!attribute [r] type
+        #   @return [::Google::Cloud::Dataplex::V1::DataScanType]
+        #     Output only. The type of DataScan.
+        # @!attribute [rw] data_quality_spec
+        #   @return [::Google::Cloud::Dataplex::V1::DataQualitySpec]
+        #     DataQualityScan related setting.
+        # @!attribute [rw] data_profile_spec
+        #   @return [::Google::Cloud::Dataplex::V1::DataProfileSpec]
+        #     DataProfileScan related setting.
+        # @!attribute [r] data_quality_result
+        #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult]
+        #     Output only. The result of the data quality scan.
+        # @!attribute [r] data_profile_result
+        #   @return [::Google::Cloud::Dataplex::V1::DataProfileResult]
+        #     Output only. The result of the data profile scan.
+        class DataScan
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # DataScan execution settings.
+          # @!attribute [rw] trigger
+          #   @return [::Google::Cloud::Dataplex::V1::Trigger]
+          #     Optional. Spec related to how often and when a scan should be triggered.
+          #
+          #     If not specified, the default is `OnDemand`, which means the scan will
+          #     not run until the user calls `RunDataScan` API.
+          # @!attribute [rw] field
+          #   @return [::String]
+          #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
+          #     contains values which monotonically increase over time.
+          #
+          #     If not specified, a data scan will run for all data in the table.
+          class ExecutionSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Status of the data scan execution.
+          # @!attribute [rw] latest_job_start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time when the latest DataScanJob started.
+          # @!attribute [rw] latest_job_end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time when the latest DataScanJob ended.
+          class ExecutionStatus
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # A DataScanJob represents an instance of DataScan execution.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The relative resource name of the DataScanJob, of the form:
+        #     `projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}`,
+        #     where `project` refers to a *project_id* or *project_number* and
+        #     `location_id` refers to a GCP region.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. System generated globally unique ID for the DataScanJob.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the DataScanJob was started.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the DataScanJob ended.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Dataplex::V1::DataScanJob::State]
+        #     Output only. Execution state for the DataScanJob.
+        # @!attribute [r] message
+        #   @return [::String]
+        #     Output only. Additional information about the current state.
+        # @!attribute [r] type
+        #   @return [::Google::Cloud::Dataplex::V1::DataScanType]
+        #     Output only. The type of the parent DataScan.
+        # @!attribute [r] data_quality_spec
+        #   @return [::Google::Cloud::Dataplex::V1::DataQualitySpec]
+        #     Output only. DataQualityScan related setting.
+        # @!attribute [r] data_profile_spec
+        #   @return [::Google::Cloud::Dataplex::V1::DataProfileSpec]
+        #     Output only. DataProfileScan related setting.
+        # @!attribute [r] data_quality_result
+        #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult]
+        #     Output only. The result of the data quality scan.
+        # @!attribute [r] data_profile_result
+        #   @return [::Google::Cloud::Dataplex::V1::DataProfileResult]
+        #     Output only. The result of the data profile scan.
+        class DataScanJob
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Execution state for the DataScanJob.
+          module State
+            # The DataScanJob state is unspecified.
+            STATE_UNSPECIFIED = 0
+
+            # The DataScanJob is running.
+            RUNNING = 1
+
+            # The DataScanJob is canceling.
+            CANCELING = 2
+
+            # The DataScanJob cancellation was successful.
+            CANCELLED = 3
+
+            # The DataScanJob completed successfully.
+            SUCCEEDED = 4
+
+            # The DataScanJob is no longer running due to an error.
+            FAILED = 5
+
+            # The DataScanJob has been created but not started to run yet.
+            PENDING = 7
+          end
+        end
+
+        # The type of DataScan.
+        module DataScanType
+          # The DataScan type is unspecified.
+          DATA_SCAN_TYPE_UNSPECIFIED = 0
+
+          # Data Quality scan.
+          DATA_QUALITY = 1
+
+          # Data Profile scan.
+          DATA_PROFILE = 2
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/dataplex/v1/logs.rb

@@ -257,8 +257,8 @@ module Google
         #     The status of the event.
         # @!attribute [rw] fast_startup_enabled
         #   @return [::Boolean]
-        #     If the session is associated with an Environment with fast startup enabled,
-        #     and was pre-created before being assigned to a user.
+        #     If the session is associated with an environment with fast startup enabled,
+        #     and was created before being assigned to a user.
         # @!attribute [rw] unassigned_duration
         #   @return [::Google::Protobuf::Duration]
         #     The idle duration of a warm pooled session before it is assigned to user.
@@ -321,6 +321,139 @@ module Google
             CREATE = 4
           end
         end
+
+        # These messages contain information about the execution of a datascan.
+        # The monitored resource is 'DataScan'
+        # @!attribute [rw] data_source
+        #   @return [::String]
+        #     The data source of the data scan
+        # @!attribute [rw] job_id
+        #   @return [::String]
+        #     The identifier of the specific data scan job this log entry is for.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time when the data scan job started to run.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time when the data scan job finished.
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::ScanType]
+        #     The type of the data scan.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::State]
+        #     The status of the data scan job.
+        # @!attribute [rw] message
+        #   @return [::String]
+        #     The message describing the data scan job event.
+        # @!attribute [rw] spec_version
+        #   @return [::String]
+        #     A version identifier of the spec which was used to execute this job.
+        # @!attribute [rw] trigger
+        #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::Trigger]
+        #     The trigger type of the data scan job.
+        # @!attribute [rw] scope
+        #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::Scope]
+        #     The scope of the data scan (e.g. full, incremental).
+        # @!attribute [rw] data_profile
+        #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileResult]
+        #     Data profile result for data profile type data scan.
+        # @!attribute [rw] data_quality
+        #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityResult]
+        #     Data quality result for data quality type data scan.
+        class DataScanEvent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Data profile result for data scan job.
+          # @!attribute [rw] row_count
+          #   @return [::Integer]
+          #     The count of rows processed in the data scan job.
+          class DataProfileResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Data quality result for data scan job.
+          # @!attribute [rw] row_count
+          #   @return [::Integer]
+          #     The count of rows processed in the data scan job.
+          # @!attribute [rw] passed
+          #   @return [::Boolean]
+          #     Whether the data quality result was `pass` or not.
+          # @!attribute [rw] dimension_passed
+          #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
+          #     The result of each dimension for data quality result.
+          #     The key of the map is the name of the dimension.
+          #     The value is the bool value depicting whether the dimension result was
+          #     `pass` or not.
+          class DataQualityResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::Boolean]
+            class DimensionPassedEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The type of the data scan.
+          module ScanType
+            # An unspecified data scan type.
+            SCAN_TYPE_UNSPECIFIED = 0
+
+            # Data scan for data profile.
+            DATA_PROFILE = 1
+
+            # Data scan for data quality.
+            DATA_QUALITY = 2
+          end
+
+          # The job state of the data scan.
+          module State
+            # Unspecified job state.
+            STATE_UNSPECIFIED = 0
+
+            # Data scan started.
+            STARTED = 1
+
+            # Data scan successfully completed.
+            SUCCEEDED = 2
+
+            # Data scan was unsuccessful.
+            FAILED = 3
+
+            # Data scan was cancelled.
+            CANCELLED = 4
+          end
+
+          # The trigger type for the data scan.
+          module Trigger
+            # An unspecified trigger type.
+            TRIGGER_UNSPECIFIED = 0
+
+            # Data scan triggers on demand.
+            ON_DEMAND = 1
+
+            # Data scan triggers as per schedule.
+            SCHEDULE = 2
+          end
+
+          # The scope of job for the data scan.
+          module Scope
+            # An unspecified scope type.
+            SCOPE_UNSPECIFIED = 0
+
+            # Data scan runs on all of the data.
+            FULL = 1
+
+            # Data scan runs on incremental data.
+            INCREMENTAL = 2
+          end
+        end
       end
     end
   end

data/proto_docs/google/cloud/dataplex/v1/metadata.rb

@@ -565,6 +565,9 @@ module Google
         #     - application/x-avro
         #     - application/x-orc
         #     - application/x-tfrecord
+        #     - application/x-parquet+iceberg
+        #     - application/x-avro+iceberg
+        #     - application/x-orc+iceberg
         #     - application/json
         #     - application/\\{subtypes}
         #     - text/csv
@@ -578,6 +581,9 @@ module Google
         # @!attribute [rw] json
         #   @return [::Google::Cloud::Dataplex::V1::StorageFormat::JsonOptions]
         #     Optional. Additional information about CSV formatted data.
+        # @!attribute [rw] iceberg
+        #   @return [::Google::Cloud::Dataplex::V1::StorageFormat::IcebergOptions]
+        #     Optional. Additional information about iceberg tables.
         class StorageFormat
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -614,6 +620,16 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Describes Iceberg data format.
+          # @!attribute [rw] metadata_location
+          #   @return [::String]
+          #     Optional. The location of where the iceberg metadata is present, must be
+          #     within the table path
+          class IcebergOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # The specific file format of the data.
           module Format
             # Format unspecified.