Class Role (2.11.0) 

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

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
TypeDescription
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
NameDescription
valueString

the string value for the role

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Role

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getValue()

public String getValue()

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

Returns
TypeDescription
String

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

toString()

public String toString()
Returns
TypeDescription
String
Overrides