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.v1.Certificate
Static Fields
CERTIFICATE_DESCRIPTION_FIELD_NUMBER
public static final int CERTIFICATE_DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CERTIFICATE_TEMPLATE_FIELD_NUMBER
public static final int CERTIFICATE_TEMPLATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONFIG_FIELD_NUMBER
public static final int CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ISSUER_CERTIFICATE_AUTHORITY_FIELD_NUMBER
public static final int ISSUER_CERTIFICATE_AUTHORITY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LIFETIME_FIELD_NUMBER
public static final int LIFETIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PEM_CERTIFICATE_CHAIN_FIELD_NUMBER
public static final int PEM_CERTIFICATE_CHAIN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PEM_CERTIFICATE_FIELD_NUMBER
public static final int PEM_CERTIFICATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PEM_CSR_FIELD_NUMBER
public static final int PEM_CSR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REVOCATION_DETAILS_FIELD_NUMBER
public static final int REVOCATION_DETAILS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SUBJECT_MODE_FIELD_NUMBER
public static final int SUBJECT_MODE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Certificate getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Certificate.Builder newBuilder()
newBuilder(Certificate prototype)
public static Certificate.Builder newBuilder(Certificate prototype)
public static Certificate parseDelimitedFrom(InputStream input)
public static Certificate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Certificate parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Certificate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Certificate parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Certificate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Certificate parseFrom(CodedInputStream input)
public static Certificate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Certificate parseFrom(InputStream input)
public static Certificate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Certificate parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Certificate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Certificate> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Optional. Labels with user-defined metadata.
map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCertificateConfigCase()
public Certificate.CertificateConfigCase getCertificateConfigCase()
getCertificateDescription()
public CertificateDescription getCertificateDescription()
Output only. A structured description of the issued X.509 certificate.
.google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCertificateDescriptionOrBuilder()
public CertificateDescriptionOrBuilder getCertificateDescriptionOrBuilder()
Output only. A structured description of the issued X.509 certificate.
.google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCertificateTemplate()
public String getCertificateTemplate()
Immutable. The resource name for a
CertificateTemplate
used to issue this certificate, in the format
projects/*/locations/*/certificateTemplates/*.
If this is specified, the caller must have the necessary permission to
use this template. If this is omitted, no template will be used.
This template must be in the same location as the
Certificate.
string certificate_template = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The certificateTemplate.
|
getCertificateTemplateBytes()
public ByteString getCertificateTemplateBytes()
Immutable. The resource name for a
CertificateTemplate
used to issue this certificate, in the format
projects/*/locations/*/certificateTemplates/*.
If this is specified, the caller must have the necessary permission to
use this template. If this is omitted, no template will be used.
This template must be in the same location as the
Certificate.
string certificate_template = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for certificateTemplate.
|
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.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];
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.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];
getCreateTime()
public Timestamp getCreateTime()
Output only. The time at which this
Certificate was created.
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time at which this
Certificate was created.
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Certificate getDefaultInstanceForType()
getIssuerCertificateAuthority()
public String getIssuerCertificateAuthority()
Output only. The resource name of the issuing
CertificateAuthority
in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.
string issuer_certificate_authority = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The issuerCertificateAuthority.
|
getIssuerCertificateAuthorityBytes()
public ByteString getIssuerCertificateAuthorityBytes()
Output only. The resource name of the issuing
CertificateAuthority
in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.
string issuer_certificate_authority = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for issuerCertificateAuthority.
|
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Optional. Labels with user-defined metadata.
map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. Labels with user-defined metadata.
map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. Labels with user-defined metadata.
map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. Labels with user-defined metadata.
map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | 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 = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
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 = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getName()
Output only. The resource name for this
Certificate in the format
projects/*/locations/*/caPools/*/certificates/*.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The resource name for this
Certificate in the format
projects/*/locations/*/caPools/*/certificates/*.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Certificate> getParserForType()
Overrides
getPemCertificate()
public String getPemCertificate()
Output only. The pem-encoded, signed X.509 certificate.
string pem_certificate = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The pemCertificate.
|
getPemCertificateBytes()
public ByteString getPemCertificateBytes()
Output only. The pem-encoded, signed X.509 certificate.
string pem_certificate = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
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 = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
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 = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
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 = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
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 = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPemCsr()
public String getPemCsr()
Immutable. A pem-encoded X.509 certificate signing request (CSR).
string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getSubjectMode()
public SubjectRequestMode getSubjectMode()
Immutable. Specifies how the
Certificate's identity
fields are to be decided. If this is omitted, the DEFAULT subject mode
will be used.
.google.cloud.security.privateca.v1.SubjectRequestMode subject_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];
getSubjectModeValue()
public int getSubjectModeValue()
Immutable. Specifies how the
Certificate's identity
fields are to be decided. If this is omitted, the DEFAULT subject mode
will be used.
.google.cloud.security.privateca.v1.SubjectRequestMode subject_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for subjectMode.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The time at which this
Certificate was updated.
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time at which this
Certificate was updated.
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCertificateDescription()
public boolean hasCertificateDescription()
Output only. A structured description of the issued X.509 certificate.
.google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
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.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
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 = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
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 = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
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 = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Certificate.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Certificate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Certificate.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
