Interface DataCatalogGrpc.AsyncService (1.29.0)

Version 1.29.0

• 1.48.0 (latest)
• 1.47.0
• 1.46.0
• 1.45.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.5
• 1.8.4
• 1.7.2
• 1.6.2
• 1.5.4

public static interface DataCatalogGrpc.AsyncService

Data Catalog API service allows clients to discover, understand, and manage their data.

Methods

createEntry(CreateEntryRequest request, StreamObserver<Entry> responseObserver)

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

Creates an entry. Only entries of 'FILESET' type or user-specified type can be created. Users should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information). A maximum of 100,000 entries may be created per entry group.

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)

A maximum of 10,000 entry groups may be created per organization across all locations. Users should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

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 on an Entry. Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be from 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. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

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. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

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. Only entries created through CreateEntry method can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

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 EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

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 using the template. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

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 that field. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

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

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. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Supported resources are:

• Tag templates.
• Entries.
• Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission
• datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
• datacatalog.entries.getIamPolicy to get policies on entries.
• 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>

listEntries(ListEntriesRequest request, StreamObserver<ListEntriesResponse> responseObserver)

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

Lists entries.

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)

Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.

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

renameTagTemplateField(RenameTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

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

Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

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. The enum values have to be unique within one enum field. Thus, an enum value cannot be renamed with a name used in any other enum value within the same enum field.

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, tags that match a query. This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequently call Get methods. Note that Data Catalog search queries do not guarantee full recall. Query results that match your query may not be returned, even in subsequent result pages. Also note that results returned (and not returned) can vary across repeated search queries. See Data Catalog Search Syntax for more information.

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 the access control policy for a resource. Replaces any existing policy. Supported resources are:

• Tag templates.
• Entries.
• Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission
• datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
• datacatalog.entries.setIamPolicy to set policies on entries.
• 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>

testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

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

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a NOT_FOUND error). Supported resources are:

• Tag templates.
• Entries.
• Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. A caller is not required to have Google IAM permission to make this request.

Parameters
Name	Description
request	com.google.iam.v1.TestIamPermissionsRequest
responseObserver	io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse>

updateEntry(UpdateEntryRequest request, StreamObserver<Entry> responseObserver)

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

Updates an existing entry. Users should enable the Data Catalog API in the project identified by the entry.name parameter (see Data Catalog Resource Project for more information).

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 EntryGroup. The user should enable the Data Catalog API in the project identified by the entry_group.name parameter (see Data Catalog Resource Project for more information).

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. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the tag_template.name parameter (see Data Catalog Resource Project for more information).

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. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

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