Cloud Spanner V1 Client - Class UpdateInstanceRequest (1.54.2)

Reference documentation and code samples for the Cloud Spanner V1 Client class UpdateInstanceRequest.

The request for UpdateInstance.

Generated from protobuf message google.spanner.admin.instance.v1.UpdateInstanceRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ instance Google\Cloud\Spanner\Admin\Instance\V1\Instance

Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in field_mask need be included.

↳ field_mask Google\Protobuf\FieldMask

Required. A mask specifying which fields in Instance should be updated. The field mask must always be specified; this prevents any future fields in Instance from being erased accidentally by clients that do not know about them.

getInstance

Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in field_mask need be included.

Generated from protobuf field .google.spanner.admin.instance.v1.Instance instance = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Cloud\Spanner\Admin\Instance\V1\Instance|null

hasInstance

clearInstance

setInstance

Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in field_mask need be included.

Generated from protobuf field .google.spanner.admin.instance.v1.Instance instance = 1 [(.google.api.field_behavior) = REQUIRED];

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

getFieldMask

Required. A mask specifying which fields in Instance should be updated.

The field mask must always be specified; this prevents any future fields in Instance from being erased accidentally by clients that do not know about them.

Generated from protobuf field .google.protobuf.FieldMask field_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasFieldMask

clearFieldMask

setFieldMask

Required. A mask specifying which fields in Instance should be updated.

The field mask must always be specified; this prevents any future fields in Instance from being erased accidentally by clients that do not know about them.

Generated from protobuf field .google.protobuf.FieldMask field_mask = 2 [(.google.api.field_behavior) = REQUIRED];

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