Discovery Engine v1 API - Class CmekConfigService.CmekConfigServiceClient (1.8.0) 

public class CmekConfigService.CmekConfigServiceClient : ClientBase<CmekConfigService.CmekConfigServiceClient>

Reference documentation and code samples for the Discovery Engine v1 API class CmekConfigService.CmekConfigServiceClient.

Client for CmekConfigService

Inheritance

object > ClientBase > ClientBaseCmekConfigServiceCmekConfigServiceClient > CmekConfigService.CmekConfigServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

CmekConfigServiceClient()

protected CmekConfigServiceClient()

Protected parameterless constructor to allow creation of test doubles.

CmekConfigServiceClient(CallInvoker)

public CmekConfigServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

CmekConfigServiceClient(ChannelBase)

public CmekConfigServiceClient(ChannelBase channel)

Creates a new client for CmekConfigService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

CmekConfigServiceClient(ClientBaseConfiguration)

protected CmekConfigServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

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.

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.

DeleteCmekConfig(DeleteCmekConfigRequest, CallOptions)

public virtual Operation DeleteCmekConfig(DeleteCmekConfigRequest request, CallOptions options)

De-provisions a CmekConfig.

Parameters
Name Description
request DeleteCmekConfigRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteCmekConfig(DeleteCmekConfigRequest, Metadata, DateTime?, CancellationToken)

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

De-provisions a CmekConfig.

Parameters
Name Description
request DeleteCmekConfigRequest

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.

DeleteCmekConfigAsync(DeleteCmekConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteCmekConfigAsync(DeleteCmekConfigRequest request, CallOptions options)

De-provisions a CmekConfig.

Parameters
Name Description
request DeleteCmekConfigRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteCmekConfigAsync(DeleteCmekConfigRequest, Metadata, DateTime?, CancellationToken)

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

De-provisions a CmekConfig.

Parameters
Name Description
request DeleteCmekConfigRequest

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.

GetCmekConfig(GetCmekConfigRequest, CallOptions)

public virtual CmekConfig GetCmekConfig(GetCmekConfigRequest request, CallOptions options)

Gets the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig].

Parameters
Name Description
request GetCmekConfigRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
CmekConfig

The response received from the server.

GetCmekConfig(GetCmekConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual CmekConfig GetCmekConfig(GetCmekConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig].

Parameters
Name Description
request GetCmekConfigRequest

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
CmekConfig

The response received from the server.

GetCmekConfigAsync(GetCmekConfigRequest, CallOptions)

public virtual AsyncUnaryCall<CmekConfig> GetCmekConfigAsync(GetCmekConfigRequest request, CallOptions options)

Gets the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig].

Parameters
Name Description
request GetCmekConfigRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallCmekConfig

The call object.

GetCmekConfigAsync(GetCmekConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CmekConfig> GetCmekConfigAsync(GetCmekConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig].

Parameters
Name Description
request GetCmekConfigRequest

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
AsyncUnaryCallCmekConfig

The call object.

ListCmekConfigs(ListCmekConfigsRequest, CallOptions)

public virtual ListCmekConfigsResponse ListCmekConfigs(ListCmekConfigsRequest request, CallOptions options)

Lists all the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s with the project.

Parameters
Name Description
request ListCmekConfigsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListCmekConfigsResponse

The response received from the server.

ListCmekConfigs(ListCmekConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCmekConfigsResponse ListCmekConfigs(ListCmekConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s with the project.

Parameters
Name Description
request ListCmekConfigsRequest

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
ListCmekConfigsResponse

The response received from the server.

ListCmekConfigsAsync(ListCmekConfigsRequest, CallOptions)

public virtual AsyncUnaryCall<ListCmekConfigsResponse> ListCmekConfigsAsync(ListCmekConfigsRequest request, CallOptions options)

Lists all the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s with the project.

Parameters
Name Description
request ListCmekConfigsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListCmekConfigsResponse

The call object.

ListCmekConfigsAsync(ListCmekConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCmekConfigsResponse> ListCmekConfigsAsync(ListCmekConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s with the project.

Parameters
Name Description
request ListCmekConfigsRequest

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
AsyncUnaryCallListCmekConfigsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override CmekConfigService.CmekConfigServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
CmekConfigServiceCmekConfigServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.DiscoveryEngine.V1.CmekConfigService.CmekConfigServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateCmekConfig(UpdateCmekConfigRequest, CallOptions)

public virtual Operation UpdateCmekConfig(UpdateCmekConfigRequest request, CallOptions options)

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

Parameters
Name Description
request UpdateCmekConfigRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

UpdateCmekConfig(UpdateCmekConfigRequest, Metadata, DateTime?, CancellationToken)

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

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

Parameters
Name Description
request UpdateCmekConfigRequest

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.

UpdateCmekConfigAsync(UpdateCmekConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateCmekConfigAsync(UpdateCmekConfigRequest request, CallOptions options)

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

Parameters
Name Description
request UpdateCmekConfigRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateCmekConfigAsync(UpdateCmekConfigRequest, Metadata, DateTime?, CancellationToken)

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

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

Parameters
Name Description
request UpdateCmekConfigRequest

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.