Google Certificate Authority Service V1 Client - Class CreateCaPoolRequest (1.3.1)

Version 1.3.1

• 2.0.1 (latest)
• 2.0.0
• 1.7.3
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.2
• 1.1.0
• 1.0.3

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

Request message for CertificateAuthorityService.CreateCaPool.

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

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 location associated with the CaPool, in the format projects/*/locations/*.
↳ ca_pool_id	string Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}
↳ ca_pool	Google\Cloud\Security\PrivateCA\V1\CaPool Required. A CaPool 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 location associated with the CaPool, in the format projects/*/locations/*.

Returns
Type	Description
string

setParent

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCaPoolId

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

Returns
Type	Description
string

setCaPoolId

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

getCaPool

Required. A CaPool with initial field values.

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

hasCaPool

clearCaPool

setCaPool

Required. A CaPool with initial field values.

Parameter
Name	Description
var	Google\Cloud\Security\PrivateCA\V1\CaPool

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 location associated with the CaPool, in the format projects/*/locations/*. Please see Google\Cloud\Security\PrivateCA\V1\CertificateAuthorityServiceClient::locationName() for help formatting this field.
caPool	Google\Cloud\Security\PrivateCA\V1\CaPool Required. A CaPool with initial field values.
caPoolId	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\CreateCaPoolRequest