Repository files navigation

Java idiomatic client forResource Manager API.

• Product Documentation
• Client Library Documentation

🚌 In October 2022, this library has moved togoogle-cloud-java/java-resourcemanager.This repository will be archived in the future.Future releases will appear in the new repository (https://github.com/googleapis/google-cloud-java/releases).The Maven artifact coordinates (com.google.cloud:google-cloud-resourcemanager) remain the same.Sample code is inhttps://github.com/GoogleCloudPlatform/java-docs-samples.

If you are using Maven withBOM, add this to your pom.xml file:

<dependencyManagement>  <dependencies>    <dependency>      <groupId>com.google.cloud</groupId>      <artifactId>libraries-bom</artifactId>      <version>26.1.3</version>      <type>pom</type>      <scope>import</scope>    </dependency>  </dependencies></dependencyManagement><dependencies>  <dependency>    <groupId>com.google.cloud</groupId>    <artifactId>google-cloud-resourcemanager</artifactId>  </dependency>

If you are using Maven without BOM, add this to your dependencies:

<dependency>  <groupId>com.google.cloud</groupId>  <artifactId>google-cloud-resourcemanager</artifactId>  <version>1.5.6</version></dependency>

If you are using Gradle 5.x or later, add this to your dependencies:

implementation platform('com.google.cloud:libraries-bom:26.1.4')implementation'com.google.cloud:google-cloud-resourcemanager'

If you are using Gradle without BOM, add this to your dependencies:

implementation'com.google.cloud:google-cloud-resourcemanager:1.7.0'

If you are using SBT, add this to your dependencies:

libraryDependencies+="com.google.cloud"%"google-cloud-resourcemanager"%"1.7.0"

See theAuthentication section in the base directory's README.

The client application making API calls must be grantedauthorization scopes required for the desired Resource Manager API APIs, and the authenticated principal must have theIAM role(s) required to access GCP resources using the Resource Manager API API calls.

You will need aGoogle Cloud Platform Console project with the Resource Manager APIAPI enabled.

Follow these instructions to get your project set up. You will also need to set up the local development environment byinstalling the Google Cloud SDK and running the following commands in command line:gcloud auth login andgcloud config set project [YOUR PROJECT ID].

You'll need to obtain thegoogle-cloud-resourcemanager library. See theQuickstart sectionto addgoogle-cloud-resourcemanager as a dependency in your code.

Resource Manager API enables you to programmatically manage resources by project, folder, and organization.

See theResource Manager API client library docs to learn how touse this Resource Manager API Client Library.

To make authenticated requests to Google Cloud Resource Manager, you must create a service objectwith Google Cloud SDK credentials. You can then make API calls by calling methods on the ResourceManager service object. The simplest way to authenticate is to useApplication Default Credentials.These credentials are automatically inferred from your environment, so you only need the followingcode to create your service object:

importcom.google.cloud.resourcemanager.ResourceManager;importcom.google.cloud.resourcemanager.ResourceManagerOptions;ResourceManagerresourceManager =ResourceManagerOptions.getDefaultInstance().getService();

You can load a project if you know its project ID and have read permissions to the project.To get a project, add the following import at the top of your file:

importcom.google.cloud.resourcemanager.Project;

Then use the following code to get the project:

StringprojectId ="my-globally-unique-project-id";// Change to a unique project IDProjectproject =resourceManager.get(projectId);

All you need to create a project is a globally unique project ID. You can also optionally attach anon-unique name and labels to your project. Read more about naming guidelines for project IDs,names, and labelshere.To create a project, add the following imports at the top of your file:

importcom.google.cloud.resourcemanager.Project;importcom.google.cloud.resourcemanager.ProjectInfo;

Then add the following code to create a project (be sure to changeprojectId to your own uniqueproject ID).

StringprojectId ="my-globally-unique-project-id";// Change to a unique project IDProjectproject =resourceManager.create(ProjectInfo.newBuilder(projectId).build());

Note that the return value fromcreate is aProject that includes additional read-onlyinformation, like creation time, project number, and lifecycle state. Read more about these fieldson theProjects page.Project, a subclass ofProjectInfo, adds a layer of service-related functionality overProjectInfo.

To edit a project, create a newProjectInfo object and pass it in to theProject.replace method.For example, to add a label to a project to denote that it's launch status is "in development", addthe following code:

ProjectnewProject =project.toBuilder()    .addLabel("launch-status","in-development")    .build()    .replace();

Note that the values of the project you pass in toreplace overwrite the server's values fornon-read-only fields, namelyprojectName andlabels. For example, if you create a project withprojectName "some-project-name" and subsequently call replace using aProjectInfo object thatdidn't set theprojectName, then the server will unset the project's name. The server ignores anyattempted changes to the read-only fieldsprojectNumber,lifecycleState, andcreateTime.TheprojectId cannot change.

Suppose that we want a list of all projects for which we have read permissions. Add the followingimport:

importjava.util.Iterator;

Then add the following code to print a list of projects you can view:

Iterator<Project>projectIterator =resourceManager.list().iterateAll().iterator();System.out.println("Projects I can view:");while (projectIterator.hasNext()) {System.out.println(projectIterator.next().getProjectId());}

You can editGoogle Cloud IAM (Identity and Access Management)policies on the project-level using this library as well. We recommend using the read-modify-writepattern to make policy changes. This entails reading the project's current policy, updating itlocally, and then sending the modified policy for writing, as shown in the snippet below. First,add these imports:

importcom.google.cloud.Identity;importcom.google.cloud.Policy;importcom.google.cloud.Role;

Assuming you have completed the steps above to create theResourceManager service object and loada project from the server, you just need to add the following code:

// Get the project's policyPolicypolicy =project.getPolicy();// Add a viewerPolicy.BuildermodifiedPolicy =policy.toBuilder();IdentitynewViewer =Identity.user("<insert user's email address here>");modifiedPolicy.addIdentity(Role.viewer(),newViewer);// Write policyPolicyupdatedPolicy =project.replacePolicy(modifiedPolicy.build());

Note that the policy you pass in toreplacePolicy overwrites the original policy. For example, ifthe original policy has two bindings and you callreplacePolicy with a new policy containing onlyone binding, the two original bindings are lost.

We put together all the code shown above into three programs. The programs assume that you arerunning from your own desktop and used the Google Cloud SDK to authenticate yourself.

The first program creates a project if it does not exist. Complete source code can be found atGetOrCreateProject.java.

The second program updates a project if it exists and lists all projects the user has permission toview. Complete source code can be found atUpdateAndListProjects.java.

The third program modifies the IAM policy associated with a project using the read-modify-writepattern. Complete source code can be found atModifyPolicy.java

To get help, follow the instructions in theshared Troubleshooting document.

Resource Manager API uses HTTP/JSON for the transport layer.

Java 8 or above is required for using this client.

Google's Java client libraries,Google Cloud Client LibrariesandGoogle Cloud API Libraries,follow theOracle Java SE support roadmap(see the Oracle Java SE Product Releases section).

In general, new feature development occurs with support for the lowest JavaLTS version covered by Oracle's Premier Support (which typically lasts 5 yearsfrom initial General Availability). If the minimum required JVM for a givenlibrary is changed, it is accompanied by asemver major release.

Java 11 and (in September 2021) Java 17 are the best choices for newdevelopment.

Google tests its client libraries with all current LTS versions covered byOracle's Extended Support (which typically lasts 8 years from initialGeneral Availability).

Google's client libraries support legacy versions of Java runtimes with longterm stable libraries that don't receive feature updates on a best efforts basisas it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to useJava 7, though apps might need to upgrade to current versions of the librarythat supports their JVM.

The latest versions and the supported Java versions are identified onthe individual GitHub repositorygithub.com/GoogleAPIs/java-SERVICENAMEand ongoogle-cloud-java.

This library followsSemantic Versioning.

Contributions to this library are always welcome and highly encouraged.

SeeCONTRIBUTING for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating inthis project you agree to abide by its terms. SeeCode of Conduct for moreinformation.

Apache 2.0 - SeeLICENSE for more information.

Java Version	Status
Java 8
Java 8 OSX
Java 8 Windows
Java 11

Java is a registered trademark of Oracle and/or its affiliates.