These values can be used to specify the fields to include in a partial response when calling * {@link ResourceManager#get} or {@link ResourceManager#list}. Project ID is always returned, * even if not specified. */ enum ProjectField implements FieldSelector { PROJECT_ID("projectId"), NAME("name"), LABELS("labels"), PROJECT_NUMBER("projectNumber"), STATE("lifecycleState"), CREATE_TIME("createTime"); static final List REQUIRED_FIELDS = ImmutableList.of(PROJECT_ID); private final String selector; ProjectField(String selector) { this.selector = selector; } @Override public String getSelector() { return selector; } } /** Class for specifying project get options. */ class ProjectGetOption extends Option { private static final long serialVersionUID = 270185129961146874L; private ProjectGetOption(ResourceManagerRpc.Option option, Object value) { super(option, value); } /** * Returns an option to specify the project's fields to be returned by the RPC call. * *
If this option is not provided all project fields are returned. {@code * ProjectGetOption.fields} can be used to specify only the fields of interest. Project ID is * always returned, even if not specified. {@link ProjectField} provides a list of fields that * can be used. */ public static ProjectGetOption fields(ProjectField... fields) { return new ProjectGetOption( ResourceManagerRpc.Option.FIELDS, Helper.selector(ProjectField.REQUIRED_FIELDS, fields)); } } /** Class for specifying project list options. */ class ProjectListOption extends Option { private static final long serialVersionUID = 7888768979702012328L; private ProjectListOption(ResourceManagerRpc.Option option, Object value) { super(option, value); } /** * Returns an option to specify a filter. * *
Filter rules are case insensitive. The fields eligible for filtering are: * *
You can specify multiple filters by adding a space between each filter. Multiple filters * are composed using "and". * *
Some examples of filters: * *
The page token (returned from a previous call to list) indicates from where listing should * continue. */ public static ProjectListOption pageToken(String pageToken) { return new ProjectListOption(ResourceManagerRpc.Option.PAGE_TOKEN, pageToken); } /** * The maximum number of projects to return per RPC. * *
The server can return fewer projects than requested. When there are more results than the * page size, the server will return a page token that can be used to fetch other results. */ public static ProjectListOption pageSize(int pageSize) { return new ProjectListOption(ResourceManagerRpc.Option.PAGE_SIZE, pageSize); } /** * Returns an option to specify the project's fields to be returned by the RPC call. * *
If this option is not provided all project fields are returned. {@code * ProjectListOption.fields} can be used to specify only the fields of interest. Project ID is * always returned, even if not specified. {@link ProjectField} provides a list of fields that * can be used. */ public static ProjectListOption fields(ProjectField... fields) { return new ProjectListOption( ResourceManagerRpc.Option.FIELDS, Helper.listSelector("projects", ProjectField.REQUIRED_FIELDS, fields)); } } /** * 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. * * @return 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 Cloud * Resource Manager create * @deprecated Please use {@link * com.google.cloud.resourcemanager.v3.ProjectsClient#create(ProjectsSettings)} instead */ @Deprecated Project create(ProjectInfo project); /** * Marks the project identified by the specified project ID for deletion. * *
This method will only affect the project if the following criteria are met: * *
Returns {@code null} if the project is not found or if the user doesn't have read * permissions for the project. * * @throws ResourceManagerException upon failure * @see * Cloud Resource Manager get * @deprecated Please use {@link * com.google.cloud.resourcemanager.v3.ProjectsClient#getProject(GetProjectRequest)} instead */ @Deprecated Project get(String projectId, ProjectGetOption... 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 {@link ProjectListOption} to filter this list, set page size, and
* set page tokens.
*
* @return {@code Page The caller must have modify permissions for this project.
*
* @return the Project representing the new project metadata
* @throws ResourceManagerException upon failure
* @see Cloud
* Resource Manager update
* @deprecated Please use {@link
* com.google.cloud.resourcemanager.v3.ProjectsClient#updateProjectAsync(UpdateProjectRequest)}
* instead
*/
@Deprecated
Project replace(ProjectInfo newProject);
/**
* Restores the project identified by the specified project ID.
*
* You can only use this method for a project that has a lifecycle state of {@link
* ProjectInfo.State#DELETE_REQUESTED}. After deletion starts, as indicated by a lifecycle state
* of {@link ProjectInfo.State#DELETE_IN_PROGRESS}, the project cannot be restored. The caller
* must have modify permissions for this project.
*
* @throws ResourceManagerException upon failure
* @see Cloud
* Resource Manager undelete
* @deprecated Please use {@link
* com.google.cloud.resourcemanager.v3.ProjectsClient#undeleteProjectAsync(UndeleteProjectRequest)}
* instead
*/
@Deprecated
void undelete(String projectId);
/**
* Returns the IAM access control policy for the specified project. Returns {@code 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
* Resource Manager getIamPolicy
* @deprecated Please use {@link
* com.google.cloud.resourcemanager.v3.ProjectsClient#getIamPolicy(GetIamPolicyRequest)}
* instead
*/
@Deprecated
Policy getPolicy(String projectId);
/**
* Sets the IAM access control policy for the specified project. Replaces any existing policy. The
* following constraints apply:
*
* 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 {@link Policy#getEtag 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 {@code 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:
*
* The page token (returned from a previous call to list) indicates from where listing should
* continue.
*/
public static ListOption pageToken(String pageToken) {
return new ListOption(ResourceManagerRpc.Option.PAGE_TOKEN, pageToken);
}
/**
* The maximum number of records to return per RPC.
*
* The server can return fewer records than requested. When there are more results than the
* page size, the server will return a page token that can be used to fetch other results.
*/
public static ListOption pageSize(int pageSize) {
return new ListOption(ResourceManagerRpc.Option.PAGE_SIZE, pageSize);
}
}
/**
* Returns the permissions and their results representing whether the caller has the permissions
* on the specified Organization.
*
* @param resource the organization's resource name, e.g. "organizations/123"
* @param permissions the set of permissions to check for the resource. Permissions with wildcards
* (such as '*' or 'storage.*') are not allowed.
* @return the permissions and their results representing whether the caller has the permissions
* on the specified Organization.
* @throws ResourceManagerException upon failure
* @see
* Resource Manager testIamPermissions
* @deprecated
*/
@Deprecated
Map 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 are not expanded.
*
* @throws ResourceManagerException upon failure
* @see Resource
* Manager getEffectiveOrgPolicy
* @deprecated
*/
@Deprecated
OrgPolicyInfo getEffectiveOrgPolicy(String resource, String constraint);
/**
* Gets the 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 one of. The etag value can be used with
* projects.setOrgPolicy() to create or update a Policy during read-modify-write.
*
* @throws ResourceManagerException upon failure
* @see Resource
* Manager getOrgPolicy
*/
OrgPolicyInfo getOrgPolicy(String resource, String constraint);
/**
* Lists the Constraints that could be applied on the specified resource.
*
* @throws ResourceManagerException upon failure
* @see Resource
* Manager listAvailableOrgPolicyConstraints
* @deprecated
*/
@Deprecated
Page Not supplying an etag on the request Policy results in an unconditional write of the Policy.
*
* @throws ResourceManagerException upon failure
* @see Resource
* Manager setOrgPolicy
* @deprecated
*/
@Deprecated
OrgPolicyInfo replaceOrgPolicy(String resource, OrgPolicyInfo orgPolicy);
}
*
*
* 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.
*
* {@code
* 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
* Resource Manager setIamPolicy
* @deprecated
*/
@Deprecated
Policy replacePolicy(String projectId, Policy newPolicy);
/**
* 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.
*
* @return A list of booleans representing whether the caller has the permissions specified (in
* the order of the given permissions)
* @throws ResourceManagerException upon failure
* @see
* Resource Manager testIamPermissions
* @see Supported Cloud
* Platform Services
* @deprecated {@link
* com.google.cloud.resourcemanager.v3.ProjectsClient#testIamPermissions(TestIamPermissionsRequest)}
*/
@Deprecated
List