1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Config
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsDeployments

ProjectsLocationsDeployments

class ProjectsLocationsDeployments extends Resource (View source)

The "deployments" collection of methods.

Typical usage is:

 $configService = new Google\Service\Config(...);
 $deployments = $configService->projects_locations_deployments;

Methods

Operation
create(string $parent, Deployment $postBody, array $optParams = [])

Creates a Deployment. (deployments.create)

Operation
delete(string $name, array $optParams = [])

Deletes a Deployment. (deployments.delete)

ConfigEmpty
deleteState(string $name, DeleteStatefileRequest $postBody, array $optParams = [])

Deletes Terraform state file in a given deployment. (deployments.deleteState)

LockInfo
exportLock(string $name, array $optParams = [])

Exports the lock info on a locked deployment. (deployments.exportLock)

Statefile
exportState(string $parent, ExportDeploymentStatefileRequest $postBody, array $optParams = [])

Exports Terraform state file from a given deployment.

Deployment
get(string $name, array $optParams = [])

Gets details about a Deployment. (deployments.get)

Policy
getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (deployments.getIamPolicy)

Statefile
importState(string $parent, ImportStatefileRequest $postBody, array $optParams = [])

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked. (deployments.importState)

ListDeploymentsResponse
listProjectsLocationsDeployments(string $parent, array $optParams = [])

Lists Deployments in a given project and location.

Operation
lock(string $name, LockDeploymentRequest $postBody, array $optParams = [])

Locks a deployment. (deployments.lock)

Operation
patch(string $name, Deployment $postBody, array $optParams = [])

Updates a Deployment. (deployments.patch)

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (deployments.setIamPolicy)

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Operation
unlock(string $name, UnlockDeploymentRequest $postBody, array $optParams = [])

Unlocks a locked deployment. (deployments.unlock)

Details

at line 70
Operation create(string $parent, Deployment $postBody, array $optParams = [])

Creates a Deployment. (deployments.create)

Parameters

string $parent

Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
Deployment $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 103
Operation delete(string $name, array $optParams = [])

Deletes a Deployment. (deployments.delete)

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 119
ConfigEmpty deleteState(string $name, DeleteStatefileRequest $postBody, array $optParams = [])

Deletes Terraform state file in a given deployment. (deployments.deleteState)

Parameters

string $name

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
DeleteStatefileRequest $postBody
array $optParams

Optional parameters.

Return Value

ConfigEmpty

Exceptions

Exception

at line 134
LockInfo exportLock(string $name, array $optParams = [])

Exports the lock info on a locked deployment. (deployments.exportLock)

Parameters

string $name

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

Optional parameters.

Return Value

LockInfo

Exceptions

Exception

at line 152
Statefile exportState(string $parent, ExportDeploymentStatefileRequest $postBody, array $optParams = [])

Exports Terraform state file from a given deployment.

(deployments.exportState)

Parameters

string $parent

Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
ExportDeploymentStatefileRequest $postBody
array $optParams

Optional parameters.

Return Value

Statefile

Exceptions

Exception

at line 167
Deployment get(string $name, array $optParams = [])

Gets details about a Deployment. (deployments.get)

Parameters

string $name

Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
array $optParams

Optional parameters.

Return Value

Deployment

Exceptions

Exception

at line 198
Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (deployments.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 216
Statefile importState(string $parent, ImportStatefileRequest $postBody, array $optParams = [])

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked. (deployments.importState)

Parameters

string $parent

Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
ImportStatefileRequest $postBody
array $optParams

Optional parameters.

Return Value

Statefile

Exceptions

Exception

at line 252
ListDeploymentsResponse listProjectsLocationsDeployments(string $parent, array $optParams = [])

Lists Deployments in a given project and location.

(deployments.listProjectsLocationsDeployments)

Parameters

string $parent

Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
array $optParams

Optional parameters.

Return Value

ListDeploymentsResponse

Exceptions

Exception

at line 268
Operation lock(string $name, LockDeploymentRequest $postBody, array $optParams = [])

Locks a deployment. (deployments.lock)

Parameters

string $name

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
LockDeploymentRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 301
Operation patch(string $name, Deployment $postBody, array $optParams = [])

Updates a Deployment. (deployments.patch)

Parameters

string $name

Resource name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}
Deployment $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 321
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (deployments.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 344
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (deployments.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception

at line 360
Operation unlock(string $name, UnlockDeploymentRequest $postBody, array $optParams = [])

Unlocks a locked deployment. (deployments.unlock)

Parameters

string $name

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
UnlockDeploymentRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception