Class KeyHandle.Builder (2.57.0) 

public static final class KeyHandle.Builder extends GeneratedMessageV3.Builder<KeyHandle.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > KeyHandle.Builder

Implements

KeyHandleOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public KeyHandle.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
KeyHandle.Builder
Overrides

build()

public KeyHandle build()
Returns
Type Description
KeyHandle

buildPartial()

public KeyHandle buildPartial()
Returns
Type Description
KeyHandle

clear()

public KeyHandle.Builder clear()
Returns
Type Description
KeyHandle.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public KeyHandle.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
KeyHandle.Builder
Overrides

clearKmsKey()

public KeyHandle.Builder clearKmsKey()

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
KeyHandle.Builder

This builder for chaining.

clearName()

public KeyHandle.Builder clearName()

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
KeyHandle.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public KeyHandle.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
KeyHandle.Builder
Overrides

clearResourceTypeSelector()

public KeyHandle.Builder clearResourceTypeSelector()

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
KeyHandle.Builder

This builder for chaining.

clone()

public KeyHandle.Builder clone()
Returns
Type Description
KeyHandle.Builder
Overrides

getDefaultInstanceForType()

public KeyHandle getDefaultInstanceForType()
Returns
Type Description
KeyHandle

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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()

public String 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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(KeyHandle other)

public KeyHandle.Builder mergeFrom(KeyHandle other)
Parameter
Name Description
other KeyHandle
Returns
Type Description
KeyHandle.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public KeyHandle.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyHandle.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public KeyHandle.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
KeyHandle.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final KeyHandle.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
KeyHandle.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public KeyHandle.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
KeyHandle.Builder
Overrides

setKmsKey(String value)

public KeyHandle.Builder setKmsKey(String value)

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) = { ... }

Parameter
Name Description
value String

The kmsKey to set.
Returns
Type Description
KeyHandle.Builder

This builder for chaining.

setKmsKeyBytes(ByteString value)

public KeyHandle.Builder setKmsKeyBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for kmsKey to set.
Returns
Type Description
KeyHandle.Builder

This builder for chaining.

setName(String value)

public KeyHandle.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
KeyHandle.Builder

This builder for chaining.

setNameBytes(ByteString value)

public KeyHandle.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
KeyHandle.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public KeyHandle.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
KeyHandle.Builder
Overrides

setResourceTypeSelector(String value)

public KeyHandle.Builder setResourceTypeSelector(String value)

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];

Parameter
Name Description
value String

The resourceTypeSelector to set.
Returns
Type Description
KeyHandle.Builder

This builder for chaining.

setResourceTypeSelectorBytes(ByteString value)

public KeyHandle.Builder setResourceTypeSelectorBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for resourceTypeSelector to set.
Returns
Type Description
KeyHandle.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final KeyHandle.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
KeyHandle.Builder
Overrides