com.google.api.services.cloudresourcemanager

Class CloudResourceManager.Projects

java.lang.Object

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

Enclosing class:

CloudResourceManager

public class CloudResourceManager.Projects
extends java.lang.Object

The "projects" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudResourceManager.Projects.ClearOrgPolicy
class	CloudResourceManager.Projects.Create
class	CloudResourceManager.Projects.Delete
class	CloudResourceManager.Projects.Get
class	CloudResourceManager.Projects.GetAncestry
class	CloudResourceManager.Projects.GetEffectiveOrgPolicy
class	CloudResourceManager.Projects.GetIamPolicy
class	CloudResourceManager.Projects.GetOrgPolicy
class	CloudResourceManager.Projects.List
class	CloudResourceManager.Projects.ListAvailableOrgPolicyConstraints
class	CloudResourceManager.Projects.ListOrgPolicies
class	CloudResourceManager.Projects.SetIamPolicy
class	CloudResourceManager.Projects.SetOrgPolicy
class	CloudResourceManager.Projects.TestIamPermissions
class	CloudResourceManager.Projects.Undelete
class	CloudResourceManager.Projects.Update

Constructor Summary

Constructors

Constructor and Description
Projects()

Method Summary

Modifier and Type	Method and Description
CloudResourceManager.Projects.ClearOrgPolicy	clearOrgPolicy(java.lang.String resource, ClearOrgPolicyRequest content) Clears a `Policy` from a resource.
CloudResourceManager.Projects.Create	create(Project content) Request that a new Project be created.
CloudResourceManager.Projects.Delete	delete(java.lang.String projectId) Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion.
CloudResourceManager.Projects.Get	get(java.lang.String projectId) Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`).
CloudResourceManager.Projects.GetAncestry	getAncestry(java.lang.String projectId, GetAncestryRequest content) Gets a list of ancestors in the resource hierarchy for the Project identified by the specified `project_id` (for example, `my-project-123`).
CloudResourceManager.Projects.GetEffectiveOrgPolicy	getEffectiveOrgPolicy(java.lang.String resource, GetEffectiveOrgPolicyRequest content) Gets the effective `Policy` on a resource.
CloudResourceManager.Projects.GetIamPolicy	getIamPolicy(java.lang.String resource, GetIamPolicyRequest content) Returns the IAM access control policy for the specified Project.
CloudResourceManager.Projects.GetOrgPolicy	getOrgPolicy(java.lang.String resource, GetOrgPolicyRequest content) Gets a `Policy` on a resource.
CloudResourceManager.Projects.List	list() Lists Projects that the caller has the `resourcemanager.projects.get` permission on and satisfy the specified filter.
CloudResourceManager.Projects.ListAvailableOrgPolicyConstraints	listAvailableOrgPolicyConstraints(java.lang.String resource, ListAvailableOrgPolicyConstraintsRequest content) Lists `Constraints` that could be applied on the specified resource.
CloudResourceManager.Projects.ListOrgPolicies	listOrgPolicies(java.lang.String resource, ListOrgPoliciesRequest content) Lists all the `Policies` set for a particular resource.
CloudResourceManager.Projects.SetIamPolicy	setIamPolicy(java.lang.String resource, SetIamPolicyRequest content) Sets the IAM access control policy for the specified Project.
CloudResourceManager.Projects.SetOrgPolicy	setOrgPolicy(java.lang.String resource, SetOrgPolicyRequest content) Updates the specified `Policy` on the resource.
CloudResourceManager.Projects.TestIamPermissions	testIamPermissions(java.lang.String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified Project.
CloudResourceManager.Projects.Undelete	undelete(java.lang.String projectId, UndeleteProjectRequest content) Restores the Project identified by the specified `project_id` (for example, `my-project-123`).
CloudResourceManager.Projects.Update	update(java.lang.String projectId, Project content) Updates the attributes of the Project identified by the specified `project_id` (for example, `my- project-123`).

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

clearOrgPolicy

public CloudResourceManager.Projects.ClearOrgPolicy clearOrgPolicy(java.lang.String resource,
                                                                   ClearOrgPolicyRequest content)
                                                            throws java.io.IOException

Clears a `Policy` from a resource. Create a request for the method "projects.clearOrgPolicy". 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 - Name of the resource for the `Policy` to clear.

content - the ClearOrgPolicyRequest

Returns:

the request

Throws:

java.io.IOException

create

public CloudResourceManager.Projects.Create create(Project content)
                                            throws java.io.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. Authorization requires the Google IAM permission `resourcemanager.projects.create` on the specified parent for the new project. The parent is identified by a specified ResourceId, which must include both an ID and a type, such as organization. This method does not associate the new project with a billing account. You can set or update the billing account associated with a project using the [`projects.updateBillingInfo`] (/billing/reference/rest/v1/projects/updateBillingInfo) method. 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:

java.io.IOException

delete

public CloudResourceManager.Projects.Delete delete(java.lang.String projectId)
                                            throws java.io.IOException

Marks the Project identified by the specified `project_id` (for example, `my-project-123`) 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 and ListProjects methods. The caller must have modify 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:

projectId - The Project ID (for example, `foo-bar-123`). Required.

Returns:

the request

Throws:

java.io.IOException

get

public CloudResourceManager.Projects.Get get(java.lang.String projectId)
                                      throws java.io.IOException

Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions 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:

projectId - The Project ID (for example, `my-project-123`). Required.

Returns:

the request

Throws:

java.io.IOException

getAncestry

public CloudResourceManager.Projects.GetAncestry getAncestry(java.lang.String projectId,
                                                             GetAncestryRequest content)
                                                      throws java.io.IOException

Gets a list of ancestors in the resource hierarchy for the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project. Create a request for the method "projects.getAncestry". 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:

projectId - The Project ID (for example, `my-project-123`). Required.

content - the GetAncestryRequest

Returns:

the request

Throws:

java.io.IOException

getEffectiveOrgPolicy

public CloudResourceManager.Projects.GetEffectiveOrgPolicy getEffectiveOrgPolicy(java.lang.String resource,
                                                                                 GetEffectiveOrgPolicyRequest content)
                                                                          throws java.io.IOException

Gets the effective `Policy` on a resource. This is the result of merging `Policies` in the resource hierarchy. The returned `Policy` will not have an `etag`set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded. Create a request for the method "projects.getEffectiveOrgPolicy". 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 - The name of the resource to start computing the effective `Policy`.

content - the GetEffectiveOrgPolicyRequest

Returns:

the request

Throws:

java.io.IOException

getIamPolicy

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

Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist. Authorization requires the Google IAM permission `resourcemanager.projects.getIamPolicy` on the project. For additional information about resource structure and identification, see [Resource Names](/apis/design/resource_names). 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 the operation documentation for the appropriate value for this field.

content - the GetIamPolicyRequest

Returns:

the request

Throws:

java.io.IOException

getOrgPolicy

public CloudResourceManager.Projects.GetOrgPolicy getOrgPolicy(java.lang.String resource,
                                                               GetOrgPolicyRequest content)
                                                        throws java.io.IOException

Gets a `Policy` on a resource. If no `Policy` is set on the resource, a `Policy` is returned with default values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can be used with `SetOrgPolicy()` to create or update a `Policy` during read-modify-write. Create a request for the method "projects.getOrgPolicy". 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 - Name of the resource the `Policy` is set on.

content - the GetOrgPolicyRequest

Returns:

the request

Throws:

java.io.IOException

list

public CloudResourceManager.Projects.List list()
                                        throws java.io.IOException

Lists Projects that the caller has the `resourcemanager.projects.get` permission on and satisfy the specified filter. 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. NOTE: If the request filter contains a `parent.type` and `parent.id` and the caller has the `resourcemanager.projects.list` permission on the parent, the results will be drawn from an alternate index which provides more consistent results. In future versions of this API, this List method will be split into List and Search to properly capture the behavorial difference. 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:

java.io.IOException

listAvailableOrgPolicyConstraints

public CloudResourceManager.Projects.ListAvailableOrgPolicyConstraints listAvailableOrgPolicyConstraints(java.lang.String resource,
                                                                                                         ListAvailableOrgPolicyConstraintsRequest content)
                                                                                                  throws java.io.IOException

Lists `Constraints` that could be applied on the specified resource. Create a request for the method "projects.listAvailableOrgPolicyConstraints". 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 - Name of the resource to list `Constraints` for.

content - the ListAvailableOrgPolicyConstraintsRequest

Returns:

the request

Throws:

java.io.IOException

listOrgPolicies

public CloudResourceManager.Projects.ListOrgPolicies listOrgPolicies(java.lang.String resource,
                                                                     ListOrgPoliciesRequest content)
                                                              throws java.io.IOException

Lists all the `Policies` set for a particular resource. Create a request for the method "projects.listOrgPolicies". 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 - Name of the resource to list Policies for.

content - the ListOrgPoliciesRequest

Returns:

the request

Throws:

java.io.IOException

setIamPolicy

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

Sets the IAM access control policy for the specified Project. Overwrites any existing policy. 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 via 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. + You can only grant ownership of a project to a member by using the GCP Console. Inviting a member will deliver an invitation email that they must accept. An invitation email is not generated if you are granting a role other than owner, or if both the member you are inviting and the project are part of your organization. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + 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. + 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. Authorization requires the Google IAM permission `resourcemanager.projects.setIamPolicy` on the project 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 the operation documentation for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

java.io.IOException

setOrgPolicy

public CloudResourceManager.Projects.SetOrgPolicy setOrgPolicy(java.lang.String resource,
                                                               SetOrgPolicyRequest content)
                                                        throws java.io.IOException

Updates the specified `Policy` on the resource. Creates a new `Policy` for that `Constraint` on the resource if one does not exist. Not supplying an `etag` on the request `Policy` results in an unconditional write of the `Policy`. Create a request for the method "projects.setOrgPolicy". 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 - Resource name of the resource to attach the `Policy`.

content - the SetOrgPolicyRequest

Returns:

the request

Throws:

java.io.IOException

testIamPermissions

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

Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. 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 the operation documentation for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

java.io.IOException

undelete

public CloudResourceManager.Projects.Undelete undelete(java.lang.String projectId,
                                                       UndeleteProjectRequest content)
                                                throws java.io.IOException

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. After deletion starts, the Project cannot be restored. The caller must have modify permissions 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:

projectId - The project ID (for example, `foo-bar-123`). Required.

content - the UndeleteProjectRequest

Returns:

the request

Throws:

java.io.IOException

update

public CloudResourceManager.Projects.Update update(java.lang.String projectId,
                                                   Project content)
                                            throws java.io.IOException

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. Create a request for the method "projects.update". 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:

projectId - The project ID (for example, `my-project-123`). Required.

content - the Project

Returns:

the request

Throws:

java.io.IOException