Interface ResourceManagerRpc (1.56.0)

public interface ResourceManagerRpc extends ServiceRpc

Deprecated. v3 GAPIC client of ResourceManager is now available

Implements

com.google.cloud.ServiceRpc

Methods

clearOrgPolicy(String resource, OrgPolicy orgPolicy) (deprecated)

public abstract void clearOrgPolicy(String resource, OrgPolicy orgPolicy)

Clears the Policy from a resource.

Parameters
Name Description
resource String
orgPolicy com.google.api.services.cloudresourcemanager.model.OrgPolicy
Exceptions
Type Description
IOException

create(Project project) (deprecated)

public abstract Project create(Project project)

Creates a new project.

Parameter
Name Description
project com.google.api.services.cloudresourcemanager.model.Project
Returns
Type Description
com.google.api.services.cloudresourcemanager.model.Project

delete(String projectId) (deprecated)

public abstract void delete(String projectId)

Marks the project identified by the specified project ID for deletion.

Parameter
Name Description
projectId String

get(String projectId, Map<ResourceManagerRpc.Option,?> options) (deprecated)

public abstract Project get(String projectId, Map<ResourceManagerRpc.Option,?> 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.

Parameters
Name Description
projectId String
options Map<Option,?>
Returns
Type Description
com.google.api.services.cloudresourcemanager.model.Project

getEffectiveOrgPolicy(String resource, String constraint) (deprecated)

public abstract OrgPolicy getEffectiveOrgPolicy(String resource, String constraint)

Gets the effective Policy on a resource.

This is the result of merging Policies in the resource hierarchy. The returned Policy does not have an etag set because it is a computed Policy across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

Parameters
Name Description
resource String
constraint String
Returns
Type Description
com.google.api.services.cloudresourcemanager.model.OrgPolicy
Exceptions
Type Description
IOException

upon failure

getOrgPolicy(String resource, String constraint) (deprecated)

public abstract OrgPolicy getOrgPolicy(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 oneof. The etag value can be used with projects.setOrgPolicy() to create or update a Policy during read-modify-write.

Parameters
Name Description
resource String
constraint String
Returns
Type Description
com.google.api.services.cloudresourcemanager.model.OrgPolicy
Exceptions
Type Description
IOException

upon failure

getPolicy(String projectId) (deprecated)

public abstract Policy getPolicy(String projectId)

Returns the IAM policy associated with a project.

Parameter
Name Description
projectId String
Returns
Type Description
com.google.api.services.cloudresourcemanager.model.Policy

list(Map<ResourceManagerRpc.Option,?> options) (deprecated)

public abstract Tuple<String,Iterable<Project>> list(Map<ResourceManagerRpc.Option,?> options)

Lists the projects visible to the current user.

Parameter
Name Description
options Map<Option,?>
Returns
Type Description
com.google.cloud.Tuple<String,Iterable<com.google.api.services.cloudresourcemanager.model.Project>>

listAvailableOrgPolicyConstraints(String resource, Map<ResourceManagerRpc.Option,?> options) (deprecated)

public abstract ResourceManagerRpc.ListResult<Constraint> listAvailableOrgPolicyConstraints(String resource, Map<ResourceManagerRpc.Option,?> options)

Lists all the Constraints that can be applied on the specified resource.

Parameters
Name Description
resource String
options Map<Option,?>
Returns
Type Description
ListResult<com.google.api.services.cloudresourcemanager.model.Constraint>
Exceptions
Type Description
IOException

upon failure

listOrgPolicies(String resource, Map<ResourceManagerRpc.Option,?> options) (deprecated)

public abstract ResourceManagerRpc.ListResult<OrgPolicy> listOrgPolicies(String resource, Map<ResourceManagerRpc.Option,?> options)

Lists all the Policies set for a particular resource.

Parameters
Name Description
resource String
options Map<Option,?>
Returns
Type Description
ListResult<com.google.api.services.cloudresourcemanager.model.OrgPolicy>
Exceptions
Type Description
IOException

upon failure

replace(Project project) (deprecated)

public abstract Project replace(Project project)

Replaces the attributes of the project. The caller must have modify permissions for this project.

Parameter
Name Description
project com.google.api.services.cloudresourcemanager.model.Project
Returns
Type Description
com.google.api.services.cloudresourcemanager.model.Project

replaceOrgPolicy(String resource, OrgPolicy orgPolicy) (deprecated)

public abstract OrgPolicy replaceOrgPolicy(String resource, OrgPolicy orgPolicy)

Updates the specified Policy on the resource. Creates a new Policy for that Constraint on the resource if one does not exist.

Not supplying an etag on the request Policy results in an unconditional write of the Policy.

Parameters
Name Description
resource String
orgPolicy com.google.api.services.cloudresourcemanager.model.OrgPolicy
Returns
Type Description
com.google.api.services.cloudresourcemanager.model.OrgPolicy
Exceptions
Type Description
IOException

upon failure

replacePolicy(String projectId, Policy newPolicy) (deprecated)

public abstract Policy replacePolicy(String projectId, Policy newPolicy)

Replaces the IAM policy associated with the given project.

Parameters
Name Description
projectId String
newPolicy com.google.api.services.cloudresourcemanager.model.Policy
Returns
Type Description
com.google.api.services.cloudresourcemanager.model.Policy

testOrgPermissions(String resource, List<String> permissions) (deprecated)

public abstract Map<String,Boolean> testOrgPermissions(String resource, List<String> permissions)

Tests whether the caller has the given permissions on the specified Organization. Returns the permissions and their results.

Parameters
Name Description
resource String
permissions List<String>
Returns
Type Description
Map<String,Boolean>
Exceptions
Type Description
IOException

upon failure

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

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

Tests whether the caller has the given permissions. Returns a list of booleans corresponding to whether or not the user has the permission in the same position of input list.

Parameters
Name Description
projectId String
permissions List<String>
Returns
Type Description
List<Boolean>

undelete(String projectId) (deprecated)

public abstract void undelete(String projectId)

Restores the project identified by the specified project ID. Undelete will only succeed if the project has a lifecycle state of DELETE_REQUESTED state. The caller must have modify permissions for this project.

Parameter
Name Description
projectId String