public static final class DataCatalogGrpc.DataCatalogFutureStub extends AbstractFutureStub<DataCatalogGrpc.DataCatalogFutureStub>
Data Catalog API service allows you to discover, understand, and manage
your data.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractFutureStub >
DataCatalogGrpc.DataCatalogFutureStub
Inherited Members
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
build(Channel channel, CallOptions callOptions)
protected DataCatalogGrpc.DataCatalogFutureStub build(Channel channel, CallOptions callOptions)
Parameters
| Name | Description |
| channel | io.grpc.Channel
|
| callOptions | io.grpc.CallOptions
|
Returns
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
createEntry(CreateEntryRequest request)
public 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.
An entry group can have a maximum of 100,000 entries.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<Entry> | |
createEntryGroup(CreateEntryGroupRequest request)
public ListenableFuture<EntryGroup> createEntryGroup(CreateEntryGroupRequest request)
Creates an entry group.
An entry group contains logically related entries together with Cloud
Identity and Access Management 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.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<EntryGroup> | |
createTag(CreateTagRequest request)
public ListenableFuture<Tag> createTag(CreateTagRequest request)
Creates a tag and assigns it to:
- An Entry if the method name is
projects.locations.entryGroups.entries.tags.create.
- Or EntryGroupif the method
name is
projects.locations.entryGroups.tags.create.
Note: The project identified by the parent parameter for the tag
and the tag template
used to create the tag must be in the same organization.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<Tag> | |
createTagTemplate(CreateTagTemplateRequest request)
public 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.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<TagTemplate> | |
createTagTemplateField(CreateTagTemplateFieldRequest request)
public 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.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<TagTemplateField> | |
deleteEntry(DeleteEntryRequest request)
public ListenableFuture<Empty> deleteEntry(DeleteEntryRequest request)
Deletes an existing entry.
You can delete only the entries created by the
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.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteEntryGroup(DeleteEntryGroupRequest request)
public ListenableFuture<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.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteTag(DeleteTagRequest request)
public ListenableFuture<Empty> deleteTag(DeleteTagRequest request)
Parameter
Returns
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteTagTemplate(DeleteTagTemplateRequest request)
public ListenableFuture<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.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteTagTemplateField(DeleteTagTemplateFieldRequest request)
public ListenableFuture<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.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<Empty> | |
getEntry(GetEntryRequest request)
public ListenableFuture<Entry> getEntry(GetEntryRequest request)
Parameter
Returns
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<Entry> | |
getEntryGroup(GetEntryGroupRequest request)
public ListenableFuture<EntryGroup> getEntryGroup(GetEntryGroupRequest request)
Parameter
Returns
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<EntryGroup> | |
getIamPolicy(GetIamPolicyRequest request)
public ListenableFuture<Policy> getIamPolicy(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.
| Name | Description |
| request | com.google.iam.v1.GetIamPolicyRequest
|
Returns
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> | |
getTagTemplate(GetTagTemplateRequest request)
public ListenableFuture<TagTemplate> getTagTemplate(GetTagTemplateRequest request)
Parameter
Returns
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<TagTemplate> | |
listEntries(ListEntriesRequest request)
public 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.
listEntryGroups(ListEntryGroupsRequest request)
public ListenableFuture<ListEntryGroupsResponse> listEntryGroups(ListEntryGroupsRequest request)
Parameter
Returns
public ListenableFuture<ListTagsResponse> listTags(ListTagsRequest request)
Lists tags assigned to an Entry.
The columns in the response are
lowercased.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<ListTagsResponse> | |
lookupEntry(LookupEntryRequest request)
public ListenableFuture<Entry> lookupEntry(LookupEntryRequest request)
Gets an entry by its target resource name.
The resource name comes from the source Google Cloud Platform service.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<Entry> | |
modifyEntryContacts(ModifyEntryContactsRequest request)
public ListenableFuture<Contacts> modifyEntryContacts(ModifyEntryContactsRequest request)
Modifies contacts, part of the business context of an
Entry.
To call this method, you must have the datacatalog.entries.updateContacts
IAM permission on the corresponding project.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<Contacts> | |
modifyEntryOverview(ModifyEntryOverviewRequest request)
public ListenableFuture<EntryOverview> modifyEntryOverview(ModifyEntryOverviewRequest request)
Modifies entry overview, part of the business context of an
Entry.
To call this method, you must have the datacatalog.entries.updateOverview
IAM permission on the corresponding project.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<EntryOverview> | |
public 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.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<TagTemplateField> | |
public ListenableFuture<TagTemplateField> renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request)
Renames an enum value in a tag template.
Within a single enum field, enum values must be unique.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<TagTemplateField> | |
searchCatalog(SearchCatalogRequest request)
public ListenableFuture<SearchCatalogResponse> searchCatalog(SearchCatalogRequest request)
Searches Data Catalog for multiple resources like entries and tags that
match a query.
This is a Custom Method 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.
setIamPolicy(SetIamPolicyRequest request)
public ListenableFuture<Policy> setIamPolicy(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.
| Name | Description |
| request | com.google.iam.v1.SetIamPolicyRequest
|
Returns
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> | |
starEntry(StarEntryRequest request)
public ListenableFuture<StarEntryResponse> starEntry(StarEntryRequest request)
Marks an Entry as starred by
the current user. Starring information is private to each user.
testIamPermissions(TestIamPermissionsRequest request)
public ListenableFuture<TestIamPermissionsResponse> testIamPermissions(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.
| Name | Description |
| request | com.google.iam.v1.TestIamPermissionsRequest
|
Returns
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse> | |
unstarEntry(UnstarEntryRequest request)
public ListenableFuture<UnstarEntryResponse> unstarEntry(UnstarEntryRequest request)
Marks an Entry as NOT starred by
the current user. Starring information is private to each user.
updateEntry(UpdateEntryRequest request)
public 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.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<Entry> | |
updateEntryGroup(UpdateEntryGroupRequest request)
public 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.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<EntryGroup> | |
updateTag(UpdateTagRequest request)
public ListenableFuture<Tag> updateTag(UpdateTagRequest request)
Parameter
Returns
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<Tag> | |
updateTagTemplate(UpdateTagTemplateRequest request)
public 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.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<TagTemplate> | |
updateTagTemplateField(UpdateTagTemplateFieldRequest request)
public 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.
| Type | Description |
| com.google.common.util.concurrent.ListenableFuture<TagTemplateField> | |
