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 CloudFilestoreManagerClient::instanceName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Filestore V1 Client - Class DeleteInstanceRequest (2.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.1 (latest)](/php/docs/reference/cloud-filestore/latest/V1.DeleteInstanceRequest)\n- [2.1.0](/php/docs/reference/cloud-filestore/2.1.0/V1.DeleteInstanceRequest)\n- [2.0.4](/php/docs/reference/cloud-filestore/2.0.4/V1.DeleteInstanceRequest)\n- [1.5.7](/php/docs/reference/cloud-filestore/1.5.7/V1.DeleteInstanceRequest)\n- [1.4.0](/php/docs/reference/cloud-filestore/1.4.0/V1.DeleteInstanceRequest)\n- [1.3.2](/php/docs/reference/cloud-filestore/1.3.2/V1.DeleteInstanceRequest)\n- [1.2.1](/php/docs/reference/cloud-filestore/1.2.1/V1.DeleteInstanceRequest)\n- [1.1.2](/php/docs/reference/cloud-filestore/1.1.2/V1.DeleteInstanceRequest)\n- [1.0.3](/php/docs/reference/cloud-filestore/1.0.3/V1.DeleteInstanceRequest) \nReference documentation and code samples for the Google Cloud Filestore V1 Client class DeleteInstanceRequest.\n\nDeleteInstanceRequest deletes an instance.\n\nGenerated from protobuf message `google.cloud.filestore.v1.DeleteInstanceRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Filestore \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The instance resource name, in the format\n`projects/{project_id}/locations/{location}/instances/{instance_id}`\n\n### setName\n\nRequired. The instance resource name, in the format\n`projects/{project_id}/locations/{location}/instances/{instance_id}`\n\n### getForce\n\nIf set to true, all snapshots of the instance will also be deleted.\n\n(Otherwise, the request will only work if the instance has no snapshots.)\n\n### setForce\n\nIf set to true, all snapshots of the instance will also be deleted.\n\n(Otherwise, the request will only work if the instance has no snapshots.)\n\n### static::build"]]
