Cloud Dataplex v1 API - Class CatalogServiceClientImpl (3.12.0) 

public sealed class CatalogServiceClientImpl : CatalogServiceClient

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

CatalogService client wrapper implementation, for convenient use.

Inheritance

object > CatalogServiceClient > CatalogServiceClientImpl

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Remarks

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.

Constructors

CatalogServiceClientImpl(CatalogServiceClient, CatalogServiceSettings, ILogger)

public CatalogServiceClientImpl(CatalogService.CatalogServiceClient grpcClient, CatalogServiceSettings settings, ILogger logger)

Constructs a client wrapper for the CatalogService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient CatalogServiceCatalogServiceClient

The underlying gRPC client.
settings CatalogServiceSettings

The base CatalogServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateAspectTypeOperationsClient

public override OperationsClient CreateAspectTypeOperationsClient { get; }

The long-running operations client for CreateAspectType.

Property Value
Type Description
OperationsClient
Overrides

CreateEntryGroupOperationsClient

public override OperationsClient CreateEntryGroupOperationsClient { get; }

The long-running operations client for CreateEntryGroup.

Property Value
Type Description
OperationsClient
Overrides

CreateEntryTypeOperationsClient

public override OperationsClient CreateEntryTypeOperationsClient { get; }

The long-running operations client for CreateEntryType.

Property Value
Type Description
OperationsClient
Overrides

CreateMetadataJobOperationsClient

public override OperationsClient CreateMetadataJobOperationsClient { get; }

The long-running operations client for CreateMetadataJob.

Property Value
Type Description
OperationsClient
Overrides

DeleteAspectTypeOperationsClient

public override OperationsClient DeleteAspectTypeOperationsClient { get; }

The long-running operations client for DeleteAspectType.

Property Value
Type Description
OperationsClient
Overrides

DeleteEntryGroupOperationsClient

public override OperationsClient DeleteEntryGroupOperationsClient { get; }

The long-running operations client for DeleteEntryGroup.

Property Value
Type Description
OperationsClient
Overrides

DeleteEntryTypeOperationsClient

public override OperationsClient DeleteEntryTypeOperationsClient { get; }

The long-running operations client for DeleteEntryType.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override CatalogService.CatalogServiceClient GrpcClient { get; }

The underlying gRPC CatalogService client

Property Value
Type Description
CatalogServiceCatalogServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateAspectTypeOperationsClient

public override OperationsClient UpdateAspectTypeOperationsClient { get; }

The long-running operations client for UpdateAspectType.

Property Value
Type Description
OperationsClient
Overrides

UpdateEntryGroupOperationsClient

public override OperationsClient UpdateEntryGroupOperationsClient { get; }

The long-running operations client for UpdateEntryGroup.

Property Value
Type Description
OperationsClient
Overrides

UpdateEntryTypeOperationsClient

public override OperationsClient UpdateEntryTypeOperationsClient { get; }

The long-running operations client for UpdateEntryType.

Property Value
Type Description
OperationsClient
Overrides

Methods

CancelMetadataJob(CancelMetadataJobRequest, CallSettings)

public override void CancelMetadataJob(CancelMetadataJobRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

CancelMetadataJobAsync(CancelMetadataJobRequest, CallSettings)

public override Task CancelMetadataJobAsync(CancelMetadataJobRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

CreateAspectType(CreateAspectTypeRequest, CallSettings)

public override Operation<AspectType, OperationMetadata> CreateAspectType(CreateAspectTypeRequest request, CallSettings callSettings = null)

Creates an AspectType.

Parameters
Name Description
request CreateAspectTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAspectTypeOperationMetadata

The RPC response.
Overrides

CreateAspectTypeAsync(CreateAspectTypeRequest, CallSettings)

public override Task<Operation<AspectType, OperationMetadata>> CreateAspectTypeAsync(CreateAspectTypeRequest request, CallSettings callSettings = null)

Creates an AspectType.

Parameters
Name Description
request CreateAspectTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAspectTypeOperationMetadata

A Task containing the RPC response.
Overrides

CreateEntry(CreateEntryRequest, CallSettings)

public override Entry CreateEntry(CreateEntryRequest request, CallSettings callSettings = null)

Creates an Entry.

Parameters
Name Description
request CreateEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Entry

The RPC response.
Overrides

CreateEntryAsync(CreateEntryRequest, CallSettings)

public override Task<Entry> CreateEntryAsync(CreateEntryRequest request, CallSettings callSettings = null)

Creates an Entry.

Parameters
Name Description
request CreateEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEntry

A Task containing the RPC response.
Overrides

CreateEntryGroup(CreateEntryGroupRequest, CallSettings)

public override Operation<EntryGroup, OperationMetadata> CreateEntryGroup(CreateEntryGroupRequest request, CallSettings callSettings = null)

Creates an EntryGroup.

Parameters
Name Description
request CreateEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEntryGroupOperationMetadata

The RPC response.
Overrides

CreateEntryGroupAsync(CreateEntryGroupRequest, CallSettings)

public override Task<Operation<EntryGroup, OperationMetadata>> CreateEntryGroupAsync(CreateEntryGroupRequest request, CallSettings callSettings = null)

Creates an EntryGroup.

Parameters
Name Description
request CreateEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEntryGroupOperationMetadata

A Task containing the RPC response.
Overrides

CreateEntryLink(CreateEntryLinkRequest, CallSettings)

public override EntryLink CreateEntryLink(CreateEntryLinkRequest request, CallSettings callSettings = null)

Creates an Entry Link.

Parameters
Name Description
request CreateEntryLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
EntryLink

The RPC response.
Overrides

CreateEntryLinkAsync(CreateEntryLinkRequest, CallSettings)

public override Task<EntryLink> CreateEntryLinkAsync(CreateEntryLinkRequest request, CallSettings callSettings = null)

Creates an Entry Link.

Parameters
Name Description
request CreateEntryLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEntryLink

A Task containing the RPC response.
Overrides

CreateEntryType(CreateEntryTypeRequest, CallSettings)

public override Operation<EntryType, OperationMetadata> CreateEntryType(CreateEntryTypeRequest request, CallSettings callSettings = null)

Creates an EntryType.

Parameters
Name Description
request CreateEntryTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEntryTypeOperationMetadata

The RPC response.
Overrides

CreateEntryTypeAsync(CreateEntryTypeRequest, CallSettings)

public override Task<Operation<EntryType, OperationMetadata>> CreateEntryTypeAsync(CreateEntryTypeRequest request, CallSettings callSettings = null)

Creates an EntryType.

Parameters
Name Description
request CreateEntryTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEntryTypeOperationMetadata

A Task containing the RPC response.
Overrides

CreateMetadataJob(CreateMetadataJobRequest, CallSettings)

public override Operation<MetadataJob, OperationMetadata> CreateMetadataJob(CreateMetadataJobRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationMetadataJobOperationMetadata

The RPC response.
Overrides

CreateMetadataJobAsync(CreateMetadataJobRequest, CallSettings)

public override Task<Operation<MetadataJob, OperationMetadata>> CreateMetadataJobAsync(CreateMetadataJobRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationMetadataJobOperationMetadata

A Task containing the RPC response.
Overrides

DeleteAspectType(DeleteAspectTypeRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteAspectType(DeleteAspectTypeRequest request, CallSettings callSettings = null)

Deletes an AspectType.

Parameters
Name Description
request DeleteAspectTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteAspectTypeAsync(DeleteAspectTypeRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteAspectTypeAsync(DeleteAspectTypeRequest request, CallSettings callSettings = null)

Deletes an AspectType.

Parameters
Name Description
request DeleteAspectTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteEntry(DeleteEntryRequest, CallSettings)

public override Entry DeleteEntry(DeleteEntryRequest request, CallSettings callSettings = null)

Deletes an Entry.

Parameters
Name Description
request DeleteEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Entry

The RPC response.
Overrides

DeleteEntryAsync(DeleteEntryRequest, CallSettings)

public override Task<Entry> DeleteEntryAsync(DeleteEntryRequest request, CallSettings callSettings = null)

Deletes an Entry.

Parameters
Name Description
request DeleteEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEntry

A Task containing the RPC response.
Overrides

DeleteEntryGroup(DeleteEntryGroupRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteEntryGroup(DeleteEntryGroupRequest request, CallSettings callSettings = null)

Deletes an EntryGroup.

Parameters
Name Description
request DeleteEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteEntryGroupAsync(DeleteEntryGroupRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteEntryGroupAsync(DeleteEntryGroupRequest request, CallSettings callSettings = null)

Deletes an EntryGroup.

Parameters
Name Description
request DeleteEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteEntryLink(DeleteEntryLinkRequest, CallSettings)

public override EntryLink DeleteEntryLink(DeleteEntryLinkRequest request, CallSettings callSettings = null)

Deletes an Entry Link.

Parameters
Name Description
request DeleteEntryLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
EntryLink

The RPC response.
Overrides

DeleteEntryLinkAsync(DeleteEntryLinkRequest, CallSettings)

public override Task<EntryLink> DeleteEntryLinkAsync(DeleteEntryLinkRequest request, CallSettings callSettings = null)

Deletes an Entry Link.

Parameters
Name Description
request DeleteEntryLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEntryLink

A Task containing the RPC response.
Overrides

DeleteEntryType(DeleteEntryTypeRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteEntryType(DeleteEntryTypeRequest request, CallSettings callSettings = null)

Deletes an EntryType.

Parameters
Name Description
request DeleteEntryTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteEntryTypeAsync(DeleteEntryTypeRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteEntryTypeAsync(DeleteEntryTypeRequest request, CallSettings callSettings = null)

Deletes an EntryType.

Parameters
Name Description
request DeleteEntryTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

GetAspectType(GetAspectTypeRequest, CallSettings)

public override AspectType GetAspectType(GetAspectTypeRequest request, CallSettings callSettings = null)

Gets an AspectType.

Parameters
Name Description
request GetAspectTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AspectType

The RPC response.
Overrides

GetAspectTypeAsync(GetAspectTypeRequest, CallSettings)

public override Task<AspectType> GetAspectTypeAsync(GetAspectTypeRequest request, CallSettings callSettings = null)

Gets an AspectType.

Parameters
Name Description
request GetAspectTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAspectType

A Task containing the RPC response.
Overrides

GetEntry(GetEntryRequest, CallSettings)

public override Entry GetEntry(GetEntryRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request GetEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Entry

The RPC response.
Overrides

GetEntryAsync(GetEntryRequest, CallSettings)

public override Task<Entry> GetEntryAsync(GetEntryRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request GetEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEntry

A Task containing the RPC response.
Overrides

GetEntryGroup(GetEntryGroupRequest, CallSettings)

public override EntryGroup GetEntryGroup(GetEntryGroupRequest request, CallSettings callSettings = null)

Gets an EntryGroup.

Parameters
Name Description
request GetEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
EntryGroup

The RPC response.
Overrides

GetEntryGroupAsync(GetEntryGroupRequest, CallSettings)

public override Task<EntryGroup> GetEntryGroupAsync(GetEntryGroupRequest request, CallSettings callSettings = null)

Gets an EntryGroup.

Parameters
Name Description
request GetEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEntryGroup

A Task containing the RPC response.
Overrides

GetEntryLink(GetEntryLinkRequest, CallSettings)

public override EntryLink GetEntryLink(GetEntryLinkRequest request, CallSettings callSettings = null)

Gets an Entry Link.

Parameters
Name Description
request GetEntryLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
EntryLink

The RPC response.
Overrides

GetEntryLinkAsync(GetEntryLinkRequest, CallSettings)

public override Task<EntryLink> GetEntryLinkAsync(GetEntryLinkRequest request, CallSettings callSettings = null)

Gets an Entry Link.

Parameters
Name Description
request GetEntryLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEntryLink

A Task containing the RPC response.
Overrides

GetEntryType(GetEntryTypeRequest, CallSettings)

public override EntryType GetEntryType(GetEntryTypeRequest request, CallSettings callSettings = null)

Gets an EntryType.

Parameters
Name Description
request GetEntryTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
EntryType

The RPC response.
Overrides

GetEntryTypeAsync(GetEntryTypeRequest, CallSettings)

public override Task<EntryType> GetEntryTypeAsync(GetEntryTypeRequest request, CallSettings callSettings = null)

Gets an EntryType.

Parameters
Name Description
request GetEntryTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEntryType

A Task containing the RPC response.
Overrides

GetMetadataJob(GetMetadataJobRequest, CallSettings)

public override MetadataJob GetMetadataJob(GetMetadataJobRequest request, CallSettings callSettings = null)

Gets a metadata job.

Parameters
Name Description
request GetMetadataJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
MetadataJob

The RPC response.
Overrides

GetMetadataJobAsync(GetMetadataJobRequest, CallSettings)

public override Task<MetadataJob> GetMetadataJobAsync(GetMetadataJobRequest request, CallSettings callSettings = null)

Gets a metadata job.

Parameters
Name Description
request GetMetadataJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskMetadataJob

A Task containing the RPC response.
Overrides

ListAspectTypes(ListAspectTypesRequest, CallSettings)

public override PagedEnumerable<ListAspectTypesResponse, AspectType> ListAspectTypes(ListAspectTypesRequest request, CallSettings callSettings = null)

Lists AspectType resources in a project and location.

Parameters
Name Description
request ListAspectTypesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListAspectTypesResponseAspectType

A pageable sequence of AspectType resources.
Overrides

ListAspectTypesAsync(ListAspectTypesRequest, CallSettings)

public override PagedAsyncEnumerable<ListAspectTypesResponse, AspectType> ListAspectTypesAsync(ListAspectTypesRequest request, CallSettings callSettings = null)

Lists AspectType resources in a project and location.

Parameters
Name Description
request ListAspectTypesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListAspectTypesResponseAspectType

A pageable asynchronous sequence of AspectType resources.
Overrides

ListEntries(ListEntriesRequest, CallSettings)

public override PagedEnumerable<ListEntriesResponse, Entry> ListEntries(ListEntriesRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request ListEntriesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListEntriesResponseEntry

A pageable sequence of Entry resources.
Overrides

ListEntriesAsync(ListEntriesRequest, CallSettings)

public override PagedAsyncEnumerable<ListEntriesResponse, Entry> ListEntriesAsync(ListEntriesRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request ListEntriesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListEntriesResponseEntry

A pageable asynchronous sequence of Entry resources.
Overrides

ListEntryGroups(ListEntryGroupsRequest, CallSettings)

public override PagedEnumerable<ListEntryGroupsResponse, EntryGroup> ListEntryGroups(ListEntryGroupsRequest request, CallSettings callSettings = null)

Lists EntryGroup resources in a project and location.

Parameters
Name Description
request ListEntryGroupsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListEntryGroupsResponseEntryGroup

A pageable sequence of EntryGroup resources.
Overrides

ListEntryGroupsAsync(ListEntryGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<ListEntryGroupsResponse, EntryGroup> ListEntryGroupsAsync(ListEntryGroupsRequest request, CallSettings callSettings = null)

Lists EntryGroup resources in a project and location.

Parameters
Name Description
request ListEntryGroupsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListEntryGroupsResponseEntryGroup

A pageable asynchronous sequence of EntryGroup resources.
Overrides

ListEntryTypes(ListEntryTypesRequest, CallSettings)

public override PagedEnumerable<ListEntryTypesResponse, EntryType> ListEntryTypes(ListEntryTypesRequest request, CallSettings callSettings = null)

Lists EntryType resources in a project and location.

Parameters
Name Description
request ListEntryTypesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListEntryTypesResponseEntryType

A pageable sequence of EntryType resources.
Overrides

ListEntryTypesAsync(ListEntryTypesRequest, CallSettings)

public override PagedAsyncEnumerable<ListEntryTypesResponse, EntryType> ListEntryTypesAsync(ListEntryTypesRequest request, CallSettings callSettings = null)

Lists EntryType resources in a project and location.

Parameters
Name Description
request ListEntryTypesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListEntryTypesResponseEntryType

A pageable asynchronous sequence of EntryType resources.
Overrides

ListMetadataJobs(ListMetadataJobsRequest, CallSettings)

public override PagedEnumerable<ListMetadataJobsResponse, MetadataJob> ListMetadataJobs(ListMetadataJobsRequest request, CallSettings callSettings = null)

Lists metadata jobs.

Parameters
Name Description
request ListMetadataJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListMetadataJobsResponseMetadataJob

A pageable sequence of MetadataJob resources.
Overrides

ListMetadataJobsAsync(ListMetadataJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListMetadataJobsResponse, MetadataJob> ListMetadataJobsAsync(ListMetadataJobsRequest request, CallSettings callSettings = null)

Lists metadata jobs.

Parameters
Name Description
request ListMetadataJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListMetadataJobsResponseMetadataJob

A pageable asynchronous sequence of MetadataJob resources.
Overrides

LookupEntry(LookupEntryRequest, CallSettings)

public override Entry LookupEntry(LookupEntryRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request LookupEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Entry

The RPC response.
Overrides

LookupEntryAsync(LookupEntryRequest, CallSettings)

public override Task<Entry> LookupEntryAsync(LookupEntryRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request LookupEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEntry

A Task containing the RPC response.
Overrides

SearchEntries(SearchEntriesRequest, CallSettings)

public override PagedEnumerable<SearchEntriesResponse, SearchEntriesResult> SearchEntries(SearchEntriesRequest request, CallSettings callSettings = null)

Searches for Entries matching the given query and scope.

Parameters
Name Description
request SearchEntriesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSearchEntriesResponseSearchEntriesResult

A pageable sequence of SearchEntriesResult resources.
Overrides

SearchEntriesAsync(SearchEntriesRequest, CallSettings)

public override PagedAsyncEnumerable<SearchEntriesResponse, SearchEntriesResult> SearchEntriesAsync(SearchEntriesRequest request, CallSettings callSettings = null)

Searches for Entries matching the given query and scope.

Parameters
Name Description
request SearchEntriesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSearchEntriesResponseSearchEntriesResult

A pageable asynchronous sequence of SearchEntriesResult resources.
Overrides

UpdateAspectType(UpdateAspectTypeRequest, CallSettings)

public override Operation<AspectType, OperationMetadata> UpdateAspectType(UpdateAspectTypeRequest request, CallSettings callSettings = null)

Updates an AspectType.

Parameters
Name Description
request UpdateAspectTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAspectTypeOperationMetadata

The RPC response.
Overrides

UpdateAspectTypeAsync(UpdateAspectTypeRequest, CallSettings)

public override Task<Operation<AspectType, OperationMetadata>> UpdateAspectTypeAsync(UpdateAspectTypeRequest request, CallSettings callSettings = null)

Updates an AspectType.

Parameters
Name Description
request UpdateAspectTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAspectTypeOperationMetadata

A Task containing the RPC response.
Overrides

UpdateEntry(UpdateEntryRequest, CallSettings)

public override Entry UpdateEntry(UpdateEntryRequest request, CallSettings callSettings = null)

Updates an Entry.

Parameters
Name Description
request UpdateEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Entry

The RPC response.
Overrides

UpdateEntryAsync(UpdateEntryRequest, CallSettings)

public override Task<Entry> UpdateEntryAsync(UpdateEntryRequest request, CallSettings callSettings = null)

Updates an Entry.

Parameters
Name Description
request UpdateEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEntry

A Task containing the RPC response.
Overrides

UpdateEntryGroup(UpdateEntryGroupRequest, CallSettings)

public override Operation<EntryGroup, OperationMetadata> UpdateEntryGroup(UpdateEntryGroupRequest request, CallSettings callSettings = null)

Updates an EntryGroup.

Parameters
Name Description
request UpdateEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEntryGroupOperationMetadata

The RPC response.
Overrides

UpdateEntryGroupAsync(UpdateEntryGroupRequest, CallSettings)

public override Task<Operation<EntryGroup, OperationMetadata>> UpdateEntryGroupAsync(UpdateEntryGroupRequest request, CallSettings callSettings = null)

Updates an EntryGroup.

Parameters
Name Description
request UpdateEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEntryGroupOperationMetadata

A Task containing the RPC response.
Overrides

UpdateEntryType(UpdateEntryTypeRequest, CallSettings)

public override Operation<EntryType, OperationMetadata> UpdateEntryType(UpdateEntryTypeRequest request, CallSettings callSettings = null)

Updates an EntryType.

Parameters
Name Description
request UpdateEntryTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEntryTypeOperationMetadata

The RPC response.
Overrides

UpdateEntryTypeAsync(UpdateEntryTypeRequest, CallSettings)

public override Task<Operation<EntryType, OperationMetadata>> UpdateEntryTypeAsync(UpdateEntryTypeRequest request, CallSettings callSettings = null)

Updates an EntryType.

Parameters
Name Description
request UpdateEntryTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEntryTypeOperationMetadata

A Task containing the RPC response.
Overrides