Google Certificate Authority Service V1 Client - Class ActivateCertificateAuthorityRequest (2.0.0)

Reference documentation and code samples for the Google Certificate Authority Service V1 Client class ActivateCertificateAuthorityRequest.

Request message for CertificateAuthorityService.ActivateCertificateAuthority.

Generated from protobuf message google.cloud.security.privateca.v1.ActivateCertificateAuthorityRequest

Namespace

Google \ Cloud \ Security \ PrivateCA \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.
↳ pem_ca_certificate string

Required. The signed CA certificate issued from FetchCertificateAuthorityCsrResponse.pem_csr.
↳ subordinate_config Google\Cloud\Security\PrivateCA\V1\SubordinateConfig

Required. Must include information about the issuer of 'pem_ca_certificate', and any further issuers until the self-signed CA.
↳ 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 CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.

Returns
Type Description
string

setName

Required. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getPemCaCertificate

Required. The signed CA certificate issued from FetchCertificateAuthorityCsrResponse.pem_csr.

Returns
Type Description
string

setPemCaCertificate

Required. The signed CA certificate issued from FetchCertificateAuthorityCsrResponse.pem_csr.

Parameter
Name Description
var string
Returns
Type Description
$this

getSubordinateConfig

Required. Must include information about the issuer of 'pem_ca_certificate', and any further issuers until the self-signed CA.

Returns
Type Description
Google\Cloud\Security\PrivateCA\V1\SubordinateConfig|null

hasSubordinateConfig

clearSubordinateConfig

setSubordinateConfig

Required. Must include information about the issuer of 'pem_ca_certificate', and any further issuers until the self-signed CA.

Parameter
Name Description
var Google\Cloud\Security\PrivateCA\V1\SubordinateConfig
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 CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*. Please see Google\Cloud\Security\PrivateCA\V1\CertificateAuthorityServiceClient::certificateAuthorityName() for help formatting this field.
Returns
Type Description
Google\Cloud\Security\PrivateCA\V1\ActivateCertificateAuthorityRequest