Reference documentation and code samples for the Google Certificate Authority Service V1 Client class CreateCertificateRequest.
Request message for CertificateAuthorityService.CreateCertificate.
Generated from protobuf message google.cloud.security.privateca.v1.CreateCertificateRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the CaPool associated with the Certificate, in the format |
↳ certificate_id |
string
Optional. It must be unique within a location and match the regular expression |
↳ certificate |
Google\Cloud\Security\PrivateCA\V1\Certificate
Required. A Certificate with initial field values. |
↳ request_id |
string
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ validate_only |
bool
Optional. If this is true, no Certificate resource will be persisted regardless of the CaPool's tier, and the returned Certificate will not contain the pem_certificate field. |
↳ issuing_certificate_authority_id |
string
Optional. The resource ID of the CertificateAuthority that should issue the certificate. This optional field will ignore the load-balancing scheme of the Pool and directly issue the certificate from the CA with the specified ID, contained in the same CaPool referenced by |
getParent
Required. The resource name of the CaPool associated with the Certificate,
in the format projects/*/locations/*/caPools/*.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The resource name of the CaPool associated with the Certificate,
in the format projects/*/locations/*/caPools/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCertificateId
Optional. It must be unique within a location and match the regular
expression [a-zA-Z0-9_-]{1,63}. This field is required when using a
CertificateAuthority in the Enterprise CertificateAuthority.Tier,
but is optional and its value is ignored otherwise.
| Returns | |
|---|---|
| Type | Description |
string | |
setCertificateId
Optional. It must be unique within a location and match the regular
expression [a-zA-Z0-9_-]{1,63}. This field is required when using a
CertificateAuthority in the Enterprise CertificateAuthority.Tier,
but is optional and its value is ignored otherwise.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCertificate
Required. A Certificate with initial field values.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Security\PrivateCA\V1\Certificate|null | |
hasCertificate
clearCertificate
setCertificate
Required. A Certificate with initial field values.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Security\PrivateCA\V1\Certificate
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestId
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Returns | |
|---|---|
| Type | Description |
string | |
setRequestId
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValidateOnly
Optional. If this is true, no Certificate resource will be persisted regardless of the CaPool's tier, and the returned Certificate will not contain the pem_certificate field.
| Returns | |
|---|---|
| Type | Description |
bool | |
setValidateOnly
Optional. If this is true, no Certificate resource will be persisted regardless of the CaPool's tier, and the returned Certificate will not contain the pem_certificate field.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIssuingCertificateAuthorityId
Optional. The resource ID of the CertificateAuthority that should issue the
certificate. This optional field will ignore the load-balancing scheme of
the Pool and directly issue the certificate from the CA with the specified
ID, contained in the same CaPool referenced by parent. Per-CA quota
rules apply. If left empty, a CertificateAuthority will be chosen from
the CaPool by the service. For example, to issue a Certificate from
a Certificate Authority with resource name
"projects/my-project/locations/us-central1/caPools/my-pool/certificateAuthorities/my-ca",
you can set the parent to
"projects/my-project/locations/us-central1/caPools/my-pool" and the
issuing_certificate_authority_id to "my-ca".
| Returns | |
|---|---|
| Type | Description |
string | |
setIssuingCertificateAuthorityId
Optional. The resource ID of the CertificateAuthority that should issue the
certificate. This optional field will ignore the load-balancing scheme of
the Pool and directly issue the certificate from the CA with the specified
ID, contained in the same CaPool referenced by parent. Per-CA quota
rules apply. If left empty, a CertificateAuthority will be chosen from
the CaPool by the service. For example, to issue a Certificate from
a Certificate Authority with resource name
"projects/my-project/locations/us-central1/caPools/my-pool/certificateAuthorities/my-ca",
you can set the parent to
"projects/my-project/locations/us-central1/caPools/my-pool" and the
issuing_certificate_authority_id to "my-ca".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |