Class KmsWrappedCryptoKey (3.5.0)
Version 3.5.0keyboard_arrow_down
public final class KmsWrappedCryptoKey extends GeneratedMessageV3 implements KmsWrappedCryptoKeyOrBuilder
Include to use an existing data crypto key wrapped by KMS.
The wrapped key must be a 128-, 192-, or 256-bit key.
Authorization requires the following IAM permissions when sending a request
to perform a crypto transformation using a KMS-wrapped crypto key:
dlp.kms.encrypt
For more information, see Creating a wrapped key .
Note: When you use Cloud KMS for cryptographic operations,
charges apply .
Protobuf type google.privacy.dlp.v2.KmsWrappedCryptoKey
Static Fields
CRYPTO_KEY_NAME_FIELD_NUMBER
public static final int CRYPTO_KEY_NAME_FIELD_NUMBER
Field Value
WRAPPED_KEY_FIELD_NUMBER
public static final int WRAPPED_KEY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static KmsWrappedCryptoKey getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static KmsWrappedCryptoKey . Builder newBuilder ()
Returns
newBuilder(KmsWrappedCryptoKey prototype)
public static KmsWrappedCryptoKey . Builder newBuilder ( KmsWrappedCryptoKey prototype )
Parameter
Returns
public static KmsWrappedCryptoKey parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static KmsWrappedCryptoKey parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static KmsWrappedCryptoKey parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static KmsWrappedCryptoKey parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static KmsWrappedCryptoKey parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static KmsWrappedCryptoKey parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static KmsWrappedCryptoKey parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static KmsWrappedCryptoKey parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static KmsWrappedCryptoKey parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static KmsWrappedCryptoKey parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static KmsWrappedCryptoKey parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static KmsWrappedCryptoKey parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<KmsWrappedCryptoKey> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getCryptoKeyName()
public String getCryptoKeyName ()
Required. The resource name of the KMS CryptoKey to use for unwrapping.
string crypto_key_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The cryptoKeyName.
getCryptoKeyNameBytes()
public ByteString getCryptoKeyNameBytes ()
Required. The resource name of the KMS CryptoKey to use for unwrapping.
string crypto_key_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for cryptoKeyName.
getDefaultInstanceForType()
public KmsWrappedCryptoKey getDefaultInstanceForType ()
Returns
getParserForType()
public Parser<KmsWrappedCryptoKey> getParserForType ()
Returns
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
getWrappedKey()
public ByteString getWrappedKey ()
Required. The wrapped data crypto key.
bytes wrapped_key = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public KmsWrappedCryptoKey . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected KmsWrappedCryptoKey . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public KmsWrappedCryptoKey . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
