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 | |
|---|---|
| Name | Description |
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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\Admin\Instance\V1\Instance
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameters | |
|---|---|
| Name | Description |
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. |
fieldMask |
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. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\Admin\Instance\V1\UpdateInstanceRequest | |