Send feedback
Class Role (1.2.5) Stay organized with collections
Save and categorize content based on your preferences.
Version 1.2.5 keyboard_arrow_down
public
final
class
Role
extends
GeneratedMessageV3
implements
RoleOrBuilder
A role in the Identity and Access Management API.
Protobuf type google.iam.admin.v1.Role
Static Fields
DELETED_FIELD_NUMBER
public
static
final
int
DELETED_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public
static
final
int
DESCRIPTION_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public
static
final
int
ETAG_FIELD_NUMBER
Field Value
INCLUDED_PERMISSIONS_FIELD_NUMBER
public
static
final
int
INCLUDED_PERMISSIONS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
Field Value
STAGE_FIELD_NUMBER
public
static
final
int
STAGE_FIELD_NUMBER
Field Value
TITLE_FIELD_NUMBER
public
static
final
int
TITLE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public
static
Role
getDefaultInstance
()
Returns
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
Returns
newBuilder()
public
static
Role
.
Builder
newBuilder
()
Returns
newBuilder(Role prototype)
public
static
Role
.
Builder
newBuilder
(
Role
prototype
)
Parameter
Returns
public
static
Role
parseDelimitedFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
public
static
Role
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public
static
Role
parseFrom
(
byte
[]
data
)
Parameter
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Role
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public
static
Role
parseFrom
(
ByteString
data
)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Role
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
public
static
Role
parseFrom
(
CodedInputStream
input
)
Parameter
Returns
Exceptions
public
static
Role
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
public
static
Role
parseFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
public
static
Role
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public
static
Role
parseFrom
(
ByteBuffer
data
)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Role
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parser()
public
static
Parser<Role>
parser
()
Returns
Methods
equals(Object obj)
public
boolean
equals
(
Object
obj
)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public
Role
getDefaultInstanceForType
()
Returns
getDeleted()
public
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
getDescription()
public
String
getDescription
()
Optional. A human-readable description for the role.
string description = 3;
Returns
getDescriptionBytes()
public
ByteString
getDescriptionBytes
()
Optional. A human-readable description for the role.
string description = 3;
Returns Type
Description
ByteString
The bytes for description.
getEtag()
public
ByteString
getEtag
()
Used to perform a consistent read-modify-write.
bytes etag = 9;
Returns
getIncludedPermissions(int index)
public
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
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
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
ProtocolStringList
getIncludedPermissionsList
()
The names of the permissions this role grants when bound in an IAM policy.
repeated string included_permissions = 7;
Returns
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
getNameBytes()
public
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
getParserForType()
public
Parser<Role>
getParserForType
()
Returns
Overrides
getSerializedSize()
public
int
getSerializedSize
()
Returns
Overrides
getStage()
public
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
getStageValue()
public
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
String
getTitle
()
Optional. A human-readable title for the role. Typically this
is limited to 100 UTF-8 bytes.
string title = 2;
Returns
getTitleBytes()
public
ByteString
getTitleBytes
()
Optional. A human-readable title for the role. Typically this
is limited to 100 UTF-8 bytes.
string title = 2;
Returns
getUnknownFields()
public
final
UnknownFieldSet
getUnknownFields
()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
Returns
Overrides
isInitialized()
public
final
boolean
isInitialized
()
Returns
Overrides
newBuilderForType()
public
Role
.
Builder
newBuilderForType
()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Role
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
Parameter
Returns
Overrides
toBuilder()
public
Role
.
Builder
toBuilder
()
Returns
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
Parameter
Overrides
Exceptions
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
