Google Cloud Config V1 Client - Class DeleteStatefileRequest (0.2.0)

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 message google.cloud.config.v1.DeleteStatefileRequest

Namespace

Google \ Cloud \ Config \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int|string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. Please see Google\Cloud\Config\V1\ConfigClient::deploymentName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Config\V1\DeleteStatefileRequest