com.google.cloud.kms.v1

Class KeyHandle.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>

com.google.cloud.kms.v1.KeyHandle.Builder

All Implemented Interfaces:

KeyHandleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

KeyHandle

public static final class KeyHandle.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>
implements KeyHandleOrBuilder

 Resource-oriented representation of a request to Cloud KMS Autokey and the
 resulting provisioning of a [CryptoKey][google.cloud.kms.v1.CryptoKey].
 

Protobuf type google.cloud.kms.v1.KeyHandle

Method Summary

Modifier and Type	Method and Description
KeyHandle.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
KeyHandle	build()
KeyHandle	buildPartial()
KeyHandle.Builder	clear()
KeyHandle.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
KeyHandle.Builder	clearKmsKey() Output only.
KeyHandle.Builder	clearName() Identifier.
KeyHandle.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
KeyHandle.Builder	clearResourceTypeSelector() Required.
KeyHandle.Builder	clone()
KeyHandle	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
KeyHandle.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
KeyHandle.Builder	mergeFrom(KeyHandle other)
KeyHandle.Builder	mergeFrom(com.google.protobuf.Message other)
KeyHandle.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
KeyHandle.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
KeyHandle.Builder	setKmsKey(String value) Output only.
KeyHandle.Builder	setKmsKeyBytes(com.google.protobuf.ByteString value) Output only.
KeyHandle.Builder	setName(String value) Identifier.
KeyHandle.Builder	setNameBytes(com.google.protobuf.ByteString value) Identifier.
KeyHandle.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
KeyHandle.Builder	setResourceTypeSelector(String value) Required.
KeyHandle.Builder	setResourceTypeSelectorBytes(com.google.protobuf.ByteString value) Required.
KeyHandle.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>

clear

public KeyHandle.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>

getDefaultInstanceForType

public KeyHandle getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public KeyHandle build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public KeyHandle buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public KeyHandle.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>

setField

public KeyHandle.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                  Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>

clearField

public KeyHandle.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>

clearOneof

public KeyHandle.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>

setRepeatedField

public KeyHandle.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          int index,
                                          Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>

addRepeatedField

public KeyHandle.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>

mergeFrom

public KeyHandle.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KeyHandle.Builder>

mergeFrom

public KeyHandle.Builder mergeFrom(KeyHandle other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>

mergeFrom

public KeyHandle.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KeyHandle.Builder>

Throws:

IOException

getName

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

Specified by:

getName in interface KeyHandleOrBuilder

Returns:

The name.

getNameBytes

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

Specified by:

getNameBytes in interface KeyHandleOrBuilder

Returns:

The bytes for name.

setName

public KeyHandle.Builder setName(String value)

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

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public KeyHandle.Builder clearName()

 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:

This builder for chaining.

setNameBytes

public KeyHandle.Builder setNameBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

getKmsKey

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

Specified by:

getKmsKey in interface KeyHandleOrBuilder

Returns:

The kmsKey.

getKmsKeyBytes

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

Specified by:

getKmsKeyBytes in interface KeyHandleOrBuilder

Returns:

The bytes for kmsKey.

setKmsKey

public KeyHandle.Builder setKmsKey(String value)

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

Parameters:

value - The kmsKey to set.

Returns:

This builder for chaining.

clearKmsKey

public KeyHandle.Builder clearKmsKey()

 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:

This builder for chaining.

setKmsKeyBytes

public KeyHandle.Builder setKmsKeyBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for kmsKey to set.

Returns:

This builder for chaining.

getResourceTypeSelector

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

Specified by:

getResourceTypeSelector in interface KeyHandleOrBuilder

Returns:

The resourceTypeSelector.

getResourceTypeSelectorBytes

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

Specified by:

getResourceTypeSelectorBytes in interface KeyHandleOrBuilder

Returns:

The bytes for resourceTypeSelector.

setResourceTypeSelector

public KeyHandle.Builder setResourceTypeSelector(String value)

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

Parameters:

value - The resourceTypeSelector to set.

Returns:

This builder for chaining.

clearResourceTypeSelector

public KeyHandle.Builder clearResourceTypeSelector()

 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:

This builder for chaining.

setResourceTypeSelectorBytes

public KeyHandle.Builder setResourceTypeSelectorBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for resourceTypeSelector to set.

Returns:

This builder for chaining.

setUnknownFields

public final KeyHandle.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>

mergeUnknownFields

public final KeyHandle.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<KeyHandle.Builder>