Class CmekConfig.Builder (2.95.0)

public static final class CmekConfig.Builder extends GeneratedMessage.Builder<CmekConfig.Builder> implements CmekConfigOrBuilder

Describes the customer-managed encryption key (CMEK) configuration associated with a project and location.

Protobuf type google.cloud.tasks.v2beta3.CmekConfig

Implements

CmekConfigOrBuilder

Static Methods

getDescriptor()

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

Methods

build()

public CmekConfig build()
Returns
Type Description
CmekConfig

buildPartial()

public CmekConfig buildPartial()
Returns
Type Description
CmekConfig

clear()

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

clearKmsKey()

public CmekConfig.Builder clearKmsKey()

Resource name of the Cloud KMS key, of the form projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.

string kms_key = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

clearName()

public CmekConfig.Builder clearName()

Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`

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

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

getDefaultInstanceForType()

public CmekConfig getDefaultInstanceForType()
Returns
Type Description
CmekConfig

getDescriptorForType()

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

getKmsKey()

public String getKmsKey()

Resource name of the Cloud KMS key, of the form projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.

string kms_key = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

Resource name of the Cloud KMS key, of the form projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.

string kms_key = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsKey.

getName()

public String getName()

Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`

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

Returns
Type Description
ByteString

The bytes for name.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CmekConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setKmsKey(String value)

public CmekConfig.Builder setKmsKey(String value)

Resource name of the Cloud KMS key, of the form projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.

string kms_key = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The kmsKey to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setKmsKeyBytes(ByteString value)

public CmekConfig.Builder setKmsKeyBytes(ByteString value)

Resource name of the Cloud KMS key, of the form projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.

string kms_key = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for kmsKey to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setName(String value)

public CmekConfig.Builder setName(String value)

Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public CmekConfig.Builder setNameBytes(ByteString value)

Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.