Class CatalogServiceGrpc.CatalogServiceFutureStub (1.53.0)

public static final class CatalogServiceGrpc.CatalogServiceFutureStub extends AbstractFutureStub<CatalogServiceGrpc.CatalogServiceFutureStub>

A stub to allow clients to do ListenableFuture-style 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.AbstractFutureStub > CatalogServiceGrpc.CatalogServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

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

cancelMetadataJob(CancelMetadataJobRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Empty>

createAspectType(CreateAspectTypeRequest request)

public ListenableFuture<Operation> createAspectType(CreateAspectTypeRequest request)

Creates an AspectType.

Parameter
Name Description
request CreateAspectTypeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createEntry(CreateEntryRequest request)

public ListenableFuture<Entry> createEntry(CreateEntryRequest request)

Creates an Entry.

Parameter
Name Description
request CreateEntryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Entry>

createEntryGroup(CreateEntryGroupRequest request)

public ListenableFuture<Operation> createEntryGroup(CreateEntryGroupRequest request)

Creates an EntryGroup.

Parameter
Name Description
request CreateEntryGroupRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createEntryType(CreateEntryTypeRequest request)

public ListenableFuture<Operation> createEntryType(CreateEntryTypeRequest request)

Creates an EntryType.

Parameter
Name Description
request CreateEntryTypeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createMetadataJob(CreateMetadataJobRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteAspectType(DeleteAspectTypeRequest request)

public ListenableFuture<Operation> deleteAspectType(DeleteAspectTypeRequest request)

Deletes an AspectType.

Parameter
Name Description
request DeleteAspectTypeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteEntry(DeleteEntryRequest request)

public ListenableFuture<Entry> deleteEntry(DeleteEntryRequest request)

Deletes an Entry.

Parameter
Name Description
request DeleteEntryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Entry>

deleteEntryGroup(DeleteEntryGroupRequest request)

public ListenableFuture<Operation> deleteEntryGroup(DeleteEntryGroupRequest request)

Deletes an EntryGroup.

Parameter
Name Description
request DeleteEntryGroupRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteEntryType(DeleteEntryTypeRequest request)

public ListenableFuture<Operation> deleteEntryType(DeleteEntryTypeRequest request)

Deletes an EntryType.

Parameter
Name Description
request DeleteEntryTypeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

getAspectType(GetAspectTypeRequest request)

public ListenableFuture<AspectType> getAspectType(GetAspectTypeRequest request)

Gets an AspectType.

Parameter
Name Description
request GetAspectTypeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AspectType>

getEntry(GetEntryRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Entry>

getEntryGroup(GetEntryGroupRequest request)

public ListenableFuture<EntryGroup> getEntryGroup(GetEntryGroupRequest request)

Gets an EntryGroup.

Parameter
Name Description
request GetEntryGroupRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EntryGroup>

getEntryType(GetEntryTypeRequest request)

public ListenableFuture<EntryType> getEntryType(GetEntryTypeRequest request)

Gets an EntryType.

Parameter
Name Description
request GetEntryTypeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EntryType>

getMetadataJob(GetMetadataJobRequest request)

public ListenableFuture<MetadataJob> getMetadataJob(GetMetadataJobRequest request)

Gets a metadata job.

Parameter
Name Description
request GetMetadataJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<MetadataJob>

listAspectTypes(ListAspectTypesRequest request)

public ListenableFuture<ListAspectTypesResponse> listAspectTypes(ListAspectTypesRequest request)

Lists AspectType resources in a project and location.

Parameter
Name Description
request ListAspectTypesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListAspectTypesResponse>

listEntries(ListEntriesRequest request)

public ListenableFuture<ListEntriesResponse> listEntries(ListEntriesRequest request)

Lists Entries within an EntryGroup.

Parameter
Name Description
request ListEntriesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEntriesResponse>

listEntryGroups(ListEntryGroupsRequest request)

public ListenableFuture<ListEntryGroupsResponse> listEntryGroups(ListEntryGroupsRequest request)

Lists EntryGroup resources in a project and location.

Parameter
Name Description
request ListEntryGroupsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEntryGroupsResponse>

listEntryTypes(ListEntryTypesRequest request)

public ListenableFuture<ListEntryTypesResponse> listEntryTypes(ListEntryTypesRequest request)

Lists EntryType resources in a project and location.

Parameter
Name Description
request ListEntryTypesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEntryTypesResponse>

listMetadataJobs(ListMetadataJobsRequest request)

public ListenableFuture<ListMetadataJobsResponse> listMetadataJobs(ListMetadataJobsRequest request)

Lists metadata jobs.

Parameter
Name Description
request ListMetadataJobsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListMetadataJobsResponse>

lookupEntry(LookupEntryRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Entry>

searchEntries(SearchEntriesRequest request)

public ListenableFuture<SearchEntriesResponse> searchEntries(SearchEntriesRequest request)

Searches for Entries matching the given query and scope.

Parameter
Name Description
request SearchEntriesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SearchEntriesResponse>

updateAspectType(UpdateAspectTypeRequest request)

public ListenableFuture<Operation> updateAspectType(UpdateAspectTypeRequest request)

Updates an AspectType.

Parameter
Name Description
request UpdateAspectTypeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateEntry(UpdateEntryRequest request)

public ListenableFuture<Entry> updateEntry(UpdateEntryRequest request)

Updates an Entry.

Parameter
Name Description
request UpdateEntryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Entry>

updateEntryGroup(UpdateEntryGroupRequest request)

public ListenableFuture<Operation> updateEntryGroup(UpdateEntryGroupRequest request)

Updates an EntryGroup.

Parameter
Name Description
request UpdateEntryGroupRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateEntryType(UpdateEntryTypeRequest request)

public ListenableFuture<Operation> updateEntryType(UpdateEntryTypeRequest request)

Updates an EntryType.

Parameter
Name Description
request UpdateEntryTypeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>