com.google.cloud.resourcemanager

Interface ResourceManager

All Superinterfaces:

com.google.cloud.Service<ResourceManagerOptions>

public interface ResourceManager
extends com.google.cloud.Service<ResourceManagerOptions>

An interface for Google Cloud Resource Manager.

See Also:

Google Cloud Resource Manager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResourceManager.ProjectField The fields of a project.
static class	ResourceManager.ProjectGetOption Class for specifying project get options.
static class	ResourceManager.ProjectListOption Class for specifying project list options.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONTENT_TYPE

Method Summary

Modifier and Type	Method and Description
Project	create(ProjectInfo project) Creates a new project.
void	delete(String projectId) Marks the project identified by the specified project ID for deletion.
Project	get(String projectId, ResourceManager.ProjectGetOption... options) Retrieves the project identified by the specified project ID.
com.google.cloud.Policy	getPolicy(String projectId) Returns the IAM access control policy for the specified project.
com.google.api.gax.paging.Page<Project>	list(ResourceManager.ProjectListOption... options) Lists the projects visible to the current user.
Project	replace(ProjectInfo newProject) Replaces the attributes of the project.
com.google.cloud.Policy	replacePolicy(String projectId, com.google.cloud.Policy newPolicy) Sets the IAM access control policy for the specified project.
List<Boolean>	testPermissions(String projectId, List<String> permissions) Returns the permissions that a caller has on the specified project.
void	undelete(String projectId) Restores the project identified by the specified project ID.

Methods inherited from interface com.google.cloud.Service

getOptions

Field Detail

DEFAULT_CONTENT_TYPE

static final String DEFAULT_CONTENT_TYPE

See Also:

Constant Field Values

Method Detail

create

Project create(ProjectInfo project)

Creates a new project.

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.

Returns:

Project object representing the new project's metadata. The returned object will include the following read-only fields supplied by the server: project number, lifecycle state, and creation time.

Throws:

ResourceManagerException - upon failure

See Also:

Cloud Resource Manager create

delete

void delete(String projectId)

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 get(java.lang.String, com.google.cloud.resourcemanager.ResourceManager.ProjectGetOption...), and the project remains visible to list(com.google.cloud.resourcemanager.ResourceManager.ProjectListOption...). However, you cannot update the project. After the deletion completes, the project is not retrievable by the get(java.lang.String, com.google.cloud.resourcemanager.ResourceManager.ProjectGetOption...) and 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

get

Project get(String projectId,
            ResourceManager.ProjectGetOption... options)

Retrieves the project identified by the specified project ID.

Returns null if the project is not found or if the user doesn't have read permissions for the project.

Throws:

ResourceManagerException - upon failure

See Also:

Cloud Resource Manager get

list

com.google.api.gax.paging.Page<Project> list(ResourceManager.ProjectListOption... options)

Lists the projects visible to the current user.

This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list. Use ResourceManager.ProjectListOption to filter this list, set page size, and set page tokens.

Returns:

Page<Project>, a page of projects

Throws:

ResourceManagerException - upon failure

See Also:

Cloud Resource Manager list

replace

Project replace(ProjectInfo newProject)

Replaces the attributes of the 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

undelete

void undelete(String projectId)

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

See Also:

Cloud Resource Manager undelete

getPolicy

com.google.cloud.Policy getPolicy(String projectId)

Returns the IAM access control policy for the specified 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.

Throws:

ResourceManagerException - upon failure

See Also:

Resource Manager getIamPolicy

replacePolicy

com.google.cloud.Policy replacePolicy(String projectId,
                                      com.google.cloud.Policy newPolicy)

Sets the IAM access control policy for the specified project. Replaces any existing policy. The following constraints apply:

• Projects currently support only user:{emailid} and serviceAccount:{emailid} members in a binding of a policy.
• To be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation.
• Members cannot be added to more than one role in the same policy.
• There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. An attempt to set a policy that removes the last ToS-accepted owner from the policy will fail.
• Calling this method requires enabling the App Engine Admin API.

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.

It is recommended that you use the read-modify-write pattern. This pattern entails reading the project's current policy, updating it locally, and then sending the modified policy for writing. Cloud IAM solves the problem of conflicting processes simultaneously attempting to modify a policy by using the etag property. This property is used to verify whether the policy has changed since the last request. When you make a request to Cloud IAM with an etag value, Cloud IAM compares the etag value in the request with the existing etag value associated with the policy. It writes the policy only if the etag values match. If the etags don't match, a ResourceManagerException is thrown, denoting that the server aborted update. If an etag is not provided, the policy is overwritten blindly.

An example of using the read-write-modify pattern is as follows:

 Policy currentPolicy = resourceManager.getPolicy("my-project-id");
 Policy modifiedPolicy = current.toBuilder()
     .removeIdentity(Role.viewer(), Identity.user("user@gmail.com"))
     .build();
 Policy newPolicy = resourceManager.replacePolicy("my-project-id", modified);
 

Throws:

ResourceManagerException - upon failure

See Also:

Resource Manager setIamPolicy

testPermissions

List<Boolean> testPermissions(String projectId,
                              List<String> permissions)

Returns the permissions that a caller has on the specified project. You typically don't call this method if you're using Google Cloud Platform directly to manage permissions. This method is intended for integration with your proprietary software, such as a customized graphical user interface. For example, the Cloud Platform Console tests IAM permissions internally to determine which UI should be available to the logged-in user. Each service that supports IAM lists the possible permissions; see the Supported Cloud Platform services page below for links to these lists.

Returns:

A list of booleans representing whether the caller has the permissions specified (in the order of the given permissions)

Throws:

ResourceManagerException - upon failure

See Also:

Resource Manager testIamPermissions, Supported Cloud Platform Services