Class AutokeyConfig.Builder (2.55.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AutokeyConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AutokeyConfig.Builder
Overrides

build()

public AutokeyConfig build()
Returns
TypeDescription
AutokeyConfig

buildPartial()

public AutokeyConfig buildPartial()
Returns
TypeDescription
AutokeyConfig

clear()

public AutokeyConfig.Builder clear()
Returns
TypeDescription
AutokeyConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AutokeyConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
AutokeyConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AutokeyConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AutokeyConfig.Builder
Overrides

clearState()

public AutokeyConfig.Builder clearState()

Output only. The state for the AutokeyConfig.

.google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
AutokeyConfig.Builder

This builder for chaining.

clone()

public AutokeyConfig.Builder clone()
Returns
TypeDescription
AutokeyConfig.Builder
Overrides

getDefaultInstanceForType()

public AutokeyConfig getDefaultInstanceForType()
Returns
TypeDescription
AutokeyConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getState()

public AutokeyConfig.State getState()

Output only. The state for the AutokeyConfig.

.google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
AutokeyConfig.State

The state.

getStateValue()

public int getStateValue()

Output only. The state for the AutokeyConfig.

.google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AutokeyConfig other)

public AutokeyConfig.Builder mergeFrom(AutokeyConfig other)
Parameter
NameDescription
otherAutokeyConfig
Returns
TypeDescription
AutokeyConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AutokeyConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutokeyConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AutokeyConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AutokeyConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AutokeyConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AutokeyConfig.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public AutokeyConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The keyProject to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for keyProject to set.

Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AutokeyConfig.Builder
Overrides

setState(AutokeyConfig.State value)

public AutokeyConfig.Builder setState(AutokeyConfig.State value)

Output only. The state for the AutokeyConfig.

.google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueAutokeyConfig.State

The state to set.

Returns
TypeDescription
AutokeyConfig.Builder

This builder for chaining.

setStateValue(int value)

public AutokeyConfig.Builder setStateValue(int value)

Output only. The state for the AutokeyConfig.

.google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
AutokeyConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AutokeyConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AutokeyConfig.Builder
Overrides