DataCatalog

import { DataCatalog } from "https://googleapis.deno.dev/v1/datacatalog:v1.ts";

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

class DataCatalog {

constructor(client?: CredentialsClient, baseUrl?: string);

async catalogSearch(req: GoogleCloudDatacatalogV1SearchCatalogRequest): Promise<GoogleCloudDatacatalogV1SearchCatalogResponse>;

async entriesLookup(opts?: EntriesLookupOptions): Promise<GoogleCloudDatacatalogV1Entry>;

async projectsLocationsEntryGroupsCreate(

parent: string,

req: GoogleCloudDatacatalogV1EntryGroup,

opts?: ProjectsLocationsEntryGroupsCreateOptions,

): Promise<GoogleCloudDatacatalogV1EntryGroup>;

async projectsLocationsEntryGroupsDelete(name: string, opts?: ProjectsLocationsEntryGroupsDeleteOptions): Promise<Empty>;

async projectsLocationsEntryGroupsEntriesCreate(

parent: string,

req: GoogleCloudDatacatalogV1Entry,

opts?: ProjectsLocationsEntryGroupsEntriesCreateOptions,

): Promise<GoogleCloudDatacatalogV1Entry>;

async projectsLocationsEntryGroupsEntriesDelete(name: string): Promise<Empty>;

async projectsLocationsEntryGroupsEntriesGet(name: string): Promise<GoogleCloudDatacatalogV1Entry>;

async projectsLocationsEntryGroupsEntriesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsLocationsEntryGroupsEntriesImport(parent: string, req: GoogleCloudDatacatalogV1ImportEntriesRequest): Promise<Operation>;

async projectsLocationsEntryGroupsEntriesList(parent: string, opts?: ProjectsLocationsEntryGroupsEntriesListOptions): Promise<GoogleCloudDatacatalogV1ListEntriesResponse>;

async projectsLocationsEntryGroupsEntriesModifyEntryContacts(name: string, req: GoogleCloudDatacatalogV1ModifyEntryContactsRequest): Promise<GoogleCloudDatacatalogV1Contacts>;

async projectsLocationsEntryGroupsEntriesModifyEntryOverview(name: string, req: GoogleCloudDatacatalogV1ModifyEntryOverviewRequest): Promise<GoogleCloudDatacatalogV1EntryOverview>;

async projectsLocationsEntryGroupsEntriesPatch(

req: GoogleCloudDatacatalogV1Entry,

opts?: ProjectsLocationsEntryGroupsEntriesPatchOptions,

): Promise<GoogleCloudDatacatalogV1Entry>;

async projectsLocationsEntryGroupsEntriesStar(name: string, req: GoogleCloudDatacatalogV1StarEntryRequest): Promise<GoogleCloudDatacatalogV1StarEntryResponse>;

async projectsLocationsEntryGroupsEntriesTagsCreate(parent: string, req: GoogleCloudDatacatalogV1Tag): Promise<GoogleCloudDatacatalogV1Tag>;

async projectsLocationsEntryGroupsEntriesTagsDelete(name: string): Promise<Empty>;

async projectsLocationsEntryGroupsEntriesTagsList(parent: string, opts?: ProjectsLocationsEntryGroupsEntriesTagsListOptions): Promise<GoogleCloudDatacatalogV1ListTagsResponse>;

async projectsLocationsEntryGroupsEntriesTagsPatch(

req: GoogleCloudDatacatalogV1Tag,

opts?: ProjectsLocationsEntryGroupsEntriesTagsPatchOptions,

): Promise<GoogleCloudDatacatalogV1Tag>;

async projectsLocationsEntryGroupsEntriesTagsReconcile(parent: string, req: GoogleCloudDatacatalogV1ReconcileTagsRequest): Promise<Operation>;

async projectsLocationsEntryGroupsEntriesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsEntryGroupsEntriesUnstar(name: string, req: GoogleCloudDatacatalogV1UnstarEntryRequest): Promise<GoogleCloudDatacatalogV1UnstarEntryResponse>;

async projectsLocationsEntryGroupsGet(name: string, opts?: ProjectsLocationsEntryGroupsGetOptions): Promise<GoogleCloudDatacatalogV1EntryGroup>;

async projectsLocationsEntryGroupsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsLocationsEntryGroupsList(parent: string, opts?: ProjectsLocationsEntryGroupsListOptions): Promise<GoogleCloudDatacatalogV1ListEntryGroupsResponse>;

async projectsLocationsEntryGroupsPatch(

req: GoogleCloudDatacatalogV1EntryGroup,

opts?: ProjectsLocationsEntryGroupsPatchOptions,

): Promise<GoogleCloudDatacatalogV1EntryGroup>;

async projectsLocationsEntryGroupsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsEntryGroupsTagsCreate(parent: string, req: GoogleCloudDatacatalogV1Tag): Promise<GoogleCloudDatacatalogV1Tag>;

async projectsLocationsEntryGroupsTagsDelete(name: string): Promise<Empty>;

async projectsLocationsEntryGroupsTagsList(parent: string, opts?: ProjectsLocationsEntryGroupsTagsListOptions): Promise<GoogleCloudDatacatalogV1ListTagsResponse>;

async projectsLocationsEntryGroupsTagsPatch(

req: GoogleCloudDatacatalogV1Tag,

opts?: ProjectsLocationsEntryGroupsTagsPatchOptions,

): Promise<GoogleCloudDatacatalogV1Tag>;

async projectsLocationsEntryGroupsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsOperationsCancel(name: string): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsTagTemplatesCreate(

parent: string,

req: GoogleCloudDatacatalogV1TagTemplate,

opts?: ProjectsLocationsTagTemplatesCreateOptions,

): Promise<GoogleCloudDatacatalogV1TagTemplate>;

async projectsLocationsTagTemplatesDelete(name: string, opts?: ProjectsLocationsTagTemplatesDeleteOptions): Promise<Empty>;

async projectsLocationsTagTemplatesFieldsCreate(

parent: string,

req: GoogleCloudDatacatalogV1TagTemplateField,

opts?: ProjectsLocationsTagTemplatesFieldsCreateOptions,

): Promise<GoogleCloudDatacatalogV1TagTemplateField>;

async projectsLocationsTagTemplatesFieldsDelete(name: string, opts?: ProjectsLocationsTagTemplatesFieldsDeleteOptions): Promise<Empty>;

async projectsLocationsTagTemplatesFieldsEnumValuesRename(name: string, req: GoogleCloudDatacatalogV1RenameTagTemplateFieldEnumValueRequest): Promise<GoogleCloudDatacatalogV1TagTemplateField>;

async projectsLocationsTagTemplatesFieldsPatch(

req: GoogleCloudDatacatalogV1TagTemplateField,

opts?: ProjectsLocationsTagTemplatesFieldsPatchOptions,

): Promise<GoogleCloudDatacatalogV1TagTemplateField>;

async projectsLocationsTagTemplatesFieldsRename(name: string, req: GoogleCloudDatacatalogV1RenameTagTemplateFieldRequest): Promise<GoogleCloudDatacatalogV1TagTemplateField>;

async projectsLocationsTagTemplatesGet(name: string): Promise<GoogleCloudDatacatalogV1TagTemplate>;

async projectsLocationsTagTemplatesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsLocationsTagTemplatesPatch(

req: GoogleCloudDatacatalogV1TagTemplate,

opts?: ProjectsLocationsTagTemplatesPatchOptions,

): Promise<GoogleCloudDatacatalogV1TagTemplate>;

async projectsLocationsTagTemplatesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsTagTemplatesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsTaxonomiesCreate(parent: string, req: GoogleCloudDatacatalogV1Taxonomy): Promise<GoogleCloudDatacatalogV1Taxonomy>;

async projectsLocationsTaxonomiesDelete(name: string): Promise<Empty>;

async projectsLocationsTaxonomiesExport(parent: string, opts?: ProjectsLocationsTaxonomiesExportOptions): Promise<GoogleCloudDatacatalogV1ExportTaxonomiesResponse>;

async projectsLocationsTaxonomiesGet(name: string): Promise<GoogleCloudDatacatalogV1Taxonomy>;

async projectsLocationsTaxonomiesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsLocationsTaxonomiesImport(parent: string, req: GoogleCloudDatacatalogV1ImportTaxonomiesRequest): Promise<GoogleCloudDatacatalogV1ImportTaxonomiesResponse>;

async projectsLocationsTaxonomiesList(parent: string, opts?: ProjectsLocationsTaxonomiesListOptions): Promise<GoogleCloudDatacatalogV1ListTaxonomiesResponse>;

async projectsLocationsTaxonomiesPatch(

req: GoogleCloudDatacatalogV1Taxonomy,

opts?: ProjectsLocationsTaxonomiesPatchOptions,

): Promise<GoogleCloudDatacatalogV1Taxonomy>;

async projectsLocationsTaxonomiesPolicyTagsCreate(parent: string, req: GoogleCloudDatacatalogV1PolicyTag): Promise<GoogleCloudDatacatalogV1PolicyTag>;

async projectsLocationsTaxonomiesPolicyTagsDelete(name: string): Promise<Empty>;

async projectsLocationsTaxonomiesPolicyTagsGet(name: string): Promise<GoogleCloudDatacatalogV1PolicyTag>;

async projectsLocationsTaxonomiesPolicyTagsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsLocationsTaxonomiesPolicyTagsList(parent: string, opts?: ProjectsLocationsTaxonomiesPolicyTagsListOptions): Promise<GoogleCloudDatacatalogV1ListPolicyTagsResponse>;

async projectsLocationsTaxonomiesPolicyTagsPatch(

req: GoogleCloudDatacatalogV1PolicyTag,

opts?: ProjectsLocationsTaxonomiesPolicyTagsPatchOptions,

): Promise<GoogleCloudDatacatalogV1PolicyTag>;

async projectsLocationsTaxonomiesPolicyTagsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsTaxonomiesPolicyTagsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsTaxonomiesReplace(name: string, req: GoogleCloudDatacatalogV1ReplaceTaxonomyRequest): Promise<GoogleCloudDatacatalogV1Taxonomy>;

async projectsLocationsTaxonomiesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsTaxonomiesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

}

§Constructors

new DataCatalog(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

catalogSearch(req: GoogleCloudDatacatalogV1SearchCatalogRequest): Promise<GoogleCloudDatacatalogV1SearchCatalogResponse>

[src]

Searches Data Catalog for multiple resources like entries and tags that match a query. This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods. Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. For more information, see [Data Catalog search syntax] (https://cloud.google.com/data-catalog/docs/how-to/search-reference).

entriesLookup(opts?: EntriesLookupOptions): Promise<GoogleCloudDatacatalogV1Entry>

[src]

Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service.

projectsLocationsEntryGroupsCreate(parent: string, req: GoogleCloudDatacatalogV1EntryGroup, opts?: ProjectsLocationsEntryGroupsCreateOptions): Promise<GoogleCloudDatacatalogV1EntryGroup>

[src]

Creates an entry group. An entry group contains logically related entries together with Cloud Identity and Access Management policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources: * BigQuery entries (@bigquery) * Pub/Sub topics (@pubsub) * Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH}) You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the @ symbol, it is reserved for automatically created groups. Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

@param parent

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.

projectsLocationsEntryGroupsDelete(name: string, opts?: ProjectsLocationsEntryGroupsDeleteOptions): Promise<Empty>

[src]

Deletes an entry group. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

@param name

Required. The name of the entry group to delete.

projectsLocationsEntryGroupsEntriesCreate(parent: string, req: GoogleCloudDatacatalogV1Entry, opts?: ProjectsLocationsEntryGroupsEntriesCreateOptions): Promise<GoogleCloudDatacatalogV1Entry>

[src]

Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project. An entry group can have a maximum of 100,000 entries.

@param parent

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.

projectsLocationsEntryGroupsEntriesDelete(name: string): Promise<Empty>

[src]

Deletes an existing entry. You can delete only the entries created by the CreateEntry method. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

@param name

Required. The name of the entry to delete.

projectsLocationsEntryGroupsEntriesGet(name: string): Promise<GoogleCloudDatacatalogV1Entry>

[src]

Gets an entry.

@param name

Required. The name of the entry to get.

projectsLocationsEntryGroupsEntriesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the access control policy for a resource. May return: * ANOT_FOUND error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - datacatalog.tagTemplates.getIamPolicy to get policies on tag templates. - datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsEntryGroupsEntriesImport(parent: string, req: GoogleCloudDatacatalogV1ImportEntriesRequest): Promise<Operation>

[src]

Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog. ImportEntries accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of DumpItem type. ImportEntries returns a long-running operation resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message.

@param parent

Required. Target entry group for ingested entries.

projectsLocationsEntryGroupsEntriesList(parent: string, opts?: ProjectsLocationsEntryGroupsEntriesListOptions): Promise<GoogleCloudDatacatalogV1ListEntriesResponse>

[src]

Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog.

@param parent

Required. The name of the entry group that contains the entries to list. Can be provided in URL format.

projectsLocationsEntryGroupsEntriesModifyEntryContacts(name: string, req: GoogleCloudDatacatalogV1ModifyEntryContactsRequest): Promise<GoogleCloudDatacatalogV1Contacts>

[src]

Modifies contacts, part of the business context of an Entry. To call this method, you must have the datacatalog.entries.updateContacts IAM permission on the corresponding project.

@param name

Required. The full resource name of the entry.

projectsLocationsEntryGroupsEntriesModifyEntryOverview(name: string, req: GoogleCloudDatacatalogV1ModifyEntryOverviewRequest): Promise<GoogleCloudDatacatalogV1EntryOverview>

[src]

Modifies entry overview, part of the business context of an Entry. To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project.

@param name

Required. The full resource name of the entry.

projectsLocationsEntryGroupsEntriesPatch(name: string, req: GoogleCloudDatacatalogV1Entry, opts?: ProjectsLocationsEntryGroupsEntriesPatchOptions): Promise<GoogleCloudDatacatalogV1Entry>

[src]

Updates an existing entry. You must enable the Data Catalog API in the project identified by the entry.name parameter. For more information, see Data Catalog resource project.

@param name

Output only. Identifier. 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.

projectsLocationsEntryGroupsEntriesStar(name: string, req: GoogleCloudDatacatalogV1StarEntryRequest): Promise<GoogleCloudDatacatalogV1StarEntryResponse>

[src]

Marks an Entry as starred by the current user. Starring information is private to each user.

@param name

Required. The name of the entry to mark as starred.

projectsLocationsEntryGroupsEntriesTagsCreate(parent: string, req: GoogleCloudDatacatalogV1Tag): Promise<GoogleCloudDatacatalogV1Tag>

[src]

Creates a tag and assigns it to: * An Entry if the method name is projects.locations.entryGroups.entries.tags.create. * Or EntryGroupif the method name is projects.locations.entryGroups.tags.create. Note: The project identified by the parent parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.

@param parent

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.

projectsLocationsEntryGroupsEntriesTagsDelete(name: string): Promise<Empty>

[src]

Deletes a tag.

@param name

Required. The name of the tag to delete.

projectsLocationsEntryGroupsEntriesTagsList(parent: string, opts?: ProjectsLocationsEntryGroupsEntriesTagsListOptions): Promise<GoogleCloudDatacatalogV1ListTagsResponse>

[src]

Lists tags assigned to an Entry. The columns in the response are lowercased.

@param parent

Required. The name of the Data Catalog resource to list the tags of. The resource can be an Entry or an EntryGroup (without /entries/{entries} at the end).

projectsLocationsEntryGroupsEntriesTagsPatch(name: string, req: GoogleCloudDatacatalogV1Tag, opts?: ProjectsLocationsEntryGroupsEntriesTagsPatchOptions): Promise<GoogleCloudDatacatalogV1Tag>

[src]

Updates an existing tag.

@param name

Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.

projectsLocationsEntryGroupsEntriesTagsReconcile(parent: string, req: GoogleCloudDatacatalogV1ReconcileTagsRequest): Promise<Operation>

[src]

ReconcileTags creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list. ReconcileTags returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and a ReconcileTagsResponse message.

@param parent

Required. Name of Entry to be tagged.

projectsLocationsEntryGroupsEntriesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsEntryGroupsEntriesUnstar(name: string, req: GoogleCloudDatacatalogV1UnstarEntryRequest): Promise<GoogleCloudDatacatalogV1UnstarEntryResponse>

[src]

Marks an Entry as NOT starred by the current user. Starring information is private to each user.

@param name

Required. The name of the entry to mark as not starred.

projectsLocationsEntryGroupsGet(name: string, opts?: ProjectsLocationsEntryGroupsGetOptions): Promise<GoogleCloudDatacatalogV1EntryGroup>

[src]

Gets an entry group.

@param name

Required. The name of the entry group to get.

projectsLocationsEntryGroupsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsEntryGroupsList(parent: string, opts?: ProjectsLocationsEntryGroupsListOptions): Promise<GoogleCloudDatacatalogV1ListEntryGroupsResponse>

[src]

Lists entry groups.

@param parent

Required. The name of the location that contains the entry groups to list. Can be provided as a URL.

projectsLocationsEntryGroupsPatch(name: string, req: GoogleCloudDatacatalogV1EntryGroup, opts?: ProjectsLocationsEntryGroupsPatchOptions): Promise<GoogleCloudDatacatalogV1EntryGroup>

[src]

Updates an entry group. You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project.

@param name

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

projectsLocationsEntryGroupsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates - Entry groups Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. To call this method, you must have the following Google IAM permissions: - datacatalog.tagTemplates.setIamPolicy to set policies on tag templates. - datacatalog.entryGroups.setIamPolicy to set policies on entry groups.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsEntryGroupsTagsCreate(parent: string, req: GoogleCloudDatacatalogV1Tag): Promise<GoogleCloudDatacatalogV1Tag>

[src]

@param parent

projectsLocationsEntryGroupsTagsDelete(name: string): Promise<Empty>

[src]

Deletes a tag.

@param name

Required. The name of the tag to delete.

projectsLocationsEntryGroupsTagsList(parent: string, opts?: ProjectsLocationsEntryGroupsTagsListOptions): Promise<GoogleCloudDatacatalogV1ListTagsResponse>

[src]

Lists tags assigned to an Entry. The columns in the response are lowercased.

@param parent

Required. The name of the Data Catalog resource to list the tags of. The resource can be an Entry or an EntryGroup (without /entries/{entries} at the end).

projectsLocationsEntryGroupsTagsPatch(name: string, req: GoogleCloudDatacatalogV1Tag, opts?: ProjectsLocationsEntryGroupsTagsPatchOptions): Promise<GoogleCloudDatacatalogV1Tag>

[src]

Updates an existing tag.

@param name

Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.

projectsLocationsEntryGroupsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsOperationsCancel(name: string): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsTagTemplatesCreate(parent: string, req: GoogleCloudDatacatalogV1TagTemplate, opts?: ProjectsLocationsTagTemplatesCreateOptions): Promise<GoogleCloudDatacatalogV1TagTemplate>

[src]

Creates a tag template. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).

@param parent

Required. The name of the project and the template location region.

projectsLocationsTagTemplatesDelete(name: string, opts?: ProjectsLocationsTagTemplatesDeleteOptions): Promise<Empty>

[src]

Deletes a tag template and all tags that use it. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

@param name

Required. The name of the tag template to delete.

projectsLocationsTagTemplatesFieldsCreate(parent: string, req: GoogleCloudDatacatalogV1TagTemplateField, opts?: ProjectsLocationsTagTemplatesFieldsCreateOptions): Promise<GoogleCloudDatacatalogV1TagTemplateField>

[src]

Creates a field in a tag template. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

@param parent

Required. The name of the project and the template location region.

projectsLocationsTagTemplatesFieldsDelete(name: string, opts?: ProjectsLocationsTagTemplatesFieldsDeleteOptions): Promise<Empty>

[src]

Deletes a field in a tag template and all uses of this field from the tags based on this template. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

@param name

Required. The name of the tag template field to delete.

projectsLocationsTagTemplatesFieldsEnumValuesRename(name: string, req: GoogleCloudDatacatalogV1RenameTagTemplateFieldEnumValueRequest): Promise<GoogleCloudDatacatalogV1TagTemplateField>

[src]

Renames an enum value in a tag template. Within a single enum field, enum values must be unique.

@param name

Required. The name of the enum field value.

projectsLocationsTagTemplatesFieldsPatch(name: string, req: GoogleCloudDatacatalogV1TagTemplateField, opts?: ProjectsLocationsTagTemplatesFieldsPatchOptions): Promise<GoogleCloudDatacatalogV1TagTemplateField>

[src]

Updates a field in a tag template. You can't update the field type with this method. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

@param name

Required. The name of the tag template field.

projectsLocationsTagTemplatesFieldsRename(name: string, req: GoogleCloudDatacatalogV1RenameTagTemplateFieldRequest): Promise<GoogleCloudDatacatalogV1TagTemplateField>

[src]

Renames a field in a tag template. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).

@param name

Required. The name of the tag template field.

projectsLocationsTagTemplatesGet(name: string): Promise<GoogleCloudDatacatalogV1TagTemplate>

[src]

Gets a tag template.

@param name

Required. The name of the tag template to get.

projectsLocationsTagTemplatesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsTagTemplatesPatch(name: string, req: GoogleCloudDatacatalogV1TagTemplate, opts?: ProjectsLocationsTagTemplatesPatchOptions): Promise<GoogleCloudDatacatalogV1TagTemplate>

[src]

Updates a tag template. You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods. You must enable the Data Catalog API in the project identified by the tag_template.name parameter. For more information, see Data Catalog resource project.

@param name

Identifier. The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.

projectsLocationsTagTemplatesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsTagTemplatesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsTaxonomiesCreate(parent: string, req: GoogleCloudDatacatalogV1Taxonomy): Promise<GoogleCloudDatacatalogV1Taxonomy>

[src]

Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags.

@param parent

Required. Resource name of the project that the taxonomy will belong to.

projectsLocationsTaxonomiesDelete(name: string): Promise<Empty>

[src]

Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

@param name

Required. Resource name of the taxonomy to delete. Note: All policy tags in this taxonomy are also deleted.

projectsLocationsTaxonomiesExport(parent: string, opts?: ProjectsLocationsTaxonomiesExportOptions): Promise<GoogleCloudDatacatalogV1ExportTaxonomiesResponse>

[src]

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates SerializedTaxonomy protocol buffers with nested policy tags that can be used as input for ImportTaxonomies calls.

@param parent

Required. Resource name of the project that the exported taxonomies belong to.

projectsLocationsTaxonomiesGet(name: string): Promise<GoogleCloudDatacatalogV1Taxonomy>

[src]

Gets a taxonomy.

@param name

Required. Resource name of the taxonomy to get.

projectsLocationsTaxonomiesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the IAM policy for a policy tag or a taxonomy.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsTaxonomiesImport(parent: string, req: GoogleCloudDatacatalogV1ImportTaxonomiesRequest): Promise<GoogleCloudDatacatalogV1ImportTaxonomiesResponse>

[src]

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.

@param parent

Required. Resource name of project that the imported taxonomies will belong to.

projectsLocationsTaxonomiesList(parent: string, opts?: ProjectsLocationsTaxonomiesListOptions): Promise<GoogleCloudDatacatalogV1ListTaxonomiesResponse>

[src]

Lists all taxonomies in a project in a particular location that you have a permission to view.

@param parent

Required. Resource name of the project to list the taxonomies of.

projectsLocationsTaxonomiesPatch(name: string, req: GoogleCloudDatacatalogV1Taxonomy, opts?: ProjectsLocationsTaxonomiesPatchOptions): Promise<GoogleCloudDatacatalogV1Taxonomy>

[src]

Updates a taxonomy, including its display name, description, and activated policy types.

@param name

Identifier. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.

projectsLocationsTaxonomiesPolicyTagsCreate(parent: string, req: GoogleCloudDatacatalogV1PolicyTag): Promise<GoogleCloudDatacatalogV1PolicyTag>

[src]

Creates a policy tag in a taxonomy.

@param parent

Required. Resource name of the taxonomy that the policy tag will belong to.

projectsLocationsTaxonomiesPolicyTagsDelete(name: string): Promise<Empty>

[src]

Deletes a policy tag together with the following: * All of its descendant policy tags, if any * Policies associated with the policy tag and its descendants * References from BigQuery table schema of the policy tag and its descendants

@param name

Required. Resource name of the policy tag to delete. Note: All of its descendant policy tags are also deleted.

projectsLocationsTaxonomiesPolicyTagsGet(name: string): Promise<GoogleCloudDatacatalogV1PolicyTag>

[src]

Gets a policy tag.

@param name

Required. Resource name of the policy tag.

projectsLocationsTaxonomiesPolicyTagsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the IAM policy for a policy tag or a taxonomy.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsTaxonomiesPolicyTagsList(parent: string, opts?: ProjectsLocationsTaxonomiesPolicyTagsListOptions): Promise<GoogleCloudDatacatalogV1ListPolicyTagsResponse>

[src]

Lists all policy tags in a taxonomy.

@param parent

Required. Resource name of the taxonomy to list the policy tags of.

projectsLocationsTaxonomiesPolicyTagsPatch(name: string, req: GoogleCloudDatacatalogV1PolicyTag, opts?: ProjectsLocationsTaxonomiesPolicyTagsPatchOptions): Promise<GoogleCloudDatacatalogV1PolicyTag>

[src]

Updates a policy tag, including its display name, description, and parent policy tag.

@param name

Identifier. Resource name of this policy tag in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs.

projectsLocationsTaxonomiesPolicyTagsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the IAM policy for a policy tag or a taxonomy.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsTaxonomiesPolicyTagsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

Returns your permissions on a specified policy tag or taxonomy.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsTaxonomiesReplace(name: string, req: GoogleCloudDatacatalogV1ReplaceTaxonomyRequest): Promise<GoogleCloudDatacatalogV1Taxonomy>

[src]

Replaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by SerializedTaxonomy and the nested SerializedPolicyTag messages. This operation automatically does the following: - Deletes the existing policy tags that are missing from the SerializedPolicyTag. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly.

@param name

Required. Resource name of the taxonomy to update.

projectsLocationsTaxonomiesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the IAM policy for a policy tag or a taxonomy.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsTaxonomiesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

Returns your permissions on a specified policy tag or taxonomy.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.