Class DataCatalogGrpc.DataCatalogFutureStub (1.9.5)

public static final class DataCatalogGrpc.DataCatalogFutureStub extends AbstractFutureStub<DataCatalogGrpc.DataCatalogFutureStub>

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DataCatalogGrpc.DataCatalogFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected DataCatalogGrpc.DataCatalogFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
DataCatalogGrpc.DataCatalogFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createEntry(CreateEntryRequest request)

public ListenableFuture<Entry> createEntry(CreateEntryRequest request)

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 for more information). A maximum of 100,000 entries may be created per entry group.

Parameter
NameDescription
requestCreateEntryRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Entry>

createEntryGroup(CreateEntryGroupRequest request)

public ListenableFuture<EntryGroup> createEntryGroup(CreateEntryGroupRequest request)

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 for more information).

Parameter
NameDescription
requestCreateEntryGroupRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EntryGroup>

createTag(CreateTagRequest request)

public ListenableFuture<Tag> createTag(CreateTagRequest request)

Creates a tag on an Entry. Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be from the same organization.

Parameter
NameDescription
requestCreateTagRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Tag>

createTagTemplate(CreateTagTemplateRequest request)

public 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 for more information).

Parameter
NameDescription
requestCreateTagTemplateRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TagTemplate>

createTagTemplateField(CreateTagTemplateFieldRequest request)

public 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 for more information).

Parameter
NameDescription
requestCreateTagTemplateFieldRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TagTemplateField>

deleteEntry(DeleteEntryRequest request)

public ListenableFuture<Empty> deleteEntry(DeleteEntryRequest request)

Deletes an existing entry. Only entries created through 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 for more information).

Parameter
NameDescription
requestDeleteEntryRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteEntryGroup(DeleteEntryGroupRequest request)

public ListenableFuture<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 for more information).

Parameter
NameDescription
requestDeleteEntryGroupRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteTag(DeleteTagRequest request)

public ListenableFuture<Empty> deleteTag(DeleteTagRequest request)

Deletes a tag.

Parameter
NameDescription
requestDeleteTagRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteTagTemplate(DeleteTagTemplateRequest request)

public ListenableFuture<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 for more information).

Parameter
NameDescription
requestDeleteTagTemplateRequest
Returns
TypeDescription
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 that field. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameter
NameDescription
requestDeleteTagTemplateFieldRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

getEntry(GetEntryRequest request)

public ListenableFuture<Entry> getEntry(GetEntryRequest request)

Gets an entry.

Parameter
NameDescription
requestGetEntryRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Entry>

getEntryGroup(GetEntryGroupRequest request)

public ListenableFuture<EntryGroup> getEntryGroup(GetEntryGroupRequest request)

Gets an EntryGroup.

Parameter
NameDescription
requestGetEntryGroupRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EntryGroup>

getIamPolicy(GetIamPolicyRequest request)

public ListenableFuture<Policy> getIamPolicy(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.
Parameter
NameDescription
requestcom.google.iam.v1.GetIamPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>

getTagTemplate(GetTagTemplateRequest request)

public ListenableFuture<TagTemplate> getTagTemplate(GetTagTemplateRequest request)

Gets a tag template.

Parameter
NameDescription
requestGetTagTemplateRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TagTemplate>

listEntries(ListEntriesRequest request)

public ListenableFuture<ListEntriesResponse> listEntries(ListEntriesRequest request)

Lists entries.

Parameter
NameDescription
requestListEntriesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListEntriesResponse>

listEntryGroups(ListEntryGroupsRequest request)

public ListenableFuture<ListEntryGroupsResponse> listEntryGroups(ListEntryGroupsRequest request)

Lists entry groups.

Parameter
NameDescription
requestListEntryGroupsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListEntryGroupsResponse>

listTags(ListTagsRequest request)

public ListenableFuture<ListTagsResponse> listTags(ListTagsRequest request)

Lists the tags on an Entry.

Parameter
NameDescription
requestListTagsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListTagsResponse>

lookupEntry(LookupEntryRequest request)

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

Parameter
NameDescription
requestLookupEntryRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Entry>

renameTagTemplateField(RenameTagTemplateFieldRequest request)

public 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 for more information).

Parameter
NameDescription
requestRenameTagTemplateFieldRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TagTemplateField>

searchCatalog(SearchCatalogRequest request)

public 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 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 for more information.

Parameter
NameDescription
requestSearchCatalogRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<SearchCatalogResponse>

setIamPolicy(SetIamPolicyRequest request)

public ListenableFuture<Policy> setIamPolicy(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.
Parameter
NameDescription
requestcom.google.iam.v1.SetIamPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>

testIamPermissions(TestIamPermissionsRequest request)

public ListenableFuture<TestIamPermissionsResponse> testIamPermissions(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.
Parameter
NameDescription
requestcom.google.iam.v1.TestIamPermissionsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse>

updateEntry(UpdateEntryRequest request)

public 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 for more information).

Parameter
NameDescription
requestUpdateEntryRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Entry>

updateEntryGroup(UpdateEntryGroupRequest request)

public 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 for more information).

Parameter
NameDescription
requestUpdateEntryGroupRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EntryGroup>

updateTag(UpdateTagRequest request)

public ListenableFuture<Tag> updateTag(UpdateTagRequest request)

Updates an existing tag.

Parameter
NameDescription
requestUpdateTagRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Tag>

updateTagTemplate(UpdateTagTemplateRequest request)

public 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 for more information).

Parameter
NameDescription
requestUpdateTagTemplateRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TagTemplate>

updateTagTemplateField(UpdateTagTemplateFieldRequest request)

public 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 for more information).

Parameter
NameDescription
requestUpdateTagTemplateFieldRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TagTemplateField>