google-cloud-dataplex-v1 0.5.0 → 0.5.1

data/proto_docs/google/api/launch_stage.rb

@@ -0,0 +1,71 @@
+# 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 Api
+    # The launch stage as defined by [Google Cloud Platform
+    # Launch Stages](https://cloud.google.com/terms/launch-stages).
+    module LaunchStage
+      # Do not use this default value.
+      LAUNCH_STAGE_UNSPECIFIED = 0
+
+      # The feature is not yet implemented. Users can not use it.
+      UNIMPLEMENTED = 6
+
+      # Prelaunch features are hidden from users and are only visible internally.
+      PRELAUNCH = 7
+
+      # Early Access features are limited to a closed group of testers. To use
+      # these features, you must sign up in advance and sign a Trusted Tester
+      # agreement (which includes confidentiality provisions). These features may
+      # be unstable, changed in backward-incompatible ways, and are not
+      # guaranteed to be released.
+      EARLY_ACCESS = 1
+
+      # Alpha is a limited availability test for releases before they are cleared
+      # for widespread use. By Alpha, all significant design issues are resolved
+      # and we are in the process of verifying functionality. Alpha customers
+      # need to apply for access, agree to applicable terms, and have their
+      # projects allowlisted. Alpha releases don't have to be feature complete,
+      # no SLAs are provided, and there are no technical support obligations, but
+      # they will be far enough along that customers can actually use them in
+      # test environments or for limited-use tests -- just like they would in
+      # normal production cases.
+      ALPHA = 2
+
+      # Beta is the point at which we are ready to open a release for any
+      # customer to use. There are no SLA or technical support obligations in a
+      # Beta release. Products will be complete from a feature perspective, but
+      # may have some open outstanding issues. Beta releases are suitable for
+      # limited production use cases.
+      BETA = 3
+
+      # GA features are open to all developers and are considered stable and
+      # fully qualified for production use.
+      GA = 4
+
+      # Deprecated features are scheduled to be shut down and removed. For more
+      # information, see the "Deprecation Policy" section of our [Terms of
+      # Service](https://cloud.google.com/terms/)
+      # and the [Google Cloud Platform Subject to the Deprecation
+      # Policy](https://cloud.google.com/terms/deprecation) documentation.
+      DEPRECATED = 5
+    end
+  end
+end

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

@@ -32,8 +32,9 @@ module Google
         #     Optional. User friendly display name.
         # @!attribute [r] uid
         #   @return [::String]
-        #     Output only. System generated globally unique ID for the environment. This ID will be
-        #     different if the environment is deleted and re-created with the same name.
+        #     Output only. System generated globally unique ID for the environment. This
+        #     ID will be different if the environment is deleted and re-created with the
+        #     same name.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. Environment creation time.
@@ -60,7 +61,8 @@ module Google
         #     Output only. Status of sessions created for this environment.
         # @!attribute [r] endpoints
         #   @return [::Google::Cloud::Dataplex::V1::Environment::Endpoints]
-        #     Output only. URI Endpoints to access sessions associated with the Environment.
+        #     Output only. URI Endpoints to access sessions associated with the
+        #     Environment.
         class Environment
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -71,7 +73,8 @@ module Google
           #     Optional. Compute resources needed for analyze interactive workloads.
           # @!attribute [rw] os_image
           #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
-          #     Required. Software Runtime Configuration for analyze interactive workloads.
+          #     Required. Software Runtime Configuration for analyze interactive
+          #     workloads.
           class InfrastructureSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -82,7 +85,8 @@ module Google
             #     Optional. Size in GB of the disk. Default is 100 GB.
             # @!attribute [rw] node_count
             #   @return [::Integer]
-            #     Optional. Total number of nodes in the sessions created for this environment.
+            #     Optional. Total number of nodes in the sessions created for this
+            #     environment.
             # @!attribute [rw] max_node_count
             #   @return [::Integer]
             #     Optional. Max configurable nodes.
@@ -108,10 +112,10 @@ module Google
             #     For example, gs://bucket-name/my/path/to/lib.tar.gz
             # @!attribute [rw] properties
             #   @return [::Google::Protobuf::Map{::String => ::String}]
-            #     Optional. Spark properties to provide configuration for use in sessions created
-            #     for this environment. The properties to set on daemon config files.
-            #     Property keys are specified in `prefix:property` format.
-            #     The prefix must be "spark".
+            #     Optional. Spark properties to provide configuration for use in sessions
+            #     created for this environment. The properties to set on daemon config
+            #     files. Property keys are specified in `prefix:property` format. The
+            #     prefix must be "spark".
             class OsImageRuntime
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -133,11 +137,11 @@ module Google
           #     auto-terminated at the end of this period.
           # @!attribute [rw] enable_fast_startup
           #   @return [::Boolean]
-          #     Optional. If True, this causes sessions to be pre-created and available for faster
-          #     startup to enable interactive exploration use-cases. This defaults to
-          #     False to avoid additional billed charges.
-          #     These can only be set to True for the environment with name set to
-          #     "default", and with default configuration.
+          #     Optional. If True, this causes sessions to be pre-created and available
+          #     for faster startup to enable interactive exploration use-cases. This
+          #     defaults to False to avoid additional billed charges. These can only be
+          #     set to True for the environment with name set to "default", and with
+          #     default configuration.
           class SessionSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -145,8 +149,8 @@ module Google
 
           # @!attribute [r] active
           #   @return [::Boolean]
-          #     Output only. Queries over sessions to mark whether the environment is currently
-          #     active or not
+          #     Output only. Queries over sessions to mark whether the environment is
+          #     currently active or not
           class SessionStatus
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -180,13 +184,14 @@ module Google
         #     projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}/content/\\{content_id}
         # @!attribute [r] uid
         #   @return [::String]
-        #     Output only. System generated globally unique ID for the content. This ID will be
-        #     different if the content is deleted and re-created with the same name.
+        #     Output only. System generated globally unique ID for the content. This ID
+        #     will be different if the content is deleted and re-created with the same
+        #     name.
         # @!attribute [rw] path
         #   @return [::String]
-        #     Required. The path for the Content file, represented as directory structure.
-        #     Unique within a lake.
-        #     Limited to alphanumerics, hyphens, underscores, dots and slashes.
+        #     Required. The path for the Content file, represented as directory
+        #     structure. Unique within a lake. Limited to alphanumerics, hyphens,
+        #     underscores, dots and slashes.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. Content creation time.

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

@@ -72,13 +72,13 @@ module Google
         #     projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     Optional. Maximum number of content to return. The service may return fewer than
-        #     this value. If unspecified, at most 10 content will be returned. The
+        #     Optional. Maximum number of content to return. The service may return fewer
+        #     than this value. If unspecified, at most 10 content 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 `ListContent` call. Provide this
-        #     to retrieve the subsequent page. When paginating, all other parameters
+        #     Optional. Page token received from a previous `ListContent` call. Provide
+        #     this to retrieve the subsequent page. When paginating, all other parameters
         #     provided to `ListContent` must match the call that provided the page
         #     token.
         # @!attribute [rw] filter

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

@@ -61,8 +61,8 @@ module Google
         #     `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
         # @!attribute [rw] etag
         #   @return [::String]
-        #     Required. The etag associated with the entity, which can be retrieved with a
-        #     [GetEntity][] request.
+        #     Required. The etag associated with the entity, which can be retrieved with
+        #     a [GetEntity][] request.
         class DeleteEntityRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -78,9 +78,10 @@ module Google
         #     Required. Specify the entity view to make a partial list request.
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     Optional. Maximum number of entities to return. The service may return fewer than
-        #     this value. If unspecified, 100 entities will be returned by default. The
-        #     maximum value is 500; larger values will will be truncated to 500.
+        #     Optional. Maximum number of entities to return. The service may return
+        #     fewer than this value. If unspecified, 100 entities will be returned by
+        #     default. The maximum value is 500; larger values will will be truncated to
+        #     500.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     Optional. Page token received from a previous `ListEntities` call. Provide
@@ -89,8 +90,8 @@ module Google
         #     page token.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     Optional. The following filter parameters can be added to the URL to limit the
-        #     entities returned by the API:
+        #     Optional. The following filter parameters can be added to the URL to limit
+        #     the entities returned by the API:
         #
         #     - Entity ID: ?filter="id=entityID"
         #     - Asset ID: ?filter="asset=assetID"
@@ -164,19 +165,20 @@ module Google
         #     `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     Optional. Maximum number of partitions to return. The service may return fewer than
-        #     this value. If unspecified, 100 partitions will be returned by default. The
-        #     maximum page size is 500; larger values will will be truncated to 500.
+        #     Optional. Maximum number of partitions to return. The service may return
+        #     fewer than this value. If unspecified, 100 partitions will be returned by
+        #     default. The maximum page size is 500; larger values will will be truncated
+        #     to 500.
         # @!attribute [rw] page_token
         #   @return [::String]
-        #     Optional. Page token received from a previous `ListPartitions` call. Provide
-        #     this to retrieve the subsequent page. When paginating, all other parameters
-        #     provided to `ListPartitions` must match the call that provided the
-        #     page token.
+        #     Optional. Page token received from a previous `ListPartitions` call.
+        #     Provide this to retrieve the subsequent page. When paginating, all other
+        #     parameters provided to `ListPartitions` must match the call that provided
+        #     the page token.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     Optional. Filter the partitions returned to the caller using a key value pair
-        #     expression. Supported operators and syntax:
+        #     Optional. Filter the partitions returned to the caller using a key value
+        #     pair expression. Supported operators and syntax:
         #
         #     - logic operators: AND, OR
         #     - comparison operators: <, >, >=, <= ,=, !=
@@ -267,8 +269,8 @@ module Google
         #     Optional. Display name must be shorter than or equal to 256 characters.
         # @!attribute [rw] description
         #   @return [::String]
-        #     Optional. User friendly longer description text. Must be shorter than or equal to
-        #     1024 characters.
+        #     Optional. User friendly longer description text. Must be shorter than or
+        #     equal to 1024 characters.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The time when the entity was created.
@@ -285,15 +287,16 @@ module Google
         #     characters.
         # @!attribute [rw] etag
         #   @return [::String]
-        #     Optional. The etag associated with the entity, which can be retrieved with a
-        #     [GetEntity][] request. Required for update and delete requests.
+        #     Optional. The etag associated with the entity, which can be retrieved with
+        #     a [GetEntity][] request. Required for update and delete requests.
         # @!attribute [rw] type
         #   @return [::Google::Cloud::Dataplex::V1::Entity::Type]
         #     Required. Immutable. The type of entity.
         # @!attribute [rw] asset
         #   @return [::String]
-        #     Required. Immutable. The ID of the asset associated with the storage location containing the
-        #     entity data. The entity must be with in the same zone with the asset.
+        #     Required. Immutable. The ID of the asset associated with the storage
+        #     location containing the entity data. The entity must be with in the same
+        #     zone with the asset.
         # @!attribute [rw] data_path
         #   @return [::String]
         #     Required. Immutable. The storage path of the entity data.
@@ -303,9 +306,9 @@ module Google
         #     `projects/project_id/datasets/dataset_id/tables/table_id`.
         # @!attribute [rw] data_path_pattern
         #   @return [::String]
-        #     Optional. The set of items within the data path constituting the data in the entity,
-        #     represented as a glob path.
-        #     Example: `gs://bucket/path/to/data/**/*.csv`.
+        #     Optional. The set of items within the data path constituting the data in
+        #     the entity, represented as a glob path. Example:
+        #     `gs://bucket/path/to/data/**/*.csv`.
         # @!attribute [r] catalog_entry
         #   @return [::String]
         #     Output only. The name of the associated Data Catalog entry.
@@ -342,12 +345,12 @@ module Google
             # Provides compatibility information for a specific metadata store.
             # @!attribute [r] compatible
             #   @return [::Boolean]
-            #     Output only. Whether the entity is compatible and can be represented in the metadata
-            #     store.
+            #     Output only. Whether the entity is compatible and can be represented in
+            #     the metadata store.
             # @!attribute [r] reason
             #   @return [::String]
-            #     Output only. Provides additional detail if the entity is incompatible with the
-            #     metadata store.
+            #     Output only. Provides additional detail if the entity is incompatible
+            #     with the metadata store.
             class Compatibility
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -377,13 +380,13 @@ module Google
         #     The name field in the response retains the encoded format.
         # @!attribute [rw] values
         #   @return [::Array<::String>]
-        #     Required. Immutable. The set of values representing the partition, which correspond to the
-        #     partition schema defined in the parent entity.
+        #     Required. Immutable. The set of values representing the partition, which
+        #     correspond to the partition schema defined in the parent entity.
         # @!attribute [rw] location
         #   @return [::String]
-        #     Required. Immutable. The location of the entity data within the partition, for example,
-        #     `gs://bucket/path/to/entity/key1=value1/key2=value2`.
-        #     Or `projects/<project_id>/datasets/<dataset_id>/tables/<table_id>`
+        #     Required. Immutable. The location of the entity data within the partition,
+        #     for example, `gs://bucket/path/to/entity/key1=value1/key2=value2`. Or
+        #     `projects/<project_id>/datasets/<dataset_id>/tables/<table_id>`
         # @!attribute [rw] etag
         #   @return [::String]
         #     Optional. The etag for this partition.
@@ -395,8 +398,8 @@ module Google
         # Schema information describing the structure and layout of the data.
         # @!attribute [rw] user_managed
         #   @return [::Boolean]
-        #     Required. Set to `true` if user-managed or `false` if managed by Dataplex. The
-        #     default is `false` (managed by Dataplex).
+        #     Required. Set to `true` if user-managed or `false` if managed by Dataplex.
+        #     The default is `false` (managed by Dataplex).
         #
         #     - Set to `false`to enable Dataplex discovery to update the schema.
         #       including new data discovery, schema inference, and schema evolution.
@@ -414,11 +417,12 @@ module Google
         #     **Note:** BigQuery SchemaFields are immutable.
         # @!attribute [rw] partition_fields
         #   @return [::Array<::Google::Cloud::Dataplex::V1::Schema::PartitionField>]
-        #     Optional. The sequence of fields describing the partition structure in entities.
-        #     If this field is empty, there are no partitions within the data.
+        #     Optional. The sequence of fields describing the partition structure in
+        #     entities. If this field is empty, there are no partitions within the data.
         # @!attribute [rw] partition_style
         #   @return [::Google::Cloud::Dataplex::V1::Schema::PartitionStyle]
-        #     Optional. The structure of paths containing partition data within the entity.
+        #     Optional. The structure of paths containing partition data within the
+        #     entity.
         class Schema
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -431,8 +435,8 @@ module Google
           #     and must begin with a letter or underscore.
           # @!attribute [rw] description
           #   @return [::String]
-          #     Optional. User friendly field description. Must be less than or equal to 1024
-          #     characters.
+          #     Optional. User friendly field description. Must be less than or equal to
+          #     1024 characters.
           # @!attribute [rw] type
           #   @return [::Google::Cloud::Dataplex::V1::Schema::Type]
           #     Required. The type of field.
@@ -453,9 +457,9 @@ module Google
           # Partition fields are immutable.
           # @!attribute [rw] name
           #   @return [::String]
-          #     Required. Partition field name must consist of letters, numbers, and underscores
-          #     only, with a maximum of length of 256 characters,
-          #     and must begin with a letter or underscore..
+          #     Required. Partition field name must consist of letters, numbers, and
+          #     underscores only, with a maximum of length of 256 characters, and must
+          #     begin with a letter or underscore..
           # @!attribute [rw] type
           #   @return [::Google::Cloud::Dataplex::V1::Schema::Type]
           #     Required. Immutable. The type of field.
@@ -546,8 +550,8 @@ module Google
         # Describes the format of the data within its storage location.
         # @!attribute [r] format
         #   @return [::Google::Cloud::Dataplex::V1::StorageFormat::Format]
-        #     Output only. The data format associated with the stored data, which represents
-        #     content type values. The value is inferred from mime type.
+        #     Output only. The data format associated with the stored data, which
+        #     represents content type values. The value is inferred from mime type.
         # @!attribute [rw] compression_format
         #   @return [::Google::Cloud::Dataplex::V1::StorageFormat::CompressionFormat]
         #     Optional. The compression type associated with the stored data.
@@ -581,12 +585,12 @@ module Google
           # Describes CSV and similar semi-structured data formats.
           # @!attribute [rw] encoding
           #   @return [::String]
-          #     Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8", and
-          #     "ISO-8859-1". Defaults to UTF-8 if unspecified.
+          #     Optional. The character encoding of the data. Accepts "US-ASCII",
+          #     "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified.
           # @!attribute [rw] header_rows
           #   @return [::Integer]
-          #     Optional. The number of rows to interpret as header rows that should be skipped
-          #     when reading data rows. Defaults to 0.
+          #     Optional. The number of rows to interpret as header rows that should be
+          #     skipped when reading data rows. Defaults to 0.
           # @!attribute [rw] delimiter
           #   @return [::String]
           #     Optional. The delimiter used to separate values. Defaults to ','.
@@ -603,8 +607,8 @@ module Google
           # Describes JSON data format.
           # @!attribute [rw] encoding
           #   @return [::String]
-          #     Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" and
-          #     "ISO-8859-1". Defaults to UTF-8 if not specified.
+          #     Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8"
+          #     and "ISO-8859-1". Defaults to UTF-8 if not specified.
           class JsonOptions
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods