Cloud Spanner V1 Client - Class UpdateInstanceConfigRequest (1.87.0)

Version 1.87.0

• 1.89.0 (latest)
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

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
Name	Description
data	array Optional. Data for populating the Message object.
↳ instance_config	Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig Required. The user instance configuration to update, which must always include the instance configuration 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 configuration to update, which must always include the instance configuration 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 configuration to update, which must always include the instance configuration 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 configuration to update, which must always include the instance configuration 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