Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class GenerateClientCertificateRequest.
Message for requests to generate a client certificate signed by the Cluster
CA.
Generated from protobuf messagegoogle.cloud.alloydb.v1.GenerateClientCertificateRequest
Namespace
Google \ Cloud \ AlloyDb \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The name of the parent resource. The required format is: * * projects/{project}/locations/{location}/clusters/{cluster}
↳ request_id
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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).
Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration.
↳ public_key
string
Optional. The public key from the client.
↳ use_metadata_exchange
bool
Optional. An optional hint to the endpoint to generate a client certificate that can be used by AlloyDB connectors to exchange additional metadata with the server after TLS handshake.
getParent
Required. The name of the parent resource. The required format is:
Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server ignores the
request if it has already been completed. The server guarantees 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 the original operation with the same request ID
was received, and if so, ignores 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 optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server ignores the
request if it has already been completed. The server guarantees 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 the original operation with the same request ID
was received, and if so, ignores 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
getCertDuration
Optional. An optional hint to the endpoint to generate the client
certificate with the requested duration. The duration can be from 1 hour to
24 hours. The endpoint may or may not honor the hint. If the hint is left
unspecified or is not honored, then the endpoint will pick an appropriate
default duration.
Optional. An optional hint to the endpoint to generate the client
certificate with the requested duration. The duration can be from 1 hour to
24 hours. The endpoint may or may not honor the hint. If the hint is left
unspecified or is not honored, then the endpoint will pick an appropriate
default duration.
Optional. An optional hint to the endpoint to generate a client certificate
that can be used by AlloyDB connectors to exchange additional metadata with
the server after TLS handshake.
Returns
Type
Description
bool
setUseMetadataExchange
Optional. An optional hint to the endpoint to generate a client certificate
that can be used by AlloyDB connectors to exchange additional metadata with
the server after TLS handshake.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The name of the parent resource. The required format is:
projects/{project}/locations/{location}/clusters/{cluster}
Please seeAlloyDBAdminClient::clusterName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud AlloyDB for PostgreSQL V1 Client - Class GenerateClientCertificateRequest (1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/php/docs/reference/cloud-alloydb/latest/V1.GenerateClientCertificateRequest)\n- [1.4.0](/php/docs/reference/cloud-alloydb/1.4.0/V1.GenerateClientCertificateRequest)\n- [1.3.0](/php/docs/reference/cloud-alloydb/1.3.0/V1.GenerateClientCertificateRequest)\n- [1.2.0](/php/docs/reference/cloud-alloydb/1.2.0/V1.GenerateClientCertificateRequest)\n- [1.1.3](/php/docs/reference/cloud-alloydb/1.1.3/V1.GenerateClientCertificateRequest)\n- [1.0.0](/php/docs/reference/cloud-alloydb/1.0.0/V1.GenerateClientCertificateRequest)\n- [0.10.3](/php/docs/reference/cloud-alloydb/0.10.3/V1.GenerateClientCertificateRequest)\n- [0.9.0](/php/docs/reference/cloud-alloydb/0.9.0/V1.GenerateClientCertificateRequest)\n- [0.8.0](/php/docs/reference/cloud-alloydb/0.8.0/V1.GenerateClientCertificateRequest)\n- [0.7.1](/php/docs/reference/cloud-alloydb/0.7.1/V1.GenerateClientCertificateRequest)\n- [0.6.0](/php/docs/reference/cloud-alloydb/0.6.0/V1.GenerateClientCertificateRequest)\n- [0.5.0](/php/docs/reference/cloud-alloydb/0.5.0/V1.GenerateClientCertificateRequest)\n- [0.4.0](/php/docs/reference/cloud-alloydb/0.4.0/V1.GenerateClientCertificateRequest)\n- [0.3.0](/php/docs/reference/cloud-alloydb/0.3.0/V1.GenerateClientCertificateRequest)\n- [0.2.1](/php/docs/reference/cloud-alloydb/0.2.1/V1.GenerateClientCertificateRequest)\n- [0.1.3](/php/docs/reference/cloud-alloydb/0.1.3/V1.GenerateClientCertificateRequest) \nReference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class GenerateClientCertificateRequest.\n\nMessage for requests to generate a client certificate signed by the Cluster\nCA.\n\nGenerated from protobuf message `google.cloud.alloydb.v1.GenerateClientCertificateRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AlloyDb \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The name of the parent resource. The required format is:\n\n- projects/{project}/locations/{location}/clusters/{cluster}\n\n### setParent\n\nRequired. The name of the parent resource. The required format is:\n\n- projects/{project}/locations/{location}/clusters/{cluster}\n\n### getRequestId\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID so that if you must retry your request, the server ignores the\nrequest if it has already been completed. The server guarantees that for at\nleast 60 minutes since the first request.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same request\nID, the server can check if the original operation with the same request ID\nwas received, and if so, ignores the second request. This prevents\nclients from accidentally creating duplicate commitments.\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n### setRequestId\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID so that if you must retry your request, the server ignores the\nrequest if it has already been completed. The server guarantees that for at\nleast 60 minutes since the first request.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same request\nID, the server can check if the original operation with the same request ID\nwas received, and if so, ignores the second request. This prevents\nclients from accidentally creating duplicate commitments.\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n### getCertDuration\n\nOptional. An optional hint to the endpoint to generate the client\ncertificate with the requested duration. The duration can be from 1 hour to\n24 hours. The endpoint may or may not honor the hint. If the hint is left\nunspecified or is not honored, then the endpoint will pick an appropriate\ndefault duration.\n\n### hasCertDuration\n\n### clearCertDuration\n\n### setCertDuration\n\nOptional. An optional hint to the endpoint to generate the client\ncertificate with the requested duration. The duration can be from 1 hour to\n24 hours. The endpoint may or may not honor the hint. If the hint is left\nunspecified or is not honored, then the endpoint will pick an appropriate\ndefault duration.\n\n### getPublicKey\n\nOptional. The public key from the client.\n\n### setPublicKey\n\nOptional. The public key from the client.\n\n### getUseMetadataExchange\n\nOptional. An optional hint to the endpoint to generate a client certificate\nthat can be used by AlloyDB connectors to exchange additional metadata with\nthe server after TLS handshake.\n\n### setUseMetadataExchange\n\nOptional. An optional hint to the endpoint to generate a client certificate\nthat can be used by AlloyDB connectors to exchange additional metadata with\nthe server after TLS handshake.\n\n### static::build"]]
