com.google.api.services.cloudresourcemanager.v3

Class CloudResourceManager.Projects

java.lang.Object

com.google.api.services.cloudresourcemanager.v3.CloudResourceManager.Projects

Enclosing class:

CloudResourceManager

public class CloudResourceManager.Projects
extends Object

The "projects" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudResourceManager.Projects.Create
class	CloudResourceManager.Projects.Delete
class	CloudResourceManager.Projects.Get
class	CloudResourceManager.Projects.GetIamPolicy
class	CloudResourceManager.Projects.List
class	CloudResourceManager.Projects.Move
class	CloudResourceManager.Projects.Patch
class	CloudResourceManager.Projects.Search
class	CloudResourceManager.Projects.SetIamPolicy
class	CloudResourceManager.Projects.TestIamPermissions
class	CloudResourceManager.Projects.Undelete

Constructor Summary

Constructors

Constructor and Description
Projects()

Method Summary

Modifier and Type	Method and Description
CloudResourceManager.Projects.Create	create(Project content) Request that a new project be created.
CloudResourceManager.Projects.Delete	delete(String name) Marks the project identified by the specified `name` (for example, `projects/415104041262`) for deletion.
CloudResourceManager.Projects.Get	get(String name) Retrieves the project identified by the specified `name` (for example, `projects/415104041262`).
CloudResourceManager.Projects.GetIamPolicy	getIamPolicy(String resource, GetIamPolicyRequest content) Returns the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g.
CloudResourceManager.Projects.List	list() Lists projects that are direct children of the specified folder or organization resource.
CloudResourceManager.Projects.Move	move(String name, MoveProjectRequest content) Move a project to another place in your resource hierarchy, under a new resource parent.
CloudResourceManager.Projects.Patch	patch(String name, Project content) Updates the `display_name` and labels of the project identified by the specified `name` (for example, `projects/415104041262`).
CloudResourceManager.Projects.Search	search() Search for projects that the caller has the `resourcemanager.projects.get` permission on, and also satisfy the specified query.
CloudResourceManager.Projects.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g.
CloudResourceManager.Projects.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified project, in the format `projects/{ProjectIdOrNumber}` e.g.
CloudResourceManager.Projects.Undelete	undelete(String name, UndeleteProjectRequest content) Restores the project identified by the specified `name` (for example, `projects/415104041262`).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Projects

public Projects()

Method Detail

create

public CloudResourceManager.Projects.Create create(Project content)
                                            throws IOException

Request that a new project be created. The result is an `Operation` which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking `Operation` is automatically deleted after a few hours, so there is no need to call `DeleteOperation`. Create a request for the method "projects.create". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the Project

Returns:

the request

Throws:

IOException

delete

public CloudResourceManager.Projects.Delete delete(String name)
                                            throws IOException

Marks the project identified by the specified `name` (for example, `projects/415104041262`) for deletion. This method will only affect the project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with GetProject, and the project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the project is not retrievable by the GetProject, ListProjects, and SearchProjects methods. This method behaves idempotently, such that deleting a `DELETE_REQUESTED` project will not cause an error, but also won't do anything. The caller must have `resourcemanager.projects.delete` permissions for this project. Create a request for the method "projects.delete". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the Project (for example, `projects/415104041262`).

Returns:

the request

Throws:

IOException

get

public CloudResourceManager.Projects.Get get(String name)
                                      throws IOException

Retrieves the project identified by the specified `name` (for example, `projects/415104041262`). The caller must have `resourcemanager.projects.get` permission for this project. Create a request for the method "projects.get". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the project (for example, `projects/415104041262`).

Returns:

the request

Throws:

IOException

getIamPolicy

public CloudResourceManager.Projects.GetIamPolicy getIamPolicy(String resource,
                                                               GetIamPolicyRequest content)
                                                        throws IOException

Returns the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. Permission is denied if the policy or the resource do not exist. Create a request for the method "projects.getIamPolicy". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the GetIamPolicyRequest

Returns:

the request

Throws:

IOException

list

public CloudResourceManager.Projects.List list()
                                        throws IOException

Lists projects that are direct children of the specified folder or organization resource. `list()` provides a strongly consistent view of the projects underneath the specified parent resource. `list()` returns projects sorted based upon the (ascending) lexical ordering of their `display_name`. The caller must have `resourcemanager.projects.list` permission on the identified parent. Create a request for the method "projects.list". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

move

public CloudResourceManager.Projects.Move move(String name,
                                               MoveProjectRequest content)
                                        throws IOException

Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.move` permission on the project, on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project. Create a request for the method "projects.move". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the project to move.

content - the MoveProjectRequest

Returns:

the request

Throws:

IOException

patch

public CloudResourceManager.Projects.Patch patch(String name,
                                                 Project content)
                                          throws IOException

Updates the `display_name` and labels of the project identified by the specified `name` (for example, `projects/415104041262`). Deleting all labels requires an update mask for labels field. The caller must have `resourcemanager.projects.update` permission for this project. Create a request for the method "projects.patch". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Output only. The unique resource name of the project. It is an int64 generated number prefixed by "projects/". Example: `projects/415104041262`

content - the Project

Returns:

the request

Throws:

IOException

search

public CloudResourceManager.Projects.Search search()
                                            throws IOException

Search for projects that the caller has the `resourcemanager.projects.get` permission on, and also satisfy the specified query. This method returns projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method. Create a request for the method "projects.search". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

setIamPolicy

public CloudResourceManager.Projects.SetIamPolicy setIamPolicy(String resource,
                                                               SetIamPolicyRequest content)
                                                        throws IOException

Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible. Create a request for the method "projects.setIamPolicy". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public CloudResourceManager.Projects.TestIamPermissions testIamPermissions(String resource,
                                                                           TestIamPermissionsRequest content)
                                                                    throws IOException

Returns permissions that a caller has on the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123.. Create a request for the method "projects.testIamPermissions". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException

undelete

public CloudResourceManager.Projects.Undelete undelete(String name,
                                                       UndeleteProjectRequest content)
                                                throws IOException

Restores the project identified by the specified `name` (for example, `projects/415104041262`). You can only use this method for a project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the project cannot be restored. The caller must have `resourcemanager.projects.undelete` permission for this project. Create a request for the method "projects.undelete". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the project (for example, `projects/415104041262`). Required.

content - the UndeleteProjectRequest

Returns:

the request

Throws:

IOException