Class KeyHandle (2.79.0)
Version 2.79.0keyboard_arrow_down
public final class KeyHandle extends GeneratedMessageV3 implements KeyHandleOrBuilder
Resource-oriented representation of a request to Cloud KMS Autokey and the
resulting provisioning of a CryptoKey .
Protobuf type google.cloud.kms.v1.KeyHandle
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
KMS_KEY_FIELD_NUMBER
public static final int KMS_KEY_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
RESOURCE_TYPE_SELECTOR_FIELD_NUMBER
public static final int RESOURCE_TYPE_SELECTOR_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static KeyHandle getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static KeyHandle . Builder newBuilder ()
newBuilder(KeyHandle prototype)
public static KeyHandle . Builder newBuilder ( KeyHandle prototype )
Parameter
Name Description
prototypeKeyHandle
public static KeyHandle parseDelimitedFrom ( InputStream input )
public static KeyHandle parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static KeyHandle parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static KeyHandle parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static KeyHandle parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static KeyHandle parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static KeyHandle parseFrom ( CodedInputStream input )
public static KeyHandle parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static KeyHandle parseFrom ( InputStream input )
public static KeyHandle parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static KeyHandle parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static KeyHandle parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<KeyHandle> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public KeyHandle getDefaultInstanceForType ()
getKmsKey()
public String getKmsKey ()
Output only. Name of a CryptoKey that has
been provisioned for Customer Managed Encryption Key (CMEK) use in the
KeyHandle project and location for the
requested resource type. The CryptoKey
project will reflect the value configured in the
AutokeyConfig on the resource
project's ancestor folder at the time of the
KeyHandle creation. If more than one
ancestor folder has a configured
AutokeyConfig , the nearest of these
configurations is used.
string kms_key = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns
Type Description
String The kmsKey.
getKmsKeyBytes()
public ByteString getKmsKeyBytes ()
Output only. Name of a CryptoKey that has
been provisioned for Customer Managed Encryption Key (CMEK) use in the
KeyHandle project and location for the
requested resource type. The CryptoKey
project will reflect the value configured in the
AutokeyConfig on the resource
project's ancestor folder at the time of the
KeyHandle creation. If more than one
ancestor folder has a configured
AutokeyConfig , the nearest of these
configurations is used.
string kms_key = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns
Type Description
ByteString The bytes for kmsKey.
getName()
Identifier. Name of the KeyHandle
resource, e.g.
projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
Identifier. Name of the KeyHandle
resource, e.g.
projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns
Type Description
ByteString The bytes for name.
getParserForType()
public Parser<KeyHandle> getParserForType ()
Overrides
getResourceTypeSelector()
public String getResourceTypeSelector ()
Required. Indicates the resource type that the resulting
CryptoKey is meant to protect, e.g.
{SERVICE}.googleapis.com/{TYPE}. See documentation for supported resource
types.
string resource_type_selector = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The resourceTypeSelector.
getResourceTypeSelectorBytes()
public ByteString getResourceTypeSelectorBytes ()
Required. Indicates the resource type that the resulting
CryptoKey is meant to protect, e.g.
{SERVICE}.googleapis.com/{TYPE}. See documentation for supported resource
types.
string resource_type_selector = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for resourceTypeSelector.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public KeyHandle . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected KeyHandle . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public KeyHandle . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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."],[],[]]
