Google Cloud AlloyDB for PostgreSQL V1 Client - Class GenerateClientCertificateRequest (1.1.0)

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 message google.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).
↳ cert_duration Google\Protobuf\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.
↳ 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 ceritificate 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:

  • projects/{project}/locations/{location}/clusters/{cluster}
Returns
Type Description
string

setParent

Required. The name of the parent resource. The required format is:

  • projects/{project}/locations/{location}/clusters/{cluster}
Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

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.

Returns
Type Description
Google\Protobuf\Duration|null

hasCertDuration

clearCertDuration

setCertDuration

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.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getPublicKey

Optional. The public key from the client.

Returns
Type Description
string

setPublicKey

Optional. The public key from the client.

Parameter
Name Description
var string
Returns
Type Description
$this

getUseMetadataExchange

Optional. An optional hint to the endpoint to generate a client ceritificate 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 ceritificate 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 see Google\Cloud\AlloyDb\V1\AlloyDBAdminClient::clusterName() for help formatting this field.
Returns
Type Description
Google\Cloud\AlloyDb\V1\GenerateClientCertificateRequest