Class CreateRoleRequest.Builder (3.78.0)

public static final class CreateRoleRequest.Builder extends GeneratedMessage.Builder<CreateRoleRequest.Builder> implements CreateRoleRequestOrBuilder

The request to create a new role.

Protobuf type google.iam.admin.v1.CreateRoleRequest

Static Methods

getDescriptor()

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

Methods

build()

public CreateRoleRequest build()
Returns
Type Description
CreateRoleRequest

buildPartial()

public CreateRoleRequest buildPartial()
Returns
Type Description
CreateRoleRequest

clear()

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

clearParent()

public CreateRoleRequest.Builder clearParent()

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

  • projects.roles.create(): projects/{PROJECT_ID}. This method creates project-level custom roles. Example request URL: https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles

  • organizations.roles.create(): organizations/{ORGANIZATION_ID}. This method creates organization-level custom roles. Example request URL: https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles

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

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

Returns
Type Description
CreateRoleRequest.Builder

This builder for chaining.

clearRole()

public CreateRoleRequest.Builder clearRole()

The Role resource to create.

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

Returns
Type Description
CreateRoleRequest.Builder

clearRoleId()

public CreateRoleRequest.Builder clearRoleId()

The role ID to use for this role.

A role ID may contain alphanumeric characters, underscores (_), and periods (.). It must contain a minimum of 3 characters and a maximum of 64 characters.

string role_id = 2;

Returns
Type Description
CreateRoleRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public CreateRoleRequest getDefaultInstanceForType()
Returns
Type Description
CreateRoleRequest

getDescriptorForType()

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

getParent()

public String getParent()

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

  • projects.roles.create(): projects/{PROJECT_ID}. This method creates project-level custom roles. Example request URL: https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles

  • organizations.roles.create(): organizations/{ORGANIZATION_ID}. This method creates organization-level custom roles. Example request URL: https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles

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

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

  • projects.roles.create(): projects/{PROJECT_ID}. This method creates project-level custom roles. Example request URL: https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles

  • organizations.roles.create(): organizations/{ORGANIZATION_ID}. This method creates organization-level custom roles. Example request URL: https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles

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

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

Returns
Type Description
ByteString

The bytes for parent.

getRole()

public Role getRole()

The Role resource to create.

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

Returns
Type Description
Role

The role.

getRoleBuilder()

public Role.Builder getRoleBuilder()

The Role resource to create.

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

Returns
Type Description
Role.Builder

getRoleId()

public String getRoleId()

The role ID to use for this role.

A role ID may contain alphanumeric characters, underscores (_), and periods (.). It must contain a minimum of 3 characters and a maximum of 64 characters.

string role_id = 2;

Returns
Type Description
String

The roleId.

getRoleIdBytes()

public ByteString getRoleIdBytes()

The role ID to use for this role.

A role ID may contain alphanumeric characters, underscores (_), and periods (.). It must contain a minimum of 3 characters and a maximum of 64 characters.

string role_id = 2;

Returns
Type Description
ByteString

The bytes for roleId.

getRoleOrBuilder()

public RoleOrBuilder getRoleOrBuilder()

The Role resource to create.

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

Returns
Type Description
RoleOrBuilder

hasRole()

public boolean hasRole()

The Role resource to create.

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

Returns
Type Description
boolean

Whether the role field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CreateRoleRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRole(Role value)

public CreateRoleRequest.Builder mergeRole(Role value)

The Role resource to create.

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

Parameter
Name Description
value Role
Returns
Type Description
CreateRoleRequest.Builder

setParent(String value)

public CreateRoleRequest.Builder setParent(String value)

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

  • projects.roles.create(): projects/{PROJECT_ID}. This method creates project-level custom roles. Example request URL: https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles

  • organizations.roles.create(): organizations/{ORGANIZATION_ID}. This method creates organization-level custom roles. Example request URL: https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles

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

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateRoleRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateRoleRequest.Builder setParentBytes(ByteString value)

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

  • projects.roles.create(): projects/{PROJECT_ID}. This method creates project-level custom roles. Example request URL: https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles

  • organizations.roles.create(): organizations/{ORGANIZATION_ID}. This method creates organization-level custom roles. Example request URL: https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles

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

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateRoleRequest.Builder

This builder for chaining.

setRole(Role value)

public CreateRoleRequest.Builder setRole(Role value)

The Role resource to create.

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

Parameter
Name Description
value Role
Returns
Type Description
CreateRoleRequest.Builder

setRole(Role.Builder builderForValue)

public CreateRoleRequest.Builder setRole(Role.Builder builderForValue)

The Role resource to create.

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

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

setRoleId(String value)

public CreateRoleRequest.Builder setRoleId(String value)

The role ID to use for this role.

A role ID may contain alphanumeric characters, underscores (_), and periods (.). It must contain a minimum of 3 characters and a maximum of 64 characters.

string role_id = 2;

Parameter
Name Description
value String

The roleId to set.

Returns
Type Description
CreateRoleRequest.Builder

This builder for chaining.

setRoleIdBytes(ByteString value)

public CreateRoleRequest.Builder setRoleIdBytes(ByteString value)

The role ID to use for this role.

A role ID may contain alphanumeric characters, underscores (_), and periods (.). It must contain a minimum of 3 characters and a maximum of 64 characters.

string role_id = 2;

Parameter
Name Description
value ByteString

The bytes for roleId to set.

Returns
Type Description
CreateRoleRequest.Builder

This builder for chaining.