Google Cloud Key Management Service v1 API - Class AutokeyAdminClientImpl (3.14.0) 

public sealed class AutokeyAdminClientImpl : AutokeyAdminClient

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

AutokeyAdmin client wrapper implementation, for convenient use.

Inheritance

object > AutokeyAdminClient > AutokeyAdminClientImpl

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Remarks

Provides interfaces for managing Cloud KMS Autokey folder-level configurations. A configuration is inherited by all descendent projects. A configuration at one folder overrides any other configurations in its ancestry. Setting a configuration on a folder is a prerequisite for Cloud KMS Autokey, so that users working in a descendant project can request provisioned [CryptoKeys][google.cloud.kms.v1.CryptoKey], ready for Customer Managed Encryption Key (CMEK) use, on-demand.

Constructors

AutokeyAdminClientImpl(AutokeyAdminClient, AutokeyAdminSettings, ILogger)

public AutokeyAdminClientImpl(AutokeyAdmin.AutokeyAdminClient grpcClient, AutokeyAdminSettings settings, ILogger logger)

Constructs a client wrapper for the AutokeyAdmin service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient AutokeyAdminAutokeyAdminClient

The underlying gRPC client.
settings AutokeyAdminSettings

The base AutokeyAdminSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override AutokeyAdmin.AutokeyAdminClient GrpcClient { get; }

The underlying gRPC AutokeyAdmin client

Property Value
Type Description
AutokeyAdminAutokeyAdminClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

GetAutokeyConfig(GetAutokeyConfigRequest, CallSettings)

public override AutokeyConfig GetAutokeyConfig(GetAutokeyConfigRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetAutokeyConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AutokeyConfig

The RPC response.
Overrides

GetAutokeyConfigAsync(GetAutokeyConfigRequest, CallSettings)

public override Task<AutokeyConfig> GetAutokeyConfigAsync(GetAutokeyConfigRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetAutokeyConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAutokeyConfig

A Task containing the RPC response.
Overrides

ShowEffectiveAutokeyConfig(ShowEffectiveAutokeyConfigRequest, CallSettings)

public override ShowEffectiveAutokeyConfigResponse ShowEffectiveAutokeyConfig(ShowEffectiveAutokeyConfigRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ShowEffectiveAutokeyConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ShowEffectiveAutokeyConfigResponse

The RPC response.
Overrides

ShowEffectiveAutokeyConfigAsync(ShowEffectiveAutokeyConfigRequest, CallSettings)

public override Task<ShowEffectiveAutokeyConfigResponse> ShowEffectiveAutokeyConfigAsync(ShowEffectiveAutokeyConfigRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ShowEffectiveAutokeyConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskShowEffectiveAutokeyConfigResponse

A Task containing the RPC response.
Overrides

UpdateAutokeyConfig(UpdateAutokeyConfigRequest, CallSettings)

public override AutokeyConfig UpdateAutokeyConfig(UpdateAutokeyConfigRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AutokeyConfig

The RPC response.
Overrides

UpdateAutokeyConfigAsync(UpdateAutokeyConfigRequest, CallSettings)

public override Task<AutokeyConfig> UpdateAutokeyConfigAsync(UpdateAutokeyConfigRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAutokeyConfig

A Task containing the RPC response.
Overrides