Interface DataCatalogGrpc.AsyncService (1.52.0)

public static interface DataCatalogGrpc.AsyncService

Data Catalog API service allows you to discover, understand, and manage your data.

Methods

createEntry(CreateEntryRequest request, StreamObserver<Entry> responseObserver)

public default void createEntry(CreateEntryRequest request, StreamObserver<Entry> responseObserver)

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.

Parameters
Name Description
request CreateEntryRequest
responseObserver io.grpc.stub.StreamObserver<Entry>

createEntryGroup(CreateEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

public default void createEntryGroup(CreateEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

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.
Parameters
Name Description
request CreateEntryGroupRequest
responseObserver io.grpc.stub.StreamObserver<EntryGroup>

createTag(CreateTagRequest request, StreamObserver<Tag> responseObserver)

public default void createTag(CreateTagRequest request, StreamObserver<Tag> responseObserver)

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 and the tag template used to create the tag must be in the same organization.
Parameters
Name Description
request CreateTagRequest
responseObserver io.grpc.stub.StreamObserver<Tag>

createTagTemplate(CreateTagTemplateRequest request, StreamObserver<TagTemplate> responseObserver)

public default void createTagTemplate(CreateTagTemplateRequest request, StreamObserver<TagTemplate> responseObserver)

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.

Parameters
Name Description
request CreateTagTemplateRequest
responseObserver io.grpc.stub.StreamObserver<TagTemplate>

createTagTemplateField(CreateTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

public default void createTagTemplateField(CreateTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

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.

Parameters
Name Description
request CreateTagTemplateFieldRequest
responseObserver io.grpc.stub.StreamObserver<TagTemplateField>

deleteEntry(DeleteEntryRequest request, StreamObserver<Empty> responseObserver)

public default void deleteEntry(DeleteEntryRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
Name Description
request DeleteEntryRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteEntryGroup(DeleteEntryGroupRequest request, StreamObserver<Empty> responseObserver)

public default void deleteEntryGroup(DeleteEntryGroupRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
Name Description
request DeleteEntryGroupRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteTag(DeleteTagRequest request, StreamObserver<Empty> responseObserver)

public default void deleteTag(DeleteTagRequest request, StreamObserver<Empty> responseObserver)

Deletes a tag.

Parameters
Name Description
request DeleteTagRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteTagTemplate(DeleteTagTemplateRequest request, StreamObserver<Empty> responseObserver)

public default void deleteTagTemplate(DeleteTagTemplateRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
Name Description
request DeleteTagTemplateRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteTagTemplateField(DeleteTagTemplateFieldRequest request, StreamObserver<Empty> responseObserver)

public default void deleteTagTemplateField(DeleteTagTemplateFieldRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
Name Description
request DeleteTagTemplateFieldRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getEntry(GetEntryRequest request, StreamObserver<Entry> responseObserver)

public default void getEntry(GetEntryRequest request, StreamObserver<Entry> responseObserver)

Gets an entry.

Parameters
Name Description
request GetEntryRequest
responseObserver io.grpc.stub.StreamObserver<Entry>

getEntryGroup(GetEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

public default void getEntryGroup(GetEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

Gets an entry group.

Parameters
Name Description
request GetEntryGroupRequest
responseObserver io.grpc.stub.StreamObserver<EntryGroup>

getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public default void getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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.
Parameters
Name Description
request com.google.iam.v1.GetIamPolicyRequest
responseObserver io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

getTagTemplate(GetTagTemplateRequest request, StreamObserver<TagTemplate> responseObserver)

public default void getTagTemplate(GetTagTemplateRequest request, StreamObserver<TagTemplate> responseObserver)

Gets a tag template.

Parameters
Name Description
request GetTagTemplateRequest
responseObserver io.grpc.stub.StreamObserver<TagTemplate>

importEntries(ImportEntriesRequest request, StreamObserver<Operation> responseObserver)

public default void importEntries(ImportEntriesRequest request, StreamObserver<Operation> responseObserver)

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] [google.longrunning.Operation] resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message.

Parameters
Name Description
request ImportEntriesRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

listEntries(ListEntriesRequest request, StreamObserver<ListEntriesResponse> responseObserver)

public default void listEntries(ListEntriesRequest request, StreamObserver<ListEntriesResponse> responseObserver)

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

Parameters
Name Description
request ListEntriesRequest
responseObserver io.grpc.stub.StreamObserver<ListEntriesResponse>

listEntryGroups(ListEntryGroupsRequest request, StreamObserver<ListEntryGroupsResponse> responseObserver)

public default void listEntryGroups(ListEntryGroupsRequest request, StreamObserver<ListEntryGroupsResponse> responseObserver)

Lists entry groups.

Parameters
Name Description
request ListEntryGroupsRequest
responseObserver io.grpc.stub.StreamObserver<ListEntryGroupsResponse>

listTags(ListTagsRequest request, StreamObserver<ListTagsResponse> responseObserver)

public default void listTags(ListTagsRequest request, StreamObserver<ListTagsResponse> responseObserver)

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

Parameters
Name Description
request ListTagsRequest
responseObserver io.grpc.stub.StreamObserver<ListTagsResponse>

lookupEntry(LookupEntryRequest request, StreamObserver<Entry> responseObserver)

public default void lookupEntry(LookupEntryRequest request, StreamObserver<Entry> responseObserver)

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

Parameters
Name Description
request LookupEntryRequest
responseObserver io.grpc.stub.StreamObserver<Entry>

modifyEntryContacts(ModifyEntryContactsRequest request, StreamObserver<Contacts> responseObserver)

public default void modifyEntryContacts(ModifyEntryContactsRequest request, StreamObserver<Contacts> responseObserver)

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.

Parameters
Name Description
request ModifyEntryContactsRequest
responseObserver io.grpc.stub.StreamObserver<Contacts>

modifyEntryOverview(ModifyEntryOverviewRequest request, StreamObserver<EntryOverview> responseObserver)

public default void modifyEntryOverview(ModifyEntryOverviewRequest request, StreamObserver<EntryOverview> responseObserver)

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.

Parameters
Name Description
request ModifyEntryOverviewRequest
responseObserver io.grpc.stub.StreamObserver<EntryOverview>

reconcileTags(ReconcileTagsRequest request, StreamObserver<Operation> responseObserver)

public default void reconcileTags(ReconcileTagsRequest request, StreamObserver<Operation> responseObserver)

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] [google.longrunning.Operation] resource that can be queried with Operations.GetOperation to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.

Parameters
Name Description
request ReconcileTagsRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

renameTagTemplateField(RenameTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

public default void renameTagTemplateField(RenameTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

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.

Parameters
Name Description
request RenameTagTemplateFieldRequest
responseObserver io.grpc.stub.StreamObserver<TagTemplateField>

renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request, StreamObserver<TagTemplateField> responseObserver)

public default void renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request, StreamObserver<TagTemplateField> responseObserver)

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

Parameters
Name Description
request RenameTagTemplateFieldEnumValueRequest
responseObserver io.grpc.stub.StreamObserver<TagTemplateField>

searchCatalog(SearchCatalogRequest request, StreamObserver<SearchCatalogResponse> responseObserver)

public default void searchCatalog(SearchCatalogRequest request, StreamObserver<SearchCatalogResponse> responseObserver)

Searches Data Catalog for multiple resources like entries and tags that match a query. This is a Custom Method 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.

Parameters
Name Description
request SearchCatalogRequest
responseObserver io.grpc.stub.StreamObserver<SearchCatalogResponse>

setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public default void setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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.
Parameters
Name Description
request com.google.iam.v1.SetIamPolicyRequest
responseObserver io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

starEntry(StarEntryRequest request, StreamObserver<StarEntryResponse> responseObserver)

public default void starEntry(StarEntryRequest request, StreamObserver<StarEntryResponse> responseObserver)

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

Parameters
Name Description
request StarEntryRequest
responseObserver io.grpc.stub.StreamObserver<StarEntryResponse>

testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

public default void testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

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.
Parameters
Name Description
request com.google.iam.v1.TestIamPermissionsRequest
responseObserver io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse>

unstarEntry(UnstarEntryRequest request, StreamObserver<UnstarEntryResponse> responseObserver)

public default void unstarEntry(UnstarEntryRequest request, StreamObserver<UnstarEntryResponse> responseObserver)

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

Parameters
Name Description
request UnstarEntryRequest
responseObserver io.grpc.stub.StreamObserver<UnstarEntryResponse>

updateEntry(UpdateEntryRequest request, StreamObserver<Entry> responseObserver)

public default void updateEntry(UpdateEntryRequest request, StreamObserver<Entry> responseObserver)

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.

Parameters
Name Description
request UpdateEntryRequest
responseObserver io.grpc.stub.StreamObserver<Entry>

updateEntryGroup(UpdateEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

public default void updateEntryGroup(UpdateEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

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.

Parameters
Name Description
request UpdateEntryGroupRequest
responseObserver io.grpc.stub.StreamObserver<EntryGroup>

updateTag(UpdateTagRequest request, StreamObserver<Tag> responseObserver)

public default void updateTag(UpdateTagRequest request, StreamObserver<Tag> responseObserver)

Updates an existing tag.

Parameters
Name Description
request UpdateTagRequest
responseObserver io.grpc.stub.StreamObserver<Tag>

updateTagTemplate(UpdateTagTemplateRequest request, StreamObserver<TagTemplate> responseObserver)

public default void updateTagTemplate(UpdateTagTemplateRequest request, StreamObserver<TagTemplate> responseObserver)

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.

Parameters
Name Description
request UpdateTagTemplateRequest
responseObserver io.grpc.stub.StreamObserver<TagTemplate>

updateTagTemplateField(UpdateTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

public default void updateTagTemplateField(UpdateTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

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.

Parameters
Name Description
request UpdateTagTemplateFieldRequest
responseObserver io.grpc.stub.StreamObserver<TagTemplateField>