Interface CertificateOrBuilder (2.13.0)

public interface CertificateOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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`

Returns

Type	Description
`boolean`

getCertificateConfigCase()

public abstract Certificate.CertificateConfigCase getCertificateConfigCase()

Returns

Type	Description
`Certificate.CertificateConfigCase`

getCertificateDescription()

public abstract 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];

Returns

Type	Description
`CertificateDescription`	The certificateDescription.

getCertificateDescriptionOrBuilder()

public abstract 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];

Returns

Type	Description
`CertificateDescriptionOrBuilder`

getCertificateTemplate()

public abstract 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 abstract ByteString getCertificateTemplateBytes()

string certificate_template = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns

Type	Description
`ByteString`	The bytes for certificateTemplate.

getConfig()

public abstract 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];

Returns

Type	Description
`CertificateConfig`	The config.

getConfigOrBuilder()

public abstract 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];

Returns

Type	Description
`CertificateConfigOrBuilder`

getCreateTime()

public abstract 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 abstract TimestampOrBuilder getCreateTimeOrBuilder()

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
`TimestampOrBuilder`

getIssuerCertificateAuthority()

public abstract 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 abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
`Map<String,String>`

getLabelsCount()

public abstract int getLabelsCount()

Optional. Labels with user-defined metadata.

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

Returns

Type	Description
`int`

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Labels with user-defined metadata.

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

Returns

Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels with user-defined metadata.

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

Parameters

Name	Description
`key`	`String`
`defaultValue`	`String`

Returns

Type	Description
`String`

getLabelsOrThrow(String key)

public abstract 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`

Returns

Type	Description
`String`

getLifetime()

public abstract 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 abstract DurationOrBuilder getLifetimeOrBuilder()

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

Returns

Type	Description
`DurationOrBuilder`

getName()

public abstract String 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 abstract 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.

getPemCertificate()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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];

Returns

Type	Description
`List<String>`	A list containing the pemCertificateChain.

getPemCsr()

public abstract 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 abstract 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 abstract 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];

Returns

Type	Description
`Certificate.RevocationDetails`	The revocationDetails.

getRevocationDetailsOrBuilder()

public abstract 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];

Returns

Type	Description
`Certificate.RevocationDetailsOrBuilder`

getSubjectMode()

public abstract 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];

Returns

Type	Description
`SubjectRequestMode`	The subjectMode.

getSubjectModeValue()

public abstract 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.

getUpdateTime()

public abstract 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 abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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
`TimestampOrBuilder`

hasCertificateDescription()

public abstract 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 abstract 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 abstract 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 abstract boolean hasLifetime()

.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 abstract 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 abstract 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 abstract 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.