Interface CatalogServiceGrpc.AsyncService (1.52.0)

public static interface CatalogServiceGrpc.AsyncService

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.

Methods

cancelMetadataJob(CancelMetadataJobRequest request, StreamObserver<Empty> responseObserver)

public default void cancelMetadataJob(CancelMetadataJobRequest request, StreamObserver<Empty> responseObserver)

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.

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

createAspectType(CreateAspectTypeRequest request, StreamObserver<Operation> responseObserver)

public default void createAspectType(CreateAspectTypeRequest request, StreamObserver<Operation> responseObserver)

Creates an AspectType.

Parameters
Name Description
request CreateAspectTypeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createEntry(CreateEntryRequest request, StreamObserver<Entry> responseObserver)

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

Creates an Entry.

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

createEntryGroup(CreateEntryGroupRequest request, StreamObserver<Operation> responseObserver)

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

Creates an EntryGroup.

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

createEntryType(CreateEntryTypeRequest request, StreamObserver<Operation> responseObserver)

public default void createEntryType(CreateEntryTypeRequest request, StreamObserver<Operation> responseObserver)

Creates an EntryType.

Parameters
Name Description
request CreateEntryTypeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createMetadataJob(CreateMetadataJobRequest request, StreamObserver<Operation> responseObserver)

public default void createMetadataJob(CreateMetadataJobRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request CreateMetadataJobRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteAspectType(DeleteAspectTypeRequest request, StreamObserver<Operation> responseObserver)

public default void deleteAspectType(DeleteAspectTypeRequest request, StreamObserver<Operation> responseObserver)

Deletes an AspectType.

Parameters
Name Description
request DeleteAspectTypeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteEntry(DeleteEntryRequest request, StreamObserver<Entry> responseObserver)

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

Deletes an Entry.

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

deleteEntryGroup(DeleteEntryGroupRequest request, StreamObserver<Operation> responseObserver)

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

Deletes an EntryGroup.

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

deleteEntryType(DeleteEntryTypeRequest request, StreamObserver<Operation> responseObserver)

public default void deleteEntryType(DeleteEntryTypeRequest request, StreamObserver<Operation> responseObserver)

Deletes an EntryType.

Parameters
Name Description
request DeleteEntryTypeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getAspectType(GetAspectTypeRequest request, StreamObserver<AspectType> responseObserver)

public default void getAspectType(GetAspectTypeRequest request, StreamObserver<AspectType> responseObserver)

Gets an AspectType.

Parameters
Name Description
request GetAspectTypeRequest
responseObserver io.grpc.stub.StreamObserver<AspectType>

getEntry(GetEntryRequest request, StreamObserver<Entry> responseObserver)

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

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.

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

getEntryGroup(GetEntryGroupRequest request, StreamObserver<EntryGroup> responseObserver)

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

Gets an EntryGroup.

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

getEntryType(GetEntryTypeRequest request, StreamObserver<EntryType> responseObserver)

public default void getEntryType(GetEntryTypeRequest request, StreamObserver<EntryType> responseObserver)

Gets an EntryType.

Parameters
Name Description
request GetEntryTypeRequest
responseObserver io.grpc.stub.StreamObserver<EntryType>

getMetadataJob(GetMetadataJobRequest request, StreamObserver<MetadataJob> responseObserver)

public default void getMetadataJob(GetMetadataJobRequest request, StreamObserver<MetadataJob> responseObserver)

Gets a metadata job.

Parameters
Name Description
request GetMetadataJobRequest
responseObserver io.grpc.stub.StreamObserver<MetadataJob>

listAspectTypes(ListAspectTypesRequest request, StreamObserver<ListAspectTypesResponse> responseObserver)

public default void listAspectTypes(ListAspectTypesRequest request, StreamObserver<ListAspectTypesResponse> responseObserver)

Lists AspectType resources in a project and location.

Parameters
Name Description
request ListAspectTypesRequest
responseObserver io.grpc.stub.StreamObserver<ListAspectTypesResponse>

listEntries(ListEntriesRequest request, StreamObserver<ListEntriesResponse> responseObserver)

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

Lists Entries within an EntryGroup.

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

listEntryGroups(ListEntryGroupsRequest request, StreamObserver<ListEntryGroupsResponse> responseObserver)

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

Lists EntryGroup resources in a project and location.

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

listEntryTypes(ListEntryTypesRequest request, StreamObserver<ListEntryTypesResponse> responseObserver)

public default void listEntryTypes(ListEntryTypesRequest request, StreamObserver<ListEntryTypesResponse> responseObserver)

Lists EntryType resources in a project and location.

Parameters
Name Description
request ListEntryTypesRequest
responseObserver io.grpc.stub.StreamObserver<ListEntryTypesResponse>

listMetadataJobs(ListMetadataJobsRequest request, StreamObserver<ListMetadataJobsResponse> responseObserver)

public default void listMetadataJobs(ListMetadataJobsRequest request, StreamObserver<ListMetadataJobsResponse> responseObserver)

Lists metadata jobs.

Parameters
Name Description
request ListMetadataJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListMetadataJobsResponse>

lookupEntry(LookupEntryRequest request, StreamObserver<Entry> responseObserver)

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

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.

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

searchEntries(SearchEntriesRequest request, StreamObserver<SearchEntriesResponse> responseObserver)

public default void searchEntries(SearchEntriesRequest request, StreamObserver<SearchEntriesResponse> responseObserver)

Searches for Entries matching the given query and scope.

Parameters
Name Description
request SearchEntriesRequest
responseObserver io.grpc.stub.StreamObserver<SearchEntriesResponse>

updateAspectType(UpdateAspectTypeRequest request, StreamObserver<Operation> responseObserver)

public default void updateAspectType(UpdateAspectTypeRequest request, StreamObserver<Operation> responseObserver)

Updates an AspectType.

Parameters
Name Description
request UpdateAspectTypeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateEntry(UpdateEntryRequest request, StreamObserver<Entry> responseObserver)

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

Updates an Entry.

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

updateEntryGroup(UpdateEntryGroupRequest request, StreamObserver<Operation> responseObserver)

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

Updates an EntryGroup.

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

updateEntryType(UpdateEntryTypeRequest request, StreamObserver<Operation> responseObserver)

public default void updateEntryType(UpdateEntryTypeRequest request, StreamObserver<Operation> responseObserver)

Updates an EntryType.

Parameters
Name Description
request UpdateEntryTypeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>