Class CertificateAuthority.KeyVersionSpec (2.46.0)

public static final class CertificateAuthority.KeyVersionSpec extends GeneratedMessageV3 implements CertificateAuthority.KeyVersionSpecOrBuilder

A Cloud KMS key configuration that a CertificateAuthority will use.

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.KeyVersionSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CertificateAuthority.KeyVersionSpec

Static Fields

ALGORITHM_FIELD_NUMBER

public static final int ALGORITHM_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_KMS_KEY_VERSION_FIELD_NUMBER

public static final int CLOUD_KMS_KEY_VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CertificateAuthority.KeyVersionSpec getDefaultInstance()
Returns
Type Description
CertificateAuthority.KeyVersionSpec

getDescriptor()

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

newBuilder()

public static CertificateAuthority.KeyVersionSpec.Builder newBuilder()
Returns
Type Description
CertificateAuthority.KeyVersionSpec.Builder

newBuilder(CertificateAuthority.KeyVersionSpec prototype)

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

parseDelimitedFrom(InputStream input)

public static CertificateAuthority.KeyVersionSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CertificateAuthority.KeyVersionSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static CertificateAuthority.KeyVersionSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CertificateAuthority.KeyVersionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static CertificateAuthority.KeyVersionSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CertificateAuthority.KeyVersionSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static CertificateAuthority.KeyVersionSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CertificateAuthority.KeyVersionSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static CertificateAuthority.KeyVersionSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CertificateAuthority.KeyVersionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<CertificateAuthority.KeyVersionSpec> parser()
Returns
Type Description
Parser<KeyVersionSpec>

Methods

equals(Object obj)

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

getAlgorithm()

public CertificateAuthority.SignHashAlgorithm getAlgorithm()

Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as HSM.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.SignHashAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CertificateAuthority.SignHashAlgorithm

The algorithm.

getAlgorithmValue()

public int getAlgorithmValue()

Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as HSM.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.SignHashAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for algorithm.

getCloudKmsKeyVersion()

public String getCloudKmsKeyVersion()

Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*. This option enables full flexibility in the key's capabilities and properties.

string cloud_kms_key_version = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The cloudKmsKeyVersion.

getCloudKmsKeyVersionBytes()

public ByteString getCloudKmsKeyVersionBytes()

Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*. This option enables full flexibility in the key's capabilities and properties.

string cloud_kms_key_version = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for cloudKmsKeyVersion.

getDefaultInstanceForType()

public CertificateAuthority.KeyVersionSpec getDefaultInstanceForType()
Returns
Type Description
CertificateAuthority.KeyVersionSpec

getKeyVersionCase()

public CertificateAuthority.KeyVersionSpec.KeyVersionCase getKeyVersionCase()
Returns
Type Description
CertificateAuthority.KeyVersionSpec.KeyVersionCase

getParserForType()

public Parser<CertificateAuthority.KeyVersionSpec> getParserForType()
Returns
Type Description
Parser<KeyVersionSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAlgorithm()

public boolean hasAlgorithm()

Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as HSM.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.SignHashAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the algorithm field is set.

hasCloudKmsKeyVersion()

public boolean hasCloudKmsKeyVersion()

Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*. This option enables full flexibility in the key's capabilities and properties.

string cloud_kms_key_version = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the cloudKmsKeyVersion 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 CertificateAuthority.KeyVersionSpec.Builder newBuilderForType()
Returns
Type Description
CertificateAuthority.KeyVersionSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public CertificateAuthority.KeyVersionSpec.Builder toBuilder()
Returns
Type Description
CertificateAuthority.KeyVersionSpec.Builder

writeTo(CodedOutputStream output)

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