Google Cloud Key Management Service v1 API - Class AutokeyAdminClient (3.13.0)

Version latest

• 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 abstract class AutokeyAdminClient

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

AutokeyAdmin client wrapper, for convenient use.

Inheritance

object > AutokeyAdminClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

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.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the AutokeyAdmin service, which is a host of "cloudkms.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default AutokeyAdmin scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default AutokeyAdmin scopes are:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/cloudkms

GrpcClient

public virtual AutokeyAdmin.AutokeyAdminClient GrpcClient { get; }

The underlying gRPC AutokeyAdmin client

Property Value
Type	Description
AutokeyAdminAutokeyAdminClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

Create()

public static AutokeyAdminClient Create()

Synchronously creates a AutokeyAdminClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AutokeyAdminClientBuilder.

Returns
Type	Description
AutokeyAdminClient	The created AutokeyAdminClient.

CreateAsync(CancellationToken)

public static Task<AutokeyAdminClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a AutokeyAdminClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AutokeyAdminClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskAutokeyAdminClient	The task representing the created AutokeyAdminClient.

GetAutokeyConfig(AutokeyConfigName, CallSettings)

public virtual AutokeyConfig GetAutokeyConfig(AutokeyConfigName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	AutokeyConfigName Required. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AutokeyConfig	The RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = AutokeyAdminClient.Create();
// Initialize request argument(s)
AutokeyConfigName name = AutokeyConfigName.FromFolder("[FOLDER]");
// Make the request
AutokeyConfig response = autokeyAdminClient.GetAutokeyConfig(name);

GetAutokeyConfig(GetAutokeyConfigRequest, CallSettings)

public virtual 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.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = AutokeyAdminClient.Create();
// Initialize request argument(s)
GetAutokeyConfigRequest request = new GetAutokeyConfigRequest
{
    AutokeyConfigName = AutokeyConfigName.FromFolder("[FOLDER]"),
};
// Make the request
AutokeyConfig response = autokeyAdminClient.GetAutokeyConfig(request);

GetAutokeyConfig(string, CallSettings)

public virtual AutokeyConfig GetAutokeyConfig(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	string Required. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AutokeyConfig	The RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = AutokeyAdminClient.Create();
// Initialize request argument(s)
string name = "folders/[FOLDER]/autokeyConfig";
// Make the request
AutokeyConfig response = autokeyAdminClient.GetAutokeyConfig(name);

GetAutokeyConfigAsync(AutokeyConfigName, CallSettings)

public virtual Task<AutokeyConfig> GetAutokeyConfigAsync(AutokeyConfigName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	AutokeyConfigName Required. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAutokeyConfig	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
AutokeyConfigName name = AutokeyConfigName.FromFolder("[FOLDER]");
// Make the request
AutokeyConfig response = await autokeyAdminClient.GetAutokeyConfigAsync(name);

GetAutokeyConfigAsync(AutokeyConfigName, CancellationToken)

public virtual Task<AutokeyConfig> GetAutokeyConfigAsync(AutokeyConfigName name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	AutokeyConfigName Required. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAutokeyConfig	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
AutokeyConfigName name = AutokeyConfigName.FromFolder("[FOLDER]");
// Make the request
AutokeyConfig response = await autokeyAdminClient.GetAutokeyConfigAsync(name);

GetAutokeyConfigAsync(GetAutokeyConfigRequest, CallSettings)

public virtual 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.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
GetAutokeyConfigRequest request = new GetAutokeyConfigRequest
{
    AutokeyConfigName = AutokeyConfigName.FromFolder("[FOLDER]"),
};
// Make the request
AutokeyConfig response = await autokeyAdminClient.GetAutokeyConfigAsync(request);

GetAutokeyConfigAsync(GetAutokeyConfigRequest, CancellationToken)

public virtual Task<AutokeyConfig> GetAutokeyConfigAsync(GetAutokeyConfigRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAutokeyConfig	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
GetAutokeyConfigRequest request = new GetAutokeyConfigRequest
{
    AutokeyConfigName = AutokeyConfigName.FromFolder("[FOLDER]"),
};
// Make the request
AutokeyConfig response = await autokeyAdminClient.GetAutokeyConfigAsync(request);

GetAutokeyConfigAsync(string, CallSettings)

public virtual Task<AutokeyConfig> GetAutokeyConfigAsync(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	string Required. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAutokeyConfig	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "folders/[FOLDER]/autokeyConfig";
// Make the request
AutokeyConfig response = await autokeyAdminClient.GetAutokeyConfigAsync(name);

GetAutokeyConfigAsync(string, CancellationToken)

public virtual Task<AutokeyConfig> GetAutokeyConfigAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	string Required. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAutokeyConfig	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "folders/[FOLDER]/autokeyConfig";
// Make the request
AutokeyConfig response = await autokeyAdminClient.GetAutokeyConfigAsync(name);

ShowEffectiveAutokeyConfig(ProjectName, CallSettings)

public virtual ShowEffectiveAutokeyConfigResponse ShowEffectiveAutokeyConfig(ProjectName parent, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	ProjectName Required. Name of the resource project to the show effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ShowEffectiveAutokeyConfigResponse	The RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = AutokeyAdminClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
ShowEffectiveAutokeyConfigResponse response = autokeyAdminClient.ShowEffectiveAutokeyConfig(parent);

ShowEffectiveAutokeyConfig(ShowEffectiveAutokeyConfigRequest, CallSettings)

public virtual 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.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = AutokeyAdminClient.Create();
// Initialize request argument(s)
ShowEffectiveAutokeyConfigRequest request = new ShowEffectiveAutokeyConfigRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
ShowEffectiveAutokeyConfigResponse response = autokeyAdminClient.ShowEffectiveAutokeyConfig(request);

ShowEffectiveAutokeyConfig(string, CallSettings)

public virtual ShowEffectiveAutokeyConfigResponse ShowEffectiveAutokeyConfig(string parent, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	string Required. Name of the resource project to the show effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ShowEffectiveAutokeyConfigResponse	The RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = AutokeyAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
ShowEffectiveAutokeyConfigResponse response = autokeyAdminClient.ShowEffectiveAutokeyConfig(parent);

ShowEffectiveAutokeyConfigAsync(ProjectName, CallSettings)

public virtual Task<ShowEffectiveAutokeyConfigResponse> ShowEffectiveAutokeyConfigAsync(ProjectName parent, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	ProjectName Required. Name of the resource project to the show effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskShowEffectiveAutokeyConfigResponse	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
ShowEffectiveAutokeyConfigResponse response = await autokeyAdminClient.ShowEffectiveAutokeyConfigAsync(parent);

ShowEffectiveAutokeyConfigAsync(ProjectName, CancellationToken)

public virtual Task<ShowEffectiveAutokeyConfigResponse> ShowEffectiveAutokeyConfigAsync(ProjectName parent, CancellationToken cancellationToken)

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

Parameters
Name	Description
parent	ProjectName Required. Name of the resource project to the show effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskShowEffectiveAutokeyConfigResponse	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
ShowEffectiveAutokeyConfigResponse response = await autokeyAdminClient.ShowEffectiveAutokeyConfigAsync(parent);

ShowEffectiveAutokeyConfigAsync(ShowEffectiveAutokeyConfigRequest, CallSettings)

public virtual 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.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
ShowEffectiveAutokeyConfigRequest request = new ShowEffectiveAutokeyConfigRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
ShowEffectiveAutokeyConfigResponse response = await autokeyAdminClient.ShowEffectiveAutokeyConfigAsync(request);

ShowEffectiveAutokeyConfigAsync(ShowEffectiveAutokeyConfigRequest, CancellationToken)

public virtual Task<ShowEffectiveAutokeyConfigResponse> ShowEffectiveAutokeyConfigAsync(ShowEffectiveAutokeyConfigRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskShowEffectiveAutokeyConfigResponse	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
ShowEffectiveAutokeyConfigRequest request = new ShowEffectiveAutokeyConfigRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
ShowEffectiveAutokeyConfigResponse response = await autokeyAdminClient.ShowEffectiveAutokeyConfigAsync(request);

ShowEffectiveAutokeyConfigAsync(string, CallSettings)

public virtual Task<ShowEffectiveAutokeyConfigResponse> ShowEffectiveAutokeyConfigAsync(string parent, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	string Required. Name of the resource project to the show effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskShowEffectiveAutokeyConfigResponse	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
ShowEffectiveAutokeyConfigResponse response = await autokeyAdminClient.ShowEffectiveAutokeyConfigAsync(parent);

ShowEffectiveAutokeyConfigAsync(string, CancellationToken)

public virtual Task<ShowEffectiveAutokeyConfigResponse> ShowEffectiveAutokeyConfigAsync(string parent, CancellationToken cancellationToken)

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

Parameters
Name	Description
parent	string Required. Name of the resource project to the show effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskShowEffectiveAutokeyConfigResponse	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
ShowEffectiveAutokeyConfigResponse response = await autokeyAdminClient.ShowEffectiveAutokeyConfigAsync(parent);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateAutokeyConfig(AutokeyConfig, FieldMask, CallSettings)

public virtual AutokeyConfig UpdateAutokeyConfig(AutokeyConfig autokeyConfig, FieldMask updateMask, 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
autokeyConfig	AutokeyConfig Required. [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] with values to update.
updateMask	FieldMask Required. Masks which fields of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] to update, e.g. keyProject.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AutokeyConfig	The RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = AutokeyAdminClient.Create();
// Initialize request argument(s)
AutokeyConfig autokeyConfig = new AutokeyConfig();
FieldMask updateMask = new FieldMask();
// Make the request
AutokeyConfig response = autokeyAdminClient.UpdateAutokeyConfig(autokeyConfig, updateMask);

UpdateAutokeyConfig(UpdateAutokeyConfigRequest, CallSettings)

public virtual 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.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = AutokeyAdminClient.Create();
// Initialize request argument(s)
UpdateAutokeyConfigRequest request = new UpdateAutokeyConfigRequest
{
    AutokeyConfig = new AutokeyConfig(),
    UpdateMask = new FieldMask(),
};
// Make the request
AutokeyConfig response = autokeyAdminClient.UpdateAutokeyConfig(request);

UpdateAutokeyConfigAsync(AutokeyConfig, FieldMask, CallSettings)

public virtual Task<AutokeyConfig> UpdateAutokeyConfigAsync(AutokeyConfig autokeyConfig, FieldMask updateMask, 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
autokeyConfig	AutokeyConfig Required. [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] with values to update.
updateMask	FieldMask Required. Masks which fields of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] to update, e.g. keyProject.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAutokeyConfig	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
AutokeyConfig autokeyConfig = new AutokeyConfig();
FieldMask updateMask = new FieldMask();
// Make the request
AutokeyConfig response = await autokeyAdminClient.UpdateAutokeyConfigAsync(autokeyConfig, updateMask);

UpdateAutokeyConfigAsync(AutokeyConfig, FieldMask, CancellationToken)

public virtual Task<AutokeyConfig> UpdateAutokeyConfigAsync(AutokeyConfig autokeyConfig, FieldMask updateMask, CancellationToken cancellationToken)

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
autokeyConfig	AutokeyConfig Required. [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] with values to update.
updateMask	FieldMask Required. Masks which fields of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] to update, e.g. keyProject.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAutokeyConfig	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
AutokeyConfig autokeyConfig = new AutokeyConfig();
FieldMask updateMask = new FieldMask();
// Make the request
AutokeyConfig response = await autokeyAdminClient.UpdateAutokeyConfigAsync(autokeyConfig, updateMask);

UpdateAutokeyConfigAsync(UpdateAutokeyConfigRequest, CallSettings)

public virtual 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.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
UpdateAutokeyConfigRequest request = new UpdateAutokeyConfigRequest
{
    AutokeyConfig = new AutokeyConfig(),
    UpdateMask = new FieldMask(),
};
// Make the request
AutokeyConfig response = await autokeyAdminClient.UpdateAutokeyConfigAsync(request);

UpdateAutokeyConfigAsync(UpdateAutokeyConfigRequest, CancellationToken)

public virtual Task<AutokeyConfig> UpdateAutokeyConfigAsync(UpdateAutokeyConfigRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAutokeyConfig	A Task containing the RPC response.

Example

// Create client
AutokeyAdminClient autokeyAdminClient = await AutokeyAdminClient.CreateAsync();
// Initialize request argument(s)
UpdateAutokeyConfigRequest request = new UpdateAutokeyConfigRequest
{
    AutokeyConfig = new AutokeyConfig(),
    UpdateMask = new FieldMask(),
};
// Make the request
AutokeyConfig response = await autokeyAdminClient.UpdateAutokeyConfigAsync(request);