Cloud Spanner V1 Client - Class UpdateInstanceConfigRequest (1.65.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.

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.

Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

getValidateOnly

An option to validate, but not actually execute, a request, and provide the same response.

Returns
TypeDescription
bool

setValidateOnly

An option to validate, but not actually execute, a request, and provide the same response.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
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.