Cloud Dataplex v1 API - Class CatalogService.CatalogServiceBase (3.4.0)

[BindServiceMethod(typeof(CatalogService), "BindService")]
public abstract class CatalogService.CatalogServiceBase

Reference documentation and code samples for the Cloud Dataplex v1 API class CatalogService.CatalogServiceBase.

Base class for server-side implementations of CatalogService

Inheritance

object > CatalogService.CatalogServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Methods

CancelMetadataJob(CancelMetadataJobRequest, ServerCallContext)

public virtual Task<Empty> CancelMetadataJob(CancelMetadataJobRequest request, ServerCallContext context)

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` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

CreateAspectType(CreateAspectTypeRequest, ServerCallContext)

public virtual Task<Operation> CreateAspectType(CreateAspectTypeRequest request, ServerCallContext context)

Creates an AspectType.

Parameters
Name	Description
`request`	`CreateAspectTypeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateEntry(CreateEntryRequest, ServerCallContext)

public virtual Task<Entry> CreateEntry(CreateEntryRequest request, ServerCallContext context)

Creates an Entry.

Parameters
Name	Description
`request`	`CreateEntryRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEntry`	The response to send back to the client (wrapped by a task).

CreateEntryGroup(CreateEntryGroupRequest, ServerCallContext)

public virtual Task<Operation> CreateEntryGroup(CreateEntryGroupRequest request, ServerCallContext context)

Creates an EntryGroup.

Parameters
Name	Description
`request`	`CreateEntryGroupRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateEntryType(CreateEntryTypeRequest, ServerCallContext)

public virtual Task<Operation> CreateEntryType(CreateEntryTypeRequest request, ServerCallContext context)

Creates an EntryType.

Parameters
Name	Description
`request`	`CreateEntryTypeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateMetadataJob(CreateMetadataJobRequest, ServerCallContext)

public virtual Task<Operation> CreateMetadataJob(CreateMetadataJobRequest request, ServerCallContext context)

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` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteAspectType(DeleteAspectTypeRequest, ServerCallContext)

public virtual Task<Operation> DeleteAspectType(DeleteAspectTypeRequest request, ServerCallContext context)

Deletes an AspectType.

Parameters
Name	Description
`request`	`DeleteAspectTypeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteEntry(DeleteEntryRequest, ServerCallContext)

public virtual Task<Entry> DeleteEntry(DeleteEntryRequest request, ServerCallContext context)

Deletes an Entry.

Parameters
Name	Description
`request`	`DeleteEntryRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEntry`	The response to send back to the client (wrapped by a task).

DeleteEntryGroup(DeleteEntryGroupRequest, ServerCallContext)

public virtual Task<Operation> DeleteEntryGroup(DeleteEntryGroupRequest request, ServerCallContext context)

Deletes an EntryGroup.

Parameters
Name	Description
`request`	`DeleteEntryGroupRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteEntryType(DeleteEntryTypeRequest, ServerCallContext)

public virtual Task<Operation> DeleteEntryType(DeleteEntryTypeRequest request, ServerCallContext context)

Deletes an EntryType.

Parameters
Name	Description
`request`	`DeleteEntryTypeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

GetAspectType(GetAspectTypeRequest, ServerCallContext)

public virtual Task<AspectType> GetAspectType(GetAspectTypeRequest request, ServerCallContext context)

Gets an AspectType.

Parameters
Name	Description
`request`	`GetAspectTypeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskAspectType`	The response to send back to the client (wrapped by a task).

GetEntry(GetEntryRequest, ServerCallContext)

public virtual Task<Entry> GetEntry(GetEntryRequest request, ServerCallContext context)

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` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEntry`	The response to send back to the client (wrapped by a task).

GetEntryGroup(GetEntryGroupRequest, ServerCallContext)

public virtual Task<EntryGroup> GetEntryGroup(GetEntryGroupRequest request, ServerCallContext context)

Gets an EntryGroup.

Parameters
Name	Description
`request`	`GetEntryGroupRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEntryGroup`	The response to send back to the client (wrapped by a task).

GetEntryType(GetEntryTypeRequest, ServerCallContext)

public virtual Task<EntryType> GetEntryType(GetEntryTypeRequest request, ServerCallContext context)

Gets an EntryType.

Parameters
Name	Description
`request`	`GetEntryTypeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEntryType`	The response to send back to the client (wrapped by a task).

GetMetadataJob(GetMetadataJobRequest, ServerCallContext)

public virtual Task<MetadataJob> GetMetadataJob(GetMetadataJobRequest request, ServerCallContext context)

Gets a metadata job.

Parameters
Name	Description
`request`	`GetMetadataJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskMetadataJob`	The response to send back to the client (wrapped by a task).

ListAspectTypes(ListAspectTypesRequest, ServerCallContext)

public virtual Task<ListAspectTypesResponse> ListAspectTypes(ListAspectTypesRequest request, ServerCallContext context)

Lists AspectType resources in a project and location.

Parameters
Name	Description
`request`	`ListAspectTypesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListAspectTypesResponse`	The response to send back to the client (wrapped by a task).

ListEntries(ListEntriesRequest, ServerCallContext)

public virtual Task<ListEntriesResponse> ListEntries(ListEntriesRequest request, ServerCallContext context)

Lists Entries within an EntryGroup.

Parameters
Name	Description
`request`	`ListEntriesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListEntriesResponse`	The response to send back to the client (wrapped by a task).

ListEntryGroups(ListEntryGroupsRequest, ServerCallContext)

public virtual Task<ListEntryGroupsResponse> ListEntryGroups(ListEntryGroupsRequest request, ServerCallContext context)

Lists EntryGroup resources in a project and location.

Parameters
Name	Description
`request`	`ListEntryGroupsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListEntryGroupsResponse`	The response to send back to the client (wrapped by a task).

ListEntryTypes(ListEntryTypesRequest, ServerCallContext)

public virtual Task<ListEntryTypesResponse> ListEntryTypes(ListEntryTypesRequest request, ServerCallContext context)

Lists EntryType resources in a project and location.

Parameters
Name	Description
`request`	`ListEntryTypesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListEntryTypesResponse`	The response to send back to the client (wrapped by a task).

ListMetadataJobs(ListMetadataJobsRequest, ServerCallContext)

public virtual Task<ListMetadataJobsResponse> ListMetadataJobs(ListMetadataJobsRequest request, ServerCallContext context)

Lists metadata jobs.

Parameters
Name	Description
`request`	`ListMetadataJobsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListMetadataJobsResponse`	The response to send back to the client (wrapped by a task).

LookupEntry(LookupEntryRequest, ServerCallContext)

public virtual Task<Entry> LookupEntry(LookupEntryRequest request, ServerCallContext context)

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` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEntry`	The response to send back to the client (wrapped by a task).

SearchEntries(SearchEntriesRequest, ServerCallContext)

public virtual Task<SearchEntriesResponse> SearchEntries(SearchEntriesRequest request, ServerCallContext context)

Searches for Entries matching the given query and scope.

Parameters
Name	Description
`request`	`SearchEntriesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSearchEntriesResponse`	The response to send back to the client (wrapped by a task).

UpdateAspectType(UpdateAspectTypeRequest, ServerCallContext)

public virtual Task<Operation> UpdateAspectType(UpdateAspectTypeRequest request, ServerCallContext context)

Updates an AspectType.

Parameters
Name	Description
`request`	`UpdateAspectTypeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateEntry(UpdateEntryRequest, ServerCallContext)

public virtual Task<Entry> UpdateEntry(UpdateEntryRequest request, ServerCallContext context)

Updates an Entry.

Parameters
Name	Description
`request`	`UpdateEntryRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEntry`	The response to send back to the client (wrapped by a task).

UpdateEntryGroup(UpdateEntryGroupRequest, ServerCallContext)

public virtual Task<Operation> UpdateEntryGroup(UpdateEntryGroupRequest request, ServerCallContext context)

Updates an EntryGroup.

Parameters
Name	Description
`request`	`UpdateEntryGroupRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateEntryType(UpdateEntryTypeRequest, ServerCallContext)

public virtual Task<Operation> UpdateEntryType(UpdateEntryTypeRequest request, ServerCallContext context)

Updates an EntryType.

Parameters
Name	Description
`request`	`UpdateEntryTypeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).