class Deployments extends Resource (View source)

The "deployments" collection of methods.

Typical usage is:

 $deploymentmanagerService = new Google\Service\DeploymentManager(...);
 $deployments = $deploymentmanagerService->deployments;

Methods

cancelPreview(string $project, string $deployment, DeploymentsCancelPreviewRequest $postBody, array $optParams = [])

Cancels and removes the preview currently associated with the deployment.

delete(string $project, string $deployment, array $optParams = [])

Deletes a deployment and all of the resources in the deployment.

get(string $project, string $deployment, array $optParams = [])

Gets information about a specific deployment. (deployments.get)

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

Gets the access control policy for a resource. May be empty if no such policy or resource exists. (deployments.getIamPolicy)

insert(string $project, Deployment $postBody, array $optParams = [])

Creates a deployment and all of the resources described by the deployment manifest. (deployments.insert)

listDeployments(string $project, array $optParams = [])

Lists all deployments for a given project. (deployments.listDeployments)

patch(string $project, string $deployment, Deployment $postBody, array $optParams = [])

Patches a deployment and all of the resources described by the deployment manifest. (deployments.patch)

setIamPolicy(string $project, string $resource, GlobalSetPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. (deployments.setIamPolicy)

stop(string $project, string $deployment, DeploymentsStopRequest $postBody, array $optParams = [])

Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.

testIamPermissions(string $project, string $resource, TestPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource.

update(string $project, string $deployment, Deployment $postBody, array $optParams = [])

Updates a deployment and all of the resources described by the deployment manifest. (deployments.update)

Details

Operation cancelPreview(string $project, string $deployment, DeploymentsCancelPreviewRequest $postBody, array $optParams = [])

Cancels and removes the preview currently associated with the deployment.

(deployments.cancelPreview)

Parameters

string $project

The project ID for this request.

string $deployment

The name of the deployment for this request.

DeploymentsCancelPreviewRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a deployment and all of the resources in the deployment.

(deployments.delete)

Parameters

string $project

The project ID for this request.

string $deployment

The name of the deployment for this request.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Gets information about a specific deployment. (deployments.get)

Parameters

string $project

The project ID for this request.

string $deployment

The name of the deployment for this request.

array $optParams

Optional parameters.

Return Value

Deployment

Exceptions

Exception

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

Gets the access control policy for a resource. May be empty if no such policy or resource exists. (deployments.getIamPolicy)

Parameters

string $project

Project ID for this request.

string $resource

Name or id of the resource for this request.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

Operation insert(string $project, Deployment $postBody, array $optParams = [])

Creates a deployment and all of the resources described by the deployment manifest. (deployments.insert)

Parameters

string $project

The project ID for this request.

Deployment $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

DeploymentsListResponse listDeployments(string $project, array $optParams = [])

Lists all deployments for a given project. (deployments.listDeployments)

Parameters

string $project

The project ID for this request.

array $optParams

Optional parameters.

Return Value

DeploymentsListResponse

Exceptions

Exception

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

Patches a deployment and all of the resources described by the deployment manifest. (deployments.patch)

Parameters

string $project

The project ID for this request.

string $deployment

The name of the deployment for this request.

Deployment $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Sets the access control policy on the specified resource. Replaces any existing policy. (deployments.setIamPolicy)

Parameters

string $project

Project ID for this request.

string $resource

Name or id of the resource for this request.

GlobalSetPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

Operation stop(string $project, string $deployment, DeploymentsStopRequest $postBody, array $optParams = [])

Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.

(deployments.stop)

Parameters

string $project

The project ID for this request.

string $deployment

The name of the deployment for this request.

DeploymentsStopRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

TestPermissionsResponse testIamPermissions(string $project, string $resource, TestPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource.

(deployments.testIamPermissions)

Parameters

string $project

Project ID for this request.

string $resource

Name or id of the resource for this request.

TestPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestPermissionsResponse

Exceptions

Exception

Operation update(string $project, string $deployment, Deployment $postBody, array $optParams = [])

Updates a deployment and all of the resources described by the deployment manifest. (deployments.update)

Parameters

string $project

The project ID for this request.

string $deployment

The name of the deployment for this request.

Deployment $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception