RoleOrBuilder (proto-google-iam-admin-v1 3.62.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Role, Role.Builder
```
public interface RoleOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getDeleted()` The current deleted state of the role.
`String`	`getDescription()` Optional.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` Optional.
`com.google.protobuf.ByteString`	`getEtag()` Used to perform a consistent read-modify-write.
`String`	`getIncludedPermissions(int index)` The names of the permissions this role grants when bound in an IAM policy.
`com.google.protobuf.ByteString`	`getIncludedPermissionsBytes(int index)` The names of the permissions this role grants when bound in an IAM policy.
`int`	`getIncludedPermissionsCount()` The names of the permissions this role grants when bound in an IAM policy.
`List<String>`	`getIncludedPermissionsList()` The names of the permissions this role grants when bound in an IAM policy.
`String`	`getName()` The name of the role.
`com.google.protobuf.ByteString`	`getNameBytes()` The name of the role.
`Role.RoleLaunchStage`	`getStage()` The current launch stage of the role.
`int`	`getStageValue()` The current launch stage of the role.
`String`	`getTitle()` Optional.
`com.google.protobuf.ByteString`	`getTitleBytes()` Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getName

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:: The name.

getNameBytes

com.google.protobuf.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:: The bytes for name.

getTitle

String getTitle()

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

string title = 2;

Returns:: The title.

getTitleBytes

com.google.protobuf.ByteString getTitleBytes()

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

string title = 2;

Returns:: The bytes for title.

getDescription

String getDescription()

 Optional. A human-readable description for the role.

string description = 3;

Returns:: The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Optional. A human-readable description for the role.

string description = 3;

Returns:: The bytes for description.

getIncludedPermissionsList

List<String> getIncludedPermissionsList()

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

repeated string included_permissions = 7;

Returns:: A list containing the includedPermissions.

getIncludedPermissionsCount

int getIncludedPermissionsCount()

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

repeated string included_permissions = 7;

Returns:: The count of includedPermissions.

getIncludedPermissions
```
String getIncludedPermissions(int index)
```
```
 The names of the permissions this role grants when bound in an IAM policy.
 
```
repeated string included_permissions = 7;
Parameters:

index - The index of the element to return.

Returns:

The includedPermissions at the given index.

getIncludedPermissionsBytes
```
com.google.protobuf.ByteString getIncludedPermissionsBytes(int index)
```
```
 The names of the permissions this role grants when bound in an IAM policy.
 
```
repeated string included_permissions = 7;
Parameters:

index - The index of the value to return.

Returns:

The bytes of the includedPermissions at the given index.

getStageValue

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:: The enum numeric value on the wire for stage.

getStage

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:: The stage.

getEtag

com.google.protobuf.ByteString getEtag()

 Used to perform a consistent read-modify-write.

bytes etag = 9;

Returns:: The etag.

getDeleted

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:: The deleted.

Interface RoleOrBuilder