com.google.cloud.kms.v1

Interface KeyHandleOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

KeyHandle, KeyHandle.Builder

public interface KeyHandleOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getKmsKey() Output only.
com.google.protobuf.ByteString	getKmsKeyBytes() Output only.
String	getName() Identifier.
com.google.protobuf.ByteString	getNameBytes() Identifier.
String	getResourceTypeSelector() Required.
com.google.protobuf.ByteString	getResourceTypeSelectorBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Identifier. Name of the [KeyHandle][google.cloud.kms.v1.KeyHandle]
 resource, e.g.
 `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.
 

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Identifier. Name of the [KeyHandle][google.cloud.kms.v1.KeyHandle]
 resource, e.g.
 `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.
 

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns:

The bytes for name.

getKmsKey

String getKmsKey()

 Output only. Name of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that has
 been provisioned for Customer Managed Encryption Key (CMEK) use in the
 [KeyHandle][google.cloud.kms.v1.KeyHandle] project and location for the
 requested resource type. The [CryptoKey][google.cloud.kms.v1.CryptoKey]
 project will reflect the value configured in the
 [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] on the resource
 project's ancestor folder at the time of the
 [KeyHandle][google.cloud.kms.v1.KeyHandle] creation. If more than one
 ancestor folder has a configured
 [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig], the nearest of these
 configurations is used.
 

string kms_key = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns:

The kmsKey.

getKmsKeyBytes

com.google.protobuf.ByteString getKmsKeyBytes()

 Output only. Name of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that has
 been provisioned for Customer Managed Encryption Key (CMEK) use in the
 [KeyHandle][google.cloud.kms.v1.KeyHandle] project and location for the
 requested resource type. The [CryptoKey][google.cloud.kms.v1.CryptoKey]
 project will reflect the value configured in the
 [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] on the resource
 project's ancestor folder at the time of the
 [KeyHandle][google.cloud.kms.v1.KeyHandle] creation. If more than one
 ancestor folder has a configured
 [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig], the nearest of these
 configurations is used.
 

string kms_key = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns:

The bytes for kmsKey.

getResourceTypeSelector

String getResourceTypeSelector()

 Required. Indicates the resource type that the resulting
 [CryptoKey][google.cloud.kms.v1.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:

The resourceTypeSelector.

getResourceTypeSelectorBytes

com.google.protobuf.ByteString getResourceTypeSelectorBytes()

 Required. Indicates the resource type that the resulting
 [CryptoKey][google.cloud.kms.v1.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:

The bytes for resourceTypeSelector.