Class Role (2.21.1)

public final class Role implements Serializable

A role in a IAM Policy. Project owners can grant access to team members to access project's resources and APIs by granting IAM roles to team members. See Also: Viewing the Grantable Roles on Resources, Understanding Roles

Inheritance

Object > Role

Implements

Serializable

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

editor()

public static Role editor()

Returns the editor role. Encapsulates all viewer's permissions and permissions for actions that modify the state of a resource. See Also: Understanding Roles

Returns
Type	Description
`Role`

of(String value)

public static Role of(String value)

Returns a new role given its string value.

If the value contains no slash character ('/'), the prefix "roles/"" is prepended. This slightly simplifies usage for predefined roles. For custom roles, call this method with the fully-qualified name, eg "projects/XXX/roles/YYY". See Also: Viewing the Grantable Roles on Resources

Parameter
Name	Description
`value`	`String` the string value for the role

Returns
Type	Description
`Role`

owner()

public static Role owner()

Returns the owner role. Encapsulates all editor's permissions and permissions to manage access control for a resource or manage the billing options for a project. See Also: Understanding Roles

Returns
Type	Description
`Role`

viewer()

public static Role viewer()

Returns the viewer role. Encapsulates the permission for read-only actions that preserve state of a resource. See Also: Understanding Roles

Returns
Type	Description
`Role`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

Object.equals(Object)

getValue()

public String getValue()

Returns the string identifier for this role. For example, "roles/viewer", "roles/editor", or "roles/owner".

Returns
Type	Description
`String`

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

Object.hashCode()

toString()

public String toString()

Returns
Type	Description
`String`

Overrides

Object.toString()