com.google.gcloud.resourcemanager.package-info Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 Google Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * A client to Google Cloud Resource Manager.
 *
 * Here's a simple usage example for using gcloud-java from App/Compute Engine. This example
 * creates a project if it does not exist. For the complete source code see
 * 
 * GetOrCreateProject.java.
 * 
 {@code
 * ResourceManager resourceManager = ResourceManagerOptions.defaultInstance().service();
 * String projectId = "my-globally-unique-project-id"; // Change to a unique project ID.
 * Project project = resourceManager.get(projectId);
 * if (project == null) {
 *   project = resourceManager.create(ProjectInfo.builder(projectId).build());
 * }
 * System.out.println("Got project " + project.projectId() + " from the server.");
 * }
 * 
 * This second example shows how to update a project if it exists and list all projects the user has
 * permission to view. For the complete source code see
 * 
 * UpdateAndListProjects.java.
 * 
 {@code
 * ResourceManager resourceManager = ResourceManagerOptions.defaultInstance().service();
 * Project project = resourceManager.get("some-project-id"); // Use an existing project's ID
 * if (project != null) {
 *   Project newProject = project.toBuilder()
 *       .addLabel("launch-status", "in-development")
 *       .build()
 *       .replace();
 *   System.out.println("Updated the labels of project " + newProject.projectId()
 *       + " to be " + newProject.labels());
 * }
 * Iterator projectIterator = resourceManager.list().iterateAll();
 * System.out.println("Projects I can view:");
 * while (projectIterator.hasNext()) {
 *   System.out.println(projectIterator.next().projectId());
 * }}
 * Remember that you must authenticate using the Google Cloud SDK. See more about
 * providing
 * credentials here.
 *
 * @see Google Cloud Resource Manager
 */

package com.google.gcloud.resourcemanager;