com.google.cloud.datacatalog.v1

Class DataCatalogGrpc.DataCatalogStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<DataCatalogGrpc.DataCatalogStub>

com.google.cloud.datacatalog.v1.DataCatalogGrpc.DataCatalogStub

Enclosing class:

DataCatalogGrpc

public static final class DataCatalogGrpc.DataCatalogStub
extends io.grpc.stub.AbstractAsyncStub<DataCatalogGrpc.DataCatalogStub>

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

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected DataCatalogGrpc.DataCatalogStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
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 EntryGroup.
void	createTag(CreateTagRequest request, io.grpc.stub.StreamObserver<Tag> responseObserver) Creates a tag on an [Entry][google.cloud.datacatalog.v1.Entry].
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 EntryGroup.
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 using the template.
void	deleteTagTemplateField(DeleteTagTemplateFieldRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a field in a tag template and all uses of that field.
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 EntryGroup.
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 the tags on an [Entry][google.cloud.datacatalog.v1.Entry].
void	lookupEntry(LookupEntryRequest request, io.grpc.stub.StreamObserver<Entry> responseObserver) Get an entry by target resource name.
void	renameTagTemplateField(RenameTagTemplateFieldRequest request, io.grpc.stub.StreamObserver<TagTemplateField> responseObserver) Renames a field in a tag template.
void	searchCatalog(SearchCatalogRequest request, io.grpc.stub.StreamObserver<SearchCatalogResponse> responseObserver) Searches Data Catalog for multiple resources like entries, tags that match a query.
void	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver) Sets the access control policy for a resource.
void	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver) Returns the caller's 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 EntryGroup.
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 io.grpc.stub.AbstractAsyncStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected DataCatalogGrpc.DataCatalogStub build(io.grpc.Channel channel,
                                                io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<DataCatalogGrpc.DataCatalogStub>

searchCatalog

public void searchCatalog(SearchCatalogRequest request,
                          io.grpc.stub.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 subsequentally 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](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.
 

createEntryGroup

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

 Creates an EntryGroup.
 An entry group contains logically related entries together with Cloud
 Identity and Access Management policies that specify the users who can
 create, edit, and view entries within the entry group.
 Data Catalog automatically creates an entry group for BigQuery entries
 ("@bigquery") and Pub/Sub topics ("@pubsub"). Users create their own entry
 group to contain Cloud Storage fileset entries or custom type entries,
 and the IAM policies associated with those entries. Entry groups, like
 entries, can be searched.
 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]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

getEntryGroup

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

 Gets an EntryGroup.
 

updateEntryGroup

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

deleteEntryGroup

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

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. 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]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 A maximum of 100,000 entries may be created per entry group.
 

updateEntry

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

deleteEntry

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

 Deletes an existing entry. Only entries created through
 [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.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]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

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)

 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.
 

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. The user should enable the Data Catalog API in
 the project identified by the `parent` parameter (see [Data Catalog
 Resource
 Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
 for more information).
 

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. 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]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

deleteTagTemplate

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

createTagTemplateField

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

updateTagTemplateField

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

renameTagTemplateField

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

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 that field.
 Users should enable the Data Catalog API in the project identified by
 the `name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

createTag

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

 Creates a tag on an [Entry][google.cloud.datacatalog.v1.Entry].
 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 from 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 the tags on 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 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.
 

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

testIamPermissions

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