Cloud Spanner V1 Client - Class DeleteInstancePartitionRequest (1.85.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class DeleteInstancePartitionRequest.

The request for DeleteInstancePartition.

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

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 partition to be deleted. Values are of the form projects/{project}/instances/{instance}/instancePartitions/{instance_partition}
↳ etag string

Optional. If not empty, the API only deletes the instance partition when the etag provided matches the current status of the requested instance partition. Otherwise, deletes the instance partition without checking the current status of the requested instance partition.

getName

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

Values are of the form projects/{project}/instances/{instance}/instancePartitions/{instance_partition}

Returns
Type Description
string

setName

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

Values are of the form projects/{project}/instances/{instance}/instancePartitions/{instance_partition}

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Optional. If not empty, the API only deletes the instance partition when the etag provided matches the current status of the requested instance partition. Otherwise, deletes the instance partition without checking the current status of the requested instance partition.

Returns
Type Description
string

setEtag

Optional. If not empty, the API only deletes the instance partition when the etag provided matches the current status of the requested instance partition. Otherwise, deletes the instance partition without checking the current status of the requested instance partition.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the instance partition to be deleted. Values are of the form projects/{project}/instances/{instance}/instancePartitions/{instance_partition} Please see Google\Cloud\Spanner\Admin\Instance\V1\InstanceAdminClient::instancePartitionName() for help formatting this field.
Returns
Type Description
Google\Cloud\Spanner\Admin\Instance\V1\DeleteInstancePartitionRequest