The "deployments" collection of methods. More...

Inheritance diagram for Google_Service_DeploymentManager_Deployments_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.

	cancelPreview ($project, $deployment, Google_Service_DeploymentManager_DeploymentsCancelPreviewRequest $postBody, $optParams=array())
	Cancels and removes the preview currently associated with the deployment.

	delete ($project, $deployment, $optParams=array())
	Deletes a deployment and all of the resources in the deployment.

	get ($project, $deployment, $optParams=array())
	Gets information about a specific deployment.

	insert ($project, Google_Service_DeploymentManager_Deployment $postBody, $optParams=array())
	Creates a deployment and all of the resources described by the deployment manifest.

	listDeployments ($project, $optParams=array())
	Lists all deployments for a given project.

	patch ($project, $deployment, Google_Service_DeploymentManager_Deployment $postBody, $optParams=array())
	Updates a deployment and all of the resources described by the deployment manifest.

	stop ($project, $deployment, Google_Service_DeploymentManager_DeploymentsStopRequest $postBody, $optParams=array())
	Stops an ongoing operation.

	update ($project, $deployment, Google_Service_DeploymentManager_Deployment $postBody, $optParams=array())
	Updates a deployment and all of the resources described by the deployment manifest.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "deployments" collection of methods.

Typical usage is: $deploymentmanagerService = new Google_Service_DeploymentManager(...); $deployments = $deploymentmanagerService->deployments;

Member Function Documentation

◆ call()

Google_Service_Resource::call	(	$name,
		$arguments,
		$expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

◆ cancelPreview()

Google_Service_DeploymentManager_Deployments_Resource::cancelPreview	(		$project,
			$deployment,
		Google_Service_DeploymentManager_DeploymentsCancelPreviewRequest	$postBody,
			$optParams = array() )

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.
Google_DeploymentsCancelPreviewRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_DeploymentManager_Operation

◆ delete()

Google_Service_DeploymentManager_Deployments_Resource::delete	(	$project,
		$deployment,
		$optParams = array() )

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 values

Google_Service_DeploymentManager_Operation

◆ get()

Google_Service_DeploymentManager_Deployments_Resource::get	(	$project,
		$deployment,
		$optParams = array() )

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 values

Google_Service_DeploymentManager_Deployment

◆ insert()

Google_Service_DeploymentManager_Deployments_Resource::insert	(		$project,
		Google_Service_DeploymentManager_Deployment	$postBody,
			$optParams = array() )

Creates a deployment and all of the resources described by the deployment manifest.

(deployments.insert)

Parameters

string	$project	The project ID for this request.
Google_Deployment	$postBody
array	$optParams	Optional parameters.

@opt_param bool preview If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

Return values

Google_Service_DeploymentManager_Operation

◆ listDeployments()

Google_Service_DeploymentManager_Deployments_Resource::listDeployments	(		$project,
			$optParams = array() )

Lists all deployments for a given project.

(deployments.listDeployments)

Parameters

string	$project	The project ID for this request.
array	$optParams	Optional parameters.

@opt_param string filter Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.

The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, filter=name ne example-instance. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request. @opt_param string maxResults Maximum count of results to be returned.

Return values

Google_Service_DeploymentManager_DeploymentsListResponse

◆ patch()

Google_Service_DeploymentManager_Deployments_Resource::patch	(		$project,
			$deployment,
		Google_Service_DeploymentManager_Deployment	$postBody,
			$optParams = array() )

Updates a deployment and all of the resources described by the deployment manifest.

This method supports patch semantics. (deployments.patch)

Parameters

string	$project	The project ID for this request.
string	$deployment	The name of the deployment for this request.
Google_Deployment	$postBody
array	$optParams	Optional parameters.

@opt_param bool preview If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. @opt_param string deletePolicy Sets the policy to use for deleting resources. @opt_param string createPolicy Sets the policy to use for creating new resources.

Return values

Google_Service_DeploymentManager_Operation

◆ stop()

Google_Service_DeploymentManager_Deployments_Resource::stop	(		$project,
			$deployment,
		Google_Service_DeploymentManager_DeploymentsStopRequest	$postBody,
			$optParams = array() )

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.
Google_DeploymentsStopRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_DeploymentManager_Operation

◆ update()

Google_Service_DeploymentManager_Deployments_Resource::update	(		$project,
			$deployment,
		Google_Service_DeploymentManager_Deployment	$postBody,
			$optParams = array() )

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.
Google_Deployment	$postBody
array	$optParams	Optional parameters.

@opt_param bool preview If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. @opt_param string deletePolicy Sets the policy to use for deleting resources. @opt_param string createPolicy Sets the policy to use for creating new resources.

Return values

Google_Service_DeploymentManager_Operation

The documentation for this class was generated from the following file:

lib/google/src/Google/Service/DeploymentManager.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ call()

◆ cancelPreview()

◆ delete()

◆ get()

◆ insert()

◆ listDeployments()

◆ patch()

◆ stop()

◆ update()