Class UpdateRoleRequest.Builder (3.25.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateRoleRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UpdateRoleRequest.Builder
Overrides

build()

public UpdateRoleRequest build()
Returns
TypeDescription
UpdateRoleRequest

buildPartial()

public UpdateRoleRequest buildPartial()
Returns
TypeDescription
UpdateRoleRequest

clear()

public UpdateRoleRequest.Builder clear()
Returns
TypeDescription
UpdateRoleRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public UpdateRoleRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
UpdateRoleRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateRoleRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
UpdateRoleRequest.Builder
Overrides

clearRole()

public UpdateRoleRequest.Builder clearRole()

The updated role.

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

Returns
TypeDescription
UpdateRoleRequest.Builder

clearUpdateMask()

public UpdateRoleRequest.Builder clearUpdateMask()

A mask describing which fields in the Role have changed.

.google.protobuf.FieldMask update_mask = 3;

Returns
TypeDescription
UpdateRoleRequest.Builder

clone()

public UpdateRoleRequest.Builder clone()
Returns
TypeDescription
UpdateRoleRequest.Builder
Overrides

getDefaultInstanceForType()

public UpdateRoleRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateRoleRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getRole()

public Role getRole()

The updated role.

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

Returns
TypeDescription
Role

The role.

getRoleBuilder()

public Role.Builder getRoleBuilder()

The updated role.

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

Returns
TypeDescription
Role.Builder

getRoleOrBuilder()

public RoleOrBuilder getRoleOrBuilder()

The updated role.

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

Returns
TypeDescription
RoleOrBuilder

getUpdateMask()

public FieldMask getUpdateMask()

A mask describing which fields in the Role have changed.

.google.protobuf.FieldMask update_mask = 3;

Returns
TypeDescription
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
TypeDescription
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

A mask describing which fields in the Role have changed.

.google.protobuf.FieldMask update_mask = 3;

Returns
TypeDescription
FieldMaskOrBuilder

hasRole()

public boolean hasRole()

The updated role.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(UpdateRoleRequest other)

public UpdateRoleRequest.Builder mergeFrom(UpdateRoleRequest other)
Parameter
NameDescription
otherUpdateRoleRequest
Returns
TypeDescription
UpdateRoleRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateRoleRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateRoleRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public UpdateRoleRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
UpdateRoleRequest.Builder
Overrides

mergeRole(Role value)

public UpdateRoleRequest.Builder mergeRole(Role value)

The updated role.

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

Parameter
NameDescription
valueRole
Returns
TypeDescription
UpdateRoleRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateRoleRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueFieldMask
Returns
TypeDescription
UpdateRoleRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateRoleRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
UpdateRoleRequest.Builder
Overrides

setRole(Role value)

public UpdateRoleRequest.Builder setRole(Role value)

The updated role.

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

Parameter
NameDescription
valueRole
Returns
TypeDescription
UpdateRoleRequest.Builder

setRole(Role.Builder builderForValue)

public UpdateRoleRequest.Builder setRole(Role.Builder builderForValue)

The updated role.

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

Parameter
NameDescription
builderForValueRole.Builder
Returns
TypeDescription
UpdateRoleRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateRoleRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueFieldMask
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
UpdateRoleRequest.Builder