Google Cloud Key Management Service v1 API - Class Autokey.AutokeyClient (3.11.0)

Version 3.11.0

• 3.13.0 (latest)
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0

public class Autokey.AutokeyClient : ClientBase<Autokey.AutokeyClient>

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class Autokey.AutokeyClient.

Client for Autokey

Inheritance

object > ClientBase > ClientBaseAutokeyAutokeyClient > Autokey.AutokeyClient

Inherited Members

ClientBase<Autokey.AutokeyClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

AutokeyClient()

protected AutokeyClient()

Protected parameterless constructor to allow creation of test doubles.

AutokeyClient(CallInvoker)

public AutokeyClient(CallInvoker callInvoker)

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

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

AutokeyClient(ChannelBase)

public AutokeyClient(ChannelBase channel)

Creates a new client for Autokey

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

AutokeyClient(ClientBaseConfiguration)

protected AutokeyClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

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.

CreateKeyHandle(CreateKeyHandleRequest, CallOptions)

public virtual Operation CreateKeyHandle(CreateKeyHandleRequest request, CallOptions options)

Creates a new [KeyHandle][google.cloud.kms.v1.KeyHandle], triggering the provisioning of a new [CryptoKey][google.cloud.kms.v1.CryptoKey] for CMEK use with the given resource type in the configured key project and the same location. [GetOperation][Operations.GetOperation] should be used to resolve the resulting long-running operation and get the resulting [KeyHandle][google.cloud.kms.v1.KeyHandle] and [CryptoKey][google.cloud.kms.v1.CryptoKey].

Parameters
Name	Description
request	CreateKeyHandleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateKeyHandle(CreateKeyHandleRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new [KeyHandle][google.cloud.kms.v1.KeyHandle], triggering the provisioning of a new [CryptoKey][google.cloud.kms.v1.CryptoKey] for CMEK use with the given resource type in the configured key project and the same location. [GetOperation][Operations.GetOperation] should be used to resolve the resulting long-running operation and get the resulting [KeyHandle][google.cloud.kms.v1.KeyHandle] and [CryptoKey][google.cloud.kms.v1.CryptoKey].

Parameters
Name	Description
request	CreateKeyHandleRequest 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
Operation	The response received from the server.

CreateKeyHandleAsync(CreateKeyHandleRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateKeyHandleAsync(CreateKeyHandleRequest request, CallOptions options)

Creates a new [KeyHandle][google.cloud.kms.v1.KeyHandle], triggering the provisioning of a new [CryptoKey][google.cloud.kms.v1.CryptoKey] for CMEK use with the given resource type in the configured key project and the same location. [GetOperation][Operations.GetOperation] should be used to resolve the resulting long-running operation and get the resulting [KeyHandle][google.cloud.kms.v1.KeyHandle] and [CryptoKey][google.cloud.kms.v1.CryptoKey].

Parameters
Name	Description
request	CreateKeyHandleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateKeyHandleAsync(CreateKeyHandleRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new [KeyHandle][google.cloud.kms.v1.KeyHandle], triggering the provisioning of a new [CryptoKey][google.cloud.kms.v1.CryptoKey] for CMEK use with the given resource type in the configured key project and the same location. [GetOperation][Operations.GetOperation] should be used to resolve the resulting long-running operation and get the resulting [KeyHandle][google.cloud.kms.v1.KeyHandle] and [CryptoKey][google.cloud.kms.v1.CryptoKey].

Parameters
Name	Description
request	CreateKeyHandleRequest 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
AsyncUnaryCallOperation	The call object.

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.

GetKeyHandle(GetKeyHandleRequest, CallOptions)

public virtual KeyHandle GetKeyHandle(GetKeyHandleRequest request, CallOptions options)

Returns the [KeyHandle][google.cloud.kms.v1.KeyHandle].

Parameters
Name	Description
request	GetKeyHandleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
KeyHandle	The response received from the server.

GetKeyHandle(GetKeyHandleRequest, Metadata, DateTime?, CancellationToken)

public virtual KeyHandle GetKeyHandle(GetKeyHandleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the [KeyHandle][google.cloud.kms.v1.KeyHandle].

Parameters
Name	Description
request	GetKeyHandleRequest 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
KeyHandle	The response received from the server.

GetKeyHandleAsync(GetKeyHandleRequest, CallOptions)

public virtual AsyncUnaryCall<KeyHandle> GetKeyHandleAsync(GetKeyHandleRequest request, CallOptions options)

Returns the [KeyHandle][google.cloud.kms.v1.KeyHandle].

Parameters
Name	Description
request	GetKeyHandleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallKeyHandle	The call object.

GetKeyHandleAsync(GetKeyHandleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<KeyHandle> GetKeyHandleAsync(GetKeyHandleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the [KeyHandle][google.cloud.kms.v1.KeyHandle].

Parameters
Name	Description
request	GetKeyHandleRequest 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
AsyncUnaryCallKeyHandle	The call object.

ListKeyHandles(ListKeyHandlesRequest, CallOptions)

public virtual ListKeyHandlesResponse ListKeyHandles(ListKeyHandlesRequest request, CallOptions options)

Lists [KeyHandles][google.cloud.kms.v1.KeyHandle].

Parameters
Name	Description
request	ListKeyHandlesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListKeyHandlesResponse	The response received from the server.

ListKeyHandles(ListKeyHandlesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListKeyHandlesResponse ListKeyHandles(ListKeyHandlesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists [KeyHandles][google.cloud.kms.v1.KeyHandle].

Parameters
Name	Description
request	ListKeyHandlesRequest 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
ListKeyHandlesResponse	The response received from the server.

ListKeyHandlesAsync(ListKeyHandlesRequest, CallOptions)

public virtual AsyncUnaryCall<ListKeyHandlesResponse> ListKeyHandlesAsync(ListKeyHandlesRequest request, CallOptions options)

Lists [KeyHandles][google.cloud.kms.v1.KeyHandle].

Parameters
Name	Description
request	ListKeyHandlesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListKeyHandlesResponse	The call object.

ListKeyHandlesAsync(ListKeyHandlesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListKeyHandlesResponse> ListKeyHandlesAsync(ListKeyHandlesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists [KeyHandles][google.cloud.kms.v1.KeyHandle].

Parameters
Name	Description
request	ListKeyHandlesRequest 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
AsyncUnaryCallListKeyHandlesResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override Autokey.AutokeyClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
AutokeyAutokeyClient

Overrides

ClientBase<Autokey.AutokeyClient>.NewInstance(ClientBase.ClientBaseConfiguration)