Class CertificateConfig (2.56.0)

public final class CertificateConfig extends GeneratedMessageV3 implements CertificateConfigOrBuilder

A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1.

Protobuf type google.cloud.security.privateca.v1.CertificateConfig

Static Fields

PUBLIC_KEY_FIELD_NUMBER

public static final int PUBLIC_KEY_FIELD_NUMBER
Field Value
Type Description
int

SUBJECT_CONFIG_FIELD_NUMBER

public static final int SUBJECT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

SUBJECT_KEY_ID_FIELD_NUMBER

public static final int SUBJECT_KEY_ID_FIELD_NUMBER
Field Value
Type Description
int

X509_CONFIG_FIELD_NUMBER

public static final int X509_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CertificateConfig getDefaultInstance()
Returns
Type Description
CertificateConfig

getDescriptor()

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

newBuilder()

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

newBuilder(CertificateConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CertificateConfig getDefaultInstanceForType()
Returns
Type Description
CertificateConfig

getParserForType()

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

getPublicKey()

public PublicKey getPublicKey()

Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR.

.google.cloud.security.privateca.v1.PublicKey public_key = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PublicKey

The publicKey.

getPublicKeyOrBuilder()

public PublicKeyOrBuilder getPublicKeyOrBuilder()

Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR.

.google.cloud.security.privateca.v1.PublicKey public_key = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PublicKeyOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSubjectConfig()

public CertificateConfig.SubjectConfig getSubjectConfig()

Required. Specifies some of the values in a certificate that are related to the subject.

.google.cloud.security.privateca.v1.CertificateConfig.SubjectConfig subject_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CertificateConfig.SubjectConfig

The subjectConfig.

getSubjectConfigOrBuilder()

public CertificateConfig.SubjectConfigOrBuilder getSubjectConfigOrBuilder()

Required. Specifies some of the values in a certificate that are related to the subject.

.google.cloud.security.privateca.v1.CertificateConfig.SubjectConfig subject_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CertificateConfig.SubjectConfigOrBuilder

getSubjectKeyId()

public CertificateConfig.KeyId getSubjectKeyId()

Optional. When specified this provides a custom SKI to be used in the certificate. This should only be used to maintain a SKI of an existing CA originally created outside CA service, which was not generated using method (1) described in RFC 5280 section 4.2.1.2.

.google.cloud.security.privateca.v1.CertificateConfig.KeyId subject_key_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CertificateConfig.KeyId

The subjectKeyId.

getSubjectKeyIdOrBuilder()

public CertificateConfig.KeyIdOrBuilder getSubjectKeyIdOrBuilder()

Optional. When specified this provides a custom SKI to be used in the certificate. This should only be used to maintain a SKI of an existing CA originally created outside CA service, which was not generated using method (1) described in RFC 5280 section 4.2.1.2.

.google.cloud.security.privateca.v1.CertificateConfig.KeyId subject_key_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CertificateConfig.KeyIdOrBuilder

getX509Config()

public X509Parameters getX509Config()

Required. Describes how some of the technical X.509 fields in a certificate should be populated.

.google.cloud.security.privateca.v1.X509Parameters x509_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
X509Parameters

The x509Config.

getX509ConfigOrBuilder()

public X509ParametersOrBuilder getX509ConfigOrBuilder()

Required. Describes how some of the technical X.509 fields in a certificate should be populated.

.google.cloud.security.privateca.v1.X509Parameters x509_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
X509ParametersOrBuilder

hasPublicKey()

public boolean hasPublicKey()

Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR.

.google.cloud.security.privateca.v1.PublicKey public_key = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the publicKey field is set.

hasSubjectConfig()

public boolean hasSubjectConfig()

Required. Specifies some of the values in a certificate that are related to the subject.

.google.cloud.security.privateca.v1.CertificateConfig.SubjectConfig subject_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the subjectConfig field is set.

hasSubjectKeyId()

public boolean hasSubjectKeyId()

Optional. When specified this provides a custom SKI to be used in the certificate. This should only be used to maintain a SKI of an existing CA originally created outside CA service, which was not generated using method (1) described in RFC 5280 section 4.2.1.2.

.google.cloud.security.privateca.v1.CertificateConfig.KeyId subject_key_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the subjectKeyId field is set.

hasX509Config()

public boolean hasX509Config()

Required. Describes how some of the technical X.509 fields in a certificate should be populated.

.google.cloud.security.privateca.v1.X509Parameters x509_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the x509Config 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 CertificateConfig.Builder newBuilderForType()
Returns
Type Description
CertificateConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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