Google Cloud BeyondCorp Client Connector Services V1 Client - Class UpdateClientConnectorServiceRequest (1.0.2)

Reference documentation and code samples for the Google Cloud BeyondCorp Client Connector Services V1 Client class UpdateClientConnectorServiceRequest.

Message for updating a ClientConnectorService

Generated from protobuf message google.cloud.beyondcorp.clientconnectorservices.v1.UpdateClientConnectorServiceRequest

Namespace

Google \ Cloud \ BeyondCorp \ ClientConnectorServices \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ update_mask Google\Protobuf\FieldMask

Required. Field mask is used to specify the fields to be overwritten in the ClientConnectorService resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. Mutable fields: display_name.

↳ client_connector_service ClientConnectorService

Required. The resource being updated.

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

↳ validate_only bool

Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

↳ allow_missing bool

Optional. If set as true, will create the resource if it is not found.

getUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the ClientConnectorService resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. Mutable fields: display_name.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the ClientConnectorService resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. Mutable fields: display_name.

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

getClientConnectorService

Required. The resource being updated.

Returns
Type Description
ClientConnectorService|null

hasClientConnectorService

clearClientConnectorService

setClientConnectorService

Required. The resource being updated.

Parameter
Name Description
var ClientConnectorService
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 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 t he 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 optional request 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 t he 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

getValidateOnly

Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

Returns
Type Description
bool

setValidateOnly

Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAllowMissing

Optional. If set as true, will create the resource if it is not found.

Returns
Type Description
bool

setAllowMissing

Optional. If set as true, will create the resource if it is not found.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
clientConnectorService ClientConnectorService

Required. The resource being updated.

updateMask Google\Protobuf\FieldMask

Required. Field mask is used to specify the fields to be overwritten in the ClientConnectorService resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Mutable fields: display_name.

Returns
Type Description
UpdateClientConnectorServiceRequest