Google Cloud Network Connectivity V1 Client - Class UpdateMulticloudDataTransferConfigRequest (2.4.0)

Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class UpdateMulticloudDataTransferConfigRequest.

Request message to update a MulticloudDataTransferConfig resource.

Generated from protobuf message google.cloud.networkconnectivity.v1.UpdateMulticloudDataTransferConfigRequest

Namespace

Google \ Cloud \ NetworkConnectivity \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ update_mask Google\Protobuf\FieldMask

Optional. FieldMask is used to specify the fields in the MulticloudDataTransferConfig resource to be overwritten by the update. The fields specified in update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten.

↳ multicloud_data_transfer_config MulticloudDataTransferConfig

Required. The MulticloudDataTransferConfig resource to update.

↳ request_id string

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate MulticloudDataTransferConfig resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported.

getUpdateMask

Optional. FieldMask is used to specify the fields in the MulticloudDataTransferConfig resource to be overwritten by the update.

The fields specified in update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. FieldMask is used to specify the fields in the MulticloudDataTransferConfig resource to be overwritten by the update.

The fields specified in update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten.

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

getMulticloudDataTransferConfig

Required. The MulticloudDataTransferConfig resource to update.

Returns
Type Description
MulticloudDataTransferConfig|null

hasMulticloudDataTransferConfig

clearMulticloudDataTransferConfig

setMulticloudDataTransferConfig

Required. The MulticloudDataTransferConfig resource to update.

Parameter
Name Description
var MulticloudDataTransferConfig
Returns
Type Description
$this

getRequestId

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate MulticloudDataTransferConfig resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported.

Returns
Type Description
string

setRequestId

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate MulticloudDataTransferConfig resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
multicloudDataTransferConfig MulticloudDataTransferConfig

Required. The MulticloudDataTransferConfig resource to update.

updateMask Google\Protobuf\FieldMask

Optional. FieldMask is used to specify the fields in the MulticloudDataTransferConfig resource to be overwritten by the update. The fields specified in update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten.

Returns
Type Description
UpdateMulticloudDataTransferConfigRequest