Class UpdateRoleRequest.Builder (3.39.0) 

public static final class UpdateRoleRequest.Builder extends GeneratedMessageV3.Builder<UpdateRoleRequest.Builder> implements UpdateRoleRequestOrBuilder

The request to update a role.

Protobuf type google.iam.admin.v1.UpdateRoleRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateRoleRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateRoleRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateRoleRequest.Builder
Overrides

build()

public UpdateRoleRequest build()
Returns
Type Description
UpdateRoleRequest

buildPartial()

public UpdateRoleRequest buildPartial()
Returns
Type Description
UpdateRoleRequest

clear()

public UpdateRoleRequest.Builder clear()
Returns
Type Description
UpdateRoleRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public UpdateRoleRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateRoleRequest.Builder
Overrides

clearName()

public UpdateRoleRequest.Builder clearName()

The name parameter's value depends on the target resource for the request, namely projects or organizations. Each resource type's name value format is described below:

  • projects.roles.patch(): projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}. This method updates only custom roles that have been created at the project level. Example request URL: https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}

  • organizations.roles.patch(): organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}. This method updates only custom roles that have been created at the organization level. Example request URL: https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}

    Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

string name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
UpdateRoleRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateRoleRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateRoleRequest.Builder
Overrides

clearRole()

public UpdateRoleRequest.Builder clearRole()

The updated role.

.google.iam.admin.v1.Role role = 2;

Returns
Type Description
UpdateRoleRequest.Builder

clearUpdateMask()

public UpdateRoleRequest.Builder clearUpdateMask()

A mask describing which fields in the Role have changed.

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
UpdateRoleRequest.Builder

clone()

public UpdateRoleRequest.Builder clone()
Returns
Type Description
UpdateRoleRequest.Builder
Overrides

getDefaultInstanceForType()

public UpdateRoleRequest getDefaultInstanceForType()
Returns
Type Description
UpdateRoleRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

public String getName()

The name parameter's value depends on the target resource for the request, namely projects or organizations. Each resource type's name value format is described below:

  • projects.roles.patch(): projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}. This method updates only custom roles that have been created at the project level. Example request URL: https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}

  • organizations.roles.patch(): organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}. This method updates only custom roles that have been created at the organization level. Example request URL: https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}

    Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

string name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name parameter's value depends on the target resource for the request, namely projects or organizations. Each resource type's name value format is described below:

  • projects.roles.patch(): projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}. This method updates only custom roles that have been created at the project level. Example request URL: https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}

  • organizations.roles.patch(): organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}. This method updates only custom roles that have been created at the organization level. Example request URL: https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}

    Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

string name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getRole()

public Role getRole()

The updated role.

.google.iam.admin.v1.Role role = 2;

Returns
Type Description
Role

The role.

getRoleBuilder()

public Role.Builder getRoleBuilder()

The updated role.

.google.iam.admin.v1.Role role = 2;

Returns
Type Description
Role.Builder

getRoleOrBuilder()

public RoleOrBuilder getRoleOrBuilder()

The updated role.

.google.iam.admin.v1.Role role = 2;

Returns
Type Description
RoleOrBuilder

getUpdateMask()

public FieldMask getUpdateMask()

A mask describing which fields in the Role have changed.

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

A mask describing which fields in the Role have changed.

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

A mask describing which fields in the Role have changed.

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
FieldMaskOrBuilder

hasRole()

public boolean hasRole()

The updated role.

.google.iam.admin.v1.Role role = 2;

Returns
Type Description
boolean

Whether the role field is set.

hasUpdateMask()

public boolean hasUpdateMask()

A mask describing which fields in the Role have changed.

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UpdateRoleRequest other)

public UpdateRoleRequest.Builder mergeFrom(UpdateRoleRequest other)
Parameter
Name Description
other UpdateRoleRequest
Returns
Type Description
UpdateRoleRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateRoleRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateRoleRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateRoleRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateRoleRequest.Builder
Overrides

mergeRole(Role value)

public UpdateRoleRequest.Builder mergeRole(Role value)

The updated role.

.google.iam.admin.v1.Role role = 2;

Parameter
Name Description
value Role
Returns
Type Description
UpdateRoleRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateRoleRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateRoleRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateRoleRequest.Builder mergeUpdateMask(FieldMask value)

A mask describing which fields in the Role have changed.

.google.protobuf.FieldMask update_mask = 3;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateRoleRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateRoleRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateRoleRequest.Builder
Overrides

setName(String value)

public UpdateRoleRequest.Builder setName(String value)

The name parameter's value depends on the target resource for the request, namely projects or organizations. Each resource type's name value format is described below:

  • projects.roles.patch(): projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}. This method updates only custom roles that have been created at the project level. Example request URL: https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}

  • organizations.roles.patch(): organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}. This method updates only custom roles that have been created at the organization level. Example request URL: https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}

    Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

string name = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.
Returns
Type Description
UpdateRoleRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public UpdateRoleRequest.Builder setNameBytes(ByteString value)

The name parameter's value depends on the target resource for the request, namely projects or organizations. Each resource type's name value format is described below:

  • projects.roles.patch(): projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}. This method updates only custom roles that have been created at the project level. Example request URL: https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}

  • organizations.roles.patch(): organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}. This method updates only custom roles that have been created at the organization level. Example request URL: https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}

    Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

string name = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
UpdateRoleRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateRoleRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateRoleRequest.Builder
Overrides

setRole(Role value)

public UpdateRoleRequest.Builder setRole(Role value)

The updated role.

.google.iam.admin.v1.Role role = 2;

Parameter
Name Description
value Role
Returns
Type Description
UpdateRoleRequest.Builder

setRole(Role.Builder builderForValue)

public UpdateRoleRequest.Builder setRole(Role.Builder builderForValue)

The updated role.

.google.iam.admin.v1.Role role = 2;

Parameter
Name Description
builderForValue Role.Builder
Returns
Type Description
UpdateRoleRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateRoleRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateRoleRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateRoleRequest.Builder setUpdateMask(FieldMask value)

A mask describing which fields in the Role have changed.

.google.protobuf.FieldMask update_mask = 3;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateRoleRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateRoleRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

A mask describing which fields in the Role have changed.

.google.protobuf.FieldMask update_mask = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateRoleRequest.Builder