Cloud Spanner V1 Client - Class DeleteInstanceConfigRequest (1.76.0)

Version latest

• 1.76.0 (latest)
• 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 DeleteInstanceConfigRequest.

The request for DeleteInstanceConfigRequest.

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

Namespace

Google \ Cloud \ Spanner \ Admin \ Instance \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. The name of the instance configuration to be deleted. Values are of the form projects/<project>/instanceConfigs/<instance_config>
↳ etag	string Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config.
↳ validate_only	bool An option to validate, but not actually execute, a request, and provide the same response.

getName

Required. The name of the instance configuration to be deleted.

Values are of the form projects/<project>/instanceConfigs/<instance_config>

Returns
Type	Description
string

setName

Required. The name of the instance configuration to be deleted.

Values are of the form projects/<project>/instanceConfigs/<instance_config>

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEtag

Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config.

Returns
Type	Description
string

setEtag

Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config.

Parameter
Name	Description
var	string

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

Parameter
Name	Description
name	string Required. The name of the instance configuration to be deleted. Values are of the form projects/<project>/instanceConfigs/<instance_config> Please see Google\Cloud\Spanner\Admin\Instance\V1\InstanceAdminClient::instanceConfigName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Spanner\Admin\Instance\V1\DeleteInstanceConfigRequest