KMS Inventory v1 API - Class KeyDashboardService.KeyDashboardServiceClient (1.3.0)

public class KeyDashboardService.KeyDashboardServiceClient : ClientBase<KeyDashboardService.KeyDashboardServiceClient>

Reference documentation and code samples for the KMS Inventory v1 API class KeyDashboardService.KeyDashboardServiceClient.

Client for KeyDashboardService

Inheritance

object > ClientBase > ClientBaseKeyDashboardServiceKeyDashboardServiceClient > KeyDashboardService.KeyDashboardServiceClient

Namespace

Google.Cloud.Kms.Inventory.V1

Assembly

Google.Cloud.Kms.Inventory.V1.dll

Constructors

KeyDashboardServiceClient()

protected KeyDashboardServiceClient()

Protected parameterless constructor to allow creation of test doubles.

KeyDashboardServiceClient(CallInvoker)

public KeyDashboardServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

KeyDashboardServiceClient(ChannelBase)

public KeyDashboardServiceClient(ChannelBase channel)

Creates a new client for KeyDashboardService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

KeyDashboardServiceClient(ClientBaseConfiguration)

protected KeyDashboardServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

ListCryptoKeys(ListCryptoKeysRequest, CallOptions)

public virtual ListCryptoKeysResponse ListCryptoKeys(ListCryptoKeysRequest request, CallOptions options)

Returns cryptographic keys managed by Cloud KMS in a given Cloud project. Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.

Parameters
Name Description
request ListCryptoKeysRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListCryptoKeysResponse

The response received from the server.

ListCryptoKeys(ListCryptoKeysRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCryptoKeysResponse ListCryptoKeys(ListCryptoKeysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns cryptographic keys managed by Cloud KMS in a given Cloud project. Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.

Parameters
Name Description
request ListCryptoKeysRequest

The request to send to the server.

headers Metadata

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

deadline 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
ListCryptoKeysResponse

The response received from the server.

ListCryptoKeysAsync(ListCryptoKeysRequest, CallOptions)

public virtual AsyncUnaryCall<ListCryptoKeysResponse> ListCryptoKeysAsync(ListCryptoKeysRequest request, CallOptions options)

Returns cryptographic keys managed by Cloud KMS in a given Cloud project. Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.

Parameters
Name Description
request ListCryptoKeysRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListCryptoKeysResponse

The call object.

ListCryptoKeysAsync(ListCryptoKeysRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCryptoKeysResponse> ListCryptoKeysAsync(ListCryptoKeysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns cryptographic keys managed by Cloud KMS in a given Cloud project. Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.

Parameters
Name Description
request ListCryptoKeysRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallListCryptoKeysResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override KeyDashboardService.KeyDashboardServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
KeyDashboardServiceKeyDashboardServiceClient
Overrides