Reference documentation and code samples for the Google Certificate Authority Service V1 Client class RevokeCertificateRequest.
Request message for CertificateAuthorityService.RevokeCertificate.
Generated from protobuf message google.cloud.security.privateca.v1.RevokeCertificateRequest
Namespace
Google \ Cloud \ Security \ PrivateCA \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The resource name for this Certificate in the format |
↳ reason |
int
Required. The RevocationReason for revoking this certificate. |
↳ 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). |
getName
Required. The resource name for this
Certificate in the format
projects/*/locations/*/caPools/*/certificates/*.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The resource name for this
Certificate in the format
projects/*/locations/*/caPools/*/certificates/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReason
Required. The RevocationReason for revoking this certificate.
| Returns | |
|---|---|
| Type | Description |
int | |
setReason
Required. The RevocationReason for revoking this certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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 | |
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The resource name for this
Certificate in the format
|
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Security\PrivateCA\V1\RevokeCertificateRequest | |