Class DataCatalogGrpc.DataCatalogStub (1.20.0)

public static final class DataCatalogGrpc.DataCatalogStub extends AbstractAsyncStub<DataCatalogGrpc.DataCatalogStub>

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

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > DataCatalogGrpc.DataCatalogStub

Inherited Members

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

io.grpc.stub.AbstractAsyncStub.<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()

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.DataCatalogStub build(Channel channel, CallOptions callOptions)

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

Returns
Type	Description
`DataCatalogGrpc.DataCatalogStub`

Overrides

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

createEntry(CreateEntryRequest request, StreamObserver<Entry> responseObserver)

public void createEntry(CreateEntryRequest request, StreamObserver<Entry> responseObserver)

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.

Parameters
Name	Description
`request`	`CreateEntryRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Entry>`

createEntryGroup(CreateEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

public void createEntryGroup(CreateEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

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

Parameters
Name	Description
`request`	`CreateEntryGroupRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<EntryGroup>`

createTag(CreateTagRequest request, StreamObserver<Tag> responseObserver)

public void createTag(CreateTagRequest request, StreamObserver<Tag> responseObserver)

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.

Parameters
Name	Description
`request`	`CreateTagRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Tag>`

createTagTemplate(CreateTagTemplateRequest request, StreamObserver<TagTemplate> responseObserver)

public void createTagTemplate(CreateTagTemplateRequest request, StreamObserver<TagTemplate> responseObserver)

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

Parameters
Name	Description
`request`	`CreateTagTemplateRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<TagTemplate>`

createTagTemplateField(CreateTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

public void createTagTemplateField(CreateTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

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

Parameters
Name	Description
`request`	`CreateTagTemplateFieldRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<TagTemplateField>`

deleteEntry(DeleteEntryRequest request, StreamObserver<Empty> responseObserver)

public void deleteEntry(DeleteEntryRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name	Description
`request`	`DeleteEntryRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

deleteEntryGroup(DeleteEntryGroupRequest request, StreamObserver<Empty> responseObserver)

public void deleteEntryGroup(DeleteEntryGroupRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name	Description
`request`	`DeleteEntryGroupRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

deleteTag(DeleteTagRequest request, StreamObserver<Empty> responseObserver)

public void deleteTag(DeleteTagRequest request, StreamObserver<Empty> responseObserver)

Deletes a tag.

Parameters
Name	Description
`request`	`DeleteTagRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

deleteTagTemplate(DeleteTagTemplateRequest request, StreamObserver<Empty> responseObserver)

public void deleteTagTemplate(DeleteTagTemplateRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name	Description
`request`	`DeleteTagTemplateRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

deleteTagTemplateField(DeleteTagTemplateFieldRequest request, StreamObserver<Empty> responseObserver)

public void deleteTagTemplateField(DeleteTagTemplateFieldRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name	Description
`request`	`DeleteTagTemplateFieldRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

getEntry(GetEntryRequest request, StreamObserver<Entry> responseObserver)

public void getEntry(GetEntryRequest request, StreamObserver<Entry> responseObserver)

Gets an entry.

Parameters
Name	Description
`request`	`GetEntryRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Entry>`

getEntryGroup(GetEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

public void getEntryGroup(GetEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

Gets an EntryGroup.

Parameters
Name	Description
`request`	`GetEntryGroupRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<EntryGroup>`

getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public void getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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.

Parameters
Name	Description
`request`	`com.google.iam.v1.GetIamPolicyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>`

getTagTemplate(GetTagTemplateRequest request, StreamObserver<TagTemplate> responseObserver)

public void getTagTemplate(GetTagTemplateRequest request, StreamObserver<TagTemplate> responseObserver)

Gets a tag template.

Parameters
Name	Description
`request`	`GetTagTemplateRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<TagTemplate>`

listEntries(ListEntriesRequest request, StreamObserver<ListEntriesResponse> responseObserver)

public void listEntries(ListEntriesRequest request, StreamObserver<ListEntriesResponse> responseObserver)

Lists entries.

Parameters
Name	Description
`request`	`ListEntriesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListEntriesResponse>`

listEntryGroups(ListEntryGroupsRequest request, StreamObserver<ListEntryGroupsResponse> responseObserver)

public void listEntryGroups(ListEntryGroupsRequest request, StreamObserver<ListEntryGroupsResponse> responseObserver)

Lists entry groups.

Parameters
Name	Description
`request`	`ListEntryGroupsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListEntryGroupsResponse>`

listTags(ListTagsRequest request, StreamObserver<ListTagsResponse> responseObserver)

public void listTags(ListTagsRequest request, StreamObserver<ListTagsResponse> responseObserver)

Lists the tags on an Entry.

Parameters
Name	Description
`request`	`ListTagsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListTagsResponse>`

lookupEntry(LookupEntryRequest request, StreamObserver<Entry> responseObserver)

public void lookupEntry(LookupEntryRequest request, StreamObserver<Entry> responseObserver)

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.

Parameters
Name	Description
`request`	`LookupEntryRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Entry>`

renameTagTemplateField(RenameTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

public void renameTagTemplateField(RenameTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

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

Parameters
Name	Description
`request`	`RenameTagTemplateFieldRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<TagTemplateField>`

searchCatalog(SearchCatalogRequest request, StreamObserver<SearchCatalogResponse> responseObserver)

public void searchCatalog(SearchCatalogRequest request, StreamObserver<SearchCatalogResponse> responseObserver)

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.

Parameters
Name	Description
`request`	`SearchCatalogRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<SearchCatalogResponse>`

setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public void setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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.

Parameters
Name	Description
`request`	`com.google.iam.v1.SetIamPolicyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>`

testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

public void testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

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.

Parameters
Name	Description
`request`	`com.google.iam.v1.TestIamPermissionsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse>`

updateEntry(UpdateEntryRequest request, StreamObserver<Entry> responseObserver)

public void updateEntry(UpdateEntryRequest request, StreamObserver<Entry> responseObserver)

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

Parameters
Name	Description
`request`	`UpdateEntryRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Entry>`

updateEntryGroup(UpdateEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

public void updateEntryGroup(UpdateEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

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

Parameters
Name	Description
`request`	`UpdateEntryGroupRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<EntryGroup>`

updateTag(UpdateTagRequest request, StreamObserver<Tag> responseObserver)

public void updateTag(UpdateTagRequest request, StreamObserver<Tag> responseObserver)

Updates an existing tag.

Parameters
Name	Description
`request`	`UpdateTagRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Tag>`

updateTagTemplate(UpdateTagTemplateRequest request, StreamObserver<TagTemplate> responseObserver)

public void updateTagTemplate(UpdateTagTemplateRequest request, StreamObserver<TagTemplate> responseObserver)

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

Parameters
Name	Description
`request`	`UpdateTagTemplateRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<TagTemplate>`

updateTagTemplateField(UpdateTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

public void updateTagTemplateField(UpdateTagTemplateFieldRequest request, StreamObserver<TagTemplateField> responseObserver)

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

Parameters
Name	Description
`request`	`UpdateTagTemplateFieldRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<TagTemplateField>`