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

Interface CertificateTemplateOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CertificateTemplate, CertificateTemplate.Builder
@Generated public interface CertificateTemplateOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Identifier. The resource name for this
 [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate]
 in the format `projects/*/locations/*/certificateTemplates/*`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. The resource name for this
 [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate]
 in the format `projects/*/locations/*/certificateTemplates/*`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • hasMaximumLifetime

      boolean hasMaximumLifetime()
       Optional. The maximum lifetime allowed for issued
 [Certificates][google.cloud.security.privateca.v1.Certificate] that use
 this template. If the issuing
 [CaPool][google.cloud.security.privateca.v1.CaPool] resource's
 [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy]
 specifies a
 [maximum_lifetime][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.maximum_lifetime]
 the minimum of the two durations will be the maximum lifetime for issued
 [Certificates][google.cloud.security.privateca.v1.Certificate]. Note that
 if the issuing
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 expires before a
 [Certificate][google.cloud.security.privateca.v1.Certificate]'s requested
 maximum_lifetime, the effective lifetime will be explicitly truncated
 to match it.
      .google.protobuf.Duration maximum_lifetime = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the maximumLifetime field is set.

    • getMaximumLifetime

      com.google.protobuf.Duration getMaximumLifetime()
       Optional. The maximum lifetime allowed for issued
 [Certificates][google.cloud.security.privateca.v1.Certificate] that use
 this template. If the issuing
 [CaPool][google.cloud.security.privateca.v1.CaPool] resource's
 [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy]
 specifies a
 [maximum_lifetime][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.maximum_lifetime]
 the minimum of the two durations will be the maximum lifetime for issued
 [Certificates][google.cloud.security.privateca.v1.Certificate]. Note that
 if the issuing
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 expires before a
 [Certificate][google.cloud.security.privateca.v1.Certificate]'s requested
 maximum_lifetime, the effective lifetime will be explicitly truncated
 to match it.
      .google.protobuf.Duration maximum_lifetime = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The maximumLifetime.

    • getMaximumLifetimeOrBuilder

      com.google.protobuf.DurationOrBuilder getMaximumLifetimeOrBuilder()
       Optional. The maximum lifetime allowed for issued
 [Certificates][google.cloud.security.privateca.v1.Certificate] that use
 this template. If the issuing
 [CaPool][google.cloud.security.privateca.v1.CaPool] resource's
 [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy]
 specifies a
 [maximum_lifetime][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.maximum_lifetime]
 the minimum of the two durations will be the maximum lifetime for issued
 [Certificates][google.cloud.security.privateca.v1.Certificate]. Note that
 if the issuing
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 expires before a
 [Certificate][google.cloud.security.privateca.v1.Certificate]'s requested
 maximum_lifetime, the effective lifetime will be explicitly truncated
 to match it.
      .google.protobuf.Duration maximum_lifetime = 9 [(.google.api.field_behavior) = OPTIONAL];

    • hasPredefinedValues

      boolean hasPredefinedValues()
       Optional. A set of X.509 values that will be applied to all issued
 certificates that use this template. If the certificate request includes
 conflicting values for the same properties, they will be overwritten by the
 values defined here. If the issuing
 [CaPool][google.cloud.security.privateca.v1.CaPool]'s
 [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy]
 defines conflicting
 [baseline_values][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.baseline_values]
 for the same properties, the certificate issuance request will fail.
      .google.cloud.security.privateca.v1.X509Parameters predefined_values = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the predefinedValues field is set.

    • getPredefinedValues

      X509Parameters getPredefinedValues()
       Optional. A set of X.509 values that will be applied to all issued
 certificates that use this template. If the certificate request includes
 conflicting values for the same properties, they will be overwritten by the
 values defined here. If the issuing
 [CaPool][google.cloud.security.privateca.v1.CaPool]'s
 [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy]
 defines conflicting
 [baseline_values][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.baseline_values]
 for the same properties, the certificate issuance request will fail.
      .google.cloud.security.privateca.v1.X509Parameters predefined_values = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The predefinedValues.

    • getPredefinedValuesOrBuilder

      X509ParametersOrBuilder getPredefinedValuesOrBuilder()
       Optional. A set of X.509 values that will be applied to all issued
 certificates that use this template. If the certificate request includes
 conflicting values for the same properties, they will be overwritten by the
 values defined here. If the issuing
 [CaPool][google.cloud.security.privateca.v1.CaPool]'s
 [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy]
 defines conflicting
 [baseline_values][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.baseline_values]
 for the same properties, the certificate issuance request will fail.
      .google.cloud.security.privateca.v1.X509Parameters predefined_values = 2 [(.google.api.field_behavior) = OPTIONAL];

    • hasIdentityConstraints

      boolean hasIdentityConstraints()
       Optional. Describes constraints on identities that may be appear in
 [Certificates][google.cloud.security.privateca.v1.Certificate] issued using
 this template. If this is omitted, then this template will not add
 restrictions on a certificate's identity.
      .google.cloud.security.privateca.v1.CertificateIdentityConstraints identity_constraints = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the identityConstraints field is set.

    • getIdentityConstraints

      CertificateIdentityConstraints getIdentityConstraints()
       Optional. Describes constraints on identities that may be appear in
 [Certificates][google.cloud.security.privateca.v1.Certificate] issued using
 this template. If this is omitted, then this template will not add
 restrictions on a certificate's identity.
      .google.cloud.security.privateca.v1.CertificateIdentityConstraints identity_constraints = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The identityConstraints.

    • getIdentityConstraintsOrBuilder

      CertificateIdentityConstraintsOrBuilder getIdentityConstraintsOrBuilder()
       Optional. Describes constraints on identities that may be appear in
 [Certificates][google.cloud.security.privateca.v1.Certificate] issued using
 this template. If this is omitted, then this template will not add
 restrictions on a certificate's identity.
      .google.cloud.security.privateca.v1.CertificateIdentityConstraints identity_constraints = 3 [(.google.api.field_behavior) = OPTIONAL];

    • hasPassthroughExtensions

      boolean hasPassthroughExtensions()
       Optional. Describes the set of X.509 extensions that may appear in a
 [Certificate][google.cloud.security.privateca.v1.Certificate] issued using
 this
 [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate].
 If a certificate request sets extensions that don't appear in the
 [passthrough_extensions][google.cloud.security.privateca.v1.CertificateTemplate.passthrough_extensions],
 those extensions will be dropped. If the issuing
 [CaPool][google.cloud.security.privateca.v1.CaPool]'s
 [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy]
 defines
 [baseline_values][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.baseline_values]
 that don't appear here, the certificate issuance request will fail. If this
 is omitted, then this template will not add restrictions on a certificate's
 X.509 extensions. These constraints do not apply to X.509 extensions set in
 this
 [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate]'s
 [predefined_values][google.cloud.security.privateca.v1.CertificateTemplate.predefined_values].
      .google.cloud.security.privateca.v1.CertificateExtensionConstraints passthrough_extensions = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the passthroughExtensions field is set.

    • getPassthroughExtensions

      CertificateExtensionConstraints getPassthroughExtensions()
       Optional. Describes the set of X.509 extensions that may appear in a
 [Certificate][google.cloud.security.privateca.v1.Certificate] issued using
 this
 [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate].
 If a certificate request sets extensions that don't appear in the
 [passthrough_extensions][google.cloud.security.privateca.v1.CertificateTemplate.passthrough_extensions],
 those extensions will be dropped. If the issuing
 [CaPool][google.cloud.security.privateca.v1.CaPool]'s
 [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy]
 defines
 [baseline_values][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.baseline_values]
 that don't appear here, the certificate issuance request will fail. If this
 is omitted, then this template will not add restrictions on a certificate's
 X.509 extensions. These constraints do not apply to X.509 extensions set in
 this
 [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate]'s
 [predefined_values][google.cloud.security.privateca.v1.CertificateTemplate.predefined_values].
      .google.cloud.security.privateca.v1.CertificateExtensionConstraints passthrough_extensions = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The passthroughExtensions.

    • getPassthroughExtensionsOrBuilder

      CertificateExtensionConstraintsOrBuilder getPassthroughExtensionsOrBuilder()
       Optional. Describes the set of X.509 extensions that may appear in a
 [Certificate][google.cloud.security.privateca.v1.Certificate] issued using
 this
 [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate].
 If a certificate request sets extensions that don't appear in the
 [passthrough_extensions][google.cloud.security.privateca.v1.CertificateTemplate.passthrough_extensions],
 those extensions will be dropped. If the issuing
 [CaPool][google.cloud.security.privateca.v1.CaPool]'s
 [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy]
 defines
 [baseline_values][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.baseline_values]
 that don't appear here, the certificate issuance request will fail. If this
 is omitted, then this template will not add restrictions on a certificate's
 X.509 extensions. These constraints do not apply to X.509 extensions set in
 this
 [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate]'s
 [predefined_values][google.cloud.security.privateca.v1.CertificateTemplate.predefined_values].
      .google.cloud.security.privateca.v1.CertificateExtensionConstraints passthrough_extensions = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getDescription

      String getDescription()
       Optional. A human-readable description of scenarios this template is
 intended for.
      string description = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. A human-readable description of scenarios this template is
 intended for.
      string description = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • hasCreateTime

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

    • getCreateTimeOrBuilder

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

    • hasUpdateTime

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

    • getUpdateTimeOrBuilder

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

    • getLabelsCount

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

    • containsLabels

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

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

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

    • getLabelsOrDefault

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

    • getLabelsOrThrow

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