Class AutokeyConfig.Builder (2.49.0) 

public static final class AutokeyConfig.Builder extends GeneratedMessageV3.Builder<AutokeyConfig.Builder> implements AutokeyConfigOrBuilder

Cloud KMS Autokey configuration for a folder.

Protobuf type google.cloud.kms.v1.AutokeyConfig

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public AutokeyConfig build()
Returns
Type Description
AutokeyConfig

buildPartial()

public AutokeyConfig buildPartial()
Returns
Type Description
AutokeyConfig

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearKeyProject()

public AutokeyConfig.Builder clearKeyProject()

Optional. Name of the key project, e.g. projects/{PROJECT_ID} or projects/{PROJECT_NUMBER}, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require cloudkms.cryptoKeys.setIamPolicy permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the cloudkms.admin role (or pertinent permissions). A request with an empty key project field will clear the configuration.

string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AutokeyConfig.Builder

This builder for chaining.

clearName()

public AutokeyConfig.Builder clearName()

Identifier. Name of the AutokeyConfig resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.

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

Returns
Type Description
AutokeyConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getDefaultInstanceForType()

public AutokeyConfig getDefaultInstanceForType()
Returns
Type Description
AutokeyConfig

getDescriptorForType()

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

getKeyProject()

public String getKeyProject()

Optional. Name of the key project, e.g. projects/{PROJECT_ID} or projects/{PROJECT_NUMBER}, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require cloudkms.cryptoKeys.setIamPolicy permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the cloudkms.admin role (or pertinent permissions). A request with an empty key project field will clear the configuration.

string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The keyProject.

getKeyProjectBytes()

public ByteString getKeyProjectBytes()

Optional. Name of the key project, e.g. projects/{PROJECT_ID} or projects/{PROJECT_NUMBER}, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require cloudkms.cryptoKeys.setIamPolicy permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the cloudkms.admin role (or pertinent permissions). A request with an empty key project field will clear the configuration.

string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for keyProject.

getName()

public String getName()

Identifier. Name of the AutokeyConfig resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Name of the AutokeyConfig resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.

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

Returns
Type Description
ByteString

The bytes for name.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AutokeyConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setKeyProject(String value)

public AutokeyConfig.Builder setKeyProject(String value)

Optional. Name of the key project, e.g. projects/{PROJECT_ID} or projects/{PROJECT_NUMBER}, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require cloudkms.cryptoKeys.setIamPolicy permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the cloudkms.admin role (or pertinent permissions). A request with an empty key project field will clear the configuration.

string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The keyProject to set.
Returns
Type Description
AutokeyConfig.Builder

This builder for chaining.

setKeyProjectBytes(ByteString value)

public AutokeyConfig.Builder setKeyProjectBytes(ByteString value)

Optional. Name of the key project, e.g. projects/{PROJECT_ID} or projects/{PROJECT_NUMBER}, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require cloudkms.cryptoKeys.setIamPolicy permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the cloudkms.admin role (or pertinent permissions). A request with an empty key project field will clear the configuration.

string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for keyProject to set.
Returns
Type Description
AutokeyConfig.Builder

This builder for chaining.

setName(String value)

public AutokeyConfig.Builder setName(String value)

Identifier. Name of the AutokeyConfig resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
AutokeyConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AutokeyConfig.Builder setNameBytes(ByteString value)

Identifier. Name of the AutokeyConfig resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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