Documentation

Google_Service_DeploymentManager_Resource_Deployments extends Google_Service_Resource
in package

The "deployments" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
cancelPreview()  : Google_Service_DeploymentManager_Operation
Cancels and removes the preview currently associated with the deployment.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DeploymentManager_Operation
Deletes a deployment and all of the resources in the deployment.
get()  : Google_Service_DeploymentManager_Deployment
Gets information about a specific deployment. (deployments.get)
getIamPolicy()  : Google_Service_DeploymentManager_Policy
Gets the access control policy for a resource. May be empty if no such policy or resource exists. (deployments.getIamPolicy)
insert()  : Google_Service_DeploymentManager_Operation
Creates a deployment and all of the resources described by the deployment manifest. (deployments.insert)
listDeployments()  : Google_Service_DeploymentManager_DeploymentsListResponse
Lists all deployments for a given project. (deployments.listDeployments)
patch()  : Google_Service_DeploymentManager_Operation
Patches a deployment and all of the resources described by the deployment manifest. (deployments.patch)
setIamPolicy()  : Google_Service_DeploymentManager_Policy
Sets the access control policy on the specified resource. Replaces any existing policy. (deployments.setIamPolicy)
stop()  : Google_Service_DeploymentManager_Operation
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()  : Google_Service_DeploymentManager_TestPermissionsResponse
Returns permissions that a caller has on the specified resource.
update()  : Google_Service_DeploymentManager_Operation
Updates a deployment and all of the resources described by the deployment manifest. (deployments.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

cancelPreview()

Cancels and removes the preview currently associated with the deployment.

public cancelPreview(string $project, string $deployment, Google_Service_DeploymentManager_DeploymentsCancelPreviewRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DeploymentManager_Operation

(deployments.cancelPreview)

Parameters
$project : string

The project ID for this request.

$deployment : string

The name of the deployment for this request.

$postBody : Google_Service_DeploymentManager_DeploymentsCancelPreviewRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DeploymentManager_Operation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

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

public delete(string $project, string $deployment[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DeploymentManager_Operation

(deployments.delete)

Parameters
$project : string

The project ID for this request.

$deployment : string

The name of the deployment for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string deletePolicy Sets the policy to use for deleting resources.

Return values
Google_Service_DeploymentManager_Operation —

getIamPolicy()

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

public getIamPolicy(string $project, string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DeploymentManager_Policy
Parameters
$project : string

Project ID for this request.

$resource : string

Name or id of the resource for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DeploymentManager_Policy —

insert()

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

public insert(string $project, Google_Service_DeploymentManager_Deployment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DeploymentManager_Operation
Parameters
$project : string

The project ID for this request.

$postBody : Google_Service_DeploymentManager_Deployment
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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.

opt_param

string createPolicy Sets the policy to use for creating new resources.

Return values
Google_Service_DeploymentManager_Operation —

listDeployments()

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

public listDeployments(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DeploymentManager_DeploymentsListResponse
Parameters
$project : string

The project ID for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

opt_param

string maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

opt_param

string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

opt_param

string filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

Return values
Google_Service_DeploymentManager_DeploymentsListResponse —

patch()

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

public patch(string $project, string $deployment, Google_Service_DeploymentManager_Deployment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DeploymentManager_Operation
Parameters
$project : string

The project ID for this request.

$deployment : string

The name of the deployment for this request.

$postBody : Google_Service_DeploymentManager_Deployment
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 will look 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 createPolicy Sets the policy to use for creating new resources.

opt_param

string deletePolicy Sets the policy to use for deleting resources.

Return values
Google_Service_DeploymentManager_Operation —

setIamPolicy()

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

public setIamPolicy(string $project, string $resource, Google_Service_DeploymentManager_GlobalSetPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DeploymentManager_Policy
Parameters
$project : string

Project ID for this request.

$resource : string

Name or id of the resource for this request.

$postBody : Google_Service_DeploymentManager_GlobalSetPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DeploymentManager_Policy —

stop()

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

public stop(string $project, string $deployment, Google_Service_DeploymentManager_DeploymentsStopRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DeploymentManager_Operation

(deployments.stop)

Parameters
$project : string

The project ID for this request.

$deployment : string

The name of the deployment for this request.

$postBody : Google_Service_DeploymentManager_DeploymentsStopRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DeploymentManager_Operation —

testIamPermissions()

Returns permissions that a caller has on the specified resource.

public testIamPermissions(string $project, string $resource, Google_Service_DeploymentManager_TestPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DeploymentManager_TestPermissionsResponse

(deployments.testIamPermissions)

Parameters
$project : string

Project ID for this request.

$resource : string

Name or id of the resource for this request.

$postBody : Google_Service_DeploymentManager_TestPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DeploymentManager_TestPermissionsResponse —

update()

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

public update(string $project, string $deployment, Google_Service_DeploymentManager_Deployment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DeploymentManager_Operation
Parameters
$project : string

The project ID for this request.

$deployment : string

The name of the deployment for this request.

$postBody : Google_Service_DeploymentManager_Deployment
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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.

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 will look 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.

Return values
Google_Service_DeploymentManager_Operation —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results