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

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

Request message for CertificateAuthorityService.UpdateCertificateAuthority.

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

Namespace

Google \ Cloud \ Security \ PrivateCA \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

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

Required. CertificateAuthority with updated values.

↳ update_mask Google\Protobuf\FieldMask

Required. A list of fields to be updated in this request.

↳ 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).

getCertificateAuthority

Required.

CertificateAuthority with updated values.

Returns
TypeDescription
Google\Cloud\Security\PrivateCA\V1\CertificateAuthority|null

hasCertificateAuthority

clearCertificateAuthority

setCertificateAuthority

Required.

CertificateAuthority with updated values.

Parameter
NameDescription
var Google\Cloud\Security\PrivateCA\V1\CertificateAuthority
Returns
TypeDescription
$this

getUpdateMask

Required. A list of fields to be updated in this request.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. A list of fields to be updated in this request.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

static::build

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

Required. CertificateAuthority with updated values.

updateMask Google\Protobuf\FieldMask

Required. A list of fields to be updated in this request.

Returns
TypeDescription
Google\Cloud\Security\PrivateCA\V1\UpdateCertificateAuthorityRequest