Class Role (3.54.0)

  public 
  
 final 
  
 class 
 Role 
  
 extends 
  
 GeneratedMessageV3 
  
 implements 
  
 RoleOrBuilder 
 

A role in the Identity and Access Management API.

Protobuf type google.iam.admin.v1.Role

Implements

RoleOrBuilder

Static Fields

DELETED_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DELETED_FIELD_NUMBER 
 
Field Value
Type
Description
int

DESCRIPTION_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DESCRIPTION_FIELD_NUMBER 
 
Field Value
Type
Description
int

ETAG_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ETAG_FIELD_NUMBER 
 
Field Value
Type
Description
int

INCLUDED_PERMISSIONS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 INCLUDED_PERMISSIONS_FIELD_NUMBER 
 
Field Value
Type
Description
int

NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

STAGE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 STAGE_FIELD_NUMBER 
 
Field Value
Type
Description
int

TITLE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 TITLE_FIELD_NUMBER 
 
Field Value
Type
Description
int

Static Methods

getDefaultInstance()

  public 
  
 static 
  
 Role 
  
 getDefaultInstance 
 () 
 
Returns
Type
Description

getDescriptor()

  public 
  
 static 
  
 final 
  
 Descriptors 
 . 
 Descriptor 
  
 getDescriptor 
 () 
 
Returns
Type
Description

newBuilder()

  public 
  
 static 
  
 Role 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type
Description

newBuilder(Role prototype)

  public 
  
 static 
  
 Role 
 . 
 Builder 
  
 newBuilder 
 ( 
 Role 
  
 prototype 
 ) 
 
Parameter
Name
Description
prototype
Returns
Type
Description

parseDelimitedFrom(InputStream input)

  public 
  
 static 
  
 Role 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Exceptions
Type
Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Role 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(byte[] data)

  public 
  
 static 
  
 Role 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 ) 
 
Parameter
Name
Description
data
byte []
Returns
Type
Description
Exceptions
Type
Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Role 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
byte []
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteString data)

  public 
  
 static 
  
 Role 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Role 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(CodedInputStream input)

  public 
  
 static 
  
 Role 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Exceptions
Type
Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Role 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(InputStream input)

  public 
  
 static 
  
 Role 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Exceptions
Type
Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Role 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteBuffer data)

  public 
  
 static 
  
 Role 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Role 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parser()

  public 
  
 static 
  
 Parser<Role> 
  
 parser 
 () 
 
Returns
Type
Description
Parser < Role >

Methods

equals(Object obj)

  public 
  
 boolean 
  
 equals 
 ( 
 Object 
  
 obj 
 ) 
 
Parameter
Name
Description
obj
Returns
Type
Description
Overrides

getDefaultInstanceForType()

  public 
  
 Role 
  
 getDefaultInstanceForType 
 () 
 
Returns
Type
Description

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
Type
Description

The deleted.

getDescription()

  public 
  
 String 
  
 getDescription 
 () 
 

Optional. A human-readable description for the role.

string description = 3;

Returns
Type
Description

The description.

getDescriptionBytes()

  public 
  
 ByteString 
  
 getDescriptionBytes 
 () 
 

Optional. A human-readable description for the role.

string description = 3;

Returns
Type
Description

The bytes for description.

getEtag()

  public 
  
 ByteString 
  
 getEtag 
 () 
 

Used to perform a consistent read-modify-write.

bytes etag = 9;

Returns
Type
Description

The etag.

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

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

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
Type
Description

A list containing the includedPermissions.

getName()

  public 
  
 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

The name.

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
Type
Description

The bytes for name.

getParserForType()

  public 
  
 Parser<Role> 
  
 getParserForType 
 () 
 
Returns
Type
Description
Parser < Role >
Overrides

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type
Description
int
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
Type
Description

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
Type
Description

The title.

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
Type
Description

The bytes for title.

hashCode()

  public 
  
 int 
  
 hashCode 
 () 
 
Returns
Type
Description
int
Overrides

internalGetFieldAccessorTable()

  protected 
  
 GeneratedMessageV3 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type
Description
Overrides

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type
Description
Overrides

newBuilderForType()

  public 
  
 Role 
 . 
 Builder 
  
 newBuilderForType 
 () 
 
Returns
Type
Description

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

  protected 
  
 Role 
 . 
 Builder 
  
 newBuilderForType 
 ( 
 GeneratedMessageV3 
 . 
 BuilderParent 
  
 parent 
 ) 
 
Parameter
Name
Description
parent
Returns
Type
Description
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

  protected 
  
 Object 
  
 newInstance 
 ( 
 GeneratedMessageV3 
 . 
 UnusedPrivateParameter 
  
 unused 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Overrides

toBuilder()

  public 
  
 Role 
 . 
 Builder 
  
 toBuilder 
 () 
 
Returns
Type
Description

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name
Description
Overrides
Exceptions
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: