Class Role

java.lang.Object
com.google.cloud.Role
All Implemented Interfaces:
Serializable

public final class Role extends Object 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:
  • Method Details

    • getValue

      public String getValue()
      Returns the string identifier for this role. For example, "roles/viewer", "roles/editor", or "roles/owner".
    • viewer

      public static Role viewer()
      Returns the viewer role. Encapsulates the permission for read-only actions that preserve state of a resource.
      See Also:
    • 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:
    • 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:
    • of

      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".

      Parameters:
      value - the string value for the role
      See Also:
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object