Class EkmConnection (2.25.0)
Version 2.25.0keyboard_arrow_down
public final class EkmConnection extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
CRYPTO_SPACE_PATH_FIELD_NUMBER
public static final int CRYPTO_SPACE_PATH_FIELD_NUMBER
Field Value
Type Description
int
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int
KEY_MANAGEMENT_MODE_FIELD_NUMBER
public static final int KEY_MANAGEMENT_MODE_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
SERVICE_RESOLVERS_FIELD_NUMBER
public static final int SERVICE_RESOLVERS_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static EkmConnection getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static EkmConnection . Builder newBuilder ()
newBuilder(EkmConnection prototype)
public static EkmConnection . Builder newBuilder ( EkmConnection prototype )
public static EkmConnection parseDelimitedFrom ( InputStream input )
public static EkmConnection parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static EkmConnection parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EkmConnection parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static EkmConnection parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EkmConnection parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static EkmConnection parseFrom ( CodedInputStream input )
public static EkmConnection parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static EkmConnection parseFrom ( InputStream input )
public static EkmConnection parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static EkmConnection parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EkmConnection parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<EkmConnection> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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.
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];
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 ()
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];
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()
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.
getParserForType()
public Parser<EkmConnection> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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
indexint
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;
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
indexint
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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public EkmConnection . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected EkmConnection . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public EkmConnection . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
