Class EkmConnection.Builder (2.49.0)

public static final class EkmConnection.Builder extends GeneratedMessageV3.Builder<EkmConnection.Builder> implements EkmConnectionOrBuilder

An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.

Protobuf type google.cloud.kms.v1.EkmConnection

Static Methods

getDescriptor()

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

Methods

addAllServiceResolvers(Iterable<? extends EkmConnection.ServiceResolver> values)

public EkmConnection.Builder addAllServiceResolvers(Iterable<? extends EkmConnection.ServiceResolver> values)

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.kms.v1.EkmConnection.ServiceResolver>
Returns
Type Description
EkmConnection.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addServiceResolvers(EkmConnection.ServiceResolver value)

public EkmConnection.Builder addServiceResolvers(EkmConnection.ServiceResolver value)

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Parameter
Name Description
value EkmConnection.ServiceResolver
Returns
Type Description
EkmConnection.Builder

addServiceResolvers(EkmConnection.ServiceResolver.Builder builderForValue)

public EkmConnection.Builder addServiceResolvers(EkmConnection.ServiceResolver.Builder builderForValue)

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Parameter
Name Description
builderForValue EkmConnection.ServiceResolver.Builder
Returns
Type Description
EkmConnection.Builder

addServiceResolvers(int index, EkmConnection.ServiceResolver value)

public EkmConnection.Builder addServiceResolvers(int index, EkmConnection.ServiceResolver value)

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Parameters
Name Description
index int
value EkmConnection.ServiceResolver
Returns
Type Description
EkmConnection.Builder

addServiceResolvers(int index, EkmConnection.ServiceResolver.Builder builderForValue)

public EkmConnection.Builder addServiceResolvers(int index, EkmConnection.ServiceResolver.Builder builderForValue)

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Parameters
Name Description
index int
builderForValue EkmConnection.ServiceResolver.Builder
Returns
Type Description
EkmConnection.Builder

addServiceResolversBuilder()

public EkmConnection.ServiceResolver.Builder addServiceResolversBuilder()

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Returns
Type Description
EkmConnection.ServiceResolver.Builder

addServiceResolversBuilder(int index)

public EkmConnection.ServiceResolver.Builder addServiceResolversBuilder(int index)

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Parameter
Name Description
index int
Returns
Type Description
EkmConnection.ServiceResolver.Builder

build()

public EkmConnection build()
Returns
Type Description
EkmConnection

buildPartial()

public EkmConnection buildPartial()
Returns
Type Description
EkmConnection

clear()

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

clearCreateTime()

public EkmConnection.Builder clearCreateTime()

Output only. The time at which the EkmConnection was created.

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

Returns
Type Description
EkmConnection.Builder

clearCryptoSpacePath()

public EkmConnection.Builder clearCryptoSpacePath()

Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.

string crypto_space_path = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EkmConnection.Builder

This builder for chaining.

clearEtag()

public EkmConnection.Builder clearEtag()

Optional. Etag of the currently stored EkmConnection.

string etag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EkmConnection.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearKeyManagementMode()

public EkmConnection.Builder clearKeyManagementMode()

Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.

.google.cloud.kms.v1.EkmConnection.KeyManagementMode key_management_mode = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EkmConnection.Builder

This builder for chaining.

clearName()

public EkmConnection.Builder clearName()

Output only. The resource name for the EkmConnection in the format projects/*/locations/*/ekmConnections/*.

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

Returns
Type Description
EkmConnection.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearServiceResolvers()

public EkmConnection.Builder clearServiceResolvers()

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Returns
Type Description
EkmConnection.Builder

clone()

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

getCreateTime()

public Timestamp getCreateTime()

Output only. The time at which the EkmConnection was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time at which the EkmConnection was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which the EkmConnection was created.

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

Returns
Type Description
TimestampOrBuilder

getCryptoSpacePath()

public String getCryptoSpacePath()

Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.

string crypto_space_path = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The cryptoSpacePath.

getCryptoSpacePathBytes()

public ByteString getCryptoSpacePathBytes()

Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.

string crypto_space_path = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cryptoSpacePath.

getDefaultInstanceForType()

public EkmConnection getDefaultInstanceForType()
Returns
Type Description
EkmConnection

getDescriptorForType()

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

getEtag()

public String getEtag()

Optional. Etag of the currently stored EkmConnection.

string etag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. Etag of the currently stored EkmConnection.

string etag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for etag.

getKeyManagementMode()

public EkmConnection.KeyManagementMode getKeyManagementMode()

Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.

.google.cloud.kms.v1.EkmConnection.KeyManagementMode key_management_mode = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EkmConnection.KeyManagementMode

The keyManagementMode.

getKeyManagementModeValue()

public int getKeyManagementModeValue()

Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.

.google.cloud.kms.v1.EkmConnection.KeyManagementMode key_management_mode = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for keyManagementMode.

getName()

public String getName()

Output only. The resource name for the EkmConnection in the format projects/*/locations/*/ekmConnections/*.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name for the EkmConnection in the format projects/*/locations/*/ekmConnections/*.

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

Returns
Type Description
ByteString

The bytes for name.

getServiceResolvers(int index)

public EkmConnection.ServiceResolver getServiceResolvers(int index)

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Parameter
Name Description
index int
Returns
Type Description
EkmConnection.ServiceResolver

getServiceResolversBuilder(int index)

public EkmConnection.ServiceResolver.Builder getServiceResolversBuilder(int index)

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Parameter
Name Description
index int
Returns
Type Description
EkmConnection.ServiceResolver.Builder

getServiceResolversBuilderList()

public List<EkmConnection.ServiceResolver.Builder> getServiceResolversBuilderList()

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Returns
Type Description
List<Builder>

getServiceResolversCount()

public int getServiceResolversCount()

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Returns
Type Description
int

getServiceResolversList()

public List<EkmConnection.ServiceResolver> getServiceResolversList()

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Returns
Type Description
List<ServiceResolver>

getServiceResolversOrBuilder(int index)

public EkmConnection.ServiceResolverOrBuilder getServiceResolversOrBuilder(int index)

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Parameter
Name Description
index int
Returns
Type Description
EkmConnection.ServiceResolverOrBuilder

getServiceResolversOrBuilderList()

public List<? extends EkmConnection.ServiceResolverOrBuilder> getServiceResolversOrBuilderList()

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Returns
Type Description
List<? extends com.google.cloud.kms.v1.EkmConnection.ServiceResolverOrBuilder>

hasCreateTime()

public boolean hasCreateTime()

Output only. The time at which the EkmConnection was created.

.google.protobuf.Timestamp create_time = 2 [(.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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public EkmConnection.Builder mergeCreateTime(Timestamp value)

Output only. The time at which the EkmConnection was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
EkmConnection.Builder

mergeFrom(EkmConnection other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeServiceResolvers(int index)

public EkmConnection.Builder removeServiceResolvers(int index)

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Parameter
Name Description
index int
Returns
Type Description
EkmConnection.Builder

setCreateTime(Timestamp value)

public EkmConnection.Builder setCreateTime(Timestamp value)

Output only. The time at which the EkmConnection was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
EkmConnection.Builder

setCreateTime(Timestamp.Builder builderForValue)

public EkmConnection.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time at which the EkmConnection was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
EkmConnection.Builder

setCryptoSpacePath(String value)

public EkmConnection.Builder setCryptoSpacePath(String value)

Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.

string crypto_space_path = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The cryptoSpacePath to set.

Returns
Type Description
EkmConnection.Builder

This builder for chaining.

setCryptoSpacePathBytes(ByteString value)

public EkmConnection.Builder setCryptoSpacePathBytes(ByteString value)

Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.

string crypto_space_path = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for cryptoSpacePath to set.

Returns
Type Description
EkmConnection.Builder

This builder for chaining.

setEtag(String value)

public EkmConnection.Builder setEtag(String value)

Optional. Etag of the currently stored EkmConnection.

string etag = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
EkmConnection.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public EkmConnection.Builder setEtagBytes(ByteString value)

Optional. Etag of the currently stored EkmConnection.

string etag = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
EkmConnection.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setKeyManagementMode(EkmConnection.KeyManagementMode value)

public EkmConnection.Builder setKeyManagementMode(EkmConnection.KeyManagementMode value)

Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.

.google.cloud.kms.v1.EkmConnection.KeyManagementMode key_management_mode = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EkmConnection.KeyManagementMode

The keyManagementMode to set.

Returns
Type Description
EkmConnection.Builder

This builder for chaining.

setKeyManagementModeValue(int value)

public EkmConnection.Builder setKeyManagementModeValue(int value)

Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.

.google.cloud.kms.v1.EkmConnection.KeyManagementMode key_management_mode = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

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

Returns
Type Description
EkmConnection.Builder

This builder for chaining.

setName(String value)

public EkmConnection.Builder setName(String value)

Output only. The resource name for the EkmConnection in the format projects/*/locations/*/ekmConnections/*.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
EkmConnection.Builder

This builder for chaining.

setNameBytes(ByteString value)

public EkmConnection.Builder setNameBytes(ByteString value)

Output only. The resource name for the EkmConnection in the format projects/*/locations/*/ekmConnections/*.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
EkmConnection.Builder

This builder for chaining.

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

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

setServiceResolvers(int index, EkmConnection.ServiceResolver value)

public EkmConnection.Builder setServiceResolvers(int index, EkmConnection.ServiceResolver value)

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Parameters
Name Description
index int
value EkmConnection.ServiceResolver
Returns
Type Description
EkmConnection.Builder

setServiceResolvers(int index, EkmConnection.ServiceResolver.Builder builderForValue)

public EkmConnection.Builder setServiceResolvers(int index, EkmConnection.ServiceResolver.Builder builderForValue)

A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;

Parameters
Name Description
index int
builderForValue EkmConnection.ServiceResolver.Builder
Returns
Type Description
EkmConnection.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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