Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://googleapis.deno.dev/v1/datacatalog:v1.ts";

§Classes

DataCatalog

A fully managed and highly scalable data discovery and metadata management service.

GoogleAuth

§Variables

auth

§Interfaces

Binding

Associates members, or principals, with a role.

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

Empty

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); }

EntriesLookupOptions

Additional options for DataCatalog#entriesLookup.

Expr

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.

GetIamPolicyRequest

Request message for GetIamPolicy method.

GetPolicyOptions

Encapsulates settings provided to GetIamPolicy.

GoogleCloudDatacatalogV1BigQueryConnectionSpec

Specification for the BigQuery connection.

GoogleCloudDatacatalogV1BigQueryDateShardedSpec

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).

GoogleCloudDatacatalogV1BigQueryRoutineSpec

Fields specific for BigQuery routines.

GoogleCloudDatacatalogV1BigQueryTableSpec

Describes a BigQuery table.

GoogleCloudDatacatalogV1BusinessContext

Business Context of the entry.

GoogleCloudDatacatalogV1CloudBigtableInstanceSpec

Specification that applies to Instance entries that are part of CLOUD_BIGTABLE system. (user_specified_type)

GoogleCloudDatacatalogV1CloudBigtableInstanceSpecCloudBigtableClusterSpec

Spec that applies to clusters of an Instance of Cloud Bigtable.

GoogleCloudDatacatalogV1CloudBigtableSystemSpec

Specification that applies to all entries that are part of CLOUD_BIGTABLE system (user_specified_type)

GoogleCloudDatacatalogV1CloudSqlBigQueryConnectionSpec

Specification for the BigQuery connection to a Cloud SQL instance.

GoogleCloudDatacatalogV1ColumnSchema

A column within a schema. Columns can be nested inside other columns.

GoogleCloudDatacatalogV1ColumnSchemaFieldElementType

Represents the type of a field element.

GoogleCloudDatacatalogV1ColumnSchemaLookerColumnSpec

Column info specific to Looker System.

GoogleCloudDatacatalogV1CommonUsageStats

Common statistics on the entry's usage. They can be set on any system.

GoogleCloudDatacatalogV1Contacts

Contact people for the entry.

GoogleCloudDatacatalogV1ContactsPerson

A contact person for the entry.

GoogleCloudDatacatalogV1CrossRegionalSource

Cross-regional source used to import an existing taxonomy into a different region.

GoogleCloudDatacatalogV1DatabaseTableSpec

Specification that applies to a table resource. Valid only for entries with the TABLE type.

GoogleCloudDatacatalogV1DatabaseTableSpecDatabaseViewSpec

Specification that applies to database view.

GoogleCloudDatacatalogV1DataplexExternalTable

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.

GoogleCloudDatacatalogV1DataplexFilesetSpec

Entry specyfication for a Dataplex fileset.

GoogleCloudDatacatalogV1DataplexSpec

Common Dataplex fields.

GoogleCloudDatacatalogV1DataplexTableSpec

Entry specification for a Dataplex table.

GoogleCloudDatacatalogV1DatasetSpec

Specification that applies to a dataset. Valid only for entries with the DATASET type.

GoogleCloudDatacatalogV1DataSource

Physical location of an entry.

GoogleCloudDatacatalogV1DataSourceConnectionSpec

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.

GoogleCloudDatacatalogV1DumpItem

Wrapper for any item that can be contained in the dump.

GoogleCloudDatacatalogV1Entry

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.

GoogleCloudDatacatalogV1EntryGroup

Entry group metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.

GoogleCloudDatacatalogV1EntryOverview

Entry overview fields for rich text descriptions of entries.

GoogleCloudDatacatalogV1ExportTaxonomiesResponse

Response message for ExportTaxonomies.

GoogleCloudDatacatalogV1FeatureOnlineStoreSpec

Detail description of the source information of a Vertex Feature Online Store.

GoogleCloudDatacatalogV1FieldType
GoogleCloudDatacatalogV1FieldTypeEnumType
GoogleCloudDatacatalogV1FieldTypeEnumTypeEnumValue
GoogleCloudDatacatalogV1FilesetSpec

Specification that applies to a fileset. Valid only for entries with the 'FILESET' type.

GoogleCloudDatacatalogV1GcsFilesetSpec

Describes a Cloud Storage fileset entry.

GoogleCloudDatacatalogV1GcsFileSpec

Specification of a single file in Cloud Storage.

GoogleCloudDatacatalogV1ImportEntriesMetadata

Metadata message for long-running operation returned by the ImportEntries.

GoogleCloudDatacatalogV1ImportEntriesRequest

Request message for ImportEntries method.

GoogleCloudDatacatalogV1ImportEntriesResponse

Response message for long-running operation returned by the ImportEntries.

GoogleCloudDatacatalogV1ImportTaxonomiesRequest

Request message for ImportTaxonomies.

GoogleCloudDatacatalogV1ImportTaxonomiesResponse

Response message for ImportTaxonomies.

GoogleCloudDatacatalogV1InlineSource

Inline source containing taxonomies to import.

GoogleCloudDatacatalogV1ListEntriesResponse

Response message for ListEntries.

GoogleCloudDatacatalogV1ListEntryGroupsResponse

Response message for ListEntryGroups.

GoogleCloudDatacatalogV1ListPolicyTagsResponse

Response message for ListPolicyTags.

GoogleCloudDatacatalogV1ListTagsResponse

Response message for ListTags.

GoogleCloudDatacatalogV1ListTaxonomiesResponse

Response message for ListTaxonomies.

GoogleCloudDatacatalogV1LookerSystemSpec

Specification that applies to entries that are part LOOKER system (user_specified_type)

GoogleCloudDatacatalogV1ModelSpec

Specification that applies to a model. Valid only for entries with the MODEL type.

GoogleCloudDatacatalogV1ModifyEntryContactsRequest

Request message for ModifyEntryContacts.

GoogleCloudDatacatalogV1ModifyEntryOverviewRequest

Request message for ModifyEntryOverview.

GoogleCloudDatacatalogV1PersonalDetails

Entry metadata relevant only to the user and private to them.

GoogleCloudDatacatalogV1PhysicalSchema

Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data.

GoogleCloudDatacatalogV1PhysicalSchemaAvroSchema

Schema in Avro JSON format.

GoogleCloudDatacatalogV1PhysicalSchemaCsvSchema

Marks a CSV-encoded data source.

GoogleCloudDatacatalogV1PhysicalSchemaOrcSchema

Marks an ORC-encoded data source.

GoogleCloudDatacatalogV1PhysicalSchemaParquetSchema

Marks a Parquet-encoded data source.

GoogleCloudDatacatalogV1PhysicalSchemaProtobufSchema

Schema in protocol buffer format.

GoogleCloudDatacatalogV1PhysicalSchemaThriftSchema

Schema in Thrift format.

GoogleCloudDatacatalogV1PolicyTag

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.

GoogleCloudDatacatalogV1ReconcileTagsMetadata

Long-running operation metadata message returned by the ReconcileTags.

GoogleCloudDatacatalogV1ReconcileTagsRequest

Request message for ReconcileTags.

GoogleCloudDatacatalogV1ReconcileTagsResponse

Long-running operation response message returned by ReconcileTags.

GoogleCloudDatacatalogV1RenameTagTemplateFieldEnumValueRequest

Request message for RenameTagTemplateFieldEnumValue.

GoogleCloudDatacatalogV1RenameTagTemplateFieldRequest

Request message for RenameTagTemplateField.

GoogleCloudDatacatalogV1ReplaceTaxonomyRequest

Request message for ReplaceTaxonomy.

GoogleCloudDatacatalogV1RoutineSpec

Specification that applies to a routine. Valid only for entries with the ROUTINE type.

GoogleCloudDatacatalogV1RoutineSpecArgument

Input or output argument of a function or stored procedure.

GoogleCloudDatacatalogV1Schema

Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.

GoogleCloudDatacatalogV1SearchCatalogRequest

Request message for SearchCatalog.

GoogleCloudDatacatalogV1SearchCatalogRequestScope

The criteria that select the subspace used for query matching.

GoogleCloudDatacatalogV1SearchCatalogResponse

Response message for SearchCatalog.

GoogleCloudDatacatalogV1SearchCatalogResult

Result in the response to a search request. Each result captures details of one entry that matches the search.

GoogleCloudDatacatalogV1SerializedPolicyTag

A nested protocol buffer that represents a policy tag and all its descendants.

GoogleCloudDatacatalogV1SerializedTaxonomy

A nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export.

GoogleCloudDatacatalogV1ServiceSpec

Specification that applies to a Service resource. Valid only for entries with the SERVICE type.

GoogleCloudDatacatalogV1SqlDatabaseSystemSpec

Specification that applies to entries that are part SQL_DATABASE system (user_specified_type)

GoogleCloudDatacatalogV1StarEntryRequest

Request message for StarEntry.

GoogleCloudDatacatalogV1StarEntryResponse

Response message for StarEntry. Empty for now

GoogleCloudDatacatalogV1StorageProperties

Details the properties of the underlying storage.

GoogleCloudDatacatalogV1SystemTimestamps

Timestamps associated with this resource in a particular system.

GoogleCloudDatacatalogV1TableSpec

Normal BigQuery table specification.

GoogleCloudDatacatalogV1Tag

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.

GoogleCloudDatacatalogV1TagField

Contains the value and additional information on a field within a Tag.

GoogleCloudDatacatalogV1TagFieldEnumValue

An enum value.

GoogleCloudDatacatalogV1TaggedEntry

Wrapper containing Entry and information about Tags that should and should not be attached to it.

GoogleCloudDatacatalogV1TagTemplate

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.

GoogleCloudDatacatalogV1TagTemplateField

The template for an individual field within a tag template.

GoogleCloudDatacatalogV1Taxonomy

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

GoogleCloudDatacatalogV1TaxonomyService

The source system of the Taxonomy.

GoogleCloudDatacatalogV1UnstarEntryRequest

Request message for UnstarEntry.

GoogleCloudDatacatalogV1UnstarEntryResponse

Response message for UnstarEntry. Empty for now

GoogleCloudDatacatalogV1UsageSignal

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.

GoogleCloudDatacatalogV1UsageStats

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)

GoogleCloudDatacatalogV1VertexDatasetSpec

Specification for vertex dataset resources.

GoogleCloudDatacatalogV1VertexModelSourceInfo

Detail description of the source information of a Vertex model.

GoogleCloudDatacatalogV1VertexModelSpec

Specification for vertex model resources.

GoogleCloudDatacatalogV1ViewSpec

Table view specification.

ListOperationsResponse

The response message for Operations.ListOperations.

Operation

This resource represents a long-running operation that is the result of a network API call.

Policy

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:

ProjectsLocationsEntryGroupsCreateOptions

Additional options for DataCatalog#projectsLocationsEntryGroupsCreate.

ProjectsLocationsEntryGroupsDeleteOptions

Additional options for DataCatalog#projectsLocationsEntryGroupsDelete.

ProjectsLocationsEntryGroupsEntriesCreateOptions

Additional options for DataCatalog#projectsLocationsEntryGroupsEntriesCreate.

ProjectsLocationsEntryGroupsEntriesListOptions

Additional options for DataCatalog#projectsLocationsEntryGroupsEntriesList.

ProjectsLocationsEntryGroupsEntriesPatchOptions

Additional options for DataCatalog#projectsLocationsEntryGroupsEntriesPatch.

ProjectsLocationsEntryGroupsEntriesTagsListOptions

Additional options for DataCatalog#projectsLocationsEntryGroupsEntriesTagsList.

ProjectsLocationsEntryGroupsEntriesTagsPatchOptions

Additional options for DataCatalog#projectsLocationsEntryGroupsEntriesTagsPatch.

ProjectsLocationsEntryGroupsGetOptions

Additional options for DataCatalog#projectsLocationsEntryGroupsGet.

ProjectsLocationsEntryGroupsListOptions

Additional options for DataCatalog#projectsLocationsEntryGroupsList.

ProjectsLocationsEntryGroupsPatchOptions

Additional options for DataCatalog#projectsLocationsEntryGroupsPatch.

ProjectsLocationsEntryGroupsTagsListOptions

Additional options for DataCatalog#projectsLocationsEntryGroupsTagsList.

ProjectsLocationsEntryGroupsTagsPatchOptions

Additional options for DataCatalog#projectsLocationsEntryGroupsTagsPatch.

ProjectsLocationsOperationsListOptions

Additional options for DataCatalog#projectsLocationsOperationsList.

ProjectsLocationsTagTemplatesCreateOptions

Additional options for DataCatalog#projectsLocationsTagTemplatesCreate.

ProjectsLocationsTagTemplatesDeleteOptions

Additional options for DataCatalog#projectsLocationsTagTemplatesDelete.

ProjectsLocationsTagTemplatesFieldsCreateOptions

Additional options for DataCatalog#projectsLocationsTagTemplatesFieldsCreate.

ProjectsLocationsTagTemplatesFieldsDeleteOptions

Additional options for DataCatalog#projectsLocationsTagTemplatesFieldsDelete.

ProjectsLocationsTagTemplatesFieldsPatchOptions

Additional options for DataCatalog#projectsLocationsTagTemplatesFieldsPatch.

ProjectsLocationsTagTemplatesPatchOptions

Additional options for DataCatalog#projectsLocationsTagTemplatesPatch.

ProjectsLocationsTaxonomiesExportOptions

Additional options for DataCatalog#projectsLocationsTaxonomiesExport.

ProjectsLocationsTaxonomiesListOptions

Additional options for DataCatalog#projectsLocationsTaxonomiesList.

ProjectsLocationsTaxonomiesPatchOptions

Additional options for DataCatalog#projectsLocationsTaxonomiesPatch.

ProjectsLocationsTaxonomiesPolicyTagsListOptions

Additional options for DataCatalog#projectsLocationsTaxonomiesPolicyTagsList.

ProjectsLocationsTaxonomiesPolicyTagsPatchOptions

Additional options for DataCatalog#projectsLocationsTaxonomiesPolicyTagsPatch.

SetIamPolicyRequest

Request message for SetIamPolicy method.

Status

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.

TestIamPermissionsRequest

Request message for TestIamPermissions method.

TestIamPermissionsResponse

Response message for TestIamPermissions method.