Class EkmConnection.Builder (2.38.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
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.cloud.kms.v1.EkmConnection.ServiceResolver>
Returns
TypeDescription
EkmConnection.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EkmConnection.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueEkmConnection.ServiceResolver
Returns
TypeDescription
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
NameDescription
builderForValueEkmConnection.ServiceResolver.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueEkmConnection.ServiceResolver
Returns
TypeDescription
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
NameDescription
indexint
builderForValueEkmConnection.ServiceResolver.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
EkmConnection.ServiceResolver.Builder

build()

public EkmConnection build()
Returns
TypeDescription
EkmConnection

buildPartial()

public EkmConnection buildPartial()
Returns
TypeDescription
EkmConnection

clear()

public EkmConnection.Builder clear()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
EkmConnection.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public EkmConnection.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
EkmConnection.Builder

clone()

public EkmConnection.Builder clone()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for cryptoSpacePath.

getDefaultInstanceForType()

public EkmConnection getDefaultInstanceForType()
Returns
TypeDescription
EkmConnection

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEtag()

public String getEtag()

Optional. Etag of the currently stored EkmConnection.

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

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. Etag of the currently stored EkmConnection.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the createTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type<