public class Iam.Projects.Roles
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
class |
Iam.Projects.Roles.Create |
class |
Iam.Projects.Roles.Delete |
class |
Iam.Projects.Roles.Get |
class |
Iam.Projects.Roles.List |
class |
Iam.Projects.Roles.Patch |
class |
Iam.Projects.Roles.Undelete |
Constructor and Description |
---|
Roles() |
Modifier and Type | Method and Description |
---|---|
Iam.Projects.Roles.Create |
create(java.lang.String parent,
CreateRoleRequest content)
Creates a new Role.
|
Iam.Projects.Roles.Delete |
delete(java.lang.String name)
Soft deletes a role.
|
Iam.Projects.Roles.Get |
get(java.lang.String name)
Gets a Role definition.
|
Iam.Projects.Roles.List |
list(java.lang.String parent)
Lists the Roles defined on a resource.
|
Iam.Projects.Roles.Patch |
patch(java.lang.String name,
Role content)
Updates a Role definition.
|
Iam.Projects.Roles.Undelete |
undelete(java.lang.String name,
UndeleteRoleRequest content)
Undelete a Role, bringing it back in its previous state.
|
public Iam.Projects.Roles.Create create(java.lang.String parent, CreateRoleRequest content) throws java.io.IOException
AbstractGoogleClientRequest.execute()
method to invoke the remote operation.parent
- The `parent` parameter's value depends on the target resource for the
request, namely
[`projects`](/iam/reference/rest/v1/projects.roles) or
[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
resource type's
`parent` value format is described below:
[`projects.roles.create()`](/iam/reference/rest/v1/projects.roles/create):
`projects/{PROJECT_ID}`. This method creates project-level
[custom roles](/iam/docs
/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
[`organizations.roles.create()`](/iam/reference/rest/v1/organizations.roles/create):
`organizations/{ORGANIZATION_ID}`. This method creates organization-level
[custom
roles](/iam/docs/understanding-custom-roles). Example request
URL:
`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
Note: Wildcard (*)
values are invalid; you must specify a complete project
ID or organization ID.content
- the CreateRoleRequest
java.io.IOException
public Iam.Projects.Roles.Delete delete(java.lang.String name) throws java.io.IOException
AbstractGoogleClientRequest.execute()
method to invoke the remote operation.name
- The `name` parameter's value depends on the target resource for the
request, namely
[`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:
[`projects.roles.delete()`](/iam/reference/rest/v1/projects.roles/delete):
`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes 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.delete()`](/iam/reference/rest/v1/organizations.roles/delete):
`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
deletes 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.java.io.IOException
public Iam.Projects.Roles.Get get(java.lang.String name) throws java.io.IOException
AbstractGoogleClientRequest.execute()
method to invoke the remote operation.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.java.io.IOException
public Iam.Projects.Roles.List list(java.lang.String parent) throws java.io.IOException
AbstractGoogleClientRequest.execute()
method to invoke the remote operation.parent
- The `parent` 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
`parent` value format is described below:
[`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string.
This method
doesn't require a resource; it simply returns all
[predefined roles](/iam/docs
/understanding-roles#predefined_roles) in
Cloud IAM. Example request URL:
`https://iam.googleapis.com/v1/roles`
[`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list):
`projects/{PROJECT_ID}`. This method lists all project-level
[custom roles](/iam/docs
/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
[`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list):
`organizations/{ORGANIZATION_ID}`. This method lists all
organization-level [custom
roles](/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
Note: Wildcard (*)
values are invalid; you must specify a complete project
ID or organization ID.java.io.IOException
public Iam.Projects.Roles.Patch patch(java.lang.String name, Role content) throws java.io.IOException
AbstractGoogleClientRequest.execute()
method to invoke the remote operation.name
- The `name` parameter's value depends on the target resource for the
request, namely
[`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:
[`projects.roles.patch()`](/iam/reference/rest/v1/projects.roles/patch):
`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates 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.patch()`](/iam/reference/rest/v1/organizations.roles/patch):
`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
updates 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.content
- the Role
java.io.IOException
public Iam.Projects.Roles.Undelete undelete(java.lang.String name, UndeleteRoleRequest content) throws java.io.IOException
AbstractGoogleClientRequest.execute()
method to invoke the remote operation.name
- The `name` parameter's value depends on the target resource for the
request, namely
[`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:
[`projects.roles.undelete()`](/iam/reference/rest/v1/projects.roles/undelete):
`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes
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.undelete()`](/iam/reference/rest/v1/organizations.roles/undelete):
`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
undeletes 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.content
- the UndeleteRoleRequest
java.io.IOException