Google Cloud Data Fusion V1 Client - Class UpdateInstanceRequest (0.3.0)

Reference documentation and code samples for the Google Cloud Data Fusion V1 Client class UpdateInstanceRequest.

Request message for updating a Data Fusion instance.

Data Fusion allows updating the labels, options, and stack driver settings. This is also used for CDF version upgrade.

Generated from protobuf message google.cloud.datafusion.v1.UpdateInstanceRequest

Methods

build

Parameters
NameDescription
instance Google\Cloud\DataFusion\V1\Instance

Required. The instance resource that replaces the resource on the server. Currently, Data Fusion only allows replacing labels, options, and stack driver settings. All other fields will be ignored.

updateMask Google\Protobuf\FieldMask

Field mask is used to specify the fields that the update will overwrite in an instance resource. 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, all the supported fields (labels, options, and version currently) will be overwritten.

Returns
TypeDescription
Google\Cloud\DataFusion\V1\UpdateInstanceRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ instance Google\Cloud\DataFusion\V1\Instance

Required. The instance resource that replaces the resource on the server. Currently, Data Fusion only allows replacing labels, options, and stack driver settings. All other fields will be ignored.

↳ update_mask Google\Protobuf\FieldMask

Field mask is used to specify the fields that the update will overwrite in an instance resource. 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, all the supported fields (labels, options, and version currently) will be overwritten.

getInstance

Required. The instance resource that replaces the resource on the server. Currently, Data Fusion only allows replacing labels, options, and stack driver settings. All other fields will be ignored.

Returns
TypeDescription
Google\Cloud\DataFusion\V1\Instance|null

hasInstance

clearInstance

setInstance

Required. The instance resource that replaces the resource on the server. Currently, Data Fusion only allows replacing labels, options, and stack driver settings. All other fields will be ignored.

Parameter
NameDescription
var Google\Cloud\DataFusion\V1\Instance
Returns
TypeDescription
$this

getUpdateMask

Field mask is used to specify the fields that the update will overwrite in an instance resource. 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, all the supported fields (labels, options, and version currently) will be overwritten.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Field mask is used to specify the fields that the update will overwrite in an instance resource. 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, all the supported fields (labels, options, and version currently) will be overwritten.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this