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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EkmConnection.BuilderImplements
EkmConnectionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
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;
Name | Description |
values | Iterable<? extends com.google.cloud.kms.v1.EkmConnection.ServiceResolver> |
Type | Description |
EkmConnection.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public EkmConnection.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
EkmConnection.Builder |
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;
Name | Description |
value | EkmConnection.ServiceResolver |
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;
Name | Description |
builderForValue | EkmConnection.ServiceResolver.Builder |
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;
Name | Description |
index | int |
value | EkmConnection.ServiceResolver |
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;
Name | Description |
index | int |
builderForValue | EkmConnection.ServiceResolver.Builder |
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;
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;
Name | Description |
index | int |
Type | Description |
EkmConnection.ServiceResolver.Builder |
build()
public EkmConnection build()
Type | Description |
EkmConnection |
buildPartial()
public EkmConnection buildPartial()
Type | Description |
EkmConnection |
clear()
public EkmConnection.Builder clear()
Type | Description |
EkmConnection.Builder |
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];
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];
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];
Type | Description |
EkmConnection.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public EkmConnection.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
EkmConnection.Builder |
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];
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];
Type | Description |
EkmConnection.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public EkmConnection.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
EkmConnection.Builder |
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;
Type | Description |
EkmConnection.Builder |
clone()
public EkmConnection.Builder clone()
Type | Description |
EkmConnection.Builder |
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];
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];
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];
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];
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];
Type | Description |
ByteString | The bytes for cryptoSpacePath. |
getDefaultInstanceForType()
public EkmConnection getDefaultInstanceForType()
Type | Description |
EkmConnection |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getEtag()
public String getEtag()
Optional. Etag of the currently stored EkmConnection.
string etag = 5 [(.google.api.field_behavior) = OPTIONAL];
Type | Description |
String | The etag. |
getEtagBytes()
public ByteString getEtagBytes()
Optional. Etag of the currently stored EkmConnection.
string etag = 5 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
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];
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];
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;
Name | Description |
index | int |
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;
Name | Description |
index | int |
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;
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;
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;
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;
Name | Description |
index | int |
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;
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];
Type | Description |
boolean | Whether the createTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
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];
Name | Description |
value | Timestamp |
Type | Description |
EkmConnection.Builder |
mergeFrom(EkmConnection other)
public EkmConnection.Builder mergeFrom(EkmConnection other)
Name | Description |
other | EkmConnection |
Type | Description |
EkmConnection.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public EkmConnection.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
EkmConnection.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public EkmConnection.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
EkmConnection.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final EkmConnection.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
EkmConnection.Builder |
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;
Name | Description |
index | int |
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];
Name | Description |
value | Timestamp |
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];
Name | Description |
builderForValue | Builder |
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];
Name | Description |
value | String The cryptoSpacePath to set. |
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];
Name | Description |
value | ByteString The bytes for cryptoSpacePath to set. |
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];
Name | Description |
value | String The etag to set. |
Type | Description |
EkmConnection.Builder | This builder for chaining. |
setEtagBytes(ByteString value)
public EkmConnection.Builder setEtagBytes(ByteString value)