com.google.cloud.datacatalog

Class DataCatalogGrpc.DataCatalogFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<DataCatalogGrpc.DataCatalogFutureStub>

com.google.cloud.datacatalog.DataCatalogGrpc.DataCatalogFutureStub

Enclosing class:

DataCatalogGrpc

public static final class DataCatalogGrpc.DataCatalogFutureStub
extends io.grpc.stub.AbstractStub<DataCatalogGrpc.DataCatalogFutureStub>

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

Method Summary

Modifier and Type	Method and Description
protected DataCatalogGrpc.DataCatalogFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Tag>	createTag(CreateTagRequest request) Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
com.google.common.util.concurrent.ListenableFuture<TagTemplate>	createTagTemplate(CreateTagTemplateRequest request) Creates a tag template.
com.google.common.util.concurrent.ListenableFuture<TagTemplateField>	createTagTemplateField(CreateTagTemplateFieldRequest request) Creates a field in a tag template.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteTag(DeleteTagRequest request) Deletes a tag.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteTagTemplate(DeleteTagTemplateRequest request) Deletes a tag template and all tags using the template.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteTagTemplateField(DeleteTagTemplateFieldRequest request) Deletes a field in a tag template and all uses of that field.
com.google.common.util.concurrent.ListenableFuture<Entry>	getEntry(GetEntryRequest request) Gets an entry.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the access control policy for a resource.
com.google.common.util.concurrent.ListenableFuture<TagTemplate>	getTagTemplate(GetTagTemplateRequest request) Gets a tag template.
com.google.common.util.concurrent.ListenableFuture<ListTagsResponse>	listTags(ListTagsRequest request) Lists the tags on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
com.google.common.util.concurrent.ListenableFuture<Entry>	lookupEntry(LookupEntryRequest request) Get an entry by target resource name.
com.google.common.util.concurrent.ListenableFuture<TagTemplateField>	renameTagTemplateField(RenameTagTemplateFieldRequest request) Renames a field in a tag template.
com.google.common.util.concurrent.ListenableFuture<SearchCatalogResponse>	searchCatalog(SearchCatalogRequest request) Searches Data Catalog for multiple resources like entries, tags that match a query.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets the access control policy for a resource.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Returns the caller's permissions on a resource.
com.google.common.util.concurrent.ListenableFuture<Entry>	updateEntry(UpdateEntryRequest request) Updates an existing entry.
com.google.common.util.concurrent.ListenableFuture<Tag>	updateTag(UpdateTagRequest request) Updates an existing tag.
com.google.common.util.concurrent.ListenableFuture<TagTemplate>	updateTagTemplate(UpdateTagTemplateRequest request) Updates a tag template.
com.google.common.util.concurrent.ListenableFuture<TagTemplateField>	updateTagTemplateField(UpdateTagTemplateFieldRequest request) Updates a field in a tag template.

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.DataCatalogFutureStub build(io.grpc.Channel channel,
                                                      io.grpc.CallOptions callOptions)

Specified by:

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

searchCatalog

public com.google.common.util.concurrent.ListenableFuture<SearchCatalogResponse> searchCatalog(SearchCatalogRequest request)

 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 searches do not have full recall. There may be results that match
 your query but are not returned, even in subsequent pages of results. These
 missing results may vary across repeated calls to search. Do not rely on
 this method if you need to guarantee full recall.
 See [Data Catalog Search
 Syntax](/data-catalog/docs/how-to/search-reference) for more information.
 

updateEntry

public com.google.common.util.concurrent.ListenableFuture<Entry> updateEntry(UpdateEntryRequest request)

 Updates an existing entry.
 

getEntry

public com.google.common.util.concurrent.ListenableFuture<Entry> getEntry(GetEntryRequest request)

 Gets an entry.
 

lookupEntry

public com.google.common.util.concurrent.ListenableFuture<Entry> lookupEntry(LookupEntryRequest request)

 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.
 

createTagTemplate

public com.google.common.util.concurrent.ListenableFuture<TagTemplate> createTagTemplate(CreateTagTemplateRequest request)

 Creates a tag template.
 

getTagTemplate

public com.google.common.util.concurrent.ListenableFuture<TagTemplate> getTagTemplate(GetTagTemplateRequest request)

 Gets a tag template.
 

updateTagTemplate

public com.google.common.util.concurrent.ListenableFuture<TagTemplate> updateTagTemplate(UpdateTagTemplateRequest request)

 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.
 

deleteTagTemplate

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteTagTemplate(DeleteTagTemplateRequest request)

 Deletes a tag template and all tags using the template.
 

createTagTemplateField

public com.google.common.util.concurrent.ListenableFuture<TagTemplateField> createTagTemplateField(CreateTagTemplateFieldRequest request)

 Creates a field in a tag template.
 

updateTagTemplateField

public com.google.common.util.concurrent.ListenableFuture<TagTemplateField> updateTagTemplateField(UpdateTagTemplateFieldRequest request)

 Updates a field in a tag template. This method cannot be used to update the
 field type.
 

renameTagTemplateField

public com.google.common.util.concurrent.ListenableFuture<TagTemplateField> renameTagTemplateField(RenameTagTemplateFieldRequest request)

 Renames a field in a tag template.
 

deleteTagTemplateField

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteTagTemplateField(DeleteTagTemplateFieldRequest request)

 Deletes a field in a tag template and all uses of that field.
 

createTag

public com.google.common.util.concurrent.ListenableFuture<Tag> createTag(CreateTagRequest request)

 Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
 

updateTag

public com.google.common.util.concurrent.ListenableFuture<Tag> updateTag(UpdateTagRequest request)

 Updates an existing tag.
 

deleteTag

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteTag(DeleteTagRequest request)

 Deletes a tag.
 

listTags

public com.google.common.util.concurrent.ListenableFuture<ListTagsResponse> listTags(ListTagsRequest request)

 Lists the tags on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
 

setIamPolicy

public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)

 Sets the access control policy for a resource. Replaces any existing
 policy.
 Supported resources are:
   - Tag templates.
 Note, this method cannot be used to manage policies for BigQuery, Cloud
 Pub/Sub and any external Google Cloud Platform resources synced to Cloud
 Data Catalog.
 Callers must have following Google IAM permission
 `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates.
 

getIamPolicy

public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)

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

testIamPermissions

public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse> testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

 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 resource are:
   - tag templates.
 Note, this method cannot be used to manage policies for BigQuery, Cloud
 Pub/Sub and any external Google Cloud Platform resources synced to Cloud
 Data Catalog.
 A caller is not required to have Google IAM permission to make this
 request.