Class CatalogServiceGrpc.CatalogServiceBlockingV2Stub (1.78.0)

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

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

The primary resources offered by this service are EntryGroups, EntryTypes, AspectTypes, Entries and EntryLinks. 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.CatalogServiceBlockingV2Stub

Methods

build(Channel channel, CallOptions callOptions)

protected CatalogServiceGrpc.CatalogServiceBlockingV2Stub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
CatalogServiceGrpc.CatalogServiceBlockingV2Stub
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
Exceptions
Type Description
io.grpc.StatusException

createAspectType(CreateAspectTypeRequest request)

public Operation createAspectType(CreateAspectTypeRequest request)

Creates an AspectType.

Parameter
Name Description
request CreateAspectTypeRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

createEntry(CreateEntryRequest request)

public Entry createEntry(CreateEntryRequest request)

Creates an Entry.

Parameter
Name Description
request CreateEntryRequest
Returns
Type Description
Entry
Exceptions
Type Description
io.grpc.StatusException

createEntryGroup(CreateEntryGroupRequest request)

public Operation createEntryGroup(CreateEntryGroupRequest request)

Creates an EntryGroup.

Parameter
Name Description
request CreateEntryGroupRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException
public EntryLink createEntryLink(CreateEntryLinkRequest request)

Creates an Entry Link.

Parameter
Name Description
request CreateEntryLinkRequest
Returns
Type Description
EntryLink
Exceptions
Type Description
io.grpc.StatusException

createEntryType(CreateEntryTypeRequest request)

public Operation createEntryType(CreateEntryTypeRequest request)

Creates an EntryType.

Parameter
Name Description
request CreateEntryTypeRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

createMetadataJob(CreateMetadataJobRequest request)

public Operation createMetadataJob(CreateMetadataJobRequest request)

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

Parameter
Name Description
request CreateMetadataJobRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteAspectType(DeleteAspectTypeRequest request)

public Operation deleteAspectType(DeleteAspectTypeRequest request)

Deletes an AspectType.

Parameter
Name Description
request DeleteAspectTypeRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteEntry(DeleteEntryRequest request)

public Entry deleteEntry(DeleteEntryRequest request)

Deletes an Entry.

Parameter
Name Description
request DeleteEntryRequest
Returns
Type Description
Entry
Exceptions
Type Description
io.grpc.StatusException

deleteEntryGroup(DeleteEntryGroupRequest request)

public Operation deleteEntryGroup(DeleteEntryGroupRequest request)

Deletes an EntryGroup.

Parameter
Name Description
request DeleteEntryGroupRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException
public EntryLink deleteEntryLink(DeleteEntryLinkRequest request)

Deletes an Entry Link.

Parameter
Name Description
request DeleteEntryLinkRequest
Returns
Type Description
EntryLink
Exceptions
Type Description
io.grpc.StatusException

deleteEntryType(DeleteEntryTypeRequest request)

public Operation deleteEntryType(DeleteEntryTypeRequest request)

Deletes an EntryType.

Parameter
Name Description
request DeleteEntryTypeRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

getAspectType(GetAspectTypeRequest request)

public AspectType getAspectType(GetAspectTypeRequest request)

Gets an AspectType.

Parameter
Name Description
request GetAspectTypeRequest
Returns
Type Description
AspectType
Exceptions
Type Description
io.grpc.StatusException

getEntry(GetEntryRequest request)

public Entry getEntry(GetEntryRequest request)

Gets an Entry. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog.

Parameter
Name Description
request GetEntryRequest
Returns
Type Description
Entry
Exceptions
Type Description
io.grpc.StatusException

getEntryGroup(GetEntryGroupRequest request)

public EntryGroup getEntryGroup(GetEntryGroupRequest request)

Gets an EntryGroup.

Parameter
Name Description
request GetEntryGroupRequest
Returns
Type Description
EntryGroup
Exceptions
Type Description
io.grpc.StatusException
public EntryLink getEntryLink(GetEntryLinkRequest request)

Gets an Entry Link.

Parameter
Name Description
request GetEntryLinkRequest
Returns
Type Description
EntryLink
Exceptions
Type Description
io.grpc.StatusException

getEntryType(GetEntryTypeRequest request)

public EntryType getEntryType(GetEntryTypeRequest request)

Gets an EntryType.

Parameter
Name Description
request GetEntryTypeRequest
Returns
Type Description
EntryType
Exceptions
Type Description
io.grpc.StatusException

getMetadataJob(GetMetadataJobRequest request)

public MetadataJob getMetadataJob(GetMetadataJobRequest request)

Gets a metadata job.

Parameter
Name Description
request GetMetadataJobRequest
Returns
Type Description
MetadataJob
Exceptions
Type Description
io.grpc.StatusException

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
Exceptions
Type Description
io.grpc.StatusException

listEntries(ListEntriesRequest request)

public ListEntriesResponse listEntries(ListEntriesRequest request)

Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog.

Parameter
Name Description
request ListEntriesRequest
Returns
Type Description
ListEntriesResponse
Exceptions
Type Description
io.grpc.StatusException

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
Exceptions
Type Description
io.grpc.StatusException

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
Exceptions
Type Description
io.grpc.StatusException

listMetadataJobs(ListMetadataJobsRequest request)

public ListMetadataJobsResponse listMetadataJobs(ListMetadataJobsRequest request)

Lists metadata jobs.

Parameter
Name Description
request ListMetadataJobsRequest
Returns
Type Description
ListMetadataJobsResponse
Exceptions
Type Description
io.grpc.StatusException

lookupEntry(LookupEntryRequest request)

public Entry lookupEntry(LookupEntryRequest request)

Looks up an entry by name using the permission on the source system. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog.

Parameter
Name Description
request LookupEntryRequest
Returns
Type Description
Entry
Exceptions
Type Description
io.grpc.StatusException

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
Exceptions
Type Description
io.grpc.StatusException

updateAspectType(UpdateAspectTypeRequest request)

public Operation updateAspectType(UpdateAspectTypeRequest request)

Updates an AspectType.

Parameter
Name Description
request UpdateAspectTypeRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateEntry(UpdateEntryRequest request)

public Entry updateEntry(UpdateEntryRequest request)

Updates an Entry.

Parameter
Name Description
request UpdateEntryRequest
Returns
Type Description
Entry
Exceptions
Type Description
io.grpc.StatusException

updateEntryGroup(UpdateEntryGroupRequest request)

public Operation updateEntryGroup(UpdateEntryGroupRequest request)

Updates an EntryGroup.

Parameter
Name Description
request UpdateEntryGroupRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateEntryType(UpdateEntryTypeRequest request)

public Operation updateEntryType(UpdateEntryTypeRequest request)

Updates an EntryType.

Parameter
Name Description
request UpdateEntryTypeRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException