The "projects" collection of methods. More...

Inheritance diagram for Google_Service_Cloudresourcemanager_Projects_Resource:

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

	create (Google_Service_Cloudresourcemanager_Project $postBody, $optParams=array())
	Creates a project resource.

	delete ($projectId, $optParams=array())
	Marks the project identified by the specified `project_id` (for example, `my- project-123`) for deletion.

	get ($projectId, $optParams=array())
	Retrieves the project identified by the specified `project_id` (for example, `my-project-123`).

	getIamPolicy ($resource, Google_Service_Cloudresourcemanager_GetIamPolicyRequest $postBody, $optParams=array())
	Returns the IAM access control policy for specified project.

	listProjects ($optParams=array())
	Lists projects that are visible to the user and satisfy the specified filter.

	setIamPolicy ($resource, Google_Service_Cloudresourcemanager_SetIamPolicyRequest $postBody, $optParams=array())
	Sets the IAM access control policy for the specified project.

	testIamPermissions ($resource, Google_Service_Cloudresourcemanager_TestIamPermissionsRequest $postBody, $optParams=array())
	Tests the specified permissions against the IAM access control policy for the specified project.

	undelete ($projectId, $optParams=array())
	Restores the project identified by the specified `project_id` (for example, `my-project-123`).

	update ($projectId, Google_Service_Cloudresourcemanager_Project $postBody, $optParams=array())
	Updates the attributes of the project identified by the specified `project_id` (for example, `my-project-123`).

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "projects" collection of methods.

Typical usage is: $cloudresourcemanagerService = new Google_Service_Cloudresourcemanager(...); $projects = $cloudresourcemanagerService->projects;

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

◆ create()

Google_Service_Cloudresourcemanager_Projects_Resource::create	(	Google_Service_Cloudresourcemanager_Project	$postBody,
			$optParams = array() )

Creates a project resource.

Initially, the project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the project. Several APIs are activated automatically for the project, including Google Cloud Storage. (projects.create)

Parameters

Google_Project	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Cloudresourcemanager_Project

◆ delete()

Google_Service_Cloudresourcemanager_Projects_Resource::delete	(		$projectId,
			$optParams = array() )

Marks the project identified by the specified project_id (for example, my- project-123) for deletion.

This method will only affect the project if the following criteria are met: + The project does not have a billing account associated with it. + The project has a lifecycle state of [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE]. This method changes the project's lifecycle state from [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE] to [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.Lifecycle State.DELETE_REQUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [google.cloudresour cemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject], and the project remains visible to [ListProjects] [google.cloudresourcemanage r.projects.v1beta1.DeveloperProjects.ListProjects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject] and [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects] methods. The caller must have modify permissions for this project. (projects.delete)

Parameters

string	$projectId	The project ID (for example, `foo-bar-123`). Required.
array	$optParams	Optional parameters.

Return values

Google_Service_Cloudresourcemanager_Empty

◆ get()

Google_Service_Cloudresourcemanager_Projects_Resource::get	(		$projectId,
			$optParams = array() )

Retrieves the project identified by the specified project_id (for example, my-project-123).

The caller must have read permissions for this project. (projects.get)

Parameters

string	$projectId	The project ID (for example, `my-project-123`). Required.
array	$optParams	Optional parameters.

Return values

Google_Service_Cloudresourcemanager_Project

◆ getIamPolicy()

Google_Service_Cloudresourcemanager_Projects_Resource::getIamPolicy	(		$resource,
		Google_Service_Cloudresourcemanager_GetIamPolicyRequest	$postBody,
			$optParams = array() )

Returns the IAM access control policy for specified project.

(projects.getIamPolicy)

Parameters

string	$resource	REQUIRED: The resource for which policy is being requested. Resource is usually specified as a path, such as, `projects/{project}`.
Google_GetIamPolicyRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Cloudresourcemanager_Policy

◆ listProjects()

Google_Service_Cloudresourcemanager_Projects_Resource::listProjects ( $optParams = array() )

Lists projects that are visible to the user and satisfy the specified filter.

This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list. (projects.listProjects)

Parameters

array $optParams Optional parameters.

@opt_param string filter An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + name + id + labels.key where key is the name of a label Some examples of using labels as filters: |Filter|Description| |---—|--------—| |name:*|The project has a name.| |name:Howl|The project's name is Howl or howl.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.| |labels.color:*|The project has the label color.| |labels.color:red|The project's label color has the value red.| |labels.color:red label.size:big|The project's label color has the value red and its label size has the value big. Optional. @opt_param string pageToken A pagination token returned from a previous call to ListProject that indicates from where listing should continue. Note: pagination is not yet supported; the server ignores this field. Optional. @opt_param int pageSize The maximum number of Projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default. Note: pagination is not yet supported; the server ignores this field. Optional.

Return values

Google_Service_Cloudresourcemanager_ListProjectsResponse

◆ setIamPolicy()

Google_Service_Cloudresourcemanager_Projects_Resource::setIamPolicy	(		$resource,
		Google_Service_Cloudresourcemanager_SetIamPolicyRequest	$postBody,
			$optParams = array() )

Sets the IAM access control policy for the specified project.

We do not currently support 'domain:' prefixed members in a Binding of a Policy. Calling this method requires enabling the App Engine Admin API. (projects.setIamPolicy)

Parameters

string	$resource	REQUIRED: The resource for which policy is being specified. `resource` is usually specified as a path, such as, `projects/{project}/zones/{zone}/disks/{disk}`.
Google_SetIamPolicyRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Cloudresourcemanager_Policy

◆ testIamPermissions()

Google_Service_Cloudresourcemanager_Projects_Resource::testIamPermissions	(		$resource,
		Google_Service_Cloudresourcemanager_TestIamPermissionsRequest	$postBody,
			$optParams = array() )

Tests the specified permissions against the IAM access control policy for the specified project.

(projects.testIamPermissions)

Parameters

string	$resource	REQUIRED: The resource for which policy detail is being requested. `resource` is usually specified as a path, such as, `projects/{project}`.
Google_TestIamPermissionsRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Cloudresourcemanager_TestIamPermissionsResponse

◆ undelete()

Google_Service_Cloudresourcemanager_Projects_Resource::undelete	(		$projectId,
			$optParams = array() )

Restores the project identified by the specified project_id (for example, my-project-123).

You can only use this method for a project that has a lifecycle state of [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v 1beta1.LifecycleState.DELETE_REQUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [google.cloudresourcemanager.pro jects.v1beta1.LifecycleState.DELETE_IN_PROGRESS], the project cannot be restored. The caller must have modify permissions for this project. (projects.undelete)

Parameters

string	$projectId	The project ID (for example, `foo-bar-123`). Required.
array	$optParams	Optional parameters.

Return values

Google_Service_Cloudresourcemanager_Empty

◆ update()

Google_Service_Cloudresourcemanager_Projects_Resource::update	(		$projectId,
		Google_Service_Cloudresourcemanager_Project	$postBody,
			$optParams = array() )

Updates the attributes of the project identified by the specified project_id (for example, my-project-123).

The caller must have modify permissions for this project. (projects.update)

Parameters

string	$projectId	The project ID (for example, `my-project-123`). Required.
Google_Project	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Cloudresourcemanager_Project

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ call()

◆ create()

◆ delete()

◆ get()

◆ getIamPolicy()

◆ listProjects()

◆ setIamPolicy()

◆ testIamPermissions()

◆ undelete()

◆ update()