Role.Builder (proto-google-iam-admin-v1 3.62.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
    - - com.google.iam.admin.v1.Role.Builder

All Implemented Interfaces:

RoleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Role
```
public static final class Role.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
implements RoleOrBuilder
```
```
 A role in the Identity and Access Management API.
 
```
Protobuf type google.iam.admin.v1.Role

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Role.Builder`	`addAllIncludedPermissions(Iterable<String> values)` The names of the permissions this role grants when bound in an IAM policy.
`Role.Builder`	`addIncludedPermissions(String value)` The names of the permissions this role grants when bound in an IAM policy.
`Role.Builder`	`addIncludedPermissionsBytes(com.google.protobuf.ByteString value)` The names of the permissions this role grants when bound in an IAM policy.
`Role.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Role`	`build()`
`Role`	`buildPartial()`
`Role.Builder`	`clear()`
`Role.Builder`	`clearDeleted()` The current deleted state of the role.
`Role.Builder`	`clearDescription()` Optional.
`Role.Builder`	`clearEtag()` Used to perform a consistent read-modify-write.
`Role.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Role.Builder`	`clearIncludedPermissions()` The names of the permissions this role grants when bound in an IAM policy.
`Role.Builder`	`clearName()` The name of the role.
`Role.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Role.Builder`	`clearStage()` The current launch stage of the role.
`Role.Builder`	`clearTitle()` Optional.
`Role.Builder`	`clone()`
`Role`	`getDefaultInstanceForType()`
`boolean`	`getDeleted()` The current deleted state of the role.
`String`	`getDescription()` Optional.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` Optional.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`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.
`com.google.protobuf.ProtocolStringList`	`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.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Role.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Role.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Role.Builder`	`mergeFrom(Role other)`
`Role.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Role.Builder`	`setDeleted(boolean value)` The current deleted state of the role.
`Role.Builder`	`setDescription(String value)` Optional.
`Role.Builder`	`setDescriptionBytes(com.google.protobuf.ByteString value)` Optional.
`Role.Builder`	`setEtag(com.google.protobuf.ByteString value)` Used to perform a consistent read-modify-write.
`Role.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Role.Builder`	`setIncludedPermissions(int index, String value)` The names of the permissions this role grants when bound in an IAM policy.
`Role.Builder`	`setName(String value)` The name of the role.
`Role.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` The name of the role.
`Role.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Role.Builder`	`setStage(Role.RoleLaunchStage value)` The current launch stage of the role.
`Role.Builder`	`setStageValue(int value)` The current launch stage of the role.
`Role.Builder`	`setTitle(String value)` Optional.
`Role.Builder`	`setTitleBytes(com.google.protobuf.ByteString value)` Optional.
`Role.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>

clear
```
public Role.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>

getDefaultInstanceForType
```
public Role getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Role build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public Role buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public Role.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>

setField

public Role.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                             Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>

clearField
```
public Role.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>

clearOneof
```
public Role.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>

setRepeatedField

public Role.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     int index,
                                     Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>

addRepeatedField

public Role.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>

mergeFrom
```
public Role.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Role.Builder>

mergeFrom

public Role.Builder mergeFrom(Role other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>

mergeFrom
```
public Role.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Role.Builder>

Throws:

IOException

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;

Specified by:: getName in interface RoleOrBuilder
Returns:: The name.

getNameBytes

public 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;

Specified by:: getNameBytes in interface RoleOrBuilder
Returns:: The bytes for name.

setName

public Role.Builder setName(String value)

 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;

Parameters:: value - The name to set.
Returns:: This builder for chaining.

clearName

public Role.Builder clearName()

 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:: This builder for chaining.

setNameBytes

public Role.Builder setNameBytes(com.google.protobuf.ByteString value)

 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;

Parameters:: value - The bytes for name to set.
Returns:: This builder for chaining.

getTitle

public String getTitle()

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

string title = 2;

Specified by:: getTitle in interface RoleOrBuilder
Returns:: The title.

getTitleBytes

public 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;

Specified by:: getTitleBytes in interface RoleOrBuilder
Returns:: The bytes for title.

setTitle

public Role.Builder setTitle(String value)

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

string title = 2;

Parameters:: value - The title to set.
Returns:: This builder for chaining.

clearTitle

public Role.Builder clearTitle()

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

string title = 2;

Returns:: This builder for chaining.

setTitleBytes

public Role.Builder setTitleBytes(com.google.protobuf.ByteString value)

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

string title = 2;

Parameters:: value - The bytes for title to set.
Returns:: This builder for chaining.

getDescription
```
public String getDescription()
```
```
 Optional. A human-readable description for the role.
 
```
string description = 3;
Specified by:

getDescription in interface RoleOrBuilder

Returns:

The description.

getDescriptionBytes
```
public com.google.protobuf.ByteString getDescriptionBytes()
```
```
 Optional. A human-readable description for the role.
 
```
string description = 3;
Specified by:

getDescriptionBytes in interface RoleOrBuilder

Returns:

The bytes for description.

setDescription

public Role.Builder setDescription(String value)

 Optional. A human-readable description for the role.

string description = 3;

Parameters:: value - The description to set.
Returns:: This builder for chaining.

clearDescription

public Role.Builder clearDescription()

 Optional. A human-readable description for the role.

string description = 3;

Returns:: This builder for chaining.

setDescriptionBytes

public Role.Builder setDescriptionBytes(com.google.protobuf.ByteString value)

 Optional. A human-readable description for the role.

string description = 3;

Parameters:: value - The bytes for description to set.
Returns:: This builder for chaining.

getIncludedPermissionsList
```
public com.google.protobuf.ProtocolStringList getIncludedPermissionsList()
```
```
 The names of the permissions this role grants when bound in an IAM policy.
 
```
repeated string included_permissions = 7;
Specified by:

getIncludedPermissionsList in interface RoleOrBuilder

Returns:

A list containing the includedPermissions.

getIncludedPermissionsCount
```
public int getIncludedPermissionsCount()
```
```
 The names of the permissions this role grants when bound in an IAM policy.
 
```
repeated string included_permissions = 7;
Specified by:

getIncludedPermissionsCount in interface RoleOrBuilder

Returns:

The count of includedPermissions.

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

getIncludedPermissions in interface RoleOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The includedPermissions at the given index.

getIncludedPermissionsBytes
```
public 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;
Specified by:

getIncludedPermissionsBytes in interface RoleOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the includedPermissions at the given index.

setIncludedPermissions

public Role.Builder setIncludedPermissions(int index,
                                           String value)

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

repeated string included_permissions = 7;

Parameters:: index - The index to set the value at.; value - The includedPermissions to set.
Returns:: This builder for chaining.

addIncludedPermissions
```
public Role.Builder addIncludedPermissions(String value)
```
```
 The names of the permissions this role grants when bound in an IAM policy.
 
```
repeated string included_permissions = 7;
Parameters:

value - The includedPermissions to add.

Returns:

This builder for chaining.

addAllIncludedPermissions

public Role.Builder addAllIncludedPermissions(Iterable<String> values)

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

repeated string included_permissions = 7;

Parameters:: values - The includedPermissions to add.
Returns:: This builder for chaining.

clearIncludedPermissions

public Role.Builder clearIncludedPermissions()

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

repeated string included_permissions = 7;

Returns:: This builder for chaining.

addIncludedPermissionsBytes

public Role.Builder addIncludedPermissionsBytes(com.google.protobuf.ByteString value)

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

repeated string included_permissions = 7;

Parameters:: value - The bytes of the includedPermissions to add.
Returns:: This builder for chaining.