Reference documentation and code samples for the Google Cloud Config V1 Client class DeleteStatefileRequest.
A request to delete a state file passed to a 'DeleteStatefile' call.
Generated from protobuf messagegoogle.cloud.config.v1.DeleteStatefileRequest
Namespace
Google \ Cloud \ Config \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
↳ lock_id
int|string
Required. Lock ID of the lock file to verify that the user who is deleting the state file previously locked the Deployment.
getName
Required. The name of the deployment in the format:
'projects/{project_id}/locations/{location}/deployments/{deployment}'.
Returns
Type
Description
string
setName
Required. The name of the deployment in the format:
'projects/{project_id}/locations/{location}/deployments/{deployment}'.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLockId
Required. Lock ID of the lock file to verify that the user who is deleting
the state file previously locked the Deployment.
Returns
Type
Description
int|string
setLockId
Required. Lock ID of the lock file to verify that the user who is deleting
the state file previously locked the Deployment.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. The name of the deployment in the format:
'projects/{project_id}/locations/{location}/deployments/{deployment}'. Please seeConfigClient::deploymentName()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 Config V1 Client - Class DeleteStatefileRequest (1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/php/docs/reference/cloud-config/latest/V1.DeleteStatefileRequest)\n- [1.4.0](/php/docs/reference/cloud-config/1.4.0/V1.DeleteStatefileRequest)\n- [1.3.0](/php/docs/reference/cloud-config/1.3.0/V1.DeleteStatefileRequest)\n- [1.2.1](/php/docs/reference/cloud-config/1.2.1/V1.DeleteStatefileRequest)\n- [1.1.0](/php/docs/reference/cloud-config/1.1.0/V1.DeleteStatefileRequest)\n- [1.0.1](/php/docs/reference/cloud-config/1.0.1/V1.DeleteStatefileRequest)\n- [0.5.2](/php/docs/reference/cloud-config/0.5.2/V1.DeleteStatefileRequest)\n- [0.2.0](/php/docs/reference/cloud-config/0.2.0/V1.DeleteStatefileRequest)\n- [0.1.3](/php/docs/reference/cloud-config/0.1.3/V1.DeleteStatefileRequest) \nReference documentation and code samples for the Google Cloud Config V1 Client class DeleteStatefileRequest.\n\nA request to delete a state file passed to a 'DeleteStatefile' call.\n\nGenerated from protobuf message `google.cloud.config.v1.DeleteStatefileRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Config \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The name of the deployment in the format:\n'projects/{project_id}/locations/{location}/deployments/{deployment}'.\n\n### setName\n\nRequired. The name of the deployment in the format:\n'projects/{project_id}/locations/{location}/deployments/{deployment}'.\n\n### getLockId\n\nRequired. Lock ID of the lock file to verify that the user who is deleting\nthe state file previously locked the Deployment.\n\n### setLockId\n\nRequired. Lock ID of the lock file to verify that the user who is deleting\nthe state file previously locked the Deployment.\n\n### static::build"]]
