Package com.google.cloud.kms.v1

Class EkmConnection

  • All Implemented Interfaces:
    EkmConnectionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class EkmConnection
extends com.google.protobuf.GeneratedMessageV3
implements EkmConnectionOrBuilder
     An [EkmConnection][google.cloud.kms.v1.EkmConnection] represents an
 individual EKM connection. It can be used for creating
 [CryptoKeys][google.cloud.kms.v1.CryptoKey] and
 [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] with a
 [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
 [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], as well as
 performing cryptographic operations using keys created within the
 [EkmConnection][google.cloud.kms.v1.EkmConnection].
    Protobuf type google.cloud.kms.v1.EkmConnection
    See Also:
    Serialized Form

    • Field Detail

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_RESOLVERS_FIELD_NUMBER

        public static final int SERVICE_RESOLVERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KEY_MANAGEMENT_MODE_FIELD_NUMBER

        public static final int KEY_MANAGEMENT_MODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CRYPTO_SPACE_PATH_FIELD_NUMBER

        public static final int CRYPTO_SPACE_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The resource name for the
 [EkmConnection][google.cloud.kms.v1.EkmConnection] in the format
 `projects/*/locations/*/ekmConnections/*`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface EkmConnectionOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name for the
 [EkmConnection][google.cloud.kms.v1.EkmConnection] in the format
 `projects/*/locations/*/ekmConnections/*`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface EkmConnectionOrBuilder
        Returns:
        The bytes for name.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time at which the
 [EkmConnection][google.cloud.kms.v1.EkmConnection] was created.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface EkmConnectionOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time at which the
 [EkmConnection][google.cloud.kms.v1.EkmConnection] was created.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface EkmConnectionOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time at which the
 [EkmConnection][google.cloud.kms.v1.EkmConnection] was created.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface EkmConnectionOrBuilder

      • getServiceResolversList

        public List<EkmConnection.ServiceResolver> getServiceResolversList()
         A list of
 [ServiceResolvers][google.cloud.kms.v1.EkmConnection.ServiceResolver] where
 the EKM can be reached. There should be one ServiceResolver per EKM
 replica. Currently, only a single
 [ServiceResolver][google.cloud.kms.v1.EkmConnection.ServiceResolver] is
 supported.
        repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;
        Specified by:
        getServiceResolversList in interface EkmConnectionOrBuilder

      • getServiceResolversOrBuilderList

        public List<? extends EkmConnection.ServiceResolverOrBuilder> getServiceResolversOrBuilderList()
         A list of
 [ServiceResolvers][google.cloud.kms.v1.EkmConnection.ServiceResolver] where
 the EKM can be reached. There should be one ServiceResolver per EKM
 replica. Currently, only a single
 [ServiceResolver][google.cloud.kms.v1.EkmConnection.ServiceResolver] is
 supported.
        repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;
        Specified by:
        getServiceResolversOrBuilderList in interface EkmConnectionOrBuilder

      • getServiceResolversCount

        public int getServiceResolversCount()
         A list of
 [ServiceResolvers][google.cloud.kms.v1.EkmConnection.ServiceResolver] where
 the EKM can be reached. There should be one ServiceResolver per EKM
 replica. Currently, only a single
 [ServiceResolver][google.cloud.kms.v1.EkmConnection.ServiceResolver] is
 supported.
        repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;
        Specified by:
        getServiceResolversCount in interface EkmConnectionOrBuilder

      • getServiceResolvers

        public EkmConnection.ServiceResolver getServiceResolvers​(int index)
         A list of
 [ServiceResolvers][google.cloud.kms.v1.EkmConnection.ServiceResolver] where
 the EKM can be reached. There should be one ServiceResolver per EKM
 replica. Currently, only a single
 [ServiceResolver][google.cloud.kms.v1.EkmConnection.ServiceResolver] is
 supported.
        repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;
        Specified by:
        getServiceResolvers in interface EkmConnectionOrBuilder

      • getServiceResolversOrBuilder

        public EkmConnection.ServiceResolverOrBuilder getServiceResolversOrBuilder​(int index)
         A list of
 [ServiceResolvers][google.cloud.kms.v1.EkmConnection.ServiceResolver] where
 the EKM can be reached. There should be one ServiceResolver per EKM
 replica. Currently, only a single
 [ServiceResolver][google.cloud.kms.v1.EkmConnection.ServiceResolver] is
 supported.
        repeated .google.cloud.kms.v1.EkmConnection.ServiceResolver service_resolvers = 3;
        Specified by:
        getServiceResolversOrBuilder in interface EkmConnectionOrBuilder

      • getEtag

        public String getEtag()
         Optional. Etag of the currently stored
 [EkmConnection][google.cloud.kms.v1.EkmConnection].
        string etag = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEtag in interface EkmConnectionOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Optional. Etag of the currently stored
 [EkmConnection][google.cloud.kms.v1.EkmConnection].
        string etag = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEtagBytes in interface EkmConnectionOrBuilder
        Returns:
        The bytes for etag.

      • 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.MANUAL].
        .google.cloud.kms.v1.EkmConnection.KeyManagementMode key_management_mode = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getKeyManagementModeValue in interface EkmConnectionOrBuilder
        Returns:
        The enum numeric value on the wire for keyManagementMode.

      • 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.MANUAL].
        .google.cloud.kms.v1.EkmConnection.KeyManagementMode key_management_mode = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getKeyManagementMode in interface EkmConnectionOrBuilder
        Returns:
        The keyManagementMode.

      • getCryptoSpacePath

        public String getCryptoSpacePath()
         Optional. Identifies the EKM Crypto Space that this
 [EkmConnection][google.cloud.kms.v1.EkmConnection] maps to. Note: This
 field is required if
 [KeyManagementMode][google.cloud.kms.v1.EkmConnection.KeyManagementMode] is
 [CLOUD_KMS][google.cloud.kms.v1.EkmConnection.KeyManagementMode.CLOUD_KMS].
        string crypto_space_path = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCryptoSpacePath in interface EkmConnectionOrBuilder
        Returns:
        The cryptoSpacePath.

      • getCryptoSpacePathBytes

        public com.google.protobuf.ByteString getCryptoSpacePathBytes()
         Optional. Identifies the EKM Crypto Space that this
 [EkmConnection][google.cloud.kms.v1.EkmConnection] maps to. Note: This
 field is required if
 [KeyManagementMode][google.cloud.kms.v1.EkmConnection.KeyManagementMode] is
 [CLOUD_KMS][google.cloud.kms.v1.EkmConnection.KeyManagementMode.CLOUD_KMS].
        string crypto_space_path = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCryptoSpacePathBytes in interface EkmConnectionOrBuilder
        Returns:
        The bytes for cryptoSpacePath.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static EkmConnection parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EkmConnection parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EkmConnection parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EkmConnection parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EkmConnection parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EkmConnection parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EkmConnection parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public EkmConnection.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public EkmConnection.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected EkmConnection.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static EkmConnection getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<EkmConnection> parser()

      • getParserForType

        public com.google.protobuf.Parser<EkmConnection> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public EkmConnection getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder