public static final class GetRoleRequest.Builder extends GeneratedMessageV3.Builder<GetRoleRequest.Builder> implements GetRoleRequestOrBuilder
The request to get the definition of an existing role.
Protobuf type google.iam.admin.v1.GetRoleRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GetRoleRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public GetRoleRequest build()
Returns
buildPartial()
public GetRoleRequest buildPartial()
Returns
clear()
public GetRoleRequest.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public GetRoleRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearName()
public GetRoleRequest.Builder clearName()
The name
parameter's value depends on the target resource for the
request, namely
roles
,
projects
,
or
organizations
.
Each resource type's name
value format is described below:
roles.get()
: roles/{ROLE_NAME}
.
This method returns results from all
predefined
roles
in Cloud IAM. Example request URL:
https://iam.googleapis.com/v1/roles/{ROLE_NAME}
projects.roles.get()
:
projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}
. This method returns 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.get()
:
organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}
. This method
returns 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
clearOneof(Descriptors.OneofDescriptor oneof)
public GetRoleRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public GetRoleRequest.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public GetRoleRequest getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getName()
The name
parameter's value depends on the target resource for the
request, namely
roles
,
projects
,
or
organizations
.
Each resource type's name
value format is described below:
roles.get()
: roles/{ROLE_NAME}
.
This method returns results from all
predefined
roles
in Cloud IAM. Example request URL:
https://iam.googleapis.com/v1/roles/{ROLE_NAME}
projects.roles.get()
:
projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}
. This method returns 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.get()
:
organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}
. This method
returns 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
roles
,
projects
,
or
organizations
.
Each resource type's name
value format is described below:
roles.get()
: roles/{ROLE_NAME}
.
This method returns results from all
predefined
roles
in Cloud IAM. Example request URL:
https://iam.googleapis.com/v1/roles/{ROLE_NAME}
projects.roles.get()
:
projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}
. This method returns 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.get()
:
organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}
. This method
returns 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
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(GetRoleRequest other)
public GetRoleRequest.Builder mergeFrom(GetRoleRequest other)
Parameter
Returns
public GetRoleRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public GetRoleRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GetRoleRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public GetRoleRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setName(String value)
public GetRoleRequest.Builder setName(String value)
The name
parameter's value depends on the target resource for the
request, namely
roles
,
projects
,
or
organizations
.
Each resource type's name
value format is described below:
roles.get()
: roles/{ROLE_NAME}
.
This method returns results from all
predefined
roles
in Cloud IAM. Example request URL:
https://iam.googleapis.com/v1/roles/{ROLE_NAME}
projects.roles.get()
:
projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}
. This method returns 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.get()
:
organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}
. This method
returns 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
setNameBytes(ByteString value)
public GetRoleRequest.Builder setNameBytes(ByteString value)
The name
parameter's value depends on the target resource for the
request, namely
roles
,
projects
,
or
organizations
.
Each resource type's name
value format is described below:
roles.get()
: roles/{ROLE_NAME}
.
This method returns results from all
predefined
roles
in Cloud IAM. Example request URL:
https://iam.googleapis.com/v1/roles/{ROLE_NAME}
projects.roles.get()
:
projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}
. This method returns 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.get()
:
organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}
. This method
returns 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
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GetRoleRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final GetRoleRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides