Reference documentation and code samples for the Google Certificate Authority Service V1 Client class CertificateTemplate.
A CertificateTemplate refers to a managed template for certificate issuance.
Generated from protobuf message google.cloud.security.privateca.v1.CertificateTemplate
Namespace
Google \ Cloud \ Security \ PrivateCA \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name for this CertificateTemplate in the format |
↳ maximum_lifetime |
Google\Protobuf\Duration
Optional. The maximum lifetime allowed for issued Certificates that use this template. If the issuing CaPool resource's IssuancePolicy specifies a maximum_lifetime the minimum of the two durations will be the maximum lifetime for issued Certificates. Note that if the issuing CertificateAuthority expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it. |
↳ predefined_values |
Google\Cloud\Security\PrivateCA\V1\X509Parameters
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's IssuancePolicy defines conflicting baseline_values for the same properties, the certificate issuance request will fail. |
↳ identity_constraints |
Google\Cloud\Security\PrivateCA\V1\CertificateIdentityConstraints
Optional. Describes constraints on identities that may be appear in Certificates issued using this template. If this is omitted, then this template will not add restrictions on a certificate's identity. |
↳ passthrough_extensions |
Google\Cloud\Security\PrivateCA\V1\CertificateExtensionConstraints
Optional. Describes the set of X.509 extensions that may appear in a Certificate issued using this CertificateTemplate. If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If the issuing CaPool's IssuancePolicy defines 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's predefined_values. |
↳ description |
string
Optional. A human-readable description of scenarios this template is intended for. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time at which this CertificateTemplate was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time at which this CertificateTemplate was updated. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels with user-defined metadata. |
getName
Output only. The resource name for this
CertificateTemplate
in the format projects/*/locations/*/certificateTemplates/*.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. The resource name for this
CertificateTemplate
in the format projects/*/locations/*/certificateTemplates/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaximumLifetime
Optional. The maximum lifetime allowed for issued Certificates that use this template. If the issuing CaPool resource's IssuancePolicy specifies a maximum_lifetime the minimum of the two durations will be the maximum lifetime for issued Certificates. Note that if the issuing CertificateAuthority expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasMaximumLifetime
clearMaximumLifetime
setMaximumLifetime
Optional. The maximum lifetime allowed for issued Certificates that use this template. If the issuing CaPool resource's IssuancePolicy specifies a maximum_lifetime the minimum of the two durations will be the maximum lifetime for issued Certificates. Note that if the issuing CertificateAuthority expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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's IssuancePolicy defines conflicting baseline_values for the same properties, the certificate issuance request will fail.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Security\PrivateCA\V1\X509Parameters|null |
|
hasPredefinedValues
clearPredefinedValues
setPredefinedValues
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's IssuancePolicy defines conflicting baseline_values for the same properties, the certificate issuance request will fail.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Security\PrivateCA\V1\X509Parameters
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIdentityConstraints
Optional. Describes constraints on identities that may be appear in Certificates issued using this template. If this is omitted, then this template will not add restrictions on a certificate's identity.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Security\PrivateCA\V1\CertificateIdentityConstraints|null |
|
hasIdentityConstraints
clearIdentityConstraints
setIdentityConstraints
Optional. Describes constraints on identities that may be appear in Certificates issued using this template. If this is omitted, then this template will not add restrictions on a certificate's identity.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Security\PrivateCA\V1\CertificateIdentityConstraints
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPassthroughExtensions
Optional. Describes the set of X.509 extensions that may appear in a Certificate issued using this CertificateTemplate.
If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If the issuing CaPool's IssuancePolicy defines 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's predefined_values.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Security\PrivateCA\V1\CertificateExtensionConstraints|null |
|
hasPassthroughExtensions
clearPassthroughExtensions
setPassthroughExtensions
Optional. Describes the set of X.509 extensions that may appear in a Certificate issued using this CertificateTemplate.
If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If the issuing CaPool's IssuancePolicy defines 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's predefined_values.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Security\PrivateCA\V1\CertificateExtensionConstraints
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A human-readable description of scenarios this template is intended for.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A human-readable description of scenarios this template is intended for.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time at which this CertificateTemplate was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this CertificateTemplate was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time at which this CertificateTemplate was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which this CertificateTemplate was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Labels with user-defined metadata.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Labels with user-defined metadata.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|