public final class KmsWrappedCryptoKey extends GeneratedMessage implements KmsWrappedCryptoKeyOrBuilderInclude 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > KmsWrappedCryptoKeyImplements
KmsWrappedCryptoKeyOrBuilderStatic Fields
CRYPTO_KEY_NAME_FIELD_NUMBER
public static final int CRYPTO_KEY_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
WRAPPED_KEY_FIELD_NUMBER
public static final int WRAPPED_KEY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static KmsWrappedCryptoKey getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static KmsWrappedCryptoKey.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey.Builder |
|
newBuilder(KmsWrappedCryptoKey prototype)
public static KmsWrappedCryptoKey.Builder newBuilder(KmsWrappedCryptoKey prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
KmsWrappedCryptoKey |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey.Builder |
|
parseDelimitedFrom(InputStream input)
public static KmsWrappedCryptoKey parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static KmsWrappedCryptoKey parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static KmsWrappedCryptoKey parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static KmsWrappedCryptoKey parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static KmsWrappedCryptoKey parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static KmsWrappedCryptoKey parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static KmsWrappedCryptoKey parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static KmsWrappedCryptoKey parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static KmsWrappedCryptoKey parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static KmsWrappedCryptoKey parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static KmsWrappedCryptoKey parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static KmsWrappedCryptoKey parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<KmsWrappedCryptoKey> parser()| Returns | |
|---|---|
| Type | Description |
Parser<KmsWrappedCryptoKey> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey |
|
getParserForType()
public Parser<KmsWrappedCryptoKey> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<KmsWrappedCryptoKey> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getWrappedKey()
public ByteString getWrappedKey()Required. The wrapped data crypto key.
bytes wrapped_key = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The wrappedKey. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public KmsWrappedCryptoKey.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected KmsWrappedCryptoKey.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey.Builder |
|
toBuilder()
public KmsWrappedCryptoKey.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
KmsWrappedCryptoKey.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|