Class Certificate

public final class Certificate extends GeneratedMessageV3 implements CertificateOrBuilder

A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

Protobuf type google.cloud.security.privateca.v1beta1.Certificate

Fields

CERTIFICATE_DESCRIPTION_FIELD_NUMBER

public static final int CERTIFICATE_DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LIFETIME_FIELD_NUMBER

public static final int LIFETIME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PEM_CERTIFICATE_CHAIN_FIELD_NUMBER

public static final int PEM_CERTIFICATE_CHAIN_FIELD_NUMBER
Field Value
TypeDescription
int

PEM_CERTIFICATE_FIELD_NUMBER

public static final int PEM_CERTIFICATE_FIELD_NUMBER
Field Value
TypeDescription
int

PEM_CSR_FIELD_NUMBER

public static final int PEM_CSR_FIELD_NUMBER
Field Value
TypeDescription
int

REVOCATION_DETAILS_FIELD_NUMBER

public static final int REVOCATION_DETAILS_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels with user-defined metadata.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCertificateConfigCase()

public Certificate.CertificateConfigCase getCertificateConfigCase()
Returns
TypeDescription
Certificate.CertificateConfigCase

getCertificateDescription()

public CertificateDescription getCertificateDescription()

Output only. A structured description of the issued X.509 certificate.

.google.cloud.security.privateca.v1beta1.CertificateDescription certificate_description = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
CertificateDescription

The certificateDescription.

getCertificateDescriptionOrBuilder()

public CertificateDescriptionOrBuilder getCertificateDescriptionOrBuilder()

Output only. A structured description of the issued X.509 certificate.

.google.cloud.security.privateca.v1beta1.CertificateDescription certificate_description = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
CertificateDescriptionOrBuilder

getConfig()

public CertificateConfig getConfig()

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

.google.cloud.security.privateca.v1beta1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
CertificateConfig

The config.

getConfigOrBuilder()

public CertificateConfigOrBuilder getConfigOrBuilder()

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

.google.cloud.security.privateca.v1beta1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
CertificateConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The time at which this Certificate was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which this Certificate was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstance()

public static Certificate getDefaultInstance()
Returns
TypeDescription
Certificate

getDefaultInstanceForType()

public Certificate getDefaultInstanceForType()
Returns
TypeDescription
Certificate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels with user-defined metadata.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels with user-defined metadata.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels with user-defined metadata.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels with user-defined metadata.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLifetime()

public Duration getLifetime()

Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.

.google.protobuf.Duration lifetime = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
Duration

The lifetime.

getLifetimeOrBuilder()

public DurationOrBuilder getLifetimeOrBuilder()

Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.

.google.protobuf.Duration lifetime = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
DurationOrBuilder

getName()

public String getName()

Output only. The resource path for this Certificate in the format projects/*/locations/*/certificateAuthorities/*/certificates/*.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource path for this Certificate in the format projects/*/locations/*/certificateAuthorities/*/certificates/*.

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Certificate> getParserForType()
Returns
TypeDescription
Parser<Certificate>
Overrides

getPemCertificate()

public String getPemCertificate()

Output only. The pem-encoded, signed X.509 certificate.

string pem_certificate = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The pemCertificate.

getPemCertificateBytes()

public ByteString getPemCertificateBytes()

Output only. The pem-encoded, signed X.509 certificate.

string pem_certificate = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for pemCertificate.

getPemCertificateChain(int index)

public String getPemCertificateChain(int index)

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The pemCertificateChain at the given index.

getPemCertificateChainBytes(int index)

public ByteString getPemCertificateChainBytes(int index)

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the pemCertificateChain at the given index.

getPemCertificateChainCount()

public int getPemCertificateChainCount()

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The count of pemCertificateChain.

getPemCertificateChainList()

public ProtocolStringList getPemCertificateChainList()

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ProtocolStringList

A list containing the pemCertificateChain.

getPemCsr()

public String getPemCsr()

Immutable. A pem-encoded X.509 certificate signing request (CSR).

string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The pemCsr.

getPemCsrBytes()

public ByteString getPemCsrBytes()

Immutable. A pem-encoded X.509 certificate signing request (CSR).

string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for pemCsr.

getRevocationDetails()

public Certificate.RevocationDetails getRevocationDetails()

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

.google.cloud.security.privateca.v1beta1.Certificate.RevocationDetails revocation_details = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Certificate.RevocationDetails

The revocationDetails.

getRevocationDetailsOrBuilder()

public Certificate.RevocationDetailsOrBuilder getRevocationDetailsOrBuilder()

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

.google.cloud.security.privateca.v1beta1.Certificate.RevocationDetails revocation_details = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Certificate.RevocationDetailsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time at which this Certificate was updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time at which this Certificate was updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

hasCertificateDescription()

public boolean hasCertificateDescription()

Output only. A structured description of the issued X.509 certificate.

.google.cloud.security.privateca.v1beta1.CertificateDescription certificate_description = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the certificateDescription field is set.

hasConfig()

public boolean hasConfig()

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

.google.cloud.security.privateca.v1beta1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
boolean

Whether the config field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time at which this Certificate was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasLifetime()

public boolean hasLifetime()

Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.

.google.protobuf.Duration lifetime = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
boolean

Whether the lifetime field is set.

hasPemCsr()

public boolean hasPemCsr()

Immutable. A pem-encoded X.509 certificate signing request (CSR).

string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
boolean

Whether the pemCsr field is set.

hasRevocationDetails()

public boolean hasRevocationDetails()

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

.google.cloud.security.privateca.v1beta1.Certificate.RevocationDetails revocation_details = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the revocationDetails field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time at which this Certificate was updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static Certificate.Builder newBuilder()
Returns
TypeDescription
Certificate.Builder

newBuilder(Certificate prototype)

public static Certificate.Builder newBuilder(Certificate prototype)
Parameter
NameDescription
prototypeCertificate
Returns
TypeDescription
Certificate.Builder

newBuilderForType()

public Certificate.Builder newBuilderForType()
Returns
TypeDescription
Certificate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Certificate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Certificate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static Certificate parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Certificate
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Certificate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Certificate
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Certificate parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Certificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Certificate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Certificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Certificate parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Certificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Certificate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Certificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Certificate parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Certificate
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Certificate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Certificate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Certificate parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Certificate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Certificate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Certificate
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Certificate parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Certificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Certificate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Certificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Certificate> parser()
Returns
TypeDescription
Parser<Certificate>

toBuilder()

public Certificate.Builder toBuilder()
Returns
TypeDescription
Certificate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException