Interface RoleOrBuilder (3.48.0) 

public interface RoleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDeleted()

public abstract boolean getDeleted()

The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

bool deleted = 11;

Returns
Type Description
boolean

The deleted.

getDescription()

public abstract String getDescription()

Optional. A human-readable description for the role.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. A human-readable description for the role.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getEtag()

public abstract ByteString getEtag()

Used to perform a consistent read-modify-write.

bytes etag = 9;

Returns
Type Description
ByteString

The etag.

getIncludedPermissions(int index)

public abstract String getIncludedPermissions(int index)

The names of the permissions this role grants when bound in an IAM policy.

repeated string included_permissions = 7;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The includedPermissions at the given index.

getIncludedPermissionsBytes(int index)

public abstract ByteString getIncludedPermissionsBytes(int index)

The names of the permissions this role grants when bound in an IAM policy.

repeated string included_permissions = 7;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the includedPermissions at the given index.

getIncludedPermissionsCount()

public abstract int getIncludedPermissionsCount()

The names of the permissions this role grants when bound in an IAM policy.

repeated string included_permissions = 7;

Returns
Type Description
int

The count of includedPermissions.

getIncludedPermissionsList()

public abstract List<String> getIncludedPermissionsList()

The names of the permissions this role grants when bound in an IAM policy.

repeated string included_permissions = 7;

Returns
Type Description
List<String>

A list containing the includedPermissions.

getName()

public abstract String getName()

The name of the role.

When Role is used in CreateRole, the role name must not be set.

When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The name of the role.

When Role is used in CreateRole, the role name must not be set.

When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getStage()

public abstract Role.RoleLaunchStage getStage()

The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.

.google.iam.admin.v1.Role.RoleLaunchStage stage = 8;

Returns
Type Description
Role.RoleLaunchStage

The stage.

getStageValue()

public abstract int getStageValue()

The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.

.google.iam.admin.v1.Role.RoleLaunchStage stage = 8;

Returns
Type Description
int

The enum numeric value on the wire for stage.

getTitle()

public abstract String getTitle()

Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

string title = 2;

Returns
Type Description
String

The title.

getTitleBytes()

public abstract ByteString getTitleBytes()

Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

string title = 2;

Returns
Type Description
ByteString

The bytes for title.