# frozen_string_literal: true

# Copyright 2020 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 DataCatalog
      module V1
        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalog}.
        # @!attribute [rw] scope
        #   @return [::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope]
        #     Required. The scope of this search request.
        #
        #     The `scope` is invalid if `include_org_ids`, `include_project_ids` are
        #     empty AND `include_gcp_public_datasets` is set to `false`. In this case,
        #     the request returns an error.
        # @!attribute [rw] query
        #   @return [::String]
        #     Optional. The query string with a minimum of 3 characters and specific syntax.
        #     For more information, see
        #     [Data Catalog search syntax](/data-catalog/docs/how-to/search-reference).
        #
        #     An empty query string returns all data assets (in the specified scope)
        #     that you have access to.
        #
        #     A query string can be a simple `xyz` or qualified by predicates:
        #
        #     * `name:x`
        #     * `column:y`
        #     * `description:z`
        # @!attribute [rw] page_size
        #   @return [::Integer]
        #     Number of results to return in a single search page.
        #
        #     Can't be negative or 0, defaults to 10 in this case.
        #     The maximum number is 1000. If exceeded, throws an "invalid argument"
        #     exception.
        # @!attribute [rw] page_token
        #   @return [::String]
        #     Optional. Pagination token that, if specified, returns the next page of search
        #     results. If empty, returns the first page.
        #
        #     This token is returned in the {::Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token}
        #     field of the response to a previous
        #     {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalogRequest}
        #     call.
        # @!attribute [rw] order_by
        #   @return [::String]
        #     Specifies the order of results.
        #
        #     Currently supported case-sensitive values are:
        #
        #     * `relevance` that can only be descending
        #     * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
        #
        #     If this parameter is omitted, it defaults to the descending `relevance`.
        class SearchCatalogRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # The criteria that select the subspace used for query matching.
          # @!attribute [rw] include_org_ids
          #   @return [::Array<::String>]
          #     The list of organization IDs to search within.
          #
          #     To find your organization ID, follow the steps from
          #     [Creating and managing organizations]
          #     (/resource-manager/docs/creating-managing-organization).
          # @!attribute [rw] include_project_ids
          #   @return [::Array<::String>]
          #     The list of project IDs to search within.
          #
          #     For more information on the distinction between project names, IDs, and
          #     numbers, see [Projects](/docs/overview/#projects).
          # @!attribute [rw] include_gcp_public_datasets
          #   @return [::Boolean]
          #     If `true`, include Google Cloud Platform (GCP) public datasets in
          #     search results. By default, they are excluded.
          #
          #     See [Google Cloud Public Datasets](/public-datasets) for more
          #     information.
          # @!attribute [rw] restricted_locations
          #   @return [::Array<::String>]
          #     Optional. The list of locations to search within. If empty, all locations are
          #     searched.
          #
          #     Returns an error if any location in the list isn't one of the [Supported
          #     regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).
          #
          #     If a location is unreachable, its name is returned in the
          #     `SearchCatalogResponse.unreachable` field. To get additional information
          #     on the error, repeat the search request and set the location name as the
          #     value of this parameter.
          # @!attribute [rw] include_public_tag_templates
          #   @return [::Boolean]
          #     Optional. If `true`, include [public tag
          #     templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable]
          #     in the search results. By default, they are included only if you have
          #     explicit permissions on them to view them. For example, if you are the
          #     owner.
          #
          #     Other scope fields, for example, ``include_org_ids``,
          #     still restrict the returned public tag templates and at least one of
          #     them is required.
          class Scope
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end
        end

        # Response message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalog}.
        # @!attribute [rw] results
        #   @return [::Array<::Google::Cloud::DataCatalog::V1::SearchCatalogResult>]
        #     Search results.
        # @!attribute [rw] next_page_token
        #   @return [::String]
        #     Pagination token that can be used in subsequent calls to retrieve the next
        #     page of results.
        # @!attribute [rw] unreachable
        #   @return [::Array<::String>]
        #     Unreachable locations. Search results don't include data from those
        #     locations.
        #
        #     To get additional information on an error, repeat the search request and
        #     restrict it to specific locations by setting the
        #     `SearchCatalogRequest.scope.restricted_locations` parameter.
        class SearchCatalogResponse
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry_group CreateEntryGroup}.
        # @!attribute [rw] parent
        #   @return [::String]
        #     Required. The names of the project and location that the new entry group belongs to.
        #
        #     Note: The entry group itself and its child resources might not be
        #     stored in the location specified in its name.
        # @!attribute [rw] entry_group_id
        #   @return [::String]
        #     Required. The ID of the entry group to create.
        #
        #     The ID must contain only letters (a-z, A-Z), numbers (0-9),
        #     underscores (_), and must start with a letter or underscore.
        #     The maximum size is 64 bytes when encoded in UTF-8.
        # @!attribute [rw] entry_group
        #   @return [::Google::Cloud::DataCatalog::V1::EntryGroup]
        #     The entry group to create. Defaults to empty.
        class CreateEntryGroupRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_entry_group UpdateEntryGroup}.
        # @!attribute [rw] entry_group
        #   @return [::Google::Cloud::DataCatalog::V1::EntryGroup]
        #     Required. Updates for the entry group. The `name` field must be set.
        # @!attribute [rw] update_mask
        #   @return [::Google::Protobuf::FieldMask]
        #     Names of fields whose values to overwrite on an entry group.
        #
        #     If this parameter is absent or empty, all modifiable fields
        #     are overwritten. If such fields are non-required and omitted in the
        #     request body, their values are emptied.
        class UpdateEntryGroupRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#get_entry_group GetEntryGroup}.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The name of the entry group to get.
        # @!attribute [rw] read_mask
        #   @return [::Google::Protobuf::FieldMask]
        #     The fields to return. If empty or omitted, all fields are returned.
        class GetEntryGroupRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_entry_group DeleteEntryGroup}.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The name of the entry group to delete.
        # @!attribute [rw] force
        #   @return [::Boolean]
        #     Optional. If true, deletes all entries in the entry group.
        class DeleteEntryGroupRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entry_groups ListEntryGroups}.
        # @!attribute [rw] parent
        #   @return [::String]
        #     Required. The name of the location that contains the entry groups to list.
        #
        #     Can be provided as a URL.
        # @!attribute [rw] page_size
        #   @return [::Integer]
        #     Optional. The maximum number of items to return.
        #
        #     Default is 10. Maximum limit is 1000.
        #     Throws an invalid argument if `page_size` is greater than 1000.
        # @!attribute [rw] page_token
        #   @return [::String]
        #     Optional. Pagination token that specifies the next page to return.
        #     If empty, returns the first page.
        class ListEntryGroupsRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Response message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entry_groups ListEntryGroups}.
        # @!attribute [rw] entry_groups
        #   @return [::Array<::Google::Cloud::DataCatalog::V1::EntryGroup>]
        #     Entry group details.
        # @!attribute [rw] next_page_token
        #   @return [::String]
        #     Pagination token to specify in the next call to retrieve the next page of
        #     results. Empty if there are no more items.
        class ListEntryGroupsResponse
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry CreateEntry}.
        # @!attribute [rw] parent
        #   @return [::String]
        #     Required. The name of the entry group this entry belongs to.
        #
        #     Note: The entry itself and its child resources might not be stored in
        #     the location specified in its name.
        # @!attribute [rw] entry_id
        #   @return [::String]
        #     Required. The ID of the entry to create.
        #
        #     The ID must contain only letters (a-z, A-Z), numbers (0-9),
        #     and underscores (_).
        #     The maximum size is 64 bytes when encoded in UTF-8.
        # @!attribute [rw] entry
        #   @return [::Google::Cloud::DataCatalog::V1::Entry]
        #     Required. The entry to create.
        class CreateEntryRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_entry UpdateEntry}.
        # @!attribute [rw] entry
        #   @return [::Google::Cloud::DataCatalog::V1::Entry]
        #     Required. Updates for the entry. The `name` field must be set.
        # @!attribute [rw] update_mask
        #   @return [::Google::Protobuf::FieldMask]
        #     Names of fields whose values to overwrite on an entry.
        #
        #     If this parameter is absent or empty, all modifiable fields
        #     are overwritten. If such fields are non-required and omitted in the
        #     request body, their values are emptied.
        #
        #     You can modify only the fields listed below.
        #
        #     For entries with type `DATA_STREAM`:
        #
        #     * `schema`
        #
        #     For entries with type `FILESET`:
        #
        #     * `schema`
        #     * `display_name`
        #     * `description`
        #     * `gcs_fileset_spec`
        #     * `gcs_fileset_spec.file_patterns`
        #
        #     For entries with `user_specified_type`:
        #
        #     * `schema`
        #     * `display_name`
        #     * `description`
        #     * `user_specified_type`
        #     * `user_specified_system`
        #     * `linked_resource`
        #     * `source_system_timestamps`
        class UpdateEntryRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_entry DeleteEntry}.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The name of the entry to delete.
        class DeleteEntryRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#get_entry GetEntry}.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The name of the entry to get.
        class GetEntryRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#lookup_entry LookupEntry}.
        # @!attribute [rw] linked_resource
        #   @return [::String]
        #     The full name of the Google Cloud Platform resource the Data Catalog
        #     entry represents. For more information, see [Full Resource Name]
        #     (https://cloud.google.com/apis/design/resource_names#full_resource_name).
        #
        #     Full names are case-sensitive. For example:
        #
        #      * `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
        #      * `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`
        # @!attribute [rw] sql_resource
        #   @return [::String]
        #     The SQL name of the entry. SQL names are case-sensitive.
        #
        #     Examples:
        #
        #     * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}`
        #     * `pubsub.topic.{PROJECT_ID}.`\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\`
        #     * `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}`
        #     * `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}`
        #     * `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}`
        #
        #     Identifiers (`*_ID`) should comply with the
        #     [Lexical structure in Standard SQL]
        #     (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
        # @!attribute [rw] fully_qualified_name
        #   @return [::String]
        #     Fully qualified name (FQN) of the resource.
        #
        #     FQNs take two forms:
        #
        #     * For non-regionalized resources:
        #
        #       `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
        #
        #     * For regionalized resources:
        #
        #       `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
        #
        #     Example for a DPMS table:
        #
        #     `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}`
        class LookupEntryRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Entry metadata.
        # A Data Catalog entry represents another resource in Google
        # Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or
        # outside of it. You can use the `linked_resource` field
        # in the entry resource to refer to the original resource ID of the source
        # system.
        #
        # An entry resource contains resource details, for example, its schema.
        # Additionally, you can attach flexible metadata to an entry in the form of a
        # {::Google::Cloud::DataCatalog::V1::Tag Tag}.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. The resource name of an entry in URL format.
        #
        #     Note: The entry itself and its child resources might not be
        #     stored in the location specified in its name.
        # @!attribute [rw] linked_resource
        #   @return [::String]
        #     The resource this metadata entry refers to.
        #
        #     For Google Cloud Platform resources, `linked_resource` is the
        #     [Full Resource Name]
        #     (https://cloud.google.com/apis/design/resource_names#full_resource_name).
        #     For example, the `linked_resource` for a table resource from BigQuery is:
        #
        #     `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
        #
        #     Output only when the entry is one of the types in the `EntryType` enum.
        #
        #     For entries with a `user_specified_type`, this field is optional and
        #     defaults to an empty string.
        #
        #     The resource string must contain only letters (a-z, A-Z), numbers (0-9),
        #     underscores (_), periods (.), colons (:), slashes (/), dashes (-),
        #     and hashes (#).
        #     The maximum size is 200 bytes when encoded in UTF-8.
        # @!attribute [rw] fully_qualified_name
        #   @return [::String]
        #     Fully qualified name (FQN) of the resource. Set automatically for entries
        #     representing resources from synced systems. Settable only during creation
        #     and read-only afterwards. Can be used for search and lookup of the entries.
        #
        #
        #     FQNs take two forms:
        #
        #     * For non-regionalized resources:
        #
        #       `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
        #
        #     * For regionalized resources:
        #
        #       `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
        #
        #     Example for a DPMS table:
        #
        #     `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}`
        # @!attribute [rw] type
        #   @return [::Google::Cloud::DataCatalog::V1::EntryType]
        #     The type of the entry.
        #     Only used for entries with types listed in the `EntryType` enum.
        #
        #     Currently, only `FILESET` enum value is allowed. All other entries
        #     created in Data Catalog must use the `user_specified_type`.
        # @!attribute [rw] user_specified_type
        #   @return [::String]
        #     Custom entry type that doesn't match any of the values allowed for input
        #     and listed in the `EntryType` enum.
        #
        #     When creating an entry, first check the type values in the enum.
        #     If there are no appropriate types for the new entry,
        #     provide a custom value, for example, `my_special_type`.
        #
        #     The `user_specified_type` string has the following limitations:
        #
        #     * Is case insensitive.
        #     * Must begin with a letter or underscore.
        #     * Can only contain letters, numbers, and underscores.
        #     * Must be at least 1 character and at most 64 characters long.
        # @!attribute [r] integrated_system
        #   @return [::Google::Cloud::DataCatalog::V1::IntegratedSystem]
        #     Output only. Indicates the entry's source system that Data Catalog
        #     integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
        # @!attribute [rw] user_specified_system
        #   @return [::String]
        #     Indicates the entry's source system that Data Catalog doesn't
        #     automatically integrate with.
        #
        #     The `user_specified_system` string has the following limitations:
        #
        #     * Is case insensitive.
        #     * Must begin with a letter or underscore.
        #     * Can only contain letters, numbers, and underscores.
        #     * Must be at least 1 character and at most 64 characters long.
        # @!attribute [rw] gcs_fileset_spec
        #   @return [::Google::Cloud::DataCatalog::V1::GcsFilesetSpec]
        #     Specification that applies to a Cloud Storage fileset. Valid only
        #     for entries with the `FILESET` type.
        # @!attribute [rw] bigquery_table_spec
        #   @return [::Google::Cloud::DataCatalog::V1::BigQueryTableSpec]
        #     Specification that applies to a BigQuery table. Valid only for
        #     entries with the `TABLE` type.
        # @!attribute [rw] bigquery_date_sharded_spec
        #   @return [::Google::Cloud::DataCatalog::V1::BigQueryDateShardedSpec]
        #     Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD`
        #     name pattern.
        #
        #     For more information, see [Introduction to partitioned tables]
        #     (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
        # @!attribute [rw] database_table_spec
        #   @return [::Google::Cloud::DataCatalog::V1::DatabaseTableSpec]
        #     Specification that applies to a table resource. Valid only
        #     for entries with the `TABLE` type.
        # @!attribute [rw] data_source_connection_spec
        #   @return [::Google::Cloud::DataCatalog::V1::DataSourceConnectionSpec]
        #     Specification that applies to a data source connection. Valid only
        #     for entries with the `DATA_SOURCE_CONNECTION` type.
        # @!attribute [rw] routine_spec
        #   @return [::Google::Cloud::DataCatalog::V1::RoutineSpec]
        #     Specification that applies to a user-defined function or procedure. Valid
        #     only for entries with the `ROUTINE` type.
        # @!attribute [rw] display_name
        #   @return [::String]
        #     Display name of an entry.
        #
        #     The name must contain only Unicode letters, numbers (0-9), underscores (_),
        #     dashes (-), spaces ( ), and can't start or end with spaces.
        #     The maximum size is 200 bytes when encoded in UTF-8.
        #     Default value is an empty string.
        # @!attribute [rw] description
        #   @return [::String]
        #     Entry description that can consist of several sentences or paragraphs
        #     that describe entry contents.
        #
        #     The description must not contain Unicode non-characters as well as C0
        #     and C1 control codes except tabs (HT), new lines (LF), carriage returns
        #     (CR), and page breaks (FF).
        #     The maximum size is 2000 bytes when encoded in UTF-8.
        #     Default value is an empty string.
        # @!attribute [rw] schema
        #   @return [::Google::Cloud::DataCatalog::V1::Schema]
        #     Schema of the entry. An entry might not have any schema attached to it.
        # @!attribute [rw] source_system_timestamps
        #   @return [::Google::Cloud::DataCatalog::V1::SystemTimestamps]
        #     Timestamps from the underlying resource, not from the Data Catalog
        #     entry.
        #
        #     Output only when the entry has a type listed in the `EntryType` enum.
        #     For entries with `user_specified_type`, this field is optional and defaults
        #     to an empty timestamp.
        # @!attribute [r] usage_signal
        #   @return [::Google::Cloud::DataCatalog::V1::UsageSignal]
        #     Output only. Resource usage statistics.
        # @!attribute [rw] labels
        #   @return [::Google::Protobuf::Map{::String => ::String}]
        #     Cloud labels attached to the entry.
        #
        #     In Data Catalog, you can create and modify labels attached only to custom
        #     entries. Synced entries have unmodifiable labels that come from the source
        #     system.
        # @!attribute [r] data_source
        #   @return [::Google::Cloud::DataCatalog::V1::DataSource]
        #     Output only. Physical location of the entry.
        class Entry
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # @!attribute [rw] key
          #   @return [::String]
          # @!attribute [rw] value
          #   @return [::String]
          class LabelsEntry
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end
        end

        # Specification that applies to a table resource. Valid only
        # for entries with the `TABLE` type.
        # @!attribute [rw] type
        #   @return [::Google::Cloud::DataCatalog::V1::DatabaseTableSpec::TableType]
        #     Type of this table.
        class DatabaseTableSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Type of the table.
          module TableType
            # Default unknown table type.
            TABLE_TYPE_UNSPECIFIED = 0

            # Native table.
            NATIVE = 1

            # External table.
            EXTERNAL = 2
          end
        end

        # Specification that applies to a data source connection. Valid only for
        # entries with the `DATA_SOURCE_CONNECTION` type.
        # @!attribute [rw] bigquery_connection_spec
        #   @return [::Google::Cloud::DataCatalog::V1::BigQueryConnectionSpec]
        #     Fields specific to BigQuery connections.
        class DataSourceConnectionSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Specification that applies to a routine. Valid only for
        # entries with the `ROUTINE` type.
        # @!attribute [rw] routine_type
        #   @return [::Google::Cloud::DataCatalog::V1::RoutineSpec::RoutineType]
        #     The type of the routine.
        # @!attribute [rw] language
        #   @return [::String]
        #     The language the routine is written in. The exact value depends on the
        #     source system. For BigQuery routines, possible values are:
        #
        #     * `SQL`
        #     * `JAVASCRIPT`
        # @!attribute [rw] routine_arguments
        #   @return [::Array<::Google::Cloud::DataCatalog::V1::RoutineSpec::Argument>]
        #     Arguments of the routine.
        # @!attribute [rw] return_type
        #   @return [::String]
        #     Return type of the argument. The exact value depends on the source system
        #     and the language.
        # @!attribute [rw] definition_body
        #   @return [::String]
        #     The body of the routine.
        # @!attribute [rw] bigquery_routine_spec
        #   @return [::Google::Cloud::DataCatalog::V1::BigQueryRoutineSpec]
        #     Fields specific for BigQuery routines.
        class RoutineSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Input or output argument of a function or stored procedure.
          # @!attribute [rw] name
          #   @return [::String]
          #     The name of the argument. A return argument of a function might not have
          #     a name.
          # @!attribute [rw] mode
          #   @return [::Google::Cloud::DataCatalog::V1::RoutineSpec::Argument::Mode]
          #     Specifies whether the argument is input or output.
          # @!attribute [rw] type
          #   @return [::String]
          #     Type of the argument. The exact value depends on the source system and
          #     the language.
          class Argument
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods

            # The input or output mode of the argument.
            module Mode
              # Unspecified mode.
              MODE_UNSPECIFIED = 0

              # The argument is input-only.
              IN = 1

              # The argument is output-only.
              OUT = 2

              # The argument is both an input and an output.
              INOUT = 3
            end
          end

          # The fine-grained type of the routine.
          module RoutineType
            # Unspecified type.
            ROUTINE_TYPE_UNSPECIFIED = 0

            # Non-builtin permanent scalar function.
            SCALAR_FUNCTION = 1

            # Stored procedure.
            PROCEDURE = 2
          end
        end

        # Entry group metadata.
        #
        # An `EntryGroup` resource represents a logical grouping of zero or more
        # Data Catalog {::Google::Cloud::DataCatalog::V1::Entry Entry} resources.
        # @!attribute [rw] name
        #   @return [::String]
        #     The resource name of the entry group in URL format.
        #
        #     Note: The entry group itself and its child resources might not be
        #     stored in the location specified in its name.
        # @!attribute [rw] display_name
        #   @return [::String]
        #     A short name to identify the entry group, for example,
        #     "analytics data - jan 2011". Default value is an empty string.
        # @!attribute [rw] description
        #   @return [::String]
        #     Entry group description. Can consist of several sentences or
        #     paragraphs that describe the entry group contents.
        #     Default value is an empty string.
        # @!attribute [r] data_catalog_timestamps
        #   @return [::Google::Cloud::DataCatalog::V1::SystemTimestamps]
        #     Output only. Timestamps of the entry group. Default value is empty.
        class EntryGroup
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_tag_template CreateTagTemplate}.
        # @!attribute [rw] parent
        #   @return [::String]
        #     Required. The name of the project and the template location
        #     [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
        # @!attribute [rw] tag_template_id
        #   @return [::String]
        #     Required. The ID of the tag template to create.
        #
        #     The ID must contain only lowercase letters (a-z), numbers (0-9),
        #     or underscores (_), and must start with a letter or underscore.
        #     The maximum size is 64 bytes when encoded in UTF-8.
        # @!attribute [rw] tag_template
        #   @return [::Google::Cloud::DataCatalog::V1::TagTemplate]
        #     Required. The tag template to create.
        class CreateTagTemplateRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#get_tag_template GetTagTemplate}.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The name of the tag template to get.
        class GetTagTemplateRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_tag_template UpdateTagTemplate}.
        # @!attribute [rw] tag_template
        #   @return [::Google::Cloud::DataCatalog::V1::TagTemplate]
        #     Required. The template to update. The `name` field must be set.
        # @!attribute [rw] update_mask
        #   @return [::Google::Protobuf::FieldMask]
        #     Names of fields whose values to overwrite on a tag template. Currently,
        #     only `display_name` can be overwritten.
        #
        #     If this parameter is absent or empty, all modifiable fields
        #     are overwritten. If such fields are non-required and omitted in the
        #     request body, their values are emptied.
        class UpdateTagTemplateRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_tag_template DeleteTagTemplate}.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The name of the tag template to delete.
        # @!attribute [rw] force
        #   @return [::Boolean]
        #     Required. If true, deletes all tags that use this template.
        #
        #     Currently, `true` is the only supported value.
        class DeleteTagTemplateRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_tag CreateTag}.
        # @!attribute [rw] parent
        #   @return [::String]
        #     Required. The name of the resource to attach this tag to.
        #
        #     Tags can be attached to entries or entry groups. An entry can have up to
        #     1000 attached tags.
        #
        #     Note: The tag and its child resources might not be stored in
        #     the location specified in its name.
        # @!attribute [rw] tag
        #   @return [::Google::Cloud::DataCatalog::V1::Tag]
        #     Required. The tag to create.
        class CreateTagRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_tag UpdateTag}.
        # @!attribute [rw] tag
        #   @return [::Google::Cloud::DataCatalog::V1::Tag]
        #     Required. The updated tag. The "name" field must be set.
        # @!attribute [rw] update_mask
        #   @return [::Google::Protobuf::FieldMask]
        #     Names of fields whose values to overwrite on a tag. Currently, a tag has
        #     the only modifiable field with the name `fields`.
        #
        #     In general, if this parameter is absent or empty, all modifiable fields
        #     are overwritten. If such fields are non-required and omitted in the
        #     request body, their values are emptied.
        class UpdateTagRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_tag DeleteTag}.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The name of the tag to delete.
        class DeleteTagRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_tag_template_field CreateTagTemplateField}.
        # @!attribute [rw] parent
        #   @return [::String]
        #     Required. The name of the project and the template location
        #     [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
        # @!attribute [rw] tag_template_field_id
        #   @return [::String]
        #     Required. The ID of the tag template field to create.
        #
        #     Note: Adding a required field to an existing template is *not* allowed.
        #
        #     Field IDs can contain letters (both uppercase and lowercase), numbers
        #     (0-9), underscores (_) and dashes (-). Field IDs must be at least 1
        #     character long and at most 128 characters long. Field IDs must also be
        #     unique within their template.
        # @!attribute [rw] tag_template_field
        #   @return [::Google::Cloud::DataCatalog::V1::TagTemplateField]
        #     Required. The tag template field to create.
        class CreateTagTemplateFieldRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_tag_template_field UpdateTagTemplateField}.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The name of the tag template field.
        # @!attribute [rw] tag_template_field
        #   @return [::Google::Cloud::DataCatalog::V1::TagTemplateField]
        #     Required. The template to update.
        # @!attribute [rw] update_mask
        #   @return [::Google::Protobuf::FieldMask]
        #     Optional. Names of fields whose values to overwrite on an individual field of a tag
        #     template. The following fields are modifiable:
        #
        #     * `display_name`
        #     * `type.enum_type`
        #     * `is_required`
        #
        #     If this parameter is absent or empty, all modifiable fields
        #     are overwritten. If such fields are non-required and omitted in the request
        #     body, their values are emptied with one exception: when updating an enum
        #     type, the provided values are merged with the existing values. Therefore,
        #     enum values can only be added, existing enum values cannot be deleted or
        #     renamed.
        #
        #     Additionally, updating a template field from optional to required is
        #     *not* allowed.
        class UpdateTagTemplateFieldRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#rename_tag_template_field RenameTagTemplateField}.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The name of the tag template.
        # @!attribute [rw] new_tag_template_field_id
        #   @return [::String]
        #     Required. The new ID of this tag template field. For example, `my_new_field`.
        class RenameTagTemplateFieldRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#rename_tag_template_field_enum_value RenameTagTemplateFieldEnumValue}.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The name of the enum field value.
        # @!attribute [rw] new_enum_value_display_name
        #   @return [::String]
        #     Required. The new display name of the enum value. For example, `my_new_enum_value`.
        class RenameTagTemplateFieldEnumValueRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_tag_template_field DeleteTagTemplateField}.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The name of the tag template field to delete.
        # @!attribute [rw] force
        #   @return [::Boolean]
        #     Required. If true, deletes this field from any tags that use it.
        #
        #     Currently, `true` is the only supported value.
        class DeleteTagTemplateFieldRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_tags ListTags}.
        # @!attribute [rw] parent
        #   @return [::String]
        #     Required. The name of the Data Catalog resource to list the tags of.
        #
        #     The resource can be an {::Google::Cloud::DataCatalog::V1::Entry Entry}
        #     or an {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}
        #     (without `/entries/{entries}` at the end).
        # @!attribute [rw] page_size
        #   @return [::Integer]
        #     The maximum number of tags to return. Default is 10. Maximum limit is 1000.
        # @!attribute [rw] page_token
        #   @return [::String]
        #     Pagination token that specifies the next page to return. If empty, the
        #     first page is returned.
        class ListTagsRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Response message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_tags ListTags}.
        # @!attribute [rw] tags
        #   @return [::Array<::Google::Cloud::DataCatalog::V1::Tag>]
        #     {::Google::Cloud::DataCatalog::V1::Tag Tag} details.
        # @!attribute [rw] next_page_token
        #   @return [::String]
        #     Pagination token of the next results page. Empty if there are
        #     no more items in results.
        class ListTagsResponse
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entries ListEntries}.
        # @!attribute [rw] parent
        #   @return [::String]
        #     Required. The name of the entry group that contains the entries to list.
        #
        #     Can be provided in URL format.
        # @!attribute [rw] page_size
        #   @return [::Integer]
        #     The maximum number of items to return. Default is 10. Maximum limit is
        #     1000. Throws an invalid argument if `page_size` is more than 1000.
        # @!attribute [rw] page_token
        #   @return [::String]
        #     Pagination token that specifies the next page to return. If empty, the
        #     first page is returned.
        # @!attribute [rw] read_mask
        #   @return [::Google::Protobuf::FieldMask]
        #     The fields to return for each entry. If empty or omitted, all
        #     fields are returned.
        #
        #     For example, to return a list of entries with only the `name` field,
        #     set `read_mask` to only one path with the `name` value.
        class ListEntriesRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Response message for
        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entries ListEntries}.
        # @!attribute [rw] entries
        #   @return [::Array<::Google::Cloud::DataCatalog::V1::Entry>]
        #     Entry details.
        # @!attribute [rw] next_page_token
        #   @return [::String]
        #     Pagination token of the next results page. Empty if there are no more items
        #     in results.
        class ListEntriesResponse
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # The enum field that lists all the types of entry resources in Data
        # Catalog. For example, a BigQuery table entry has the `TABLE` type.
        module EntryType
          # Default unknown type.
          ENTRY_TYPE_UNSPECIFIED = 0

          # Output only. The entry type that has a GoogleSQL schema, including
          # logical views.
          TABLE = 2

          # Output only. The type of models.
          #
          # For more information, see [Supported models in BigQuery ML]
          # (https://cloud.google.com/bigquery-ml/docs/introduction#supported_models_in).
          MODEL = 5

          # An entry type for streaming entries. For example, a Pub/Sub topic.
          DATA_STREAM = 3

          # An entry type for a set of files or objects. For example, a
          # Cloud Storage fileset.
          FILESET = 4

          # A group of servers that work together. For example, a Kafka cluster.
          CLUSTER = 6

          # A database.
          DATABASE = 7

          # Output only. Connection to a data source. For example, a BigQuery
          # connection.
          DATA_SOURCE_CONNECTION = 8

          # Output only. Routine, for example, a BigQuery routine.
          ROUTINE = 9

          # A service, for example, a Dataproc Metastore service.
          SERVICE = 14
        end
      end
    end
  end
end