com.google.cloud.resourcemanager

Class Project

java.lang.Object

com.google.cloud.resourcemanager.ProjectInfo

com.google.cloud.resourcemanager.Project

All Implemented Interfaces:

Serializable

public class Project
extends ProjectInfo

A Google Cloud Resource Manager project object.

A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources. This class' member variables are immutable. Methods that change or update the underlying Project information return a new Project instance. Project adds a layer of service-related functionality over ProjectInfo.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Project.Builder Builder for Project.

Nested classes/interfaces inherited from class com.google.cloud.resourcemanager.ProjectInfo

ProjectInfo.State

Method Summary

Methods

Modifier and Type	Method and Description
void	delete() Marks the project identified by the specified project ID for deletion.
boolean	equals(Object obj)
Policy	getPolicy() Returns the IAM access control policy for this project.
int	hashCode()
Project	reload() Fetches the project's latest information.
Project	replace() Replaces the attributes of the project with the attributes of this project.
Policy	replacePolicy(Policy newPolicy) Sets the IAM access control policy for this project.
ResourceManager	resourceManager() Returns the ResourceManager service object associated with this Project.
Project.Builder	toBuilder()
void	undelete() Restores the project identified by the specified project ID.

Methods inherited from class com.google.cloud.resourcemanager.ProjectInfo

builder, createTimeMillis, labels, name, projectId, projectNumber, state

Methods inherited from class java.lang.Object

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

Method Detail

resourceManager

public ResourceManager resourceManager()

Returns the ResourceManager service object associated with this Project.

reload

public Project reload()

Fetches the project's latest information. Returns null if the project does not exist.

Returns:

Project containing the project's updated metadata or null if not found

Throws:

ResourceManagerException - upon failure

delete

public void delete()

Marks the project identified by the specified project ID 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 ProjectInfo.State.ACTIVE.

This method changes the project's lifecycle state from ProjectInfo.State.ACTIVE to ProjectInfo.State.DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the lifecycle state changes to ProjectInfo.State.DELETE_IN_PROGRESS. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with ResourceManager.get(java.lang.String, com.google.cloud.resourcemanager.ResourceManager.ProjectGetOption...), and the project remains visible to ResourceManager.list(com.google.cloud.resourcemanager.ResourceManager.ProjectListOption...). However, you cannot update the project. After the deletion completes, the project is not retrievable by the ResourceManager.get(java.lang.String, com.google.cloud.resourcemanager.ResourceManager.ProjectGetOption...) and ResourceManager.list(com.google.cloud.resourcemanager.ResourceManager.ProjectListOption...) methods. The caller must have modify permissions for this project.

Throws:

ResourceManagerException - upon failure

See Also:

Cloud Resource Manager delete

undelete

public void undelete()

Restores the project identified by the specified project ID.

You can only use this method for a project that has a lifecycle state of ProjectInfo.State.DELETE_REQUESTED. After deletion starts, as indicated by a lifecycle state of ProjectInfo.State.DELETE_IN_PROGRESS, the project cannot be restored. The caller must have modify permissions for this project.

Throws:

ResourceManagerException - upon failure (including when the project can't be restored)

See Also:

Cloud Resource Manager undelete

replace

public Project replace()

Replaces the attributes of the project with the attributes of this project.

The caller must have modify permissions for this project.

Returns:

the Project representing the new project metadata

Throws:

ResourceManagerException - upon failure

See Also:

Cloud Resource Manager update

getPolicy

public Policy getPolicy()

Returns the IAM access control policy for this project. Returns null if the resource does not exist or if you do not have adequate permission to view the project or get the policy.

Returns:

the IAM policy for the project

Throws:

ResourceManagerException - upon failure

See Also:

Resource Manager getIamPolicy

replacePolicy

public Policy replacePolicy(Policy newPolicy)

Sets the IAM access control policy for this project. Replaces any existing policy. It is recommended that you use the read-modify-write pattern. See code samples and important details of replacing policies in the documentation for ResourceManager.replacePolicy(java.lang.String, com.google.cloud.resourcemanager.Policy).

Returns:

the newly set IAM policy for this project

Throws:

ResourceManagerException - upon failure

See Also:

Resource Manager setIamPolicy

toBuilder

public Project.Builder toBuilder()

Overrides:

toBuilder in class ProjectInfo

equals

public final boolean equals(Object obj)

Overrides:

equals in class ProjectInfo

hashCode

public final int hashCode()

Overrides:

hashCode in class ProjectInfo