Google Cloud Filestore V1 Client - Class DeleteInstanceRequest (1.4.0)

Version 1.4.0

• 2.0.2 (latest)
• 2.0.1
• 1.5.7
• 1.4.0
• 1.3.2
• 1.2.1
• 1.1.2
• 1.0.3

Reference documentation and code samples for the Google Cloud Filestore V1 Client class DeleteInstanceRequest.

DeleteInstanceRequest deletes an instance.

Generated from protobuf message google.cloud.filestore.v1.DeleteInstanceRequest

Namespace

Google \ Cloud \ Filestore \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}
↳ force	bool If set to true, all snapshots of the instance will also be deleted. (Otherwise, the request will only work if the instance has no snapshots.)

getName

Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}

Returns
Type	Description
string

setName

Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getForce

If set to true, all snapshots of the instance will also be deleted.

(Otherwise, the request will only work if the instance has no snapshots.)

Returns
Type	Description
bool

setForce

If set to true, all snapshots of the instance will also be deleted.

(Otherwise, the request will only work if the instance has no snapshots.)

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

static::build

Parameter
Name	Description
name	string Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} Please see Google\Cloud\Filestore\V1\CloudFilestoreManagerClient::instanceName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Filestore\V1\DeleteInstanceRequest