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

Class CertificateTemplate

  • All Implemented Interfaces:
    CertificateTemplateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CertificateTemplate
extends com.google.protobuf.GeneratedMessageV3
implements CertificateTemplateOrBuilder
     A
 [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate]
 refers to a managed template for certificate issuance.
    Protobuf type google.cloud.security.privateca.v1.CertificateTemplate
    See Also:
    Serialized Form

    • Field Detail

      • PREDEFINED_VALUES_FIELD_NUMBER

        public static final int PREDEFINED_VALUES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IDENTITY_CONSTRAINTS_FIELD_NUMBER

        public static final int IDENTITY_CONSTRAINTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PASSTHROUGH_EXTENSIONS_FIELD_NUMBER

        public static final int PASSTHROUGH_EXTENSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. 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) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface CertificateTemplateOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. 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) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface CertificateTemplateOrBuilder
        Returns:
        The bytes for name.

      • hasPredefinedValues

        public 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];
        Specified by:
        hasPredefinedValues in interface CertificateTemplateOrBuilder
        Returns:
        Whether the predefinedValues field is set.

      • getPredefinedValues

        public 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];
        Specified by:
        getPredefinedValues in interface CertificateTemplateOrBuilder
        Returns:
        The predefinedValues.

      • getPredefinedValuesOrBuilder

        public 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];
        Specified by:
        getPredefinedValuesOrBuilder in interface CertificateTemplateOrBuilder

      • hasIdentityConstraints

        public 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];
        Specified by:
        hasIdentityConstraints in interface CertificateTemplateOrBuilder
        Returns:
        Whether the identityConstraints field is set.

      • getIdentityConstraints

        public 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];
        Specified by:
        getIdentityConstraints in interface CertificateTemplateOrBuilder
        Returns:
        The identityConstraints.

      • getIdentityConstraintsOrBuilder

        public 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];
        Specified by:
        getIdentityConstraintsOrBuilder in interface CertificateTemplateOrBuilder

      • hasPassthroughExtensions

        public 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];
        Specified by:
        hasPassthroughExtensions in interface CertificateTemplateOrBuilder
        Returns:
        Whether the passthroughExtensions field is set.

      • getPassthroughExtensions

        public 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];
        Specified by:
        getPassthroughExtensions in interface CertificateTemplateOrBuilder
        Returns:
        The passthroughExtensions.

      • getPassthroughExtensionsOrBuilder

        public 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];
        Specified by:
        getPassthroughExtensionsOrBuilder in interface CertificateTemplateOrBuilder

      • getDescription

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

      • getDescriptionBytes

        public 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];
        Specified by:
        getDescriptionBytes in interface CertificateTemplateOrBuilder
        Returns:
        The bytes for description.

      • hasCreateTime

        public 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];
        Specified by:
        hasCreateTime in interface CertificateTemplateOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public 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];
        Specified by:
        getCreateTime in interface CertificateTemplateOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public 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];
        Specified by:
        getCreateTimeOrBuilder in interface CertificateTemplateOrBuilder

      • hasUpdateTime

        public 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];
        Specified by:
        hasUpdateTime in interface CertificateTemplateOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public 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];
        Specified by:
        getUpdateTime in interface CertificateTemplateOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public 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];
        Specified by:
        getUpdateTimeOrBuilder in interface CertificateTemplateOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional. Labels with user-defined metadata.
        map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface CertificateTemplateOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CertificateTemplate parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CertificateTemplate parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CertificateTemplate parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CertificateTemplate parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CertificateTemplate parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CertificateTemplate parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CertificateTemplate parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public CertificateTemplate.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public CertificateTemplate.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected CertificateTemplate.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<CertificateTemplate> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public CertificateTemplate getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder