API Reference google_api_data_catalog v0.32.2
View SourceModules
API client metadata for GoogleApi.DataCatalog.V1.
API calls for all endpoints tagged Catalog.
API calls for all endpoints tagged Entries.
API calls for all endpoints tagged Organizations.
API calls for all endpoints tagged Projects.
Handle Tesla connections for GoogleApi.DataCatalog.V1.
Associates members, or principals, with a role.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Request message for GetIamPolicy method.
Encapsulates settings provided to GetIamPolicy.
Specification for the BigQuery connection.
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).
Fields specific for BigQuery routines.
Describes a BigQuery table.
Business Context of the entry.
Specification that applies to Instance entries that are part of CLOUD_BIGTABLE system. (user_specified_type)
Spec that applies to clusters of an Instance of Cloud Bigtable.
Specification that applies to all entries that are part of CLOUD_BIGTABLE system (user_specified_type)
Specification for the BigQuery connection to a Cloud SQL instance.
A column within a schema. Columns can be nested inside other columns.
Represents the type of a field element.
Column info specific to Looker System.
Common statistics on the entry's usage. They can be set on any system.
Contact people for the entry.
A contact person for the entry.
Cross-regional source used to import an existing taxonomy into a different region.
Physical location of an entry.
Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type. Only one of internal specs can be set at the time, and cannot be changed later.
Specification that applies to a table resource. Valid only for entries with the TABLE type.
Specification that applies to database view.
External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog.
Entry specyfication for a Dataplex fileset.
Common Dataplex fields.
Entry specification for a Dataplex table.
Specification that applies to a dataset. Valid only for entries with the DATASET type.
Wrapper for any item that can be contained in the dump.
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 Tag.
Entry group metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.
Entry overview fields for rich text descriptions of entries.
Response message for ExportTaxonomies.
Detail description of the source information of a Vertex Feature Online Store.
Attributes
-
allowedValues(type:list(GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1FieldTypeEnumTypeEnumValue.t), default:nil) - The set of allowed values for this enum. This set must not be empty and can include up to 100 allowed values. The display names of the values in this set must not be empty and must be case-insensitively unique within this set. The order of items in this set is preserved. This field can be used to create, remove, and reorder enum values. To rename enum values, use theRenameTagTemplateFieldEnumValuemethod.
Attributes
-
displayName(type:String.t, default:nil) - Required. The display name of the enum value. Must not be an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
Specification that applies to a fileset. Valid only for entries with the 'FILESET' type.
Specification of a single file in Cloud Storage.
Describes a Cloud Storage fileset entry.
Metadata message for long-running operation returned by the ImportEntries.
Request message for ImportEntries method.
Response message for long-running operation returned by the ImportEntries.
Request message for ImportTaxonomies.
Response message for ImportTaxonomies.
Inline source containing taxonomies to import.
Response message for ListEntries.
Response message for ListEntryGroups.
Response message for ListPolicyTags.
Response message for ListTags.
Response message for ListTaxonomies.
Specification that applies to entries that are part LOOKER system (user_specified_type)
The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig.
Specification that applies to a model. Valid only for entries with the MODEL type.
Request message for ModifyEntryContacts.
Request message for ModifyEntryOverview.
The configuration related to the migration from Data Catalog to Dataplex that has been applied to an organization and any projects under it. It is the response message for RetrieveConfig.
Entry metadata relevant only to the user and private to them.
Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data.
Schema in Avro JSON format.
Marks a CSV-encoded data source.
Marks an ORC-encoded data source.
Marks a Parquet-encoded data source.
Schema in protocol buffer format.
Schema in Thrift format.
Denotes one policy tag in a taxonomy, for example, SSN. Policy tags can be defined in a hierarchy. For example: + Geolocation + LatLong + City + ZipCode Where the "Geolocation" policy tag contains three children.
Long-running operation metadata message returned by the ReconcileTags.
Request message for ReconcileTags.
Long-running operation response message returned by ReconcileTags.
Request message for RenameTagTemplateFieldEnumValue.
Request message for RenameTagTemplateField.
Request message for ReplaceTaxonomy.
Specification that applies to a routine. Valid only for entries with the ROUTINE type.
Input or output argument of a function or stored procedure.
Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.
Request message for SearchCatalog.
The criteria that select the subspace used for query matching.
Response message for SearchCatalog.
Result in the response to a search request. Each result captures details of one entry that matches the search.
A nested protocol buffer that represents a policy tag and all its descendants.
A nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export.
Specification that applies to a Service resource. Valid only for entries with the SERVICE type.
Request message for SetConfig.
Specification that applies to entries that are part SQL_DATABASE system (user_specified_type)
Request message for StarEntry.
Response message for StarEntry. Empty for now
Details the properties of the underlying storage.
Timestamps associated with this resource in a particular system.
Normal BigQuery table specification.
Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See Data Catalog IAM for information on the permissions needed to create or view tags.
Contains the value and additional information on a field within a Tag.
A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
The template for an individual field within a tag template.
Wrapper containing Entry and information about Tags that should and should not be attached to it.
A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For example, a "data sensitivity" taxonomy might contain the following policy tags: + PII + Account number + Age + SSN + Zipcode + Financials + Revenue A "data origin" taxonomy might contain the following policy tags: + User data + Employee data + Partner data + Public data
The source system of the Taxonomy.
Request message for UnstarEntry.
Response message for UnstarEntry. Empty for now
The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day.
Detailed statistics on the entry's usage. Usage statistics have the following limitations: - Only BigQuery tables have them. - They only include BigQuery query jobs. - They might be underestimated because wildcard table references are not yet counted. For more information, see [Querying multiple tables using a wildcard table] (https://cloud.google.com/bigquery/docs/querying-wildcard-tables)
Specification for vertex dataset resources.
Detail description of the source information of a Vertex model.
Specification for vertex model resources.
Table view specification.
The response message for Operations.ListOperations.
This resource represents a long-running operation that is the result of a network API call.
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.
Request message for SetIamPolicy method.
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Request message for TestIamPermissions method.
Response message for TestIamPermissions method.
API client metadata for GoogleApi.DataCatalog.V1beta1.
API calls for all endpoints tagged Catalog.
API calls for all endpoints tagged Entries.
API calls for all endpoints tagged Projects.
Handle Tesla connections for GoogleApi.DataCatalog.V1beta1.
Associates members, or principals, with a role.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Request message for GetIamPolicy method.
Encapsulates settings provided to GetIamPolicy.
Specification for the BigQuery connection.
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).
Fields specific for BigQuery routines.
Describes a BigQuery table.
Business Context of the entry.
Specification that applies to Instance entries that are part of CLOUD_BIGTABLE system. (user_specified_type)
Spec that applies to clusters of an Instance of Cloud Bigtable.
Specification that applies to all entries that are part of CLOUD_BIGTABLE system (user_specified_type)
Specification for the BigQuery connection to a Cloud SQL instance.
A column within a schema. Columns can be nested inside other columns.
Represents the type of a field element.
Column info specific to Looker System.
Common statistics on the entry's usage. They can be set on any system.
Contact people for the entry.
A contact person for the entry.
Physical location of an entry.
Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type. Only one of internal specs can be set at the time, and cannot be changed later.
Specification that applies to a table resource. Valid only for entries with the TABLE type.
Specification that applies to database view.
External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog.
Entry specyfication for a Dataplex fileset.
Common Dataplex fields.
Entry specification for a Dataplex table.
Specification that applies to a dataset. Valid only for entries with the DATASET type.
Wrapper for any item that can be contained in the dump.
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 Tag.
Entry overview fields for rich text descriptions of entries.
Detail description of the source information of a Vertex Feature Online Store.
Specification that applies to a fileset. Valid only for entries with the 'FILESET' type.
Specification of a single file in Cloud Storage.
Describes a Cloud Storage fileset entry.
Metadata message for long-running operation returned by the ImportEntries.
Response message for long-running operation returned by the ImportEntries.
Specification that applies to entries that are part LOOKER system (user_specified_type)
Specification that applies to a model. Valid only for entries with the MODEL type.
Entry metadata relevant only to the user and private to them.
Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data.
Schema in Avro JSON format.
Marks a CSV-encoded data source.
Marks an ORC-encoded data source.
Marks a Parquet-encoded data source.
Schema in protocol buffer format.
Schema in Thrift format.
Long-running operation metadata message returned by the ReconcileTags.
Long-running operation response message returned by ReconcileTags.
Specification that applies to a routine. Valid only for entries with the ROUTINE type.
Input or output argument of a function or stored procedure.
Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.
Specification that applies to a Service resource. Valid only for entries with the SERVICE type.
Specification that applies to entries that are part SQL_DATABASE system (user_specified_type)
Details the properties of the underlying storage.
Timestamps associated with this resource in a particular system.
Normal BigQuery table specification.
Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See Data Catalog IAM for information on the permissions needed to create or view tags.
Contains the value and additional information on a field within a Tag.
Wrapper containing Entry and information about Tags that should and should not be attached to it.
The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day.
Detailed statistics on the entry's usage. Usage statistics have the following limitations: - Only BigQuery tables have them. - They only include BigQuery query jobs. - They might be underestimated because wildcard table references are not yet counted. For more information, see [Querying multiple tables using a wildcard table] (https://cloud.google.com/bigquery/docs/querying-wildcard-tables)
Specification for vertex dataset resources.
Detail description of the source information of a Vertex model.
Specification for vertex model resources.
Table view specification.
Spec for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding
Describes a BigQuery table.
Representation of a column within a schema. Columns could be nested inside other columns.
Entry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or outside of Google Cloud Platform. Clients 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, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag.
EntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.
Response message for ExportTaxonomies.
Specifications of a single file in Cloud Storage.
Describes a Cloud Storage fileset entry.
Request message for ImportTaxonomies.
Response message for ImportTaxonomies.
Inline source used for taxonomies import.
Response message for ListEntries.
Response message for ListEntryGroups.
Response message for ListPolicyTags.
Response message for ListTags.
Response message for ListTaxonomies.
Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierarchy: Geolocation -> (LatLong, City, ZipCode). PolicyTag "Geolocation" contains three child policy tags: "LatLong", "City", and "ZipCode".
Request message for RenameTagTemplateFieldEnumValue.
Request message for RenameTagTemplateField.
Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
Request message for SearchCatalog.
The criteria that select the subspace used for query matching.
Response message for SearchCatalog.
A result that appears in the response of a search request. Each result captures details of one entry that matches the search.
Message representing one policy tag when exported as a nested proto.
Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation.
Timestamps about this resource according to a particular system.
Normal BigQuery table spec.
Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template. See Data Catalog IAM for information on the permissions needed to create or view tags.
Contains the value and supporting information for a field within a Tag.
Holds an enum value.
A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. Tag template roles provide permissions to create, edit, and use the template. See, for example, the TagTemplate User role, which includes permission to use the tag template to tag resources.
The template for an individual field within a tag template.
A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data sensitivity taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data origin taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data.
The source system of the Taxonomy.
The set of all usage signals that we store in Data Catalog.
Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only include BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables
Table view specification.
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.
Request message for SetIamPolicy method.
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Request message for TestIamPermissions method.
Response message for TestIamPermissions method.