Show / Hide Table of Contents

Namespace Google.Apis.CloudKMS.v1

Classes

CloudKMSBaseServiceRequest<TResponse>

A base abstract class for CloudKMS requests.

CloudKMSService

The CloudKMS Service.

CloudKMSService.Scope

Available OAuth 2.0 scopes for use with the Cloud Key Management Service (KMS) API.

CloudKMSService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Cloud Key Management Service (KMS) API.

ProjectsResource

The "projects" collection of methods.

ProjectsResource.LocationsResource

The "locations" collection of methods.

ProjectsResource.LocationsResource.EkmConfigResource

The "ekmConfig" collection of methods.

ProjectsResource.LocationsResource.EkmConfigResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.EkmConfigResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.EkmConfigResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.EkmConnectionsResource

The "ekmConnections" collection of methods.

ProjectsResource.LocationsResource.EkmConnectionsResource.CreateRequest

Creates a new EkmConnection in a given Project and Location.

ProjectsResource.LocationsResource.EkmConnectionsResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.EkmConnectionsResource.GetRequest

Returns metadata for a given EkmConnection.

ProjectsResource.LocationsResource.EkmConnectionsResource.ListRequest

Lists EkmConnections.

ProjectsResource.LocationsResource.EkmConnectionsResource.PatchRequest

Updates an EkmConnection's metadata.

ProjectsResource.LocationsResource.EkmConnectionsResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.EkmConnectionsResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.EkmConnectionsResource.VerifyConnectivityRequest

Verifies that Cloud KMS can successfully connect to the external key manager specified by an EkmConnection. If there is an error connecting to the EKM, this method returns a FAILED_PRECONDITION status containing structured information as described at https://cloud.google.com/kms/docs/reference/ekm_errors.

ProjectsResource.LocationsResource.GenerateRandomBytesRequest

Generate random bytes using the Cloud KMS randomness source in the provided location.

ProjectsResource.LocationsResource.GetEkmConfigRequest

Returns the EkmConfig singleton resource for a given project and location.

ProjectsResource.LocationsResource.GetRequest

Gets information about a location.

ProjectsResource.LocationsResource.KeyRingsResource

The "keyRings" collection of methods.

ProjectsResource.LocationsResource.KeyRingsResource.CreateRequest

Create a new KeyRing in a given Project and Location.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource

The "cryptoKeys" collection of methods.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CreateRequest

Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource

The "cryptoKeyVersions" collection of methods.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.AsymmetricDecryptRequest

Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.AsymmetricSignRequest

Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.CreateRequest

Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.DestroyRequest

Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.GetPublicKeyRequest

Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.GetRequest

Returns metadata for a given CryptoKeyVersion.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.ImportRequest

Import wrapped key material into a CryptoKeyVersion. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.ListRequest

Lists CryptoKeyVersions.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.MacSignRequest

Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.MacVerifyRequest

Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.PatchRequest

Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.RestoreRequest

Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.DecryptRequest

Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.EncryptRequest

Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.GetRequest

Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.ListRequest

Lists CryptoKeys.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.PatchRequest

Update a CryptoKey.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.UpdatePrimaryVersionRequest

Update the version of a CryptoKey that will be used in Encrypt. Returns an error if called on a key whose purpose is not ENCRYPT_DECRYPT.

ProjectsResource.LocationsResource.KeyRingsResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.KeyRingsResource.GetRequest

Returns metadata for a given KeyRing.

ProjectsResource.LocationsResource.KeyRingsResource.ImportJobsResource

The "importJobs" collection of methods.

ProjectsResource.LocationsResource.KeyRingsResource.ImportJobsResource.CreateRequest

Create a new ImportJob within a KeyRing. ImportJob.import_method is required.

ProjectsResource.LocationsResource.KeyRingsResource.ImportJobsResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.KeyRingsResource.ImportJobsResource.GetRequest

Returns metadata for a given ImportJob.

ProjectsResource.LocationsResource.KeyRingsResource.ImportJobsResource.ListRequest

Lists ImportJobs.

ProjectsResource.LocationsResource.KeyRingsResource.ImportJobsResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.KeyRingsResource.ImportJobsResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.KeyRingsResource.ListRequest

Lists KeyRings.

ProjectsResource.LocationsResource.KeyRingsResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.KeyRingsResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.ListRequest

Lists information about the supported locations for this service.

ProjectsResource.LocationsResource.UpdateEkmConfigRequest

Updates the EkmConfig singleton resource for a given project and location.

Enums

CloudKMSBaseServiceRequest<TResponse>.AltEnum

Data format for response.

CloudKMSBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.ListRequest.ViewEnum

The fields to include in the response.

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.ListRequest.VersionViewEnum

The fields of the primary version to include in the response.

In This Article
Back to top Generated by DocFX