Cloud Spanner V1 Client - Class DeleteInstanceConfigRequest (1.78.0)

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