Google Cloud Key Management Service v1 API - Class AutokeyAdmin.AutokeyAdminClient (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 AutokeyAdmin.AutokeyAdminClient : ClientBase<AutokeyAdmin.AutokeyAdminClient>

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

Client for AutokeyAdmin

Inheritance

object > ClientBase > ClientBaseAutokeyAdminAutokeyAdminClient > AutokeyAdmin.AutokeyAdminClient

Inherited Members

ClientBase<AutokeyAdmin.AutokeyAdminClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

AutokeyAdminClient()

protected AutokeyAdminClient()

Protected parameterless constructor to allow creation of test doubles.

AutokeyAdminClient(CallInvoker)

public AutokeyAdminClient(CallInvoker callInvoker)

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

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

AutokeyAdminClient(ChannelBase)

public AutokeyAdminClient(ChannelBase channel)

Creates a new client for AutokeyAdmin

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

AutokeyAdminClient(ClientBaseConfiguration)

protected AutokeyAdminClient(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.

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.

GetAutokeyConfig(GetAutokeyConfigRequest, CallOptions)

public virtual AutokeyConfig GetAutokeyConfig(GetAutokeyConfigRequest request, CallOptions options)

Returns the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] for a folder.

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

Returns
Type	Description
AutokeyConfig	The response received from the server.

GetAutokeyConfig(GetAutokeyConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AutokeyConfig GetAutokeyConfig(GetAutokeyConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] for a folder.

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

GetAutokeyConfigAsync(GetAutokeyConfigRequest, CallOptions)

public virtual AsyncUnaryCall<AutokeyConfig> GetAutokeyConfigAsync(GetAutokeyConfigRequest request, CallOptions options)

Returns the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] for a folder.

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

Returns
Type	Description
AsyncUnaryCallAutokeyConfig	The call object.

GetAutokeyConfigAsync(GetAutokeyConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AutokeyConfig> GetAutokeyConfigAsync(GetAutokeyConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] for a folder.

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

NewInstance(ClientBaseConfiguration)

protected override AutokeyAdmin.AutokeyAdminClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
AutokeyAdminAutokeyAdminClient

Overrides

ClientBase<AutokeyAdmin.AutokeyAdminClient>.NewInstance(ClientBase.ClientBaseConfiguration)

ShowEffectiveAutokeyConfig(ShowEffectiveAutokeyConfigRequest, CallOptions)

public virtual ShowEffectiveAutokeyConfigResponse ShowEffectiveAutokeyConfig(ShowEffectiveAutokeyConfigRequest request, CallOptions options)

Returns the effective Cloud KMS Autokey configuration for a given project.

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

Returns
Type	Description
ShowEffectiveAutokeyConfigResponse	The response received from the server.

ShowEffectiveAutokeyConfig(ShowEffectiveAutokeyConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual ShowEffectiveAutokeyConfigResponse ShowEffectiveAutokeyConfig(ShowEffectiveAutokeyConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the effective Cloud KMS Autokey configuration for a given project.

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

ShowEffectiveAutokeyConfigAsync(ShowEffectiveAutokeyConfigRequest, CallOptions)

public virtual AsyncUnaryCall<ShowEffectiveAutokeyConfigResponse> ShowEffectiveAutokeyConfigAsync(ShowEffectiveAutokeyConfigRequest request, CallOptions options)

Returns the effective Cloud KMS Autokey configuration for a given project.

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

Returns
Type	Description
AsyncUnaryCallShowEffectiveAutokeyConfigResponse	The call object.

ShowEffectiveAutokeyConfigAsync(ShowEffectiveAutokeyConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ShowEffectiveAutokeyConfigResponse> ShowEffectiveAutokeyConfigAsync(ShowEffectiveAutokeyConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the effective Cloud KMS Autokey configuration for a given project.

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

UpdateAutokeyConfig(UpdateAutokeyConfigRequest, CallOptions)

public virtual AutokeyConfig UpdateAutokeyConfig(UpdateAutokeyConfigRequest request, CallOptions options)

Updates the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] for a folder. The caller must have both cloudkms.autokeyConfigs.update permission on the parent folder and cloudkms.cryptoKeys.setIamPolicy permission on the provided key project. A [KeyHandle][google.cloud.kms.v1.KeyHandle] creation in the folder's descendant projects will use this configuration to determine where to create the resulting [CryptoKey][google.cloud.kms.v1.CryptoKey].

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

Returns
Type	Description
AutokeyConfig	The response received from the server.

UpdateAutokeyConfig(UpdateAutokeyConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AutokeyConfig UpdateAutokeyConfig(UpdateAutokeyConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] for a folder. The caller must have both cloudkms.autokeyConfigs.update permission on the parent folder and cloudkms.cryptoKeys.setIamPolicy permission on the provided key project. A [KeyHandle][google.cloud.kms.v1.KeyHandle] creation in the folder's descendant projects will use this configuration to determine where to create the resulting [CryptoKey][google.cloud.kms.v1.CryptoKey].

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

UpdateAutokeyConfigAsync(UpdateAutokeyConfigRequest, CallOptions)

public virtual AsyncUnaryCall<AutokeyConfig> UpdateAutokeyConfigAsync(UpdateAutokeyConfigRequest request, CallOptions options)

Updates the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] for a folder. The caller must have both cloudkms.autokeyConfigs.update permission on the parent folder and cloudkms.cryptoKeys.setIamPolicy permission on the provided key project. A [KeyHandle][google.cloud.kms.v1.KeyHandle] creation in the folder's descendant projects will use this configuration to determine where to create the resulting [CryptoKey][google.cloud.kms.v1.CryptoKey].

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

Returns
Type	Description
AsyncUnaryCallAutokeyConfig	The call object.

UpdateAutokeyConfigAsync(UpdateAutokeyConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AutokeyConfig> UpdateAutokeyConfigAsync(UpdateAutokeyConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] for a folder. The caller must have both cloudkms.autokeyConfigs.update permission on the parent folder and cloudkms.cryptoKeys.setIamPolicy permission on the provided key project. A [KeyHandle][google.cloud.kms.v1.KeyHandle] creation in the folder's descendant projects will use this configuration to determine where to create the resulting [CryptoKey][google.cloud.kms.v1.CryptoKey].

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