Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
(no description)
| File Size: | 912 lines (31 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 17 classes
Google_Service_Cloudresourcemanager:: (1 method):
__construct()
Google_Service_Cloudresourcemanager_Organizations_Resource:: (6 methods):
get()
getIamPolicy()
listOrganizations()
setIamPolicy()
testIamPermissions()
update()
Google_Service_Cloudresourcemanager_Projects_Resource:: (9 methods):
create()
delete()
get()
getIamPolicy()
listProjects()
setIamPolicy()
testIamPermissions()
undelete()
update()
Google_Service_Cloudresourcemanager_Binding:: (4 methods):
setMembers()
getMembers()
setRole()
getRole()
Google_Service_Cloudresourcemanager_Empty:: (0 methods):
Google_Service_Cloudresourcemanager_GetIamPolicyRequest:: (0 methods):
Google_Service_Cloudresourcemanager_ListOrganizationsResponse:: (4 methods):
setNextPageToken()
getNextPageToken()
setOrganizations()
getOrganizations()
Google_Service_Cloudresourcemanager_ListProjectsResponse:: (4 methods):
setNextPageToken()
getNextPageToken()
setProjects()
getProjects()
Google_Service_Cloudresourcemanager_Organization:: (6 methods):
setDisplayName()
getDisplayName()
setOrganizationId()
getOrganizationId()
setOwner()
getOwner()
Google_Service_Cloudresourcemanager_OrganizationOwner:: (2 methods):
setDirectoryCustomerId()
getDirectoryCustomerId()
Google_Service_Cloudresourcemanager_Policy:: (6 methods):
setBindings()
getBindings()
setEtag()
getEtag()
setVersion()
getVersion()
Google_Service_Cloudresourcemanager_Project:: (14 methods):
setCreateTime()
getCreateTime()
setLabels()
getLabels()
setLifecycleState()
getLifecycleState()
setName()
getName()
setParent()
getParent()
setProjectId()
getProjectId()
setProjectNumber()
getProjectNumber()
Google_Service_Cloudresourcemanager_ProjectLabels:: (0 methods):
Google_Service_Cloudresourcemanager_ResourceId:: (4 methods):
setId()
getId()
setType()
getType()
Google_Service_Cloudresourcemanager_SetIamPolicyRequest:: (2 methods):
setPolicy()
getPolicy()
Google_Service_Cloudresourcemanager_TestIamPermissionsRequest:: (2 methods):
setPermissions()
getPermissions()
Google_Service_Cloudresourcemanager_TestIamPermissionsResponse:: (2 methods):
setPermissions()
getPermissions()
Class: Google_Service_Cloudresourcemanager - X-Ref
Service definition for Cloudresourcemanager (v1beta1).<p>
The Google Cloud Resource Manager API provides methods for creating, reading,
and updating of project metadata.</p>
<p>
For more information about this service, see the API
<a href="https://cloud.google.com/resource-manager" target="_blank">Documentation</a>
</p>
| __construct(Google_Client $client) X-Ref |
| Constructs the internal representation of the Cloudresourcemanager service. param: Google_Client $client |
Class: Google_Service_Cloudresourcemanager_Organizations_Resource - X-Ref
The "organizations" collection of methods.Typical usage is:
<code>
$cloudresourcemanagerService = new Google_Service_Cloudresourcemanager(...);
$organizations = $cloudresourcemanagerService->organizations;
</code>
| get($organizationId, $optParams = array() X-Ref |
| Fetches an Organization resource by id. (organizations.get) param: string $organizationId The id of the Organization resource to fetch. param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_Organization |
| getIamPolicy($resource, Google_Service_Cloudresourcemanager_GetIamPolicyRequest $postBody, $optParams = array() X-Ref |
| Gets the access control policy for a Organization resource. May be empty if no such policy or resource exists. (organizations.getIamPolicy) param: string $resource REQUIRED: The resource for which policy is being param: Google_GetIamPolicyRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_Policy |
| listOrganizations($optParams = array() X-Ref |
| Query Organization resources. (organizations.listOrganizations) param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_ListOrganizationsResponse |
| setIamPolicy($resource, Google_Service_Cloudresourcemanager_SetIamPolicyRequest $postBody, $optParams = array() X-Ref |
| Sets the access control policy on a Organization resource. Replaces any existing policy. (organizations.setIamPolicy) param: string $resource REQUIRED: The resource for which policy is being param: Google_SetIamPolicyRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_Policy |
| testIamPermissions($resource, Google_Service_Cloudresourcemanager_TestIamPermissionsRequest $postBody, $optParams = array() X-Ref |
| Returns permissions that a caller has on the specified Organization. (organizations.testIamPermissions) param: string $resource REQUIRED: The resource for which policy detail is param: Google_TestIamPermissionsRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_TestIamPermissionsResponse |
| update($organizationId, Google_Service_Cloudresourcemanager_Organization $postBody, $optParams = array() X-Ref |
| Updates an Organization resource. (organizations.update) param: string $organizationId An immutable id for the Organization that is param: Google_Organization $postBody param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_Organization |
Class: Google_Service_Cloudresourcemanager_Projects_Resource - X-Ref
The "projects" collection of methods.Typical usage is:
<code>
$cloudresourcemanagerService = new Google_Service_Cloudresourcemanager(...);
$projects = $cloudresourcemanagerService->projects;
</code>
| create(Google_Service_Cloudresourcemanager_Project $postBody, $optParams = array() X-Ref |
| 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) param: Google_Project $postBody param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_Project |
| delete($projectId, $optParams = array() X-Ref |
| 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) param: string $projectId The project ID (for example, `foo-bar-123`). param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_Empty |
| get($projectId, $optParams = array() X-Ref |
| 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) param: string $projectId The project ID (for example, `my-project-123`). param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_Project |
| getIamPolicy($resource, Google_Service_Cloudresourcemanager_GetIamPolicyRequest $postBody, $optParams = array() X-Ref |
| Returns the IAM access control policy for specified project. (projects.getIamPolicy) param: string $resource REQUIRED: The resource for which policy is being param: Google_GetIamPolicyRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_Policy |
| listProjects($optParams = array() X-Ref |
| 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) param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_ListProjectsResponse |
| setIamPolicy($resource, Google_Service_Cloudresourcemanager_SetIamPolicyRequest $postBody, $optParams = array() X-Ref |
| 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) param: string $resource REQUIRED: The resource for which policy is being param: Google_SetIamPolicyRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_Policy |
| testIamPermissions($resource, Google_Service_Cloudresourcemanager_TestIamPermissionsRequest $postBody, $optParams = array() X-Ref |
| Tests the specified permissions against the IAM access control policy for the specified project. (projects.testIamPermissions) param: string $resource REQUIRED: The resource for which policy detail is param: Google_TestIamPermissionsRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_TestIamPermissionsResponse |
| undelete($projectId, $optParams = array() X-Ref |
| 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) param: string $projectId The project ID (for example, `foo-bar-123`). param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_Empty |
| update($projectId, Google_Service_Cloudresourcemanager_Project $postBody, $optParams = array() X-Ref |
| 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) param: string $projectId The project ID (for example, `my-project-123`). param: Google_Project $postBody param: array $optParams Optional parameters. return: Google_Service_Cloudresourcemanager_Project |
Class: Google_Service_Cloudresourcemanager_Binding - X-Ref
| setMembers($members) X-Ref |
| No description |
| getMembers() X-Ref |
| No description |
| setRole($role) X-Ref |
| No description |
| getRole() X-Ref |
| No description |
Class: Google_Service_Cloudresourcemanager_ListOrganizationsResponse - X-Ref
| setNextPageToken($nextPageToken) X-Ref |
| No description |
| getNextPageToken() X-Ref |
| No description |
| setOrganizations($organizations) X-Ref |
| No description |
| getOrganizations() X-Ref |
| No description |
Class: Google_Service_Cloudresourcemanager_ListProjectsResponse - X-Ref
| setNextPageToken($nextPageToken) X-Ref |
| No description |
| getNextPageToken() X-Ref |
| No description |
| setProjects($projects) X-Ref |
| No description |
| getProjects() X-Ref |
| No description |
Class: Google_Service_Cloudresourcemanager_Organization - X-Ref
| setDisplayName($displayName) X-Ref |
| No description |
| getDisplayName() X-Ref |
| No description |
| setOrganizationId($organizationId) X-Ref |
| No description |
| getOrganizationId() X-Ref |
| No description |
| setOwner(Google_Service_Cloudresourcemanager_OrganizationOwner $owner) X-Ref |
| No description |
| getOwner() X-Ref |
| No description |
Class: Google_Service_Cloudresourcemanager_OrganizationOwner - X-Ref
| setDirectoryCustomerId($directoryCustomerId) X-Ref |
| No description |
| getDirectoryCustomerId() X-Ref |
| No description |
Class: Google_Service_Cloudresourcemanager_Policy - X-Ref
| setBindings($bindings) X-Ref |
| No description |
| getBindings() X-Ref |
| No description |
| setEtag($etag) X-Ref |
| No description |
| getEtag() X-Ref |
| No description |
| setVersion($version) X-Ref |
| No description |
| getVersion() X-Ref |
| No description |
Class: Google_Service_Cloudresourcemanager_Project - X-Ref
| setCreateTime($createTime) X-Ref |
| No description |
| getCreateTime() X-Ref |
| No description |
| setLabels($labels) X-Ref |
| No description |
| getLabels() X-Ref |
| No description |
| setLifecycleState($lifecycleState) X-Ref |
| No description |
| getLifecycleState() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setParent(Google_Service_Cloudresourcemanager_ResourceId $parent) X-Ref |
| No description |
| getParent() X-Ref |
| No description |
| setProjectId($projectId) X-Ref |
| No description |
| getProjectId() X-Ref |
| No description |
| setProjectNumber($projectNumber) X-Ref |
| No description |
| getProjectNumber() X-Ref |
| No description |
