Class DataCatalogGrpc.DataCatalogBlockingStub (1.10.0)

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

Data Catalog API service allows clients to discover, understand, and manage their 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.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. 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

Name	Description
request	`CreateEntryRequest`

Returns

Type	Description
Entry

createEntryGroup(CreateEntryGroupRequest request)

public 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

Name	Description
request	`CreateEntryGroupRequest`

Returns

Type	Description
EntryGroup

createTag(CreateTagRequest request)

public 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

Name	Description
request	`CreateTagRequest`

Returns

Type	Description
Tag

createTagTemplate(CreateTagTemplateRequest request)

public 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

Name	Description
request	`CreateTagTemplateRequest`

Returns

Type	Description
TagTemplate

createTagTemplateField(CreateTagTemplateFieldRequest request)

public 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

Name	Description
request	`CreateTagTemplateFieldRequest`

Returns

Type	Description
TagTemplateField

deleteEntry(DeleteEntryRequest request)

public 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

Name	Description
request	`DeleteEntryRequest`

Returns

Type	Description
Empty

deleteEntryGroup(DeleteEntryGroupRequest request)

public 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

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

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

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

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

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

listEntries(ListEntriesRequest request)

public ListEntriesResponse listEntries(ListEntriesRequest request)

Lists entries.

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 the tags on an Entry.

Parameter

Name	Description
request	`ListTagsRequest`

Returns

Type	Description
ListTagsResponse

lookupEntry(LookupEntryRequest request)

public 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

Name	Description
request	`LookupEntryRequest`

Returns

Type	Description
Entry

renameTagTemplateField(RenameTagTemplateFieldRequest request)

public 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

Name	Description
request	`RenameTagTemplateFieldRequest`

Returns

Type	Description
TagTemplateField

searchCatalog(SearchCatalogRequest request)

public 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

Name	Description
request	`SearchCatalogRequest`

Returns

Type	Description
SearchCatalogResponse

setIamPolicy(SetIamPolicyRequest request)

public 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

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

Returns

Type	Description
com.google.iam.v1.Policy

testIamPermissions(TestIamPermissionsRequest request)

public 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

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

Returns

Type	Description
com.google.iam.v1.TestIamPermissionsResponse

updateEntry(UpdateEntryRequest request)

public 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

Name	Description
request	`UpdateEntryRequest`

Returns

Type	Description
Entry

updateEntryGroup(UpdateEntryGroupRequest request)

public 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

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

Name	Description
request	`UpdateTagTemplateRequest`

Returns

Type	Description
TagTemplate

updateTagTemplateField(UpdateTagTemplateFieldRequest request)

public 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

Name	Description
request	`UpdateTagTemplateFieldRequest`

Returns

Type	Description
TagTemplateField