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

Interface CertificateAuthorityOrBuilder

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

    • Method Detail

      • getName

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

      • getNameBytes

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

      • getTypeValue

        int getTypeValue()
         Required. Immutable. The
 [Type][google.cloud.security.privateca.v1.CertificateAuthority.Type] of
 this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
        .google.cloud.security.privateca.v1.CertificateAuthority.Type type = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The enum numeric value on the wire for type.

      • getType

        CertificateAuthority.Type getType()
         Required. Immutable. The
 [Type][google.cloud.security.privateca.v1.CertificateAuthority.Type] of
 this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
        .google.cloud.security.privateca.v1.CertificateAuthority.Type type = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The type.

      • hasConfig

        boolean hasConfig()
         Required. Immutable. The config used to create a self-signed X.509
 certificate or CSR.
        .google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        Whether the config field is set.

      • getConfig

        CertificateConfig getConfig()
         Required. Immutable. The config used to create a self-signed X.509
 certificate or CSR.
        .google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The config.

      • getConfigOrBuilder

        CertificateConfigOrBuilder getConfigOrBuilder()
         Required. Immutable. The config used to create a self-signed X.509
 certificate or CSR.
        .google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

      • hasLifetime

        boolean hasLifetime()
         Required. Immutable. The desired lifetime of the CA certificate. Used to
 create the "not_before_time" and "not_after_time" fields inside an X.509
 certificate.
        .google.protobuf.Duration lifetime = 4 [(.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 the CA certificate. Used to
 create the "not_before_time" and "not_after_time" fields inside an X.509
 certificate.
        .google.protobuf.Duration lifetime = 4 [(.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 the CA certificate. Used to
 create the "not_before_time" and "not_after_time" fields inside an X.509
 certificate.
        .google.protobuf.Duration lifetime = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

      • hasKeySpec

        boolean hasKeySpec()
         Required. Immutable. Used when issuing certificates for this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
 If this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 is a self-signed CertificateAuthority, this key is also used to sign the
 self-signed CA certificate. Otherwise, it is used to sign a CSR.
        .google.cloud.security.privateca.v1.CertificateAuthority.KeyVersionSpec key_spec = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        Whether the keySpec field is set.

      • getKeySpec

        CertificateAuthority.KeyVersionSpec getKeySpec()
         Required. Immutable. Used when issuing certificates for this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
 If this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 is a self-signed CertificateAuthority, this key is also used to sign the
 self-signed CA certificate. Otherwise, it is used to sign a CSR.
        .google.cloud.security.privateca.v1.CertificateAuthority.KeyVersionSpec key_spec = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The keySpec.

      • getKeySpecOrBuilder

        CertificateAuthority.KeyVersionSpecOrBuilder getKeySpecOrBuilder()
         Required. Immutable. Used when issuing certificates for this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
 If this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 is a self-signed CertificateAuthority, this key is also used to sign the
 self-signed CA certificate. Otherwise, it is used to sign a CSR.
        .google.cloud.security.privateca.v1.CertificateAuthority.KeyVersionSpec key_spec = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

      • hasSubordinateConfig

        boolean hasSubordinateConfig()
         Optional. If this is a subordinate
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority],
 this field will be set with the subordinate configuration, which describes
 its issuers. This may be updated, but this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 must continue to validate.
        .google.cloud.security.privateca.v1.SubordinateConfig subordinate_config = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the subordinateConfig field is set.

      • getSubordinateConfig

        SubordinateConfig getSubordinateConfig()
         Optional. If this is a subordinate
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority],
 this field will be set with the subordinate configuration, which describes
 its issuers. This may be updated, but this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 must continue to validate.
        .google.cloud.security.privateca.v1.SubordinateConfig subordinate_config = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The subordinateConfig.

      • getSubordinateConfigOrBuilder

        SubordinateConfigOrBuilder getSubordinateConfigOrBuilder()
         Optional. If this is a subordinate
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority],
 this field will be set with the subordinate configuration, which describes
 its issuers. This may be updated, but this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 must continue to validate.
        .google.cloud.security.privateca.v1.SubordinateConfig subordinate_config = 6 [(.google.api.field_behavior) = OPTIONAL];

      • getTierValue

        int getTierValue()
         Output only. The
 [CaPool.Tier][google.cloud.security.privateca.v1.CaPool.Tier] of the
 [CaPool][google.cloud.security.privateca.v1.CaPool] that includes this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
        .google.cloud.security.privateca.v1.CaPool.Tier tier = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for tier.

      • getTier

        CaPool.Tier getTier()
         Output only. The
 [CaPool.Tier][google.cloud.security.privateca.v1.CaPool.Tier] of the
 [CaPool][google.cloud.security.privateca.v1.CaPool] that includes this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
        .google.cloud.security.privateca.v1.CaPool.Tier tier = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The tier.

      • getStateValue

        int getStateValue()
         Output only. The
 [State][google.cloud.security.privateca.v1.CertificateAuthority.State] for
 this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
        .google.cloud.security.privateca.v1.CertificateAuthority.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for state.

      • getState

        CertificateAuthority.State getState()
         Output only. The
 [State][google.cloud.security.privateca.v1.CertificateAuthority.State] for
 this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
        .google.cloud.security.privateca.v1.CertificateAuthority.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The state.

      • getPemCaCertificatesList

        List<String> getPemCaCertificatesList()
         Output only. This
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 certificate chain, including the current
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 certificate. Ordered such that the root issuer is the final element
 (consistent with RFC 5246). For a self-signed CA, this will only list the
 current
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 certificate.
        repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        A list containing the pemCaCertificates.

      • getPemCaCertificatesCount

        int getPemCaCertificatesCount()
         Output only. This
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 certificate chain, including the current
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 certificate. Ordered such that the root issuer is the final element
 (consistent with RFC 5246). For a self-signed CA, this will only list the
 current
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 certificate.
        repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The count of pemCaCertificates.

      • getPemCaCertificates

        String getPemCaCertificates​(int index)
         Output only. This
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 certificate chain, including the current
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 certificate. Ordered such that the root issuer is the final element
 (consistent with RFC 5246). For a self-signed CA, this will only list the
 current
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 certificate.
        repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        index - The index of the element to return.
        Returns:
        The pemCaCertificates at the given index.

      • getPemCaCertificatesBytes

        com.google.protobuf.ByteString getPemCaCertificatesBytes​(int index)
         Output only. This
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 certificate chain, including the current
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 certificate. Ordered such that the root issuer is the final element
 (consistent with RFC 5246). For a self-signed CA, this will only list the
 current
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 certificate.
        repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the pemCaCertificates at the given index.

      • getCaCertificateDescriptionsList

        List<CertificateDescription> getCaCertificateDescriptionsList()
         Output only. A structured description of this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 CA certificate and its issuers. Ordered as self-to-root.
        repeated .google.cloud.security.privateca.v1.CertificateDescription ca_certificate_descriptions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCaCertificateDescriptions

        CertificateDescription getCaCertificateDescriptions​(int index)
         Output only. A structured description of this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 CA certificate and its issuers. Ordered as self-to-root.
        repeated .google.cloud.security.privateca.v1.CertificateDescription ca_certificate_descriptions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCaCertificateDescriptionsCount

        int getCaCertificateDescriptionsCount()
         Output only. A structured description of this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 CA certificate and its issuers. Ordered as self-to-root.
        repeated .google.cloud.security.privateca.v1.CertificateDescription ca_certificate_descriptions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCaCertificateDescriptionsOrBuilderList

        List<? extends CertificateDescriptionOrBuilder> getCaCertificateDescriptionsOrBuilderList()
         Output only. A structured description of this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 CA certificate and its issuers. Ordered as self-to-root.
        repeated .google.cloud.security.privateca.v1.CertificateDescription ca_certificate_descriptions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCaCertificateDescriptionsOrBuilder

        CertificateDescriptionOrBuilder getCaCertificateDescriptionsOrBuilder​(int index)
         Output only. A structured description of this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s
 CA certificate and its issuers. Ordered as self-to-root.
        repeated .google.cloud.security.privateca.v1.CertificateDescription ca_certificate_descriptions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getGcsBucket

        String getGcsBucket()
         Immutable. The name of a Cloud Storage bucket where this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 will publish content, such as the CA certificate and CRLs. This must be a
 bucket name, without any prefixes (such as `gs://`) or suffixes (such as
 `.googleapis.com`). For example, to use a bucket named `my-bucket`, you
 would simply specify `my-bucket`. If not specified, a managed bucket will
 be created.
        string gcs_bucket = 11 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The gcsBucket.

      • getGcsBucketBytes

        com.google.protobuf.ByteString getGcsBucketBytes()
         Immutable. The name of a Cloud Storage bucket where this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 will publish content, such as the CA certificate and CRLs. This must be a
 bucket name, without any prefixes (such as `gs://`) or suffixes (such as
 `.googleapis.com`). For example, to use a bucket named `my-bucket`, you
 would simply specify `my-bucket`. If not specified, a managed bucket will
 be created.
        string gcs_bucket = 11 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The bytes for gcsBucket.

      • hasAccessUrls

        boolean hasAccessUrls()
         Output only. URLs for accessing content published by this CA, such as the
 CA certificate and CRLs.
        .google.cloud.security.privateca.v1.CertificateAuthority.AccessUrls access_urls = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the accessUrls field is set.

      • getAccessUrls

        CertificateAuthority.AccessUrls getAccessUrls()
         Output only. URLs for accessing content published by this CA, such as the
 CA certificate and CRLs.
        .google.cloud.security.privateca.v1.CertificateAuthority.AccessUrls access_urls = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The accessUrls.

      • getAccessUrlsOrBuilder

        CertificateAuthority.AccessUrlsOrBuilder getAccessUrlsOrBuilder()
         Output only. URLs for accessing content published by this CA, such as the
 CA certificate and CRLs.
        .google.cloud.security.privateca.v1.CertificateAuthority.AccessUrls access_urls = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasCreateTime

        boolean hasCreateTime()
         Output only. The time at which this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 was created.
        .google.protobuf.Timestamp create_time = 13 [(.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
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 was created.
        .google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

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

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. The time at which this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 was last updated.
        .google.protobuf.Timestamp update_time = 14 [(.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
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 was last updated.
        .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

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

      • hasDeleteTime

        boolean hasDeleteTime()
         Output only. The time at which this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 was soft deleted, if it is in the
 [DELETED][google.cloud.security.privateca.v1.CertificateAuthority.State.DELETED]
 state.
        .google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        com.google.protobuf.Timestamp getDeleteTime()
         Output only. The time at which this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 was soft deleted, if it is in the
 [DELETED][google.cloud.security.privateca.v1.CertificateAuthority.State.DELETED]
 state.
        .google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
         Output only. The time at which this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 was soft deleted, if it is in the
 [DELETED][google.cloud.security.privateca.v1.CertificateAuthority.State.DELETED]
 state.
        .google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasExpireTime

        boolean hasExpireTime()
         Output only. The time at which this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 will be permanently purged, if it is in the
 [DELETED][google.cloud.security.privateca.v1.CertificateAuthority.State.DELETED]
 state.
        .google.protobuf.Timestamp expire_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the expireTime field is set.

      • getExpireTime

        com.google.protobuf.Timestamp getExpireTime()
         Output only. The time at which this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 will be permanently purged, if it is in the
 [DELETED][google.cloud.security.privateca.v1.CertificateAuthority.State.DELETED]
 state.
        .google.protobuf.Timestamp expire_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The expireTime.

      • getExpireTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
         Output only. The time at which this
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 will be permanently purged, if it is in the
 [DELETED][google.cloud.security.privateca.v1.CertificateAuthority.State.DELETED]
 state.
        .google.protobuf.Timestamp expire_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsCount

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

      • containsLabels

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

      • getLabelsMap

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

      • getLabelsOrDefault

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

      • getLabelsOrThrow

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