public static interface CatalogServiceGrpc.AsyncServiceThe 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.
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> |
createEntryLink(CreateEntryLinkRequest request, StreamObserver<EntryLink> responseObserver)
public default void createEntryLink(CreateEntryLinkRequest request, StreamObserver<EntryLink> responseObserver)Creates an Entry Link.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateEntryLinkRequest |
responseObserver |
io.grpc.stub.StreamObserver<EntryLink> |
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> |
createMetadataFeed(CreateMetadataFeedRequest request, StreamObserver<Operation> responseObserver)
public default void createMetadataFeed(CreateMetadataFeedRequest request, StreamObserver<Operation> responseObserver)Creates a MetadataFeed.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateMetadataFeedRequest |
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 metadata from a third-party system into Dataplex Universal Catalog.
| 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> |
deleteEntryLink(DeleteEntryLinkRequest request, StreamObserver<EntryLink> responseObserver)
public default void deleteEntryLink(DeleteEntryLinkRequest request, StreamObserver<EntryLink> responseObserver)Deletes an Entry Link.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteEntryLinkRequest |
responseObserver |
io.grpc.stub.StreamObserver<EntryLink> |
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> |
deleteMetadataFeed(DeleteMetadataFeedRequest request, StreamObserver<Operation> responseObserver)
public default void deleteMetadataFeed(DeleteMetadataFeedRequest request, StreamObserver<Operation> responseObserver)Deletes a MetadataFeed.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteMetadataFeedRequest |
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.
| 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> |
getEntryLink(GetEntryLinkRequest request, StreamObserver<EntryLink> responseObserver)
public default void getEntryLink(GetEntryLinkRequest request, StreamObserver<EntryLink> responseObserver)Gets an Entry Link.
| Parameters | |
|---|---|
| Name | Description |
request |
GetEntryLinkRequest |
responseObserver |
io.grpc.stub.StreamObserver<EntryLink> |
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> |
getMetadataFeed(GetMetadataFeedRequest request, StreamObserver<MetadataFeed> responseObserver)
public default void getMetadataFeed(GetMetadataFeedRequest request, StreamObserver<MetadataFeed> responseObserver)Gets a MetadataFeed.
| Parameters | |
|---|---|
| Name | Description |
request |
GetMetadataFeedRequest |
responseObserver |
io.grpc.stub.StreamObserver<MetadataFeed> |
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> |
listMetadataFeeds(ListMetadataFeedsRequest request, StreamObserver<ListMetadataFeedsResponse> responseObserver)
public default void listMetadataFeeds(ListMetadataFeedsRequest request, StreamObserver<ListMetadataFeedsResponse> responseObserver)Retrieve a list of MetadataFeeds.
| Parameters | |
|---|---|
| Name | Description |
request |
ListMetadataFeedsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListMetadataFeedsResponse> |
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> |
lookupContext(LookupContextRequest request, StreamObserver<LookupContextResponse> responseObserver)
public default void lookupContext(LookupContextRequest request, StreamObserver<LookupContextResponse> responseObserver)Looks up LLM Context for the specified resources.
| Parameters | |
|---|---|
| Name | Description |
request |
LookupContextRequest |
responseObserver |
io.grpc.stub.StreamObserver<LookupContextResponse> |
lookupEntry(LookupEntryRequest request, StreamObserver<Entry> responseObserver)
public default void lookupEntry(LookupEntryRequest request, StreamObserver<Entry> responseObserver)Looks up an entry by name using the permission on the source system.
| Parameters | |
|---|---|
| Name | Description |
request |
LookupEntryRequest |
responseObserver |
io.grpc.stub.StreamObserver<Entry> |
lookupEntryLinks(LookupEntryLinksRequest request, StreamObserver<LookupEntryLinksResponse> responseObserver)
public default void lookupEntryLinks(LookupEntryLinksRequest request, StreamObserver<LookupEntryLinksResponse> responseObserver)Looks up Entry Links referencing the specified Entry.
| Parameters | |
|---|---|
| Name | Description |
request |
LookupEntryLinksRequest |
responseObserver |
io.grpc.stub.StreamObserver<LookupEntryLinksResponse> |
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> |
updateEntryLink(UpdateEntryLinkRequest request, StreamObserver<EntryLink> responseObserver)
public default void updateEntryLink(UpdateEntryLinkRequest request, StreamObserver<EntryLink> responseObserver)Updates an Entry Link.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateEntryLinkRequest |
responseObserver |
io.grpc.stub.StreamObserver<EntryLink> |
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> |
updateMetadataFeed(UpdateMetadataFeedRequest request, StreamObserver<Operation> responseObserver)
public default void updateMetadataFeed(UpdateMetadataFeedRequest request, StreamObserver<Operation> responseObserver)Updates a MetadataFeed.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateMetadataFeedRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |