Class EkmConnection (2.48.0)

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

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()
Returns
Type Description
EkmConnection

getDescriptor()

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

newBuilder()

public static EkmConnection.Builder newBuilder()
Returns
Type Description
EkmConnection.Builder

newBuilder(EkmConnection prototype)

public static EkmConnection.Builder newBuilder(EkmConnection prototype)
Parameter
Name Description
prototype EkmConnection
Returns
Type Description
EkmConnection.Builder

parseDelimitedFrom(InputStream input)

public static EkmConnection parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EkmConnection
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EkmConnection parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EkmConnection
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static EkmConnection parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
EkmConnection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EkmConnection parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EkmConnection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EkmConnection parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
EkmConnection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EkmConnection parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EkmConnection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EkmConnection parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EkmConnection
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EkmConnection parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EkmConnection
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static EkmConnection parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EkmConnection
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EkmConnection parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EkmConnection
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static EkmConnection parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EkmConnection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EkmConnection parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EkmConnection
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<EkmConnection> parser()
Returns
Type Description
Parser<EkmConnection>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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];

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

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.

getParserForType()

public Parser<EkmConnection> getParserForType()
Returns
Type Description
Parser<EkmConnection>
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
index int
Returns
Type Description
EkmConnection.ServiceResolver

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EkmConnection.Builder newBuilderForType()
Returns
Type Description
EkmConnection.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EkmConnection.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EkmConnection.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public EkmConnection.Builder toBuilder()
Returns
Type Description
EkmConnection.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException