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>

A stub to allow clients to do ListenableFuture-style rpc calls to service DataCatalog.

 Data Catalog API service allows you to discover, understand, and manage
 your 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 entry group.
com.google.common.util.concurrent.ListenableFuture<Tag>	createTag(CreateTagRequest request) 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`.
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 entry group.
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 that use it.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteTagTemplateField(DeleteTagTemplateFieldRequest request) Deletes a field in a tag template and all uses of this field from the tags based on this template.
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 entry group.
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<com.google.longrunning.Operation>	importEntries(ImportEntriesRequest request) Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog.
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 tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
com.google.common.util.concurrent.ListenableFuture<Entry>	lookupEntry(LookupEntryRequest request) Gets an entry by its target resource name.
com.google.common.util.concurrent.ListenableFuture<Contacts>	modifyEntryContacts(ModifyEntryContactsRequest request) Modifies contacts, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry].
com.google.common.util.concurrent.ListenableFuture<EntryOverview>	modifyEntryOverview(ModifyEntryOverviewRequest request) Modifies entry overview, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry].
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	reconcileTags(ReconcileTagsRequest request) `ReconcileTags` creates or updates a list of tags on the entry.
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 and tags that match a query.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets an access control policy for a resource.
com.google.common.util.concurrent.ListenableFuture<StarEntryResponse>	starEntry(StarEntryRequest request) Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Gets your permissions on a resource.
com.google.common.util.concurrent.ListenableFuture<UnstarEntryResponse>	unstarEntry(UnstarEntryRequest request) Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user.
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 entry group.
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 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 com.google.common.util.concurrent.ListenableFuture<EntryGroup> createEntryGroup(CreateEntryGroupRequest request)

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

 Gets an entry group.
 

updateEntryGroup

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

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

 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 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.
 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 com.google.common.util.concurrent.ListenableFuture<Entry> updateEntry(UpdateEntryRequest request)

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

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

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

listEntries

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

 Lists entries.
 Note: Currently, this method can list only custom entries.
 To get a list of both custom and automatically created entries, use
 [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
 

modifyEntryOverview

public com.google.common.util.concurrent.ListenableFuture<EntryOverview> modifyEntryOverview(ModifyEntryOverviewRequest request)

 Modifies entry overview, part of the business context of an
 [Entry][google.cloud.datacatalog.v1.Entry].
 To call this method, you must have the `datacatalog.entries.updateOverview`
 IAM permission on the corresponding project.
 

modifyEntryContacts

public com.google.common.util.concurrent.ListenableFuture<Contacts> modifyEntryContacts(ModifyEntryContactsRequest request)

 Modifies contacts, part of the business context of an
 [Entry][google.cloud.datacatalog.v1.Entry].
 To call this method, you must have the `datacatalog.entries.updateContacts`
 IAM permission on the corresponding project.
 

createTagTemplate

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

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

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

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

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

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

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

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

 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 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 tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
 The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are
 lowercased.
 

reconcileTags

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> reconcileTags(ReconcileTagsRequest request)

 `ReconcileTags` creates or updates a list of tags on the entry.
 If the
 [ReconcileTagsRequest.force_delete_missing][google.cloud.datacatalog.v1.ReconcileTagsRequest.force_delete_missing]
 parameter is set, the operation deletes tags not included in the input tag
 list.
 `ReconcileTags` returns a [long-running operation]
 [google.longrunning.Operation] resource that can be queried with
 [Operations.GetOperation][google.longrunning.Operations.GetOperation]
 to return [ReconcileTagsMetadata]
 [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and
 a [ReconcileTagsResponse]
 [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.
 

starEntry

public com.google.common.util.concurrent.ListenableFuture<StarEntryResponse> starEntry(StarEntryRequest request)

 Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by
 the current user. Starring information is private to each user.
 

unstarEntry

public com.google.common.util.concurrent.ListenableFuture<UnstarEntryResponse> unstarEntry(UnstarEntryRequest request)

 Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by
 the current user. Starring information is private to each user.
 

setIamPolicy

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

 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 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.
 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 com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse> testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

 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.
 

importEntries

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> importEntries(ImportEntriesRequest request)

 Imports entries from a source, such as data previously dumped into a
 Cloud Storage bucket, into Data Catalog. Import of entries
 is a sync operation that reconciles the state of the third-party system
 with the Data Catalog.
 `ImportEntries` accepts source data snapshots of a third-party system.
 Snapshot should be delivered as a .wire or base65-encoded .txt file
 containing a sequence of Protocol Buffer messages of
 [DumpItem][google.cloud.datacatalog.v1.DumpItem] type.
 `ImportEntries` returns a [long-running operation]
 [google.longrunning.Operation] resource that can be queried with
 [Operations.GetOperation][google.longrunning.Operations.GetOperation]
 to return
 [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata]
 and an
 [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse]
 message.