Reference documentation and code samples for the Cloud Spanner V1 Client class UpdateInstanceConfigRequest.
The request for UpdateInstanceConfigRequest.
Generated from protobuf message google.spanner.admin.instance.v1.UpdateInstanceConfigRequest
Namespace
Google \ Cloud \ Spanner \ Admin \ Instance \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ instance_config |
Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig
Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used. |
↳ update_mask |
Google\Protobuf\FieldMask
Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated. |
↳ validate_only |
bool
An option to validate, but not actually execute, a request, and provide the same response. |
getInstanceConfig
Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig|null | |
hasInstanceConfig
clearInstanceConfig
setInstanceConfig
Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateMask
Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null | |
hasUpdateMask
clearUpdateMask
setUpdateMask
Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValidateOnly
An option to validate, but not actually execute, a request, and provide the same response.
| Returns | |
|---|---|
| Type | Description |
bool | |
setValidateOnly
An option to validate, but not actually execute, a request, and provide the same response.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameters | |
|---|---|
| Name | Description |
instanceConfig |
Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig
Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used. |
updateMask |
Google\Protobuf\FieldMask
Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\Admin\Instance\V1\UpdateInstanceConfigRequest | |