com.google.api.services.iam.v1

Class Iam.Roles

java.lang.Object

com.google.api.services.iam.v1.Iam.Roles

Enclosing class:

Iam

public class Iam.Roles
extends Object

The "roles" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Iam.Roles.Get
class	Iam.Roles.List
class	Iam.Roles.QueryGrantableRoles

Constructor Summary

Constructors

Constructor and Description
Roles()

Method Summary

Modifier and Type	Method and Description
Iam.Roles.Get	get(String name) Gets a Role definition.
Iam.Roles.List	list() Lists the Roles defined on a resource.
Iam.Roles.QueryGrantableRoles	queryGrantableRoles(QueryGrantableRolesRequest content) Queries roles that can be granted on a particular resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Roles

public Roles()

Method Detail

get

public Iam.Roles.Get get(String name)
                  throws IOException

Gets a Role definition. Create a request for the method "roles.get". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](/iam/docs /understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

Returns:

the request

Throws:

IOException

list

public Iam.Roles.List list()
                    throws IOException

Lists the Roles defined on a resource. Create a request for the method "roles.list". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

queryGrantableRoles

public Iam.Roles.QueryGrantableRoles queryGrantableRoles(QueryGrantableRolesRequest content)
                                                  throws IOException

Queries roles that can be granted on a particular resource. A role is grantable if it can be used as the role in a binding for a policy for that resource. Create a request for the method "roles.queryGrantableRoles". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the QueryGrantableRolesRequest

Returns:

the request

Throws:

IOException