- 2.84.0 (latest)
- 2.83.0
- 2.81.0
- 2.79.0
- 2.78.0
- 2.77.0
- 2.76.0
- 2.75.0
- 2.73.0
- 2.71.0
- 2.70.0
- 2.67.0
- 2.66.0
- 2.65.0
- 2.63.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.8
- 2.5.3
- 2.4.4
- 2.3.1
Package com.google.cloud.kms.v1 (2.83.0)
| GitHub Repository |
Client Classes
Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.
| Client | Description |
|---|---|
| com. |
Service Description: 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 |
| com. |
Service Description: Provides interfaces for using Cloud KMS Autokey to provision new CryptoKeys, ready for Customer Managed Encryption Key (CMEK) use, on-demand. To support certain client tooling, this feature is modeled around a |
| com. |
Service Description: Google Cloud Key Management EKM Service
Manages external cryptographic keys and operations using those keys. Implements a REST model with the following objects: |
| com. |
Service Description: Google Cloud Key Management Service
Manages cryptographic keys and operations using those keys. Implements a REST model with the following objects: |
Settings Classes
Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.
| Settings | Description |
|---|---|
| com. |
Settings class to configure an instance of AutokeyAdminClient.
The default instance has everything set to sensible defaults: |
| com. |
Settings class to configure an instance of AutokeyClient.
The default instance has everything set to sensible defaults: |
| com. |
Settings class to configure an instance of EkmServiceClient.
The default instance has everything set to sensible defaults: |
| com. |
Settings class to configure an instance of KeyManagementServiceClient.
The default instance has everything set to sensible defaults: |
Classes
| Class | Description |
|---|---|
| com. |
Request message for KeyManagementService.AsymmetricDecrypt. |
| com. |
Request message for KeyManagementService.AsymmetricDecrypt. |
| com. |
Response message for KeyManagementService.AsymmetricDecrypt. |
| com. |
Response message for KeyManagementService.AsymmetricDecrypt. |
| com. |
Request message for KeyManagementService.AsymmetricSign. |
| com. |
Request message for KeyManagementService.AsymmetricSign. |
| com. |
Response message for KeyManagementService.AsymmetricSign. |
| com. |
Response message for KeyManagementService.AsymmetricSign. |
| com. |
|
| com. |
|
| com. |
|
| com. |
Provides interfaces for managing Cloud KMS Autokey folder-level configurations. A configuration is inherited by all descendent projects. A |
| com. |
Base class for the server implementation of the service AutokeyAdmin. Provides interfaces for managing Cloud KMS |
| com. |
|
| com. |
Builder for AutokeyAdminSettings. |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
Cloud KMS Autokey configuration for a folder. |
| com. |
Cloud KMS Autokey configuration for a folder. |
| com. |
|
| com. |
Builder for folders/{folder}/autokeyConfig. |
| com. |
Provides interfaces for using Cloud KMS Autokey to provision new CryptoKeys, ready for Customer Managed |
| com. |
Base class for the server implementation of the service Autokey. Provides interfaces for using Cloud KMS |
| com. |
|
| com. |
Builder for AutokeySettings. |
| com. |
A Certificate represents an X.509 certificate used to authenticate HTTPS connections to EKM replicas. |
| com. |
A Certificate represents an X.509 certificate used to authenticate HTTPS connections to EKM replicas. |
| com. |
Data with integrity verification field. |
| com. |
Data with integrity verification field. |
| com. |
Request message for KeyManagementService.CreateCryptoKey. |
| com. |
Request message for KeyManagementService.CreateCryptoKey. |
| com. |
Request message for KeyManagementService.CreateCryptoKeyVersion. |
| com. |
Request message for KeyManagementService.CreateCryptoKeyVersion. |
| com. |
Request message for EkmService.CreateEkmConnection. |
| com. |
Request message for EkmService.CreateEkmConnection. |
| com. |
Request message for KeyManagementService.CreateImportJob. |
| com. |
Request message for KeyManagementService.CreateImportJob. |
| com. |
Metadata message for CreateKeyHandle long-running operation response. |
| com. |
Metadata message for CreateKeyHandle long-running operation response. |
| com. |
Request message for Autokey.CreateKeyHandle. |
| com. |
Request message for Autokey.CreateKeyHandle. |
| com. |
Request message for KeyManagementService.CreateKeyRing. |
| com. |
Request message for KeyManagementService.CreateKeyRing. |
| com. |
A CryptoKey represents a logical key that can be used for cryptographic operations. |
| com. |
A CryptoKey represents a logical key that can be used for cryptographic operations. |
| com. |
|
| com. |
Builder for projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. |
| com. |
AUTO-GENERATED DOCUMENTATION AND CLASS |
| com. |
Builder for CryptoKeyPathName. |
| com. |
A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. |
| com. |
A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. |
| com. |
|
| com. |
Builder for projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}. |
| com. |
A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually |
| com. |
A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually |
| com. |
Request message for KeyManagementService.Decapsulate. |
| com. |
Request message for KeyManagementService.Decapsulate. |
| com. |
Response message for KeyManagementService.Decapsulate. |
| com. |
Response message for KeyManagementService.Decapsulate. |
| com. |
Request message for KeyManagementService.Decrypt. |
| com. |
Request message for KeyManagementService.Decrypt. |
| com. |
Response message for KeyManagementService.Decrypt. |
| com. |
Response message for KeyManagementService.Decrypt. |
| com. |
Request message for KeyManagementService.DestroyCryptoKeyVersion. |
| com. |
Request message for KeyManagementService.DestroyCryptoKeyVersion. |
| com. |
A Digest holds a cryptographic message digest. |
| com. |
A Digest holds a cryptographic message digest. |
| com. |
An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and |
| com. |
An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and |
| com. |
|
| com. |
Builder for projects/{project}/locations/{location}/ekmConfig. |
| com. |
An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and |
| com. |
An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and |
| com. |
A ServiceResolver represents an EKM replica that can be reached within an EkmConnection. |
| com. |
A ServiceResolver represents an EKM replica that can be reached within an EkmConnection. |
| com. |
|
| com. |
Builder for projects/{project}/locations/{location}/ekmConnections/{ekm_connection}. |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
Google Cloud Key Management EKM Service Manages external cryptographic keys and operations using those keys. Implements a REST model with the following objects: |
| com. |
Base class for the server implementation of the service EkmService. Google Cloud Key Management EKM Service |
| com. |
|
| com. |
Builder for EkmServiceSettings. |
| com. |
Request message for KeyManagementService.Encrypt. |
| com. |
Request message for KeyManagementService.Encrypt. |
| com. |
Response message for KeyManagementService.Encrypt. |
| com. |
Response message for KeyManagementService.Encrypt. |
| com. |
ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL |
| com. |
ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL |
| com. |
Request message for KeyManagementService.GenerateRandomBytes. |
| com. |
Request message for KeyManagementService.GenerateRandomBytes. |
| com. |
Response message for KeyManagementService.GenerateRandomBytes. |
| com. |
Response message for KeyManagementService.GenerateRandomBytes. |
| com. |
Request message for GetAutokeyConfig. |
| com. |
Request message for GetAutokeyConfig. |
| com. |
Request message for KeyManagementService.GetCryptoKey. |
| com. |
Request message for KeyManagementService.GetCryptoKey. |
| com. |
Request message for KeyManagementService.GetCryptoKeyVersion. |
| com. |
Request message for KeyManagementService.GetCryptoKeyVersion. |
| com. |
Request message for EkmService.GetEkmConfig. |
| com. |
Request message for EkmService.GetEkmConfig. |
| com. |
Request message for EkmService.GetEkmConnection. |
| com. |
Request message for EkmService.GetEkmConnection. |
| com. |
Request message for KeyManagementService.GetImportJob. |
| com. |
Request message for KeyManagementService.GetImportJob. |
| com. |
Request message for GetKeyHandle. |
| com. |
Request message for GetKeyHandle. |
| com. |
Request message for KeyManagementService.GetKeyRing. |
| com. |
Request message for KeyManagementService.GetKeyRing. |
| com. |
Request message for KeyManagementService.GetPublicKey. |
| com. |
Request message for KeyManagementService.GetPublicKey. |
| com. |
Request message for KeyManagementService.ImportCryptoKeyVersion. |
| com. |
Request message for KeyManagementService.ImportCryptoKeyVersion. |
| com. |
An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing |
| com. |
An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing |
| com. |
The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. |
| com. |
The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. |
| com. |
|
| com. |
Builder for projects/{project}/locations/{location}/keyRings/{key_ring}/importJobs/{import_job}. |
| com. |
A KeyAccessJustificationsPolicy specifies zero or more allowed |
| com. |
A KeyAccessJustificationsPolicy specifies zero or more allowed |
| com. |
Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a CryptoKey. |
| com. |
Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a CryptoKey. |
| com. |
|
| com. |
Builder for projects/{project}/locations/{location}/keyHandles/{key_handle}. |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
Google Cloud Key Management Service Manages cryptographic keys and operations using those keys. Implements a REST model with the following objects: |
| com. |
Base class for the server implementation of the service KeyManagementService. Google Cloud Key Management Service |
| com. |
Builder for KeyManagementServiceSettings. |
| com. |
AUTO-GENERATED DOCUMENTATION AND CLASS |
| com. |
Deprecated. This resource name class will be removed in the next major version. AUTO-GENERATED DOCUMENTATION AND CLASS |
| com. |
Contains an HSM-generated attestation about a key operation. For more information, see Verifying attestations. |
| com. |
Contains an HSM-generated attestation about a key operation. For more information, see Verifying attestations. |
| com. |
Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. |
| com. |
Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. |
| com. |
A KeyRing is a toplevel logical grouping of CryptoKeys. |
| com. |
A KeyRing is a toplevel logical grouping of CryptoKeys. |
| com. |
|
| com. |
Builder for projects/{project}/locations/{location}/keyRings/{key_ring}. |
| com. |
|
| com. |
|
| com. |
Request message for KeyManagementService.ListCryptoKeyVersions. |
| com. |
Request message for KeyManagementService.ListCryptoKeyVersions. |
| com. |
Response message for KeyManagementService.ListCryptoKeyVersions. |
| com. |
Response message for KeyManagementService.ListCryptoKeyVersions. |
| com. |
Request message for KeyManagementService.ListCryptoKeys. |
| com. |
Request message for KeyManagementService.ListCryptoKeys. |
| com. |
Response message for KeyManagementService.ListCryptoKeys. |
| com. |
Response message for KeyManagementService.ListCryptoKeys. |
| com. |
Request message for EkmService.ListEkmConnections. |
| com. |
Request message for EkmService.ListEkmConnections. |
| com. |
Response message for EkmService.ListEkmConnections. |
| com. |
Response message for EkmService.ListEkmConnections. |
| com. |
Request message for KeyManagementService.ListImportJobs. |
| com. |
Request message for KeyManagementService.ListImportJobs. |
| com. |
Response message for KeyManagementService.ListImportJobs. |
| com. |
Response message for KeyManagementService.ListImportJobs. |
| com. |
Request message for Autokey.ListKeyHandles. |
| com. |
Request message for Autokey.ListKeyHandles. |
| com. |
Response message for Autokey.ListKeyHandles. |
| com. |
Response message for Autokey.ListKeyHandles. |
| com. |
Request message for KeyManagementService.ListKeyRings. |
| com. |
Request message for KeyManagementService.ListKeyRings. |
| com. |
Response message for KeyManagementService.ListKeyRings. |
| com. |
Response message for KeyManagementService.ListKeyRings. |
| com. |
Cloud KMS metadata for the given google.cloud.location.Location. |
| com. |
Cloud KMS metadata for the given google.cloud.location.Location. |
| com. |
|
| com. |
Builder for projects/{project}/locations/{location}. |
| com. |
Request message for KeyManagementService.MacSign. |
| com. |
Request message for KeyManagementService.MacSign. |
| com. |
Response message for KeyManagementService.MacSign. |
| com. |
Response message for KeyManagementService.MacSign. |
| com. |
Request message for KeyManagementService.MacVerify. |
| com. |
Request message for KeyManagementService.MacVerify. |
| com. |
Response message for KeyManagementService.MacVerify. |
| com. |
Response message for KeyManagementService.MacVerify. |
| com. |
|
| com. |
Builder for projects/{project}. |
| com. |
The public keys for a given CryptoKeyVersion. Obtained via GetPublicKey. |
| com. |
The public keys for a given CryptoKeyVersion. Obtained via GetPublicKey. |
| com. |
Request message for KeyManagementService.RawDecrypt. |
| com. |
Request message for KeyManagementService.RawDecrypt. |
| com. |
Response message for KeyManagementService.RawDecrypt. |
| com. |
Response message for KeyManagementService.RawDecrypt. |
| com. |
Request message for KeyManagementService.RawEncrypt. |
| com. |
Request message for KeyManagementService.RawEncrypt. |
| com. |
Response message for KeyManagementService.RawEncrypt. |
| com. |
Response message for KeyManagementService.RawEncrypt. |
| com. |
Request message for KeyManagementService.RestoreCryptoKeyVersion. |
| com. |
Request message for KeyManagementService.RestoreCryptoKeyVersion. |
| com. |
Request message for ShowEffectiveAutokeyConfig. |
| com. |
Request message for ShowEffectiveAutokeyConfig. |
| com. |
Response message for ShowEffectiveAutokeyConfig. |
| com. |
Response message for ShowEffectiveAutokeyConfig. |
| com. |
Deprecated. This resource name class will be removed in the next major version. AUTO-GENERATED DOCUMENTATION AND CLASS |
| com. |
Request message for UpdateAutokeyConfig. |
| com. |
Request message for UpdateAutokeyConfig. |
| com. |
Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion. |
| com. |
Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion. |
| com. |
Request message for KeyManagementService.UpdateCryptoKey. |
| com. |
Request message for KeyManagementService.UpdateCryptoKey. |
| com. |
Request message for KeyManagementService.UpdateCryptoKeyVersion. |
| com. |
Request message for KeyManagementService.UpdateCryptoKeyVersion. |
| com. |
Request message for EkmService.UpdateEkmConfig. |
| com. |
Request message for EkmService.UpdateEkmConfig. |
| com. |
Request message for EkmService.UpdateEkmConnection. |
| com. |
Request message for EkmService.UpdateEkmConnection. |
| com. |
Request message for EkmService.VerifyConnectivity. |
| com. |
Request message for EkmService.VerifyConnectivity. |
| com. |
Response message for EkmService.VerifyConnectivity. |
| com. |
Response message for EkmService.VerifyConnectivity. |
Interfaces
Enums
| Enum | Description |
|---|---|
| com. |
Describes the reason for a data access. Please refer to https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes for the detailed semantic meaning of justification reason codes. |
| com. |
The states AutokeyConfig can be in. |
| com. |
CryptoKeyPurpose describes the cryptographic capabilities of a CryptoKey. A given key can only be used |
| com. |
|
| com. |
The algorithm of the CryptoKeyVersion, indicating what parameters must be used for each cryptographic operation. |
| com. |
The state of a CryptoKeyVersion, indicating if it can be used. |
| com. |
A view for CryptoKeyVersions. Controls the level of detail returned for CryptoKeyVersions in |
| com. |
|
| com. |
KeyManagementMode describes who can perform control plane cryptographic operations using this EkmConnection. |
| com. |
|
| com. |
The state of the ImportJob, indicating if it can be used. |
| com. |
ImportMethod describes the key wrapping method chosen for this ImportJob. |
| com. |
Attestation formats provided by the HSM. |
| com. |
ProtectionLevel specifies how cryptographic operations are performed. For more information, see Protection levels. |
| com. |
The supported PublicKey formats. |