Package com.google.cloud.security.privateca.v1

Interface CertificateOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Certificate, Certificate.Builder
    public interface CertificateOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Output only. The resource name for this
 [Certificate][google.cloud.security.privateca.v1.Certificate] in the format
 `projects/*/locations/*/caPools/*/certificates/*`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name for this
 [Certificate][google.cloud.security.privateca.v1.Certificate] in the format
 `projects/*/locations/*/caPools/*/certificates/*`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for name.

      • hasPemCsr

        boolean hasPemCsr()
         Immutable. A pem-encoded X.509 certificate signing request (CSR).
        string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        Whether the pemCsr field is set.

      • getPemCsr

        String getPemCsr()
         Immutable. A pem-encoded X.509 certificate signing request (CSR).
        string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The pemCsr.

      • getPemCsrBytes

        com.google.protobuf.ByteString getPemCsrBytes()
         Immutable. A pem-encoded X.509 certificate signing request (CSR).
        string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The bytes for pemCsr.

      • hasConfig

        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:
        Whether the config field is set.

      • getConfig

        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:
        The config.

      • getConfigOrBuilder

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

      • getIssuerCertificateAuthority

        String getIssuerCertificateAuthority()
         Output only. The resource name of the issuing
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
        string issuer_certificate_authority = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The issuerCertificateAuthority.

      • getIssuerCertificateAuthorityBytes

        com.google.protobuf.ByteString getIssuerCertificateAuthorityBytes()
         Output only. The resource name of the issuing
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
        string issuer_certificate_authority = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for issuerCertificateAuthority.

      • hasLifetime

        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:
        Whether the lifetime field is set.

      • getLifetime

        com.google.protobuf.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:
        The lifetime.

      • getLifetimeOrBuilder

        com.google.protobuf.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];

      • getCertificateTemplate

        String getCertificateTemplate()
         Immutable. The resource name for a
 [CertificateTemplate][google.cloud.security.privateca.v1.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][google.cloud.security.privateca.v1.Certificate].
        string certificate_template = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        The certificateTemplate.

      • getCertificateTemplateBytes

        com.google.protobuf.ByteString getCertificateTemplateBytes()
         Immutable. The resource name for a
 [CertificateTemplate][google.cloud.security.privateca.v1.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][google.cloud.security.privateca.v1.Certificate].
        string certificate_template = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for certificateTemplate.

      • getSubjectModeValue

        int getSubjectModeValue()
         Immutable. Specifies how the
 [Certificate][google.cloud.security.privateca.v1.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:
        The enum numeric value on the wire for subjectMode.

      • getSubjectMode

        SubjectRequestMode getSubjectMode()
         Immutable. Specifies how the
 [Certificate][google.cloud.security.privateca.v1.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:
        The subjectMode.

      • hasRevocationDetails

        boolean hasRevocationDetails()
         Output only. Details regarding the revocation of this
 [Certificate][google.cloud.security.privateca.v1.Certificate]. This
 [Certificate][google.cloud.security.privateca.v1.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:
        Whether the revocationDetails field is set.

      • getRevocationDetails

        Certificate.RevocationDetails getRevocationDetails()
         Output only. Details regarding the revocation of this
 [Certificate][google.cloud.security.privateca.v1.Certificate]. This
 [Certificate][google.cloud.security.privateca.v1.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:
        The revocationDetails.

      • getRevocationDetailsOrBuilder

        Certificate.RevocationDetailsOrBuilder getRevocationDetailsOrBuilder()
         Output only. Details regarding the revocation of this
 [Certificate][google.cloud.security.privateca.v1.Certificate]. This
 [Certificate][google.cloud.security.privateca.v1.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];

      • getPemCertificate

        String getPemCertificate()
         Output only. The pem-encoded, signed X.509 certificate.
        string pem_certificate = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The pemCertificate.

      • getPemCertificateBytes

        com.google.protobuf.ByteString getPemCertificateBytes()
         Output only. The pem-encoded, signed X.509 certificate.
        string pem_certificate = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for pemCertificate.

      • hasCertificateDescription

        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:
        Whether the certificateDescription field is set.

      • getCertificateDescription

        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:
        The certificateDescription.

      • getCertificateDescriptionOrBuilder

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

      • getPemCertificateChainList

        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:
        A list containing the pemCertificateChain.

      • getPemCertificateChainCount

        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:
        The count of pemCertificateChain.

      • getPemCertificateChain

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The pemCertificateChain at the given index.

      • getPemCertificateChainBytes

        com.google.protobuf.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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the pemCertificateChain at the given index.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. The time at which this
 [Certificate][google.cloud.security.privateca.v1.Certificate] was created.
        .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. The time at which this
 [Certificate][google.cloud.security.privateca.v1.Certificate] was created.
        .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time at which this
 [Certificate][google.cloud.security.privateca.v1.Certificate] was created.
        .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. The time at which this
 [Certificate][google.cloud.security.privateca.v1.Certificate] was updated.
        .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time at which this
 [Certificate][google.cloud.security.privateca.v1.Certificate] was updated.
        .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time at which this
 [Certificate][google.cloud.security.privateca.v1.Certificate] was updated.
        .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsCount

        int getLabelsCount()
         Optional. Labels with user-defined metadata.
        map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];

      • containsLabels

        boolean containsLabels​(String key)
         Optional. Labels with user-defined metadata.
        map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Optional. Labels with user-defined metadata.
        map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Optional. Labels with user-defined metadata.
        map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Optional. Labels with user-defined metadata.
        map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];