Class CatalogServiceGrpc.CatalogServiceBlockingStub (1.53.0)

public static final class CatalogServiceGrpc.CatalogServiceBlockingStub extends AbstractBlockingStub<CatalogServiceGrpc.CatalogServiceBlockingStub>

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

The primary resources offered by this service are EntryGroups, EntryTypes, AspectTypes, and Entries. They collectively let data administrators organize, manage, secure, and catalog data located across cloud projects in their organization in a variety of storage systems, including Cloud Storage and BigQuery.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > CatalogServiceGrpc.CatalogServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected CatalogServiceGrpc.CatalogServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
CatalogServiceGrpc.CatalogServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelMetadataJob(CancelMetadataJobRequest request)

public Empty cancelMetadataJob(CancelMetadataJobRequest request)

Cancels a metadata job. If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.

Parameter
Name Description
request CancelMetadataJobRequest
Returns
Type Description
Empty

createAspectType(CreateAspectTypeRequest request)

public Operation createAspectType(CreateAspectTypeRequest request)

Creates an AspectType.

Parameter
Name Description
request CreateAspectTypeRequest
Returns
Type Description
Operation

createEntry(CreateEntryRequest request)

public Entry createEntry(CreateEntryRequest request)

Creates an Entry.

Parameter
Name Description
request CreateEntryRequest
Returns
Type Description
Entry

createEntryGroup(CreateEntryGroupRequest request)

public Operation createEntryGroup(CreateEntryGroupRequest request)

Creates an EntryGroup.

Parameter
Name Description
request CreateEntryGroupRequest
Returns
Type Description
Operation

createEntryType(CreateEntryTypeRequest request)

public Operation createEntryType(CreateEntryTypeRequest request)

Creates an EntryType.

Parameter
Name Description
request CreateEntryTypeRequest
Returns
Type Description
Operation

createMetadataJob(CreateMetadataJobRequest request)

public Operation createMetadataJob(CreateMetadataJobRequest request)

Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.

Parameter
Name Description
request CreateMetadataJobRequest
Returns
Type Description
Operation

deleteAspectType(DeleteAspectTypeRequest request)

public Operation deleteAspectType(DeleteAspectTypeRequest request)

Deletes an AspectType.

Parameter
Name Description
request DeleteAspectTypeRequest
Returns
Type Description
Operation

deleteEntry(DeleteEntryRequest request)

public Entry deleteEntry(DeleteEntryRequest request)

Deletes an Entry.

Parameter
Name Description
request DeleteEntryRequest
Returns
Type Description
Entry

deleteEntryGroup(DeleteEntryGroupRequest request)

public Operation deleteEntryGroup(DeleteEntryGroupRequest request)

Deletes an EntryGroup.

Parameter
Name Description
request DeleteEntryGroupRequest
Returns
Type Description
Operation

deleteEntryType(DeleteEntryTypeRequest request)

public Operation deleteEntryType(DeleteEntryTypeRequest request)

Deletes an EntryType.

Parameter
Name Description
request DeleteEntryTypeRequest
Returns
Type Description
Operation

getAspectType(GetAspectTypeRequest request)

public AspectType getAspectType(GetAspectTypeRequest request)

Gets an AspectType.

Parameter
Name Description
request GetAspectTypeRequest
Returns
Type Description
AspectType

getEntry(GetEntryRequest request)

public Entry getEntry(GetEntryRequest request)

Gets an Entry. Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog.

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

getEntryType(GetEntryTypeRequest request)

public EntryType getEntryType(GetEntryTypeRequest request)

Gets an EntryType.

Parameter
Name Description
request GetEntryTypeRequest
Returns
Type Description
EntryType

getMetadataJob(GetMetadataJobRequest request)

public MetadataJob getMetadataJob(GetMetadataJobRequest request)

Gets a metadata job.

Parameter
Name Description
request GetMetadataJobRequest
Returns
Type Description
MetadataJob

listAspectTypes(ListAspectTypesRequest request)

public ListAspectTypesResponse listAspectTypes(ListAspectTypesRequest request)

Lists AspectType resources in a project and location.

Parameter
Name Description
request ListAspectTypesRequest
Returns
Type Description
ListAspectTypesResponse

listEntries(ListEntriesRequest request)

public ListEntriesResponse listEntries(ListEntriesRequest request)

Lists Entries within an EntryGroup.

Parameter
Name Description
request ListEntriesRequest
Returns
Type Description
ListEntriesResponse

listEntryGroups(ListEntryGroupsRequest request)

public ListEntryGroupsResponse listEntryGroups(ListEntryGroupsRequest request)

Lists EntryGroup resources in a project and location.

Parameter
Name Description
request ListEntryGroupsRequest
Returns
Type Description
ListEntryGroupsResponse

listEntryTypes(ListEntryTypesRequest request)

public ListEntryTypesResponse listEntryTypes(ListEntryTypesRequest request)

Lists EntryType resources in a project and location.

Parameter
Name Description
request ListEntryTypesRequest
Returns
Type Description
ListEntryTypesResponse

listMetadataJobs(ListMetadataJobsRequest request)

public ListMetadataJobsResponse listMetadataJobs(ListMetadataJobsRequest request)

Lists metadata jobs.

Parameter
Name Description
request ListMetadataJobsRequest
Returns
Type Description
ListMetadataJobsResponse

lookupEntry(LookupEntryRequest request)

public Entry lookupEntry(LookupEntryRequest request)

Looks up a single Entry by name using the permission on the source system. Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog.

Parameter
Name Description
request LookupEntryRequest
Returns
Type Description
Entry

searchEntries(SearchEntriesRequest request)

public SearchEntriesResponse searchEntries(SearchEntriesRequest request)

Searches for Entries matching the given query and scope.

Parameter
Name Description
request SearchEntriesRequest
Returns
Type Description
SearchEntriesResponse

updateAspectType(UpdateAspectTypeRequest request)

public Operation updateAspectType(UpdateAspectTypeRequest request)

Updates an AspectType.

Parameter
Name Description
request UpdateAspectTypeRequest
Returns
Type Description
Operation

updateEntry(UpdateEntryRequest request)

public Entry updateEntry(UpdateEntryRequest request)

Updates an Entry.

Parameter
Name Description
request UpdateEntryRequest
Returns
Type Description
Entry

updateEntryGroup(UpdateEntryGroupRequest request)

public Operation updateEntryGroup(UpdateEntryGroupRequest request)

Updates an EntryGroup.

Parameter
Name Description
request UpdateEntryGroupRequest
Returns
Type Description
Operation

updateEntryType(UpdateEntryTypeRequest request)

public Operation updateEntryType(UpdateEntryTypeRequest request)

Updates an EntryType.

Parameter
Name Description
request UpdateEntryTypeRequest
Returns
Type Description
Operation