public static final class ListRolesRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder> implements ListRolesRequestOrBuilder
The request to get all roles defined under a resource.Protobuf type
google.iam.admin.v1.ListRolesRequest| Modifier and Type | Method and Description |
|---|---|
ListRolesRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ListRolesRequest |
build() |
ListRolesRequest |
buildPartial() |
ListRolesRequest.Builder |
clear() |
ListRolesRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
ListRolesRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
ListRolesRequest.Builder |
clearPageSize()
Optional limit on the number of roles to include in the response.
|
ListRolesRequest.Builder |
clearPageToken()
Optional pagination token returned in an earlier ListRolesResponse.
|
ListRolesRequest.Builder |
clearParent()
The `parent` parameter's value depends on the target resource for the
request, namely
[`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
[`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
or
[`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
|
ListRolesRequest.Builder |
clearShowDeleted()
Include Roles that have been deleted.
|
ListRolesRequest.Builder |
clearView()
Optional view for the returned Role objects.
|
ListRolesRequest.Builder |
clone() |
ListRolesRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
int |
getPageSize()
Optional limit on the number of roles to include in the response.
|
String |
getPageToken()
Optional pagination token returned in an earlier ListRolesResponse.
|
com.google.protobuf.ByteString |
getPageTokenBytes()
Optional pagination token returned in an earlier ListRolesResponse.
|
String |
getParent()
The `parent` parameter's value depends on the target resource for the
request, namely
[`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
[`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
or
[`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
|
com.google.protobuf.ByteString |
getParentBytes()
The `parent` parameter's value depends on the target resource for the
request, namely
[`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
[`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
or
[`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
|
boolean |
getShowDeleted()
Include Roles that have been deleted.
|
RoleView |
getView()
Optional view for the returned Role objects.
|
int |
getViewValue()
Optional view for the returned Role objects.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ListRolesRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ListRolesRequest.Builder |
mergeFrom(ListRolesRequest other) |
ListRolesRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
ListRolesRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ListRolesRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ListRolesRequest.Builder |
setPageSize(int value)
Optional limit on the number of roles to include in the response.
|
ListRolesRequest.Builder |
setPageToken(String value)
Optional pagination token returned in an earlier ListRolesResponse.
|
ListRolesRequest.Builder |
setPageTokenBytes(com.google.protobuf.ByteString value)
Optional pagination token returned in an earlier ListRolesResponse.
|
ListRolesRequest.Builder |
setParent(String value)
The `parent` parameter's value depends on the target resource for the
request, namely
[`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
[`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
or
[`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
|
ListRolesRequest.Builder |
setParentBytes(com.google.protobuf.ByteString value)
The `parent` parameter's value depends on the target resource for the
request, namely
[`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
[`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
or
[`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
|
ListRolesRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
ListRolesRequest.Builder |
setShowDeleted(boolean value)
Include Roles that have been deleted.
|
ListRolesRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ListRolesRequest.Builder |
setView(RoleView value)
Optional view for the returned Role objects.
|
ListRolesRequest.Builder |
setViewValue(int value)
Optional view for the returned Role objects.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>public ListRolesRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>public ListRolesRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ListRolesRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ListRolesRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ListRolesRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>public ListRolesRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>public ListRolesRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>public ListRolesRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>public ListRolesRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>public ListRolesRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>public ListRolesRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListRolesRequest.Builder>public ListRolesRequest.Builder mergeFrom(ListRolesRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>public ListRolesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListRolesRequest.Builder>IOExceptionpublic String getParent()
The `parent` parameter's value depends on the target resource for the
request, namely
[`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
[`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
or
[`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
Each resource type's `parent` value format is described below:
* [`roles.list()`](https://cloud.google.com/iam/reference/rest/v1/roles/list): An empty string.
This method doesn't require a resource; it simply returns all
[predefined
roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles)
in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles`
* [`projects.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/projects.roles/list):
`projects/{PROJECT_ID}`. This method lists all project-level
[custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
* [`organizations.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles/list):
`organizations/{ORGANIZATION_ID}`. This method lists all
organization-level [custom
roles](https://cloud.google.com/iam/docs/understanding-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) = { ... }getParent in interface ListRolesRequestOrBuilderpublic com.google.protobuf.ByteString getParentBytes()
The `parent` parameter's value depends on the target resource for the
request, namely
[`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
[`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
or
[`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
Each resource type's `parent` value format is described below:
* [`roles.list()`](https://cloud.google.com/iam/reference/rest/v1/roles/list): An empty string.
This method doesn't require a resource; it simply returns all
[predefined
roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles)
in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles`
* [`projects.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/projects.roles/list):
`projects/{PROJECT_ID}`. This method lists all project-level
[custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
* [`organizations.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles/list):
`organizations/{ORGANIZATION_ID}`. This method lists all
organization-level [custom
roles](https://cloud.google.com/iam/docs/understanding-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) = { ... }getParentBytes in interface ListRolesRequestOrBuilderpublic ListRolesRequest.Builder setParent(String value)
The `parent` parameter's value depends on the target resource for the
request, namely
[`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
[`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
or
[`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
Each resource type's `parent` value format is described below:
* [`roles.list()`](https://cloud.google.com/iam/reference/rest/v1/roles/list): An empty string.
This method doesn't require a resource; it simply returns all
[predefined
roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles)
in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles`
* [`projects.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/projects.roles/list):
`projects/{PROJECT_ID}`. This method lists all project-level
[custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
* [`organizations.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles/list):
`organizations/{ORGANIZATION_ID}`. This method lists all
organization-level [custom
roles](https://cloud.google.com/iam/docs/understanding-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) = { ... }value - The parent to set.public ListRolesRequest.Builder clearParent()
The `parent` parameter's value depends on the target resource for the
request, namely
[`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
[`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
or
[`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
Each resource type's `parent` value format is described below:
* [`roles.list()`](https://cloud.google.com/iam/reference/rest/v1/roles/list): An empty string.
This method doesn't require a resource; it simply returns all
[predefined
roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles)
in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles`
* [`projects.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/projects.roles/list):
`projects/{PROJECT_ID}`. This method lists all project-level
[custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
* [`organizations.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles/list):
`organizations/{ORGANIZATION_ID}`. This method lists all
organization-level [custom
roles](https://cloud.google.com/iam/docs/understanding-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) = { ... }public ListRolesRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
The `parent` parameter's value depends on the target resource for the
request, namely
[`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
[`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
or
[`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
Each resource type's `parent` value format is described below:
* [`roles.list()`](https://cloud.google.com/iam/reference/rest/v1/roles/list): An empty string.
This method doesn't require a resource; it simply returns all
[predefined
roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles)
in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles`
* [`projects.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/projects.roles/list):
`projects/{PROJECT_ID}`. This method lists all project-level
[custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
* [`organizations.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles/list):
`organizations/{ORGANIZATION_ID}`. This method lists all
organization-level [custom
roles](https://cloud.google.com/iam/docs/understanding-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) = { ... }value - The bytes for parent to set.public int getPageSize()
Optional limit on the number of roles to include in the response. The default is 300, and the maximum is 1,000.
int32 page_size = 2;getPageSize in interface ListRolesRequestOrBuilderpublic ListRolesRequest.Builder setPageSize(int value)
Optional limit on the number of roles to include in the response. The default is 300, and the maximum is 1,000.
int32 page_size = 2;value - The pageSize to set.public ListRolesRequest.Builder clearPageSize()
Optional limit on the number of roles to include in the response. The default is 300, and the maximum is 1,000.
int32 page_size = 2;public String getPageToken()
Optional pagination token returned in an earlier ListRolesResponse.
string page_token = 3;getPageToken in interface ListRolesRequestOrBuilderpublic com.google.protobuf.ByteString getPageTokenBytes()
Optional pagination token returned in an earlier ListRolesResponse.
string page_token = 3;getPageTokenBytes in interface ListRolesRequestOrBuilderpublic ListRolesRequest.Builder setPageToken(String value)
Optional pagination token returned in an earlier ListRolesResponse.
string page_token = 3;value - The pageToken to set.public ListRolesRequest.Builder clearPageToken()
Optional pagination token returned in an earlier ListRolesResponse.
string page_token = 3;public ListRolesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
Optional pagination token returned in an earlier ListRolesResponse.
string page_token = 3;value - The bytes for pageToken to set.public int getViewValue()
Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field.
.google.iam.admin.v1.RoleView view = 4;getViewValue in interface ListRolesRequestOrBuilderpublic ListRolesRequest.Builder setViewValue(int value)
Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field.
.google.iam.admin.v1.RoleView view = 4;value - The enum numeric value on the wire for view to set.public RoleView getView()
Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field.
.google.iam.admin.v1.RoleView view = 4;getView in interface ListRolesRequestOrBuilderpublic ListRolesRequest.Builder setView(RoleView value)
Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field.
.google.iam.admin.v1.RoleView view = 4;value - The view to set.public ListRolesRequest.Builder clearView()
Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field.
.google.iam.admin.v1.RoleView view = 4;public boolean getShowDeleted()
Include Roles that have been deleted.
bool show_deleted = 6;getShowDeleted in interface ListRolesRequestOrBuilderpublic ListRolesRequest.Builder setShowDeleted(boolean value)
Include Roles that have been deleted.
bool show_deleted = 6;value - The showDeleted to set.public ListRolesRequest.Builder clearShowDeleted()
Include Roles that have been deleted.
bool show_deleted = 6;public final ListRolesRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>public final ListRolesRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>Copyright © 2025 Google LLC. All rights reserved.