com.google.cloud.datacatalog.v1

Class DataCatalogGrpc.DataCatalogFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

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

com.google.cloud.datacatalog.v1.DataCatalogGrpc.DataCatalogFutureStub

Enclosing class:

DataCatalogGrpc

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

 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.DataCatalogFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Entry>	createEntry(CreateEntryRequest request) Creates an entry.
com.google.common.util.concurrent.ListenableFuture<EntryGroup>	createEntryGroup(CreateEntryGroupRequest request) Creates an EntryGroup.
com.google.common.util.concurrent.ListenableFuture<Tag>	createTag(CreateTagRequest request) Creates a tag on an [Entry][google.cloud.datacatalog.v1.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>	deleteEntry(DeleteEntryRequest request) Deletes an existing entry.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteEntryGroup(DeleteEntryGroupRequest request) Deletes an EntryGroup.
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<EntryGroup>	getEntryGroup(GetEntryGroupRequest request) Gets an EntryGroup.
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<ListEntriesResponse>	listEntries(ListEntriesRequest request) Lists entries.
com.google.common.util.concurrent.ListenableFuture<ListEntryGroupsResponse>	listEntryGroups(ListEntryGroupsRequest request) Lists entry groups.
com.google.common.util.concurrent.ListenableFuture<ListTagsResponse>	listTags(ListTagsRequest request) Lists the tags on an [Entry][google.cloud.datacatalog.v1.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<TagTemplateField>	renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request) Renames an enum value 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<EntryGroup>	updateEntryGroup(UpdateEntryGroupRequest request) Updates an EntryGroup.
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.AbstractFutureStub

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.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 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](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.
 

createEntryGroup

public com.google.common.util.concurrent.ListenableFuture<EntryGroup> createEntryGroup(CreateEntryGroupRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<EntryGroup> getEntryGroup(GetEntryGroupRequest request)

 Gets an EntryGroup.
 

updateEntryGroup

public com.google.common.util.concurrent.ListenableFuture<EntryGroup> updateEntryGroup(UpdateEntryGroupRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteEntryGroup(DeleteEntryGroupRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<ListEntryGroupsResponse> listEntryGroups(ListEntryGroupsRequest request)

 Lists entry groups.
 

createEntry

public com.google.common.util.concurrent.ListenableFuture<Entry> createEntry(CreateEntryRequest request)

 Creates an entry. Only entries of types 'FILESET', 'CLUSTER', 'DATA_STREAM'
 or with a 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 com.google.common.util.concurrent.ListenableFuture<Entry> updateEntry(UpdateEntryRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteEntry(DeleteEntryRequest request)

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

listEntries

public com.google.common.util.concurrent.ListenableFuture<ListEntriesResponse> listEntries(ListEntriesRequest request)

 Lists entries.
 

createTagTemplate

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

 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 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.
 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 com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteTagTemplate(DeleteTagTemplateRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<TagTemplateField> createTagTemplateField(CreateTagTemplateFieldRequest request)

 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 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. 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 com.google.common.util.concurrent.ListenableFuture<TagTemplateField> renameTagTemplateField(RenameTagTemplateFieldRequest request)

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

renameTagTemplateFieldEnumValue

public com.google.common.util.concurrent.ListenableFuture<TagTemplateField> renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request)

 Renames an enum value in a tag template. The enum values have to be unique
 within one enum field.
 

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.
 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 com.google.common.util.concurrent.ListenableFuture<Tag> createTag(CreateTagRequest request)

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