Class EkmConfig (2.47.0)

public final class EkmConfig extends GeneratedMessageV3 implements EkmConfigOrBuilder

An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.

Protobuf type google.cloud.kms.v1.EkmConfig

Implements

EkmConfigOrBuilder

Static Fields

DEFAULT_EKM_CONNECTION_FIELD_NUMBER

public static final int DEFAULT_EKM_CONNECTION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EkmConfig getDefaultInstance()
Returns
Type Description
EkmConfig

getDescriptor()

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

newBuilder()

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

newBuilder(EkmConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultEkmConnection()

public String getDefaultEkmConnection()

Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.

string default_ekm_connection = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The defaultEkmConnection.

getDefaultEkmConnectionBytes()

public ByteString getDefaultEkmConnectionBytes()

Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.

string default_ekm_connection = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for defaultEkmConnection.

getDefaultInstanceForType()

public EkmConfig getDefaultInstanceForType()
Returns
Type Description
EkmConfig

getName()

public String getName()

Output only. The resource name for the EkmConfig in the format projects/*/locations/*/ekmConfig.

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 EkmConfig in the format projects/*/locations/*/ekmConfig.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<EkmConfig> getParserForType()
Returns
Type Description
Parser<EkmConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 EkmConfig.Builder newBuilderForType()
Returns
Type Description
EkmConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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