Reference documentation and code samples for the AlloyDB V1 API class Google::Cloud::AlloyDB::V1::GenerateClientCertificateRequest.
Message for requests to generate a client certificate signed by the Cluster
CA.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#cert_duration
defcert_duration()->::Google::Protobuf::Duration
Returns
(::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.
value (::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.
Returns
(::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.
#parent
defparent()->::String
Returns
(::String) —
Required. The name of the parent resource. The required format is:
(::String) — Optional. The public key from the client.
#public_key=
defpublic_key=(value)->::String
Parameter
value (::String) — Optional. The public key from the client.
Returns
(::String) — Optional. The public key from the client.
#request_id
defrequest_id()->::String
Returns
(::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).
#request_id=
defrequest_id=(value)->::String
Parameter
value (::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).
Returns
(::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).
#use_metadata_exchange
defuse_metadata_exchange()->::Boolean
Returns
(::Boolean) — 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.
#use_metadata_exchange=
defuse_metadata_exchange=(value)->::Boolean
Parameter
value (::Boolean) — 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
(::Boolean) — 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.
[[["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-08-07 UTC."],[],[],null,["# AlloyDB V1 API - Class Google::Cloud::AlloyDB::V1::GenerateClientCertificateRequest (v1.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.1 (latest)](/ruby/docs/reference/google-cloud-alloy_db-v1/latest/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-alloy_db-v1/1.3.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-alloy_db-v1/1.2.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-alloy_db-v1/1.1.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-alloy_db-v1/1.0.1/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-alloy_db-v1/0.12.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-alloy_db-v1/0.11.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-alloy_db-v1/0.10.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [0.9.2](/ruby/docs/reference/google-cloud-alloy_db-v1/0.9.2/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [0.8.2](/ruby/docs/reference/google-cloud-alloy_db-v1/0.8.2/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [0.7.0](/ruby/docs/reference/google-cloud-alloy_db-v1/0.7.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-alloy_db-v1/0.6.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-alloy_db-v1/0.5.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-alloy_db-v1/0.4.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-alloy_db-v1/0.3.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-alloy_db-v1/0.2.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-alloy_db-v1/0.1.0/Google-Cloud-AlloyDB-V1-GenerateClientCertificateRequest) \nReference documentation and code samples for the AlloyDB V1 API class Google::Cloud::AlloyDB::V1::GenerateClientCertificateRequest.\n\nMessage for requests to generate a client certificate signed by the Cluster\nCA. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #cert_duration\n\n def cert_duration() -\u003e ::Google::Protobuf::Duration\n\n**Returns**\n\n- ([::Google::Protobuf::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.\n\n### #cert_duration=\n\n def cert_duration=(value) -\u003e ::Google::Protobuf::Duration\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::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. \n**Returns**\n\n- ([::Google::Protobuf::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.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The name of the parent resource. The required format is:\n\n - projects/{project}/locations/{location}/clusters/{cluster}\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) ---\n\n Required. The name of the parent resource. The required format is:\n- projects/{project}/locations/{location}/clusters/{cluster} \n**Returns**\n\n- (::String) --- Required. The name of the parent resource. The required format is:\n\n - projects/{project}/locations/{location}/clusters/{cluster}\n\n### #public_key\n\n def public_key() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The public key from the client.\n\n### #public_key=\n\n def public_key=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The public key from the client. \n**Returns**\n\n- (::String) --- Optional. The public key from the client.\n\n### #request_id\n\n def request_id() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n For example, consider a situation where you make an initial request and\n the request times out. If you make the request again with the same request\n ID, the server can check if the original operation with the same request ID\n was received, and if so, ignores the second request. This prevents\n clients from accidentally creating duplicate commitments.\n\n The request ID must be a valid UUID with the exception that zero UUID is\n not supported (00000000-0000-0000-0000-000000000000).\n\n### #request_id=\n\n def request_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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.\n\n\n For example, consider a situation where you make an initial request and\n the request times out. If you make the request again with the same request\n ID, the server can check if the original operation with the same request ID\n was received, and if so, ignores the second request. This prevents\n clients from accidentally creating duplicate commitments.\n\n The request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000). \n**Returns**\n\n- (::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.\n\n For example, consider a situation where you make an initial request and\n the request times out. If you make the request again with the same request\n ID, the server can check if the original operation with the same request ID\n was received, and if so, ignores the second request. This prevents\n clients from accidentally creating duplicate commitments.\n\n The request ID must be a valid UUID with the exception that zero UUID is\n not supported (00000000-0000-0000-0000-000000000000).\n\n### #use_metadata_exchange\n\n def use_metadata_exchange() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- 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.\n\n### #use_metadata_exchange=\n\n def use_metadata_exchange=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- 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. \n**Returns**\n\n- (::Boolean) --- 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."]]