Interface ListRolesRequestOrBuilder (3.40.0)

public interface ListRolesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPageSize()

public abstract 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;

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public abstract String getPageToken()

Optional pagination token returned in an earlier ListRolesResponse.

string page_token = 3;

Returns
Type	Description
`String`	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Optional pagination token returned in an earlier ListRolesResponse.

string page_token = 3;

Returns
Type	Description
`ByteString`	The bytes for pageToken.

getParent()

public abstract 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) = { ... }

Returns
Type	Description
`String`	The parent.

getParentBytes()

public abstract 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) = { ... }

Returns
Type	Description
`ByteString`	The bytes for parent.

getShowDeleted()

public abstract boolean getShowDeleted()

Include Roles that have been deleted.

bool show_deleted = 6;

Returns
Type	Description
`boolean`	The showDeleted.

getView()

public abstract 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;

Returns
Type	Description
`RoleView`	The view.

getViewValue()

public abstract int getViewValue()

.google.iam.admin.v1.RoleView view = 4;

Returns
Type	Description
`int`	The enum numeric value on the wire for view.