Google Certificate Authority Service V1 Client - Class CreateCertificateAuthorityRequest (1.7.2)

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

Request message for CertificateAuthorityService.CreateCertificateAuthority.

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

Namespace

Google \ Cloud \ Security \ PrivateCA \ V1

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 CertificateAuthorities, in the format projects/*/locations/*/caPools/*.

↳ certificate_authority_id string

Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}

↳ certificate_authority Google\Cloud\Security\PrivateCA\V1\CertificateAuthority

Required. A CertificateAuthority 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).

getParent

Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format projects/*/locations/*/caPools/*.

Returns
Type Description
string

setParent

Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format projects/*/locations/*/caPools/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getCertificateAuthorityId

Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}

Returns
Type Description
string

setCertificateAuthorityId

Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}

Parameter
Name Description
var string
Returns
Type Description
$this

getCertificateAuthority

Required. A CertificateAuthority with initial field values.

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

hasCertificateAuthority

clearCertificateAuthority

setCertificateAuthority

Required. A CertificateAuthority with initial field values.

Parameter
Name Description
var Google\Cloud\Security\PrivateCA\V1\CertificateAuthority
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

Parameters
Name Description
parent string

Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format projects/*/locations/*/caPools/*. Please see Google\Cloud\Security\PrivateCA\V1\CertificateAuthorityServiceClient::caPoolName() for help formatting this field.

certificateAuthority Google\Cloud\Security\PrivateCA\V1\CertificateAuthority

Required. A CertificateAuthority with initial field values.

certificateAuthorityId string

Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}

Returns
Type Description
Google\Cloud\Security\PrivateCA\V1\CreateCertificateAuthorityRequest