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 \ V1Methods
__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 see ConfigClient::deploymentName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
DeleteStatefileRequest |
|