Class KmsConfig.Builder (0.23.0)

public static final class KmsConfig.Builder extends GeneratedMessageV3.Builder<KmsConfig.Builder> implements KmsConfigOrBuilder

KmsConfig is the customer managed encryption key(CMEK) configuration.

Protobuf type google.cloud.netapp.v1.KmsConfig

Inheritance

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

Implements

KmsConfigOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public KmsConfig build()
Returns
Type Description
KmsConfig

buildPartial()

public KmsConfig buildPartial()
Returns
Type Description
KmsConfig

clear()

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

clearCreateTime()

public KmsConfig.Builder clearCreateTime()

Output only. Create time of the KmsConfig.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
KmsConfig.Builder

clearCryptoKeyName()

public KmsConfig.Builder clearCryptoKeyName()

Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.

string crypto_key_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
KmsConfig.Builder

This builder for chaining.

clearDescription()

public KmsConfig.Builder clearDescription()

Description of the KmsConfig.

string description = 6;

Returns
Type Description
KmsConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearInstructions()

public KmsConfig.Builder clearInstructions()

Output only. Instructions to provide the access to the customer provided encryption key.

string instructions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
KmsConfig.Builder

This builder for chaining.

clearLabels()

public KmsConfig.Builder clearLabels()
Returns
Type Description
KmsConfig.Builder

clearName()

public KmsConfig.Builder clearName()

Identifier. Name of the KmsConfig.

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

Returns
Type Description
KmsConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearServiceAccount()

public KmsConfig.Builder clearServiceAccount()

Output only. The Service account which will have access to the customer provided encryption key.

string service_account = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
KmsConfig.Builder

This builder for chaining.

clearState()

public KmsConfig.Builder clearState()

Output only. State of the KmsConfig.

.google.cloud.netapp.v1.KmsConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
KmsConfig.Builder

This builder for chaining.

clearStateDetails()

public KmsConfig.Builder clearStateDetails()

Output only. State details of the KmsConfig.

string state_details = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
KmsConfig.Builder

This builder for chaining.

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time of the KmsConfig.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Create time of the KmsConfig.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time of the KmsConfig.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCryptoKeyName()

public String getCryptoKeyName()

Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.

string crypto_key_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The cryptoKeyName.

getCryptoKeyNameBytes()

public ByteString getCryptoKeyNameBytes()

Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.

string crypto_key_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for cryptoKeyName.

getDefaultInstanceForType()

public KmsConfig getDefaultInstanceForType()
Returns
Type Description
KmsConfig

getDescription()

public String getDescription()

Description of the KmsConfig.

string description = 6;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the KmsConfig.

string description = 6;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getInstructions()

public String getInstructions()

Output only. Instructions to provide the access to the customer provided encryption key.

string instructions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The instructions.

getInstructionsBytes()

public ByteString getInstructionsBytes()

Output only. Instructions to provide the access to the customer provided encryption key.

string instructions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for instructions.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs

map<string, string> labels = 7;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs

map<string, string> labels = 7;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs

map<string, string> labels = 7;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Identifier. Name of the KmsConfig.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Name of the KmsConfig.

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

Returns
Type Description
ByteString

The bytes for name.

getServiceAccount()

public String getServiceAccount()

Output only. The Service account which will have access to the customer provided encryption key.

string service_account = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Output only. The Service account which will have access to the customer provided encryption key.

string service_account = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for serviceAccount.

getState()

public KmsConfig.State getState()

Output only. State of the KmsConfig.

.google.cloud.netapp.v1.KmsConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
KmsConfig.State

The state.

getStateDetails()

public String getStateDetails()

Output only. State details of the KmsConfig.

string state_details = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The stateDetails.

getStateDetailsBytes()

public ByteString getStateDetailsBytes()

Output only. State details of the KmsConfig.

string state_details = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for stateDetails.

getStateValue()

public int getStateValue()

Output only. State of the KmsConfig.

.google.cloud.netapp.v1.KmsConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time of the KmsConfig.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public KmsConfig.Builder mergeCreateTime(Timestamp value)

Output only. Create time of the KmsConfig.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
KmsConfig.Builder

mergeFrom(KmsConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllLabels(Map<String,String> values)

public KmsConfig.Builder putAllLabels(Map<String,String> values)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
KmsConfig.Builder

putLabels(String key, String value)

public KmsConfig.Builder putLabels(String key, String value)

Labels as key value pairs

map<string, string> labels = 7;

Parameters
Name Description
key String
value String
Returns
Type Description
KmsConfig.Builder

removeLabels(String key)

public KmsConfig.Builder removeLabels(String key)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
KmsConfig.Builder

setCreateTime(Timestamp value)

public KmsConfig.Builder setCreateTime(Timestamp value)

Output only. Create time of the KmsConfig.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
KmsConfig.Builder

setCreateTime(Timestamp.Builder builderForValue)

public KmsConfig.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Create time of the KmsConfig.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
KmsConfig.Builder

setCryptoKeyName(String value)

public KmsConfig.Builder setCryptoKeyName(String value)

Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.

string crypto_key_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The cryptoKeyName to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setCryptoKeyNameBytes(ByteString value)

public KmsConfig.Builder setCryptoKeyNameBytes(ByteString value)

Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.

string crypto_key_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for cryptoKeyName to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setDescription(String value)

public KmsConfig.Builder setDescription(String value)

Description of the KmsConfig.

string description = 6;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public KmsConfig.Builder setDescriptionBytes(ByteString value)

Description of the KmsConfig.

string description = 6;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setInstructions(String value)

public KmsConfig.Builder setInstructions(String value)

Output only. Instructions to provide the access to the customer provided encryption key.

string instructions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The instructions to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setInstructionsBytes(ByteString value)

public KmsConfig.Builder setInstructionsBytes(ByteString value)

Output only. Instructions to provide the access to the customer provided encryption key.

string instructions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for instructions to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setName(String value)

public KmsConfig.Builder setName(String value)

Identifier. Name of the KmsConfig.

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public KmsConfig.Builder setNameBytes(ByteString value)

Identifier. Name of the KmsConfig.

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

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

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

setServiceAccount(String value)

public KmsConfig.Builder setServiceAccount(String value)

Output only. The Service account which will have access to the customer provided encryption key.

string service_account = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The serviceAccount to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

public KmsConfig.Builder setServiceAccountBytes(ByteString value)

Output only. The Service account which will have access to the customer provided encryption key.

string service_account = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for serviceAccount to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setState(KmsConfig.State value)

public KmsConfig.Builder setState(KmsConfig.State value)

Output only. State of the KmsConfig.

.google.cloud.netapp.v1.KmsConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value KmsConfig.State

The state to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setStateDetails(String value)

public KmsConfig.Builder setStateDetails(String value)

Output only. State details of the KmsConfig.

string state_details = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The stateDetails to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setStateDetailsBytes(ByteString value)

public KmsConfig.Builder setStateDetailsBytes(ByteString value)

Output only. State details of the KmsConfig.

string state_details = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for stateDetails to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setStateValue(int value)

public KmsConfig.Builder setStateValue(int value)

Output only. State of the KmsConfig.

.google.cloud.netapp.v1.KmsConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
KmsConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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