Class DataCatalogGrpc.DataCatalogBlockingStub (1.59.0)

public static final class DataCatalogGrpc.DataCatalogBlockingStub extends AbstractBlockingStub<DataCatalogGrpc.DataCatalogBlockingStub>

A stub to allow clients to do synchronous rpc calls to service DataCatalog.

Data Catalog API service allows you to discover, understand, and manage your data.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > DataCatalogGrpc.DataCatalogBlockingStub

Inherited Members

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractBlockingStub.<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.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected DataCatalogGrpc.DataCatalogBlockingStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`DataCatalogGrpc.DataCatalogBlockingStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createEntry(CreateEntryRequest request)

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

Parameter
Name	Description
`request`	`CreateEntryRequest`

Returns
Type	Description
`Entry`

createEntryGroup(CreateEntryGroupRequest request)

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

Parameter
Name	Description
`request`	`CreateEntryGroupRequest`

Returns
Type	Description
`EntryGroup`

createTag(CreateTagRequest request)

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

Parameter
Name	Description
`request`	`CreateTagRequest`

Returns
Type	Description
`Tag`

createTagTemplate(CreateTagTemplateRequest request)

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

Parameter
Name	Description
`request`	`CreateTagTemplateRequest`

Returns
Type	Description
`TagTemplate`

createTagTemplateField(CreateTagTemplateFieldRequest request)

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

Parameter
Name	Description
`request`	`CreateTagTemplateFieldRequest`

Returns
Type	Description
`TagTemplateField`

deleteEntry(DeleteEntryRequest request)

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

Parameter
Name	Description
`request`	`DeleteEntryRequest`

Returns
Type	Description
`Empty`

deleteEntryGroup(DeleteEntryGroupRequest request)

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

Parameter
Name	Description
`request`	`DeleteEntryGroupRequest`

Returns
Type	Description
`Empty`

deleteTag(DeleteTagRequest request)

public Empty deleteTag(DeleteTagRequest request)

Deletes a tag.

Parameter
Name	Description
`request`	`DeleteTagRequest`

Returns
Type	Description
`Empty`

deleteTagTemplate(DeleteTagTemplateRequest request)

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

Parameter
Name	Description
`request`	`DeleteTagTemplateRequest`

Returns
Type	Description
`Empty`

deleteTagTemplateField(DeleteTagTemplateFieldRequest request)

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

Parameter
Name	Description
`request`	`DeleteTagTemplateFieldRequest`

Returns
Type	Description
`Empty`

getEntry(GetEntryRequest request)

public Entry getEntry(GetEntryRequest request)

Gets an entry.

Parameter
Name	Description
`request`	`GetEntryRequest`

Returns
Type	Description
`Entry`

getEntryGroup(GetEntryGroupRequest request)

public EntryGroup getEntryGroup(GetEntryGroupRequest request)

Gets an entry group.

Parameter
Name	Description
`request`	`GetEntryGroupRequest`

Returns
Type	Description
`EntryGroup`

getIamPolicy(GetIamPolicyRequest request)

public Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. May return:

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

Parameter
Name	Description
`request`	`com.google.iam.v1.GetIamPolicyRequest`

Returns
Type	Description
`com.google.iam.v1.Policy`

getTagTemplate(GetTagTemplateRequest request)

public TagTemplate getTagTemplate(GetTagTemplateRequest request)

Gets a tag template.

Parameter
Name	Description
`request`	`GetTagTemplateRequest`

Returns
Type	Description
`TagTemplate`

importEntries(ImportEntriesRequest request)

public 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 type. ImportEntries returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message.

Parameter
Name	Description
`request`	`ImportEntriesRequest`

Returns
Type	Description
`Operation`

listEntries(ListEntriesRequest request)

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

Parameter
Name	Description
`request`	`ListEntriesRequest`

Returns
Type	Description
`ListEntriesResponse`

listEntryGroups(ListEntryGroupsRequest request)

public ListEntryGroupsResponse listEntryGroups(ListEntryGroupsRequest request)

Lists entry groups.

Parameter
Name	Description
`request`	`ListEntryGroupsRequest`

Returns
Type	Description
`ListEntryGroupsResponse`

listTags(ListTagsRequest request)

public ListTagsResponse listTags(ListTagsRequest request)

Lists tags assigned to an Entry. The columns in the response are lowercased.

Parameter
Name	Description
`request`	`ListTagsRequest`

Returns
Type	Description
`ListTagsResponse`

lookupEntry(LookupEntryRequest request)

public Entry lookupEntry(LookupEntryRequest request)

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

Parameter
Name	Description
`request`	`LookupEntryRequest`

Returns
Type	Description
`Entry`

modifyEntryContacts(ModifyEntryContactsRequest request)

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

Parameter
Name	Description
`request`	`ModifyEntryContactsRequest`

Returns
Type	Description
`Contacts`

modifyEntryOverview(ModifyEntryOverviewRequest request)

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

Parameter
Name	Description
`request`	`ModifyEntryOverviewRequest`

Returns
Type	Description
`EntryOverview`

reconcileTags(ReconcileTagsRequest request)

public Operation reconcileTags(ReconcileTagsRequest request)

ReconcileTags creates or updates a list of tags on the entry. If the 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 to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.

Parameter
Name	Description
`request`	`ReconcileTagsRequest`

Returns
Type	Description
`Operation`

renameTagTemplateField(RenameTagTemplateFieldRequest request)

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

Parameter
Name	Description
`request`	`RenameTagTemplateFieldRequest`

Returns
Type	Description
`TagTemplateField`

renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request)

public TagTemplateField renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request)

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

Parameter
Name	Description
`request`	`RenameTagTemplateFieldEnumValueRequest`

Returns
Type	Description
`TagTemplateField`

searchCatalog(SearchCatalogRequest request)

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

Parameter
Name	Description
`request`	`SearchCatalogRequest`

Returns
Type	Description
`SearchCatalogResponse`

setIamPolicy(SetIamPolicyRequest request)

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

Parameter
Name	Description
`request`	`com.google.iam.v1.SetIamPolicyRequest`

Returns
Type	Description
`com.google.iam.v1.Policy`

starEntry(StarEntryRequest request)

public StarEntryResponse starEntry(StarEntryRequest request)

Marks an Entry as starred by the current user. Starring information is private to each user.

Parameter
Name	Description
`request`	`StarEntryRequest`

Returns
Type	Description
`StarEntryResponse`

testIamPermissions(TestIamPermissionsRequest request)

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

Parameter
Name	Description
`request`	`com.google.iam.v1.TestIamPermissionsRequest`

Returns
Type	Description
`com.google.iam.v1.TestIamPermissionsResponse`

unstarEntry(UnstarEntryRequest request)

public UnstarEntryResponse unstarEntry(UnstarEntryRequest request)

Marks an Entry as NOT starred by the current user. Starring information is private to each user.

Parameter
Name	Description
`request`	`UnstarEntryRequest`

Returns
Type	Description
`UnstarEntryResponse`

updateEntry(UpdateEntryRequest request)

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

Parameter
Name	Description
`request`	`UpdateEntryRequest`

Returns
Type	Description
`Entry`

updateEntryGroup(UpdateEntryGroupRequest request)

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

Parameter
Name	Description
`request`	`UpdateEntryGroupRequest`

Returns
Type	Description
`EntryGroup`

updateTag(UpdateTagRequest request)

public Tag updateTag(UpdateTagRequest request)

Updates an existing tag.

Parameter
Name	Description
`request`	`UpdateTagRequest`

Returns
Type	Description
`Tag`

updateTagTemplate(UpdateTagTemplateRequest request)

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

Parameter
Name	Description
`request`	`UpdateTagTemplateRequest`

Returns
Type	Description
`TagTemplate`

updateTagTemplateField(UpdateTagTemplateFieldRequest request)

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

Parameter
Name	Description
`request`	`UpdateTagTemplateFieldRequest`

Returns
Type	Description
`TagTemplateField`