Class CertificateDescription (2.48.0)

public final class CertificateDescription extends GeneratedMessageV3 implements CertificateDescriptionOrBuilder

A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.

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

Static Fields

AIA_ISSUING_CERTIFICATE_URLS_FIELD_NUMBER

public static final int AIA_ISSUING_CERTIFICATE_URLS_FIELD_NUMBER
Field Value
Type Description
int

AUTHORITY_KEY_ID_FIELD_NUMBER

public static final int AUTHORITY_KEY_ID_FIELD_NUMBER
Field Value
Type Description
int

CERT_FINGERPRINT_FIELD_NUMBER

public static final int CERT_FINGERPRINT_FIELD_NUMBER
Field Value
Type Description
int

CRL_DISTRIBUTION_POINTS_FIELD_NUMBER

public static final int CRL_DISTRIBUTION_POINTS_FIELD_NUMBER
Field Value
Type Description
int

PUBLIC_KEY_FIELD_NUMBER

public static final int PUBLIC_KEY_FIELD_NUMBER
Field Value
Type Description
int

SUBJECT_DESCRIPTION_FIELD_NUMBER

public static final int SUBJECT_DESCRIPTION_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_DESCRIPTION_FIELD_NUMBER

public static final int X509_DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CertificateDescription getDefaultInstance()
Returns
Type Description
CertificateDescription

getDescriptor()

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

newBuilder()

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

newBuilder(CertificateDescription prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAiaIssuingCertificateUrls(int index)

public String getAiaIssuingCertificateUrls(int index)

Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.

repeated string aia_issuing_certificate_urls = 7;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The aiaIssuingCertificateUrls at the given index.

getAiaIssuingCertificateUrlsBytes(int index)

public ByteString getAiaIssuingCertificateUrlsBytes(int index)

Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.

repeated string aia_issuing_certificate_urls = 7;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the aiaIssuingCertificateUrls at the given index.

getAiaIssuingCertificateUrlsCount()

public int getAiaIssuingCertificateUrlsCount()

Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.

repeated string aia_issuing_certificate_urls = 7;

Returns
Type Description
int

The count of aiaIssuingCertificateUrls.

getAiaIssuingCertificateUrlsList()

public ProtocolStringList getAiaIssuingCertificateUrlsList()

Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.

repeated string aia_issuing_certificate_urls = 7;

Returns
Type Description
ProtocolStringList

A list containing the aiaIssuingCertificateUrls.

getAuthorityKeyId()

public CertificateDescription.KeyId getAuthorityKeyId()

Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1

.google.cloud.security.privateca.v1.CertificateDescription.KeyId authority_key_id = 5;

Returns
Type Description
CertificateDescription.KeyId

The authorityKeyId.

getAuthorityKeyIdOrBuilder()

public CertificateDescription.KeyIdOrBuilder getAuthorityKeyIdOrBuilder()

Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1

.google.cloud.security.privateca.v1.CertificateDescription.KeyId authority_key_id = 5;

Returns
Type Description
CertificateDescription.KeyIdOrBuilder

getCertFingerprint()

public CertificateDescription.CertificateFingerprint getCertFingerprint()

The hash of the x.509 certificate.

.google.cloud.security.privateca.v1.CertificateDescription.CertificateFingerprint cert_fingerprint = 8;

Returns
Type Description
CertificateDescription.CertificateFingerprint

The certFingerprint.

getCertFingerprintOrBuilder()

public CertificateDescription.CertificateFingerprintOrBuilder getCertFingerprintOrBuilder()

The hash of the x.509 certificate.

.google.cloud.security.privateca.v1.CertificateDescription.CertificateFingerprint cert_fingerprint = 8;

Returns
Type Description
CertificateDescription.CertificateFingerprintOrBuilder

getCrlDistributionPoints(int index)

public String getCrlDistributionPoints(int index)

Describes a list of locations to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13

repeated string crl_distribution_points = 6;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The crlDistributionPoints at the given index.

getCrlDistributionPointsBytes(int index)

public ByteString getCrlDistributionPointsBytes(int index)

Describes a list of locations to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13

repeated string crl_distribution_points = 6;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the crlDistributionPoints at the given index.

getCrlDistributionPointsCount()

public int getCrlDistributionPointsCount()

Describes a list of locations to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13

repeated string crl_distribution_points = 6;

Returns
Type Description
int

The count of crlDistributionPoints.

getCrlDistributionPointsList()

public ProtocolStringList getCrlDistributionPointsList()

Describes a list of locations to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13

repeated string crl_distribution_points = 6;

Returns
Type Description
ProtocolStringList

A list containing the crlDistributionPoints.

getDefaultInstanceForType()

public CertificateDescription getDefaultInstanceForType()
Returns
Type Description
CertificateDescription

getParserForType()

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

getPublicKey()

public PublicKey getPublicKey()

The public key that corresponds to an issued certificate.

.google.cloud.security.privateca.v1.PublicKey public_key = 3;

Returns
Type Description
PublicKey

The publicKey.

getPublicKeyOrBuilder()

public PublicKeyOrBuilder getPublicKeyOrBuilder()

The public key that corresponds to an issued certificate.

.google.cloud.security.privateca.v1.PublicKey public_key = 3;

Returns
Type Description
PublicKeyOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSubjectDescription()

public CertificateDescription.SubjectDescription getSubjectDescription()

Describes some of the values in a certificate that are related to the subject and lifetime.

.google.cloud.security.privateca.v1.CertificateDescription.SubjectDescription subject_description = 1;

Returns
Type Description
CertificateDescription.SubjectDescription

The subjectDescription.

getSubjectDescriptionOrBuilder()

public CertificateDescription.SubjectDescriptionOrBuilder getSubjectDescriptionOrBuilder()

Describes some of the values in a certificate that are related to the subject and lifetime.

.google.cloud.security.privateca.v1.CertificateDescription.SubjectDescription subject_description = 1;

Returns
Type Description
CertificateDescription.SubjectDescriptionOrBuilder

getSubjectKeyId()

public CertificateDescription.KeyId getSubjectKeyId()

Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.

.google.cloud.security.privateca.v1.CertificateDescription.KeyId subject_key_id = 4;

Returns
Type Description
CertificateDescription.KeyId

The subjectKeyId.

getSubjectKeyIdOrBuilder()

public CertificateDescription.KeyIdOrBuilder getSubjectKeyIdOrBuilder()

Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.

.google.cloud.security.privateca.v1.CertificateDescription.KeyId subject_key_id = 4;

Returns
Type Description
CertificateDescription.KeyIdOrBuilder

getX509Description()

public X509Parameters getX509Description()

Describes some of the technical X.509 fields in a certificate.

.google.cloud.security.privateca.v1.X509Parameters x509_description = 2;

Returns
Type Description
X509Parameters

The x509Description.

getX509DescriptionOrBuilder()

public X509ParametersOrBuilder getX509DescriptionOrBuilder()

Describes some of the technical X.509 fields in a certificate.

.google.cloud.security.privateca.v1.X509Parameters x509_description = 2;

Returns
Type Description
X509ParametersOrBuilder

hasAuthorityKeyId()

public boolean hasAuthorityKeyId()

Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1

.google.cloud.security.privateca.v1.CertificateDescription.KeyId authority_key_id = 5;

Returns
Type Description
boolean

Whether the authorityKeyId field is set.

hasCertFingerprint()

public boolean hasCertFingerprint()

The hash of the x.509 certificate.

.google.cloud.security.privateca.v1.CertificateDescription.CertificateFingerprint cert_fingerprint = 8;

Returns
Type Description
boolean

Whether the certFingerprint field is set.

hasPublicKey()

public boolean hasPublicKey()

The public key that corresponds to an issued certificate.

.google.cloud.security.privateca.v1.PublicKey public_key = 3;

Returns
Type Description
boolean

Whether the publicKey field is set.

hasSubjectDescription()

public boolean hasSubjectDescription()

Describes some of the values in a certificate that are related to the subject and lifetime.

.google.cloud.security.privateca.v1.CertificateDescription.SubjectDescription subject_description = 1;

Returns
Type Description
boolean

Whether the subjectDescription field is set.

hasSubjectKeyId()

public boolean hasSubjectKeyId()

Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.

.google.cloud.security.privateca.v1.CertificateDescription.KeyId subject_key_id = 4;

Returns
Type Description
boolean

Whether the subjectKeyId field is set.

hasX509Description()

public boolean hasX509Description()

Describes some of the technical X.509 fields in a certificate.

.google.cloud.security.privateca.v1.X509Parameters x509_description = 2;

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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