- 3.50.0 (latest)
- 3.49.0
- 3.48.0
- 3.47.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.0
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.0.0
- 1.2.5
- 1.1.8
- 0.2.0
public static final class ListRolesRequest.Builder extends GeneratedMessageV3.Builder<ListRolesRequest.Builder> implements ListRolesRequestOrBuilder
The request to get all roles defined under a resource.
Protobuf type google.iam.admin.v1.ListRolesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListRolesRequest.BuilderImplements
ListRolesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListRolesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
ListRolesRequest.Builder |
build()
public ListRolesRequest build()
Type | Description |
ListRolesRequest |
buildPartial()
public ListRolesRequest buildPartial()
Type | Description |
ListRolesRequest |
clear()
public ListRolesRequest.Builder clear()
Type | Description |
ListRolesRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListRolesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
ListRolesRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListRolesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
ListRolesRequest.Builder |
clearPageSize()
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;
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |
clearPageToken()
public ListRolesRequest.Builder clearPageToken()
Optional pagination token returned in an earlier ListRolesResponse.
string page_token = 3;
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |
clearParent()
public ListRolesRequest.Builder clearParent()
The parent
parameter's value depends on the target resource for the
request, namely
roles
,
projects
, or
organizations
. Each
resource type's parent
value format is described below:
roles.list()
: An empty string. This method doesn't require a resource; it simply returns all predefined roles in Cloud IAM. Example request URL:https://iam.googleapis.com/v1/roles
projects.roles.list()
:projects/{PROJECT_ID}
. This method lists all project-level custom roles. Example request URL:https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles
organizations.roles.list()
:organizations/{ORGANIZATION_ID}
. This method lists all 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) = { ... }
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |
clearShowDeleted()
public ListRolesRequest.Builder clearShowDeleted()
Include Roles that have been deleted.
bool show_deleted = 6;
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |
clearView()
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;
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |
clone()
public ListRolesRequest.Builder clone()
Type | Description |
ListRolesRequest.Builder |
getDefaultInstanceForType()
public ListRolesRequest getDefaultInstanceForType()
Type | Description |
ListRolesRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getPageSize()
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;
Type | Description |
int | The pageSize. |
getPageToken()
public String getPageToken()
Optional pagination token returned in an earlier ListRolesResponse.
string page_token = 3;
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
Optional pagination token returned in an earlier ListRolesResponse.
string page_token = 3;
Type | Description |
ByteString | The bytes for pageToken. |
getParent()
public String getParent()
The parent
parameter's value depends on the target resource for the
request, namely
roles
,
projects
, or
organizations
. Each
resource type's parent
value format is described below:
roles.list()
: An empty string. This method doesn't require a resource; it simply returns all predefined roles in Cloud IAM. Example request URL:https://iam.googleapis.com/v1/roles
projects.roles.list()
:projects/{PROJECT_ID}
. This method lists all project-level custom roles. Example request URL:https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles
organizations.roles.list()
:organizations/{ORGANIZATION_ID}
. This method lists all 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) = { ... }
Type | Description |
String | The parent. |
getParentBytes()
public ByteString getParentBytes()
The parent
parameter's value depends on the target resource for the
request, namely
roles
,
projects
, or
organizations
. Each
resource type's parent
value format is described below:
roles.list()
: An empty string. This method doesn't require a resource; it simply returns all predefined roles in Cloud IAM. Example request URL:https://iam.googleapis.com/v1/roles
projects.roles.list()
:projects/{PROJECT_ID}
. This method lists all project-level custom roles. Example request URL:https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles
organizations.roles.list()
:organizations/{ORGANIZATION_ID}
. This method lists all 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) = { ... }
Type | Description |
ByteString | The bytes for parent. |
getShowDeleted()
public boolean getShowDeleted()
Include Roles that have been deleted.
bool show_deleted = 6;
Type | Description |
boolean | The showDeleted. |
getView()
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;
Type | Description |
RoleView | The view. |
getViewValue()
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;
Type | Description |
int | The enum numeric value on the wire for view. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(ListRolesRequest other)
public ListRolesRequest.Builder mergeFrom(ListRolesRequest other)
Name | Description |
other | ListRolesRequest |
Type | Description |
ListRolesRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListRolesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
ListRolesRequest.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public ListRolesRequest.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
ListRolesRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListRolesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
ListRolesRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListRolesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
ListRolesRequest.Builder |
setPageSize(int value)
public 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;
Name | Description |
value | int The pageSize to set. |
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListRolesRequest.Builder setPageToken(String value)
Optional pagination token returned in an earlier ListRolesResponse.
string page_token = 3;
Name | Description |
value | String The pageToken to set. |
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListRolesRequest.Builder setPageTokenBytes(ByteString value)
Optional pagination token returned in an earlier ListRolesResponse.
string page_token = 3;
Name | Description |
value | ByteString The bytes for pageToken to set. |
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |
setParent(String value)
public ListRolesRequest.Builder setParent(String value)
The parent
parameter's value depends on the target resource for the
request, namely
roles
,
projects
, or
organizations
. Each
resource type's parent
value format is described below:
roles.list()
: An empty string. This method doesn't require a resource; it simply returns all predefined roles in Cloud IAM. Example request URL:https://iam.googleapis.com/v1/roles
projects.roles.list()
:projects/{PROJECT_ID}
. This method lists all project-level custom roles. Example request URL:https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles
organizations.roles.list()
:organizations/{ORGANIZATION_ID}
. This method lists all 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) = { ... }
Name | Description |
value | String The parent to set. |
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListRolesRequest.Builder setParentBytes(ByteString value)
The parent
parameter's value depends on the target resource for the
request, namely
roles
,
projects
, or
organizations
. Each
resource type's parent
value format is described below:
roles.list()
: An empty string. This method doesn't require a resource; it simply returns all predefined roles in Cloud IAM. Example request URL:https://iam.googleapis.com/v1/roles
projects.roles.list()
:projects/{PROJECT_ID}
. This method lists all project-level custom roles. Example request URL:https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles
organizations.roles.list()
:organizations/{ORGANIZATION_ID}
. This method lists all 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) = { ... }
Name | Description |
value | ByteString The bytes for parent to set. |
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListRolesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
ListRolesRequest.Builder |
setShowDeleted(boolean value)
public ListRolesRequest.Builder setShowDeleted(boolean value)
Include Roles that have been deleted.
bool show_deleted = 6;
Name | Description |
value | boolean The showDeleted to set. |
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListRolesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
ListRolesRequest.Builder |
setView(RoleView value)
public 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;
Name | Description |
value | RoleView The view to set. |
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |
setViewValue(int value)
public 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;
Name | Description |
value | int The enum numeric value on the wire for view to set. |
Type | Description |
ListRolesRequest.Builder | This builder for chaining. |