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

public class CatalogService.CatalogServiceClient : ClientBase<CatalogService.CatalogServiceClient>

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

Client for CatalogService

Inheritance

object > ClientBase > ClientBaseCatalogServiceCatalogServiceClient > CatalogService.CatalogServiceClient

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

CatalogServiceClient()

protected CatalogServiceClient()

Protected parameterless constructor to allow creation of test doubles.

CatalogServiceClient(CallInvoker)

public CatalogServiceClient(CallInvoker callInvoker)

Creates a new client for CatalogService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

CatalogServiceClient(ChannelBase)

public CatalogServiceClient(ChannelBase channel)

Creates a new client for CatalogService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

CatalogServiceClient(ClientBaseConfiguration)

protected CatalogServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CancelMetadataJob(CancelMetadataJobRequest, CallOptions)

public virtual Empty CancelMetadataJob(CancelMetadataJobRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

CancelMetadataJob(CancelMetadataJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty CancelMetadataJob(CancelMetadataJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

CancelMetadataJobAsync(CancelMetadataJobRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> CancelMetadataJobAsync(CancelMetadataJobRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

CancelMetadataJobAsync(CancelMetadataJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> CancelMetadataJobAsync(CancelMetadataJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

CreateAspectType(CreateAspectTypeRequest, CallOptions)

public virtual Operation CreateAspectType(CreateAspectTypeRequest request, CallOptions options)

Creates an AspectType.

Parameters
Name Description
request CreateAspectTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateAspectType(CreateAspectTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateAspectType(CreateAspectTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an AspectType.

Parameters
Name Description
request CreateAspectTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateAspectTypeAsync(CreateAspectTypeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateAspectTypeAsync(CreateAspectTypeRequest request, CallOptions options)

Creates an AspectType.

Parameters
Name Description
request CreateAspectTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateAspectTypeAsync(CreateAspectTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateAspectTypeAsync(CreateAspectTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an AspectType.

Parameters
Name Description
request CreateAspectTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateEntry(CreateEntryRequest, CallOptions)

public virtual Entry CreateEntry(CreateEntryRequest request, CallOptions options)

Creates an Entry.

Parameters
Name Description
request CreateEntryRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Entry

The response received from the server.

CreateEntry(CreateEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual Entry CreateEntry(CreateEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an Entry.

Parameters
Name Description
request CreateEntryRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Entry

The response received from the server.

CreateEntryAsync(CreateEntryRequest, CallOptions)

public virtual AsyncUnaryCall<Entry> CreateEntryAsync(CreateEntryRequest request, CallOptions options)

Creates an Entry.

Parameters
Name Description
request CreateEntryRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEntry

The call object.

CreateEntryAsync(CreateEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Entry> CreateEntryAsync(CreateEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an Entry.

Parameters
Name Description
request CreateEntryRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEntry

The call object.

CreateEntryGroup(CreateEntryGroupRequest, CallOptions)

public virtual Operation CreateEntryGroup(CreateEntryGroupRequest request, CallOptions options)

Creates an EntryGroup.

Parameters
Name Description
request CreateEntryGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateEntryGroup(CreateEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateEntryGroup(CreateEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an EntryGroup.

Parameters
Name Description
request CreateEntryGroupRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateEntryGroupAsync(CreateEntryGroupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateEntryGroupAsync(CreateEntryGroupRequest request, CallOptions options)

Creates an EntryGroup.

Parameters
Name Description
request CreateEntryGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateEntryGroupAsync(CreateEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateEntryGroupAsync(CreateEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an EntryGroup.

Parameters
Name Description
request CreateEntryGroupRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateEntryType(CreateEntryTypeRequest, CallOptions)

public virtual Operation CreateEntryType(CreateEntryTypeRequest request, CallOptions options)

Creates an EntryType.

Parameters
Name Description
request CreateEntryTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateEntryType(CreateEntryTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateEntryType(CreateEntryTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an EntryType.

Parameters
Name Description
request CreateEntryTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateEntryTypeAsync(CreateEntryTypeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateEntryTypeAsync(CreateEntryTypeRequest request, CallOptions options)

Creates an EntryType.

Parameters
Name Description
request CreateEntryTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateEntryTypeAsync(CreateEntryTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateEntryTypeAsync(CreateEntryTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an EntryType.

Parameters
Name Description
request CreateEntryTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateMetadataJob(CreateMetadataJobRequest, CallOptions)

public virtual Operation CreateMetadataJob(CreateMetadataJobRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateMetadataJob(CreateMetadataJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateMetadataJob(CreateMetadataJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateMetadataJobAsync(CreateMetadataJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateMetadataJobAsync(CreateMetadataJobRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateMetadataJobAsync(CreateMetadataJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateMetadataJobAsync(CreateMetadataJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteAspectType(DeleteAspectTypeRequest, CallOptions)

public virtual Operation DeleteAspectType(DeleteAspectTypeRequest request, CallOptions options)

Deletes an AspectType.

Parameters
Name Description
request DeleteAspectTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteAspectType(DeleteAspectTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteAspectType(DeleteAspectTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an AspectType.

Parameters
Name Description
request DeleteAspectTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteAspectTypeAsync(DeleteAspectTypeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAspectTypeAsync(DeleteAspectTypeRequest request, CallOptions options)

Deletes an AspectType.

Parameters
Name Description
request DeleteAspectTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteAspectTypeAsync(DeleteAspectTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAspectTypeAsync(DeleteAspectTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an AspectType.

Parameters
Name Description
request DeleteAspectTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteEntry(DeleteEntryRequest, CallOptions)

public virtual Entry DeleteEntry(DeleteEntryRequest request, CallOptions options)

Deletes an Entry.

Parameters
Name Description
request DeleteEntryRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Entry

The response received from the server.

DeleteEntry(DeleteEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual Entry DeleteEntry(DeleteEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an Entry.

Parameters
Name Description
request DeleteEntryRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Entry

The response received from the server.

DeleteEntryAsync(DeleteEntryRequest, CallOptions)

public virtual AsyncUnaryCall<Entry> DeleteEntryAsync(DeleteEntryRequest request, CallOptions options)

Deletes an Entry.

Parameters
Name Description
request DeleteEntryRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEntry

The call object.

DeleteEntryAsync(DeleteEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Entry> DeleteEntryAsync(DeleteEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an Entry.

Parameters
Name Description
request DeleteEntryRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEntry

The call object.

DeleteEntryGroup(DeleteEntryGroupRequest, CallOptions)

public virtual Operation DeleteEntryGroup(DeleteEntryGroupRequest request, CallOptions options)

Deletes an EntryGroup.

Parameters
Name Description
request DeleteEntryGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteEntryGroup(DeleteEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteEntryGroup(DeleteEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an EntryGroup.

Parameters
Name Description
request DeleteEntryGroupRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteEntryGroupAsync(DeleteEntryGroupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteEntryGroupAsync(DeleteEntryGroupRequest request, CallOptions options)

Deletes an EntryGroup.

Parameters
Name Description
request DeleteEntryGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteEntryGroupAsync(DeleteEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteEntryGroupAsync(DeleteEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an EntryGroup.

Parameters
Name Description
request DeleteEntryGroupRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteEntryType(DeleteEntryTypeRequest, CallOptions)

public virtual Operation DeleteEntryType(DeleteEntryTypeRequest request, CallOptions options)

Deletes an EntryType.

Parameters
Name Description
request DeleteEntryTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteEntryType(DeleteEntryTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteEntryType(DeleteEntryTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an EntryType.

Parameters
Name Description
request DeleteEntryTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteEntryTypeAsync(DeleteEntryTypeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteEntryTypeAsync(DeleteEntryTypeRequest request, CallOptions options)

Deletes an EntryType.

Parameters
Name Description
request DeleteEntryTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteEntryTypeAsync(DeleteEntryTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteEntryTypeAsync(DeleteEntryTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an EntryType.

Parameters
Name Description
request DeleteEntryTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetAspectType(GetAspectTypeRequest, CallOptions)

public virtual AspectType GetAspectType(GetAspectTypeRequest request, CallOptions options)

Gets an AspectType.

Parameters
Name Description
request GetAspectTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AspectType

The response received from the server.

GetAspectType(GetAspectTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AspectType GetAspectType(GetAspectTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an AspectType.

Parameters
Name Description
request GetAspectTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AspectType

The response received from the server.

GetAspectTypeAsync(GetAspectTypeRequest, CallOptions)

public virtual AsyncUnaryCall<AspectType> GetAspectTypeAsync(GetAspectTypeRequest request, CallOptions options)

Gets an AspectType.

Parameters
Name Description
request GetAspectTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallAspectType

The call object.

GetAspectTypeAsync(GetAspectTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AspectType> GetAspectTypeAsync(GetAspectTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an AspectType.

Parameters
Name Description
request GetAspectTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallAspectType

The call object.

GetEntry(GetEntryRequest, CallOptions)

public virtual Entry GetEntry(GetEntryRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Entry

The response received from the server.

GetEntry(GetEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual Entry GetEntry(GetEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Entry

The response received from the server.

GetEntryAsync(GetEntryRequest, CallOptions)

public virtual AsyncUnaryCall<Entry> GetEntryAsync(GetEntryRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEntry

The call object.

GetEntryAsync(GetEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Entry> GetEntryAsync(GetEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEntry

The call object.

GetEntryGroup(GetEntryGroupRequest, CallOptions)

public virtual EntryGroup GetEntryGroup(GetEntryGroupRequest request, CallOptions options)

Gets an EntryGroup.

Parameters
Name Description
request GetEntryGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
EntryGroup

The response received from the server.

GetEntryGroup(GetEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual EntryGroup GetEntryGroup(GetEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an EntryGroup.

Parameters
Name Description
request GetEntryGroupRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
EntryGroup

The response received from the server.

GetEntryGroupAsync(GetEntryGroupRequest, CallOptions)

public virtual AsyncUnaryCall<EntryGroup> GetEntryGroupAsync(GetEntryGroupRequest request, CallOptions options)

Gets an EntryGroup.

Parameters
Name Description
request GetEntryGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEntryGroup

The call object.

GetEntryGroupAsync(GetEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EntryGroup> GetEntryGroupAsync(GetEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an EntryGroup.

Parameters
Name Description
request GetEntryGroupRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEntryGroup

The call object.

GetEntryType(GetEntryTypeRequest, CallOptions)

public virtual EntryType GetEntryType(GetEntryTypeRequest request, CallOptions options)

Gets an EntryType.

Parameters
Name Description
request GetEntryTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
EntryType

The response received from the server.

GetEntryType(GetEntryTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual EntryType GetEntryType(GetEntryTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an EntryType.

Parameters
Name Description
request GetEntryTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
EntryType

The response received from the server.

GetEntryTypeAsync(GetEntryTypeRequest, CallOptions)

public virtual AsyncUnaryCall<EntryType> GetEntryTypeAsync(GetEntryTypeRequest request, CallOptions options)

Gets an EntryType.

Parameters
Name Description
request GetEntryTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEntryType

The call object.

GetEntryTypeAsync(GetEntryTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EntryType> GetEntryTypeAsync(GetEntryTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an EntryType.

Parameters
Name Description
request GetEntryTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEntryType

The call object.

GetMetadataJob(GetMetadataJobRequest, CallOptions)

public virtual MetadataJob GetMetadataJob(GetMetadataJobRequest request, CallOptions options)

Gets a metadata job.

Parameters
Name Description
request GetMetadataJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
MetadataJob

The response received from the server.

GetMetadataJob(GetMetadataJobRequest, Metadata, DateTime?, CancellationToken)

public virtual MetadataJob GetMetadataJob(GetMetadataJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a metadata job.

Parameters
Name Description
request GetMetadataJobRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
MetadataJob

The response received from the server.

GetMetadataJobAsync(GetMetadataJobRequest, CallOptions)

public virtual AsyncUnaryCall<MetadataJob> GetMetadataJobAsync(GetMetadataJobRequest request, CallOptions options)

Gets a metadata job.

Parameters
Name Description
request GetMetadataJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallMetadataJob

The call object.

GetMetadataJobAsync(GetMetadataJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<MetadataJob> GetMetadataJobAsync(GetMetadataJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a metadata job.

Parameters
Name Description
request GetMetadataJobRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallMetadataJob

The call object.

ListAspectTypes(ListAspectTypesRequest, CallOptions)

public virtual ListAspectTypesResponse ListAspectTypes(ListAspectTypesRequest request, CallOptions options)

Lists AspectType resources in a project and location.

Parameters
Name Description
request ListAspectTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListAspectTypesResponse

The response received from the server.

ListAspectTypes(ListAspectTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListAspectTypesResponse ListAspectTypes(ListAspectTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists AspectType resources in a project and location.

Parameters
Name Description
request ListAspectTypesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListAspectTypesResponse

The response received from the server.

ListAspectTypesAsync(ListAspectTypesRequest, CallOptions)

public virtual AsyncUnaryCall<ListAspectTypesResponse> ListAspectTypesAsync(ListAspectTypesRequest request, CallOptions options)

Lists AspectType resources in a project and location.

Parameters
Name Description
request ListAspectTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListAspectTypesResponse

The call object.

ListAspectTypesAsync(ListAspectTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListAspectTypesResponse> ListAspectTypesAsync(ListAspectTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists AspectType resources in a project and location.

Parameters
Name Description
request ListAspectTypesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListAspectTypesResponse

The call object.

ListEntries(ListEntriesRequest, CallOptions)

public virtual ListEntriesResponse ListEntries(ListEntriesRequest request, CallOptions options)

Lists Entries within an EntryGroup.

Parameters
Name Description
request ListEntriesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListEntriesResponse

The response received from the server.

ListEntries(ListEntriesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEntriesResponse ListEntries(ListEntriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Entries within an EntryGroup.

Parameters
Name Description
request ListEntriesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListEntriesResponse

The response received from the server.

ListEntriesAsync(ListEntriesRequest, CallOptions)

public virtual AsyncUnaryCall<ListEntriesResponse> ListEntriesAsync(ListEntriesRequest request, CallOptions options)

Lists Entries within an EntryGroup.

Parameters
Name Description
request ListEntriesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListEntriesResponse

The call object.

ListEntriesAsync(ListEntriesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEntriesResponse> ListEntriesAsync(ListEntriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Entries within an EntryGroup.

Parameters
Name Description
request ListEntriesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListEntriesResponse

The call object.

ListEntryGroups(ListEntryGroupsRequest, CallOptions)

public virtual ListEntryGroupsResponse ListEntryGroups(ListEntryGroupsRequest request, CallOptions options)

Lists EntryGroup resources in a project and location.

Parameters
Name Description
request ListEntryGroupsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListEntryGroupsResponse

The response received from the server.

ListEntryGroups(ListEntryGroupsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEntryGroupsResponse ListEntryGroups(ListEntryGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists EntryGroup resources in a project and location.

Parameters
Name Description
request ListEntryGroupsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListEntryGroupsResponse

The response received from the server.

ListEntryGroupsAsync(ListEntryGroupsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEntryGroupsResponse> ListEntryGroupsAsync(ListEntryGroupsRequest request, CallOptions options)

Lists EntryGroup resources in a project and location.

Parameters
Name Description
request ListEntryGroupsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListEntryGroupsResponse

The call object.

ListEntryGroupsAsync(ListEntryGroupsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEntryGroupsResponse> ListEntryGroupsAsync(ListEntryGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists EntryGroup resources in a project and location.

Parameters
Name Description
request ListEntryGroupsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListEntryGroupsResponse

The call object.

ListEntryTypes(ListEntryTypesRequest, CallOptions)

public virtual ListEntryTypesResponse ListEntryTypes(ListEntryTypesRequest request, CallOptions options)

Lists EntryType resources in a project and location.

Parameters
Name Description
request ListEntryTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListEntryTypesResponse

The response received from the server.

ListEntryTypes(ListEntryTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEntryTypesResponse ListEntryTypes(ListEntryTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists EntryType resources in a project and location.

Parameters
Name Description
request ListEntryTypesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListEntryTypesResponse

The response received from the server.

ListEntryTypesAsync(ListEntryTypesRequest, CallOptions)

public virtual AsyncUnaryCall<ListEntryTypesResponse> ListEntryTypesAsync(ListEntryTypesRequest request, CallOptions options)

Lists EntryType resources in a project and location.

Parameters
Name Description
request ListEntryTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListEntryTypesResponse

The call object.

ListEntryTypesAsync(ListEntryTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEntryTypesResponse> ListEntryTypesAsync(ListEntryTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists EntryType resources in a project and location.

Parameters
Name Description
request ListEntryTypesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListEntryTypesResponse

The call object.

ListMetadataJobs(ListMetadataJobsRequest, CallOptions)

public virtual ListMetadataJobsResponse ListMetadataJobs(ListMetadataJobsRequest request, CallOptions options)

Lists metadata jobs.

Parameters
Name Description
request ListMetadataJobsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListMetadataJobsResponse

The response received from the server.

ListMetadataJobs(ListMetadataJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListMetadataJobsResponse ListMetadataJobs(ListMetadataJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists metadata jobs.

Parameters
Name Description
request ListMetadataJobsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListMetadataJobsResponse

The response received from the server.

ListMetadataJobsAsync(ListMetadataJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListMetadataJobsResponse> ListMetadataJobsAsync(ListMetadataJobsRequest request, CallOptions options)

Lists metadata jobs.

Parameters
Name Description
request ListMetadataJobsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListMetadataJobsResponse

The call object.

ListMetadataJobsAsync(ListMetadataJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListMetadataJobsResponse> ListMetadataJobsAsync(ListMetadataJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists metadata jobs.

Parameters
Name Description
request ListMetadataJobsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListMetadataJobsResponse

The call object.

LookupEntry(LookupEntryRequest, CallOptions)

public virtual Entry LookupEntry(LookupEntryRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Entry

The response received from the server.

LookupEntry(LookupEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual Entry LookupEntry(LookupEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Entry

The response received from the server.

LookupEntryAsync(LookupEntryRequest, CallOptions)

public virtual AsyncUnaryCall<Entry> LookupEntryAsync(LookupEntryRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEntry

The call object.

LookupEntryAsync(LookupEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Entry> LookupEntryAsync(LookupEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEntry

The call object.

NewInstance(ClientBaseConfiguration)

protected override CatalogService.CatalogServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
CatalogServiceCatalogServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Dataplex.V1.CatalogService.CatalogServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SearchEntries(SearchEntriesRequest, CallOptions)

public virtual SearchEntriesResponse SearchEntries(SearchEntriesRequest request, CallOptions options)

Searches for Entries matching the given query and scope.

Parameters
Name Description
request SearchEntriesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
SearchEntriesResponse

The response received from the server.

SearchEntries(SearchEntriesRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchEntriesResponse SearchEntries(SearchEntriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Searches for Entries matching the given query and scope.

Parameters
Name Description
request SearchEntriesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
SearchEntriesResponse

The response received from the server.

SearchEntriesAsync(SearchEntriesRequest, CallOptions)

public virtual AsyncUnaryCall<SearchEntriesResponse> SearchEntriesAsync(SearchEntriesRequest request, CallOptions options)

Searches for Entries matching the given query and scope.

Parameters
Name Description
request SearchEntriesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSearchEntriesResponse

The call object.

SearchEntriesAsync(SearchEntriesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchEntriesResponse> SearchEntriesAsync(SearchEntriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Searches for Entries matching the given query and scope.

Parameters
Name Description
request SearchEntriesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSearchEntriesResponse

The call object.

UpdateAspectType(UpdateAspectTypeRequest, CallOptions)

public virtual Operation UpdateAspectType(UpdateAspectTypeRequest request, CallOptions options)

Updates an AspectType.

Parameters
Name Description
request UpdateAspectTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateAspectType(UpdateAspectTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateAspectType(UpdateAspectTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an AspectType.

Parameters
Name Description
request UpdateAspectTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpdateAspectTypeAsync(UpdateAspectTypeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAspectTypeAsync(UpdateAspectTypeRequest request, CallOptions options)

Updates an AspectType.

Parameters
Name Description
request UpdateAspectTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateAspectTypeAsync(UpdateAspectTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateAspectTypeAsync(UpdateAspectTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an AspectType.

Parameters
Name Description
request UpdateAspectTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateEntry(UpdateEntryRequest, CallOptions)

public virtual Entry UpdateEntry(UpdateEntryRequest request, CallOptions options)

Updates an Entry.

Parameters
Name Description
request UpdateEntryRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Entry

The response received from the server.

UpdateEntry(UpdateEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual Entry UpdateEntry(UpdateEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an Entry.

Parameters
Name Description
request UpdateEntryRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Entry

The response received from the server.

UpdateEntryAsync(UpdateEntryRequest, CallOptions)

public virtual AsyncUnaryCall<Entry> UpdateEntryAsync(UpdateEntryRequest request, CallOptions options)

Updates an Entry.

Parameters
Name Description
request UpdateEntryRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEntry

The call object.

UpdateEntryAsync(UpdateEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Entry> UpdateEntryAsync(UpdateEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an Entry.

Parameters
Name Description
request UpdateEntryRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEntry

The call object.

UpdateEntryGroup(UpdateEntryGroupRequest, CallOptions)

public virtual Operation UpdateEntryGroup(UpdateEntryGroupRequest request, CallOptions options)

Updates an EntryGroup.

Parameters
Name Description
request UpdateEntryGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateEntryGroup(UpdateEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateEntryGroup(UpdateEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an EntryGroup.

Parameters
Name Description
request UpdateEntryGroupRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpdateEntryGroupAsync(UpdateEntryGroupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateEntryGroupAsync(UpdateEntryGroupRequest request, CallOptions options)

Updates an EntryGroup.

Parameters
Name Description
request UpdateEntryGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateEntryGroupAsync(UpdateEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateEntryGroupAsync(UpdateEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an EntryGroup.

Parameters
Name Description
request UpdateEntryGroupRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateEntryType(UpdateEntryTypeRequest, CallOptions)

public virtual Operation UpdateEntryType(UpdateEntryTypeRequest request, CallOptions options)

Updates an EntryType.

Parameters
Name Description
request UpdateEntryTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateEntryType(UpdateEntryTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateEntryType(UpdateEntryTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an EntryType.

Parameters
Name Description
request UpdateEntryTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpdateEntryTypeAsync(UpdateEntryTypeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateEntryTypeAsync(UpdateEntryTypeRequest request, CallOptions options)

Updates an EntryType.

Parameters
Name Description
request UpdateEntryTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateEntryTypeAsync(UpdateEntryTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateEntryTypeAsync(UpdateEntryTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an EntryType.

Parameters
Name Description
request UpdateEntryTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.