com.google.cloud.datacatalog.v1

Class DataCatalogGrpc.DataCatalogImplBase

java.lang.Object

com.google.cloud.datacatalog.v1.DataCatalogGrpc.DataCatalogImplBase

All Implemented Interfaces:

io.grpc.BindableService

Enclosing class:

DataCatalogGrpc

public abstract static class DataCatalogGrpc.DataCatalogImplBase
extends Object
implements io.grpc.BindableService

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

Constructor Summary

Constructors

Constructor and Description
DataCatalogImplBase()

Method Summary

Modifier and Type	Method and Description
io.grpc.ServerServiceDefinition	bindService()
void	createEntry(CreateEntryRequest request, io.grpc.stub.StreamObserver<Entry> responseObserver) Creates an entry.
void	createEntryGroup(CreateEntryGroupRequest request, io.grpc.stub.StreamObserver<EntryGroup> responseObserver) Creates an entry group.
void	createTag(CreateTagRequest request, io.grpc.stub.StreamObserver<Tag> responseObserver) Creates a tag and assigns it to: * An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is ``projects.locations.entryGroups.entries.tags.create``.
void	createTagTemplate(CreateTagTemplateRequest request, io.grpc.stub.StreamObserver<TagTemplate> responseObserver) Creates a tag template.
void	createTagTemplateField(CreateTagTemplateFieldRequest request, io.grpc.stub.StreamObserver<TagTemplateField> responseObserver) Creates a field in a tag template.
void	deleteEntry(DeleteEntryRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes an existing entry.
void	deleteEntryGroup(DeleteEntryGroupRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes an entry group.
void	deleteTag(DeleteTagRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a tag.
void	deleteTagTemplate(DeleteTagTemplateRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a tag template and all tags that use it.
void	deleteTagTemplateField(DeleteTagTemplateFieldRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a field in a tag template and all uses of this field from the tags based on this template.
void	getEntry(GetEntryRequest request, io.grpc.stub.StreamObserver<Entry> responseObserver) Gets an entry.
void	getEntryGroup(GetEntryGroupRequest request, io.grpc.stub.StreamObserver<EntryGroup> responseObserver) Gets an entry group.
void	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver) Gets the access control policy for a resource.
void	getTagTemplate(GetTagTemplateRequest request, io.grpc.stub.StreamObserver<TagTemplate> responseObserver) Gets a tag template.
void	listEntries(ListEntriesRequest request, io.grpc.stub.StreamObserver<ListEntriesResponse> responseObserver) Lists entries.
void	listEntryGroups(ListEntryGroupsRequest request, io.grpc.stub.StreamObserver<ListEntryGroupsResponse> responseObserver) Lists entry groups.
void	listTags(ListTagsRequest request, io.grpc.stub.StreamObserver<ListTagsResponse> responseObserver) Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
void	lookupEntry(LookupEntryRequest request, io.grpc.stub.StreamObserver<Entry> responseObserver) Gets an entry by its target resource name.
void	renameTagTemplateField(RenameTagTemplateFieldRequest request, io.grpc.stub.StreamObserver<TagTemplateField> responseObserver) Renames a field in a tag template.
void	renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request, io.grpc.stub.StreamObserver<TagTemplateField> responseObserver) Renames an enum value in a tag template.
void	searchCatalog(SearchCatalogRequest request, io.grpc.stub.StreamObserver<SearchCatalogResponse> responseObserver) Searches Data Catalog for multiple resources like entries and tags that match a query.
void	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver) Sets an access control policy for a resource.
void	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver) Gets your permissions on a resource.
void	updateEntry(UpdateEntryRequest request, io.grpc.stub.StreamObserver<Entry> responseObserver) Updates an existing entry.
void	updateEntryGroup(UpdateEntryGroupRequest request, io.grpc.stub.StreamObserver<EntryGroup> responseObserver) Updates an entry group.
void	updateTag(UpdateTagRequest request, io.grpc.stub.StreamObserver<Tag> responseObserver) Updates an existing tag.
void	updateTagTemplate(UpdateTagTemplateRequest request, io.grpc.stub.StreamObserver<TagTemplate> responseObserver) Updates a tag template.
void	updateTagTemplateField(UpdateTagTemplateFieldRequest request, io.grpc.stub.StreamObserver<TagTemplateField> responseObserver) Updates a field in a tag template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataCatalogImplBase

public DataCatalogImplBase()

Method Detail

searchCatalog

public void searchCatalog(SearchCatalogRequest request,
                          io.grpc.stub.StreamObserver<SearchCatalogResponse> responseObserver)

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

createEntryGroup

public void createEntryGroup(CreateEntryGroupRequest request,
                             io.grpc.stub.StreamObserver<EntryGroup> responseObserver)

 Creates an entry group.
 An entry group contains logically related entries together with [Cloud
 Identity and Access Management](/data-catalog/docs/concepts/iam) 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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 

getEntryGroup

public void getEntryGroup(GetEntryGroupRequest request,
                          io.grpc.stub.StreamObserver<EntryGroup> responseObserver)

 Gets an entry group.
 

updateEntryGroup

public void updateEntryGroup(UpdateEntryGroupRequest request,
                             io.grpc.stub.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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 

deleteEntryGroup

public void deleteEntryGroup(DeleteEntryGroupRequest request,
                             io.grpc.stub.StreamObserver<com.google.protobuf.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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 

listEntryGroups

public void listEntryGroups(ListEntryGroupsRequest request,
                            io.grpc.stub.StreamObserver<ListEntryGroupsResponse> responseObserver)

 Lists entry groups.
 

createEntry

public void createEntry(CreateEntryRequest request,
                        io.grpc.stub.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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 An entry group can have a maximum of 100,000 entries.
 

updateEntry

public void updateEntry(UpdateEntryRequest request,
                        io.grpc.stub.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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 

deleteEntry

public void deleteEntry(DeleteEntryRequest request,
                        io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 Deletes an existing entry.
 You can delete only the entries created by the
 [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 

getEntry

public void getEntry(GetEntryRequest request,
                     io.grpc.stub.StreamObserver<Entry> responseObserver)

 Gets an entry.
 

lookupEntry

public void lookupEntry(LookupEntryRequest request,
                        io.grpc.stub.StreamObserver<Entry> responseObserver)

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

listEntries

public void listEntries(ListEntriesRequest request,
                        io.grpc.stub.StreamObserver<ListEntriesResponse> responseObserver)

 Lists entries.
 

createTagTemplate

public void createTagTemplate(CreateTagTemplateRequest request,
                              io.grpc.stub.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]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 

getTagTemplate

public void getTagTemplate(GetTagTemplateRequest request,
                           io.grpc.stub.StreamObserver<TagTemplate> responseObserver)

 Gets a tag template.
 

updateTagTemplate

public void updateTagTemplate(UpdateTagTemplateRequest request,
                              io.grpc.stub.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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 

deleteTagTemplate

public void deleteTagTemplate(DeleteTagTemplateRequest request,
                              io.grpc.stub.StreamObserver<com.google.protobuf.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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 

createTagTemplateField

public void createTagTemplateField(CreateTagTemplateFieldRequest request,
                                   io.grpc.stub.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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 

updateTagTemplateField

public void updateTagTemplateField(UpdateTagTemplateFieldRequest request,
                                   io.grpc.stub.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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 

renameTagTemplateField

public void renameTagTemplateField(RenameTagTemplateFieldRequest request,
                                   io.grpc.stub.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]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 

renameTagTemplateFieldEnumValue

public void renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request,
                                            io.grpc.stub.StreamObserver<TagTemplateField> responseObserver)

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

deleteTagTemplateField

public void deleteTagTemplateField(DeleteTagTemplateFieldRequest request,
                                   io.grpc.stub.StreamObserver<com.google.protobuf.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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 

createTag

public void createTag(CreateTagRequest request,
                      io.grpc.stub.StreamObserver<Tag> responseObserver)

 Creates a tag and assigns it to:
 * An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
   ``projects.locations.entryGroups.entries.tags.create``.
 * Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if 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.
 

updateTag

public void updateTag(UpdateTagRequest request,
                      io.grpc.stub.StreamObserver<Tag> responseObserver)

 Updates an existing tag.
 

deleteTag

public void deleteTag(DeleteTagRequest request,
                      io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 Deletes a tag.
 

listTags

public void listTags(ListTagsRequest request,
                     io.grpc.stub.StreamObserver<ListTagsResponse> responseObserver)

 Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
 

setIamPolicy

public void setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request,
                         io.grpc.stub.StreamObserver<com.google.iam.v1.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.
 

getIamPolicy

public void getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request,
                         io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)

 Gets the access control policy for a resource.
 May return:
 * A`NOT_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.
 

testIamPermissions

public void testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request,
                               io.grpc.stub.StreamObserver<com.google.iam.v1.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.
 

bindService

public final io.grpc.ServerServiceDefinition bindService()

Specified by:

bindService in interface io.grpc.BindableService