Class CreateRoleRequest (3.42.0) 

public final class CreateRoleRequest extends GeneratedMessageV3 implements CreateRoleRequestOrBuilder

The request to create a new role.

Protobuf type google.iam.admin.v1.CreateRoleRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CreateRoleRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

ROLE_FIELD_NUMBER

public static final int ROLE_FIELD_NUMBER
Field Value
Type Description
int

ROLE_ID_FIELD_NUMBER

public static final int ROLE_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateRoleRequest getDefaultInstance()
Returns
Type Description
CreateRoleRequest

getDescriptor()

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

newBuilder()

public static CreateRoleRequest.Builder newBuilder()
Returns
Type Description
CreateRoleRequest.Builder

newBuilder(CreateRoleRequest prototype)

public static CreateRoleRequest.Builder newBuilder(CreateRoleRequest prototype)
Parameter
Name Description
prototype CreateRoleRequest
Returns
Type Description
CreateRoleRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateRoleRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateRoleRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateRoleRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRoleRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateRoleRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateRoleRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateRoleRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRoleRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateRoleRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateRoleRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateRoleRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRoleRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateRoleRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateRoleRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateRoleRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRoleRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateRoleRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateRoleRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateRoleRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRoleRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateRoleRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateRoleRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateRoleRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRoleRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateRoleRequest> parser()
Returns
Type Description
Parser<CreateRoleRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CreateRoleRequest getDefaultInstanceForType()
Returns
Type Description
CreateRoleRequest

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.

getParserForType()

public Parser<CreateRoleRequest> getParserForType()
Returns
Type Description
Parser<CreateRoleRequest>
Overrides

getRole()

public Role getRole()

The Role resource to create.

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

Returns
Type Description
Role

The role.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateRoleRequest.Builder newBuilderForType()
Returns
Type Description
CreateRoleRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateRoleRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateRoleRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateRoleRequest.Builder toBuilder()
Returns
Type Description
CreateRoleRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException