target.apidocs.com.google.api.services.compute.model.CustomerEncryptionKey.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20250320-2.0.0

Show newest version







CustomerEncryptionKey (Compute Engine API v1-rev20250107-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class CustomerEncryptionKey



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.CustomerEncryptionKey













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class CustomerEncryptionKey
extends com.google.api.client.json.GenericJson
Model definition for CustomerEncryptionKey.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


CustomerEncryptionKey() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CustomerEncryptionKey
clone() 


String
getKmsKeyName()
The name of the encryption key that is stored in Google Cloud KMS.



String
getKmsKeyServiceAccount()
The service account being used for the encryption request for the given KMS key.



String
getRawKey()
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either
 encrypt or decrypt this resource.



String
getRsaEncryptedKey()
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to
 either encrypt or decrypt this resource.



String
getSha256()
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
 that protects this resource.



CustomerEncryptionKey
set(String fieldName,
   Object value) 


CustomerEncryptionKey
setKmsKeyName(String kmsKeyName)
The name of the encryption key that is stored in Google Cloud KMS.



CustomerEncryptionKey
setKmsKeyServiceAccount(String kmsKeyServiceAccount)
The service account being used for the encryption request for the given KMS key.



CustomerEncryptionKey
setRawKey(String rawKey)
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either
 encrypt or decrypt this resource.



CustomerEncryptionKey
setRsaEncryptedKey(String rsaEncryptedKey)
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to
 either encrypt or decrypt this resource.



CustomerEncryptionKey
setSha256(String sha256)
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
 that protects this resource.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





CustomerEncryptionKey
public CustomerEncryptionKey()









Method Detail





getKmsKeyName
public String getKmsKeyName()
The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName":
 "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-
 qualifed key name may be returned for resource GET requests. For example: "kmsKeyName":
 "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key
 /cryptoKeyVersions/1

Returns:
value or null for none








setKmsKeyName
public CustomerEncryptionKey setKmsKeyName(String kmsKeyName)
The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName":
 "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-
 qualifed key name may be returned for resource GET requests. For example: "kmsKeyName":
 "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key
 /cryptoKeyVersions/1

Parameters:
kmsKeyName - kmsKeyName or null for none








getKmsKeyServiceAccount
public String getKmsKeyServiceAccount()
The service account being used for the encryption request for the given KMS key. If absent, the
 Compute Engine default service account is used. For example: "kmsKeyServiceAccount":
 "name@project_id.iam.gserviceaccount.com/

Returns:
value or null for none








setKmsKeyServiceAccount
public CustomerEncryptionKey setKmsKeyServiceAccount(String kmsKeyServiceAccount)
The service account being used for the encryption request for the given KMS key. If absent, the
 Compute Engine default service account is used. For example: "kmsKeyServiceAccount":
 "name@project_id.iam.gserviceaccount.com/

Parameters:
kmsKeyServiceAccount - kmsKeyServiceAccount or null for none








getRawKey
public String getRawKey()
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either
 encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For
 example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

Returns:
value or null for none








setRawKey
public CustomerEncryptionKey setRawKey(String rawKey)
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either
 encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For
 example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

Parameters:
rawKey - rawKey or null for none








getRsaEncryptedKey
public String getRsaEncryptedKey()
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to
 either encrypt or decrypt this resource. You can provide either the rawKey or the
 rsaEncryptedKey. For example: "rsaEncryptedKey":
 "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
 z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
 D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the
 following requirements before you can provide it to Compute Engine: 1. The key is wrapped using
 a RSA public key certificate provided by Google. 2. After being wrapped, the key must be
 encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
 https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Returns:
value or null for none








setRsaEncryptedKey
public CustomerEncryptionKey setRsaEncryptedKey(String rsaEncryptedKey)
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to
 either encrypt or decrypt this resource. You can provide either the rawKey or the
 rsaEncryptedKey. For example: "rsaEncryptedKey":
 "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
 z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
 D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the
 following requirements before you can provide it to Compute Engine: 1. The key is wrapped using
 a RSA public key certificate provided by Google. 2. After being wrapped, the key must be
 encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
 https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Parameters:
rsaEncryptedKey - rsaEncryptedKey or null for none








getSha256
public String getSha256()
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
 that protects this resource.

Returns:
value or null for none








setSha256
public CustomerEncryptionKey setSha256(String sha256)
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
 that protects this resource.

Parameters:
sha256 - sha256 or null for none








set
public CustomerEncryptionKey set(String fieldName,
                                 Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public CustomerEncryptionKey clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.

Modifier and Type	Method and Description
`CustomerEncryptionKey`	`clone()`
`String`	`getKmsKeyName()` The name of the encryption key that is stored in Google Cloud KMS.
`String`	`getKmsKeyServiceAccount()` The service account being used for the encryption request for the given KMS key.
`String`	`getRawKey()` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`String`	`getRsaEncryptedKey()` Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
`String`	`getSha256()` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`CustomerEncryptionKey`	`set(String fieldName, Object value)`
`CustomerEncryptionKey`	`setKmsKeyName(String kmsKeyName)` The name of the encryption key that is stored in Google Cloud KMS.
`CustomerEncryptionKey`	`setKmsKeyServiceAccount(String kmsKeyServiceAccount)` The service account being used for the encryption request for the given KMS key.
`CustomerEncryptionKey`	`setRawKey(String rawKey)` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`CustomerEncryptionKey`	`setRsaEncryptedKey(String rsaEncryptedKey)` Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
`CustomerEncryptionKey`	`setSha256(String sha256)` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.