com.google.api.services.iam.v1

Class Iam.Organizations.Roles

java.lang.Object

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

Enclosing class:

Iam.Organizations

public class Iam.Organizations.Roles
extends java.lang.Object

The "roles" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Iam.Organizations.Roles.Create
class	Iam.Organizations.Roles.Delete
class	Iam.Organizations.Roles.Get
class	Iam.Organizations.Roles.List
class	Iam.Organizations.Roles.Patch
class	Iam.Organizations.Roles.Undelete

Constructor Summary

Constructors

Constructor and Description
Roles()

Method Summary

Modifier and Type	Method and Description
Iam.Organizations.Roles.Create	create(java.lang.String parent, CreateRoleRequest content) Creates a new Role.
Iam.Organizations.Roles.Delete	delete(java.lang.String name) Soft deletes a role.
Iam.Organizations.Roles.Get	get(java.lang.String name) Gets a Role definition.
Iam.Organizations.Roles.List	list(java.lang.String parent) Lists the Roles defined on a resource.
Iam.Organizations.Roles.Patch	patch(java.lang.String name, Role content) Updates a Role definition.
Iam.Organizations.Roles.Undelete	undelete(java.lang.String name, UndeleteRoleRequest content) Undelete a Role, bringing it back in its previous state.

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

create

public Iam.Organizations.Roles.Create create(java.lang.String parent,
                                             CreateRoleRequest content)
                                      throws java.io.IOException

Creates a new Role. Create a request for the method "roles.create". 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:

parent - The resource name of the parent resource in one of the following formats: `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}`

content - the CreateRoleRequest

Returns:

the request

Throws:

java.io.IOException

delete

public Iam.Organizations.Roles.Delete delete(java.lang.String name)
                                      throws java.io.IOException

Soft deletes a role. The role is suspended and cannot be used to create new IAM Policy Bindings. The Role will not be included in `ListRoles()` unless `show_deleted` is set in the `ListRolesRequest`. The Role contains the deleted boolean set. Existing Bindings remains, but are inactive. The Role can be undeleted within 7 days. After 7 days the Role is deleted and all Bindings associated with the role are removed. Create a request for the method "roles.delete". 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 resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}`

Returns:

the request

Throws:

java.io.IOException

get

public Iam.Organizations.Roles.Get get(java.lang.String name)
                                throws java.io.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 resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}`

Returns:

the request

Throws:

java.io.IOException

list

public Iam.Organizations.Roles.List list(java.lang.String parent)
                                  throws java.io.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.

Parameters:

parent - The resource name of the parent resource in one of the following formats: `` (empty string) -- this refers to curated roles. `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}`

Returns:

the request

Throws:

java.io.IOException

patch

public Iam.Organizations.Roles.Patch patch(java.lang.String name,
                                           Role content)
                                    throws java.io.IOException

Updates a Role definition. Create a request for the method "roles.patch". 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 resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}`

content - the Role

Returns:

the request

Throws:

java.io.IOException

undelete

public Iam.Organizations.Roles.Undelete undelete(java.lang.String name,
                                                 UndeleteRoleRequest content)
                                          throws java.io.IOException

Undelete a Role, bringing it back in its previous state. Create a request for the method "roles.undelete". 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 resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}`

content - the UndeleteRoleRequest

Returns:

the request

Throws:

java.io.IOException