Iam.Roles.List (Identity and Access Management (IAM) API v1-rev20190816-1.28.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.iam.v1.IamRequest<ListRolesResponse>
        
        com.google.api.services.iam.v1.Iam.Roles.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Iam.Roles
```
public class Iam.Roles.List
extends IamRequest<ListRolesResponse>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List()
Lists the Roles defined on a resource.

Constructors
Modifier	Constructor and Description
`protected`	`List()` Lists the Roles defined on a resource.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`Integer`	`getPageSize()` Optional limit on the number of roles to include in the response.
`String`	`getPageToken()` 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`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles).
`Boolean`	`getShowDeleted()` Include Roles that have been deleted.
`String`	`getView()` Optional view for the returned Role objects.
`Iam.Roles.List`	`set(String parameterName, Object value)`
`Iam.Roles.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Iam.Roles.List`	`setAccessToken(String accessToken)` OAuth access token.
`Iam.Roles.List`	`setAlt(String alt)` Data format for response.
`Iam.Roles.List`	`setCallback(String callback)` JSONP
`Iam.Roles.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Iam.Roles.List`	`setKey(String key)` API key.
`Iam.Roles.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Iam.Roles.List`	`setPageSize(Integer pageSize)` Optional limit on the number of roles to include in the response.
`Iam.Roles.List`	`setPageToken(String pageToken)` Optional pagination token returned in an earlier ListRolesResponse.
`Iam.Roles.List`	`setParent(String parent)` The `parent` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles).
`Iam.Roles.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Iam.Roles.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Iam.Roles.List`	`setShowDeleted(Boolean showDeleted)` Include Roles that have been deleted.
`Iam.Roles.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Iam.Roles.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`Iam.Roles.List`	`setView(String view)` Optional view for the returned Role objects.

Methods inherited from class com.google.api.services.iam.v1.IamRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List()
```
    Lists the Roles defined on a resource. Create a request for the method "roles.list". This request holds the parameters needed by the the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Iam.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<ListRolesResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListRolesResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Iam.Roles.List set$Xgafv(String $Xgafv)
```
    Description copied from class: IamRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class IamRequest<ListRolesResponse>
  - setAccessToken
```
public Iam.Roles.List setAccessToken(String accessToken)
```
    Description copied from class: IamRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class IamRequest<ListRolesResponse>
  - setAlt
```
public Iam.Roles.List setAlt(String alt)
```
    Description copied from class: IamRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class IamRequest<ListRolesResponse>
  - setCallback
```
public Iam.Roles.List setCallback(String callback)
```
    Description copied from class: IamRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class IamRequest<ListRolesResponse>
  - setFields
```
public Iam.Roles.List setFields(String fields)
```
    Description copied from class: IamRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class IamRequest<ListRolesResponse>
  - setKey
```
public Iam.Roles.List setKey(String key)
```
    Description copied from class: IamRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class IamRequest<ListRolesResponse>
  - setOauthToken
```
public Iam.Roles.List setOauthToken(String oauthToken)
```
    Description copied from class: IamRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class IamRequest<ListRolesResponse>
  - setPrettyPrint
```
public Iam.Roles.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: IamRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class IamRequest<ListRolesResponse>
  - setQuotaUser
```
public Iam.Roles.List setQuotaUser(String quotaUser)
```
    Description copied from class: IamRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class IamRequest<ListRolesResponse>
  - setUploadType
```
public Iam.Roles.List setUploadType(String uploadType)
```
    Description copied from class: IamRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class IamRequest<ListRolesResponse>
  - setUploadProtocol
```
public Iam.Roles.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: IamRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class IamRequest<ListRolesResponse>
  - getPageSize
```
public Integer getPageSize()
```
    Optional limit on the number of roles to include in the response.
  - setPageSize
```
public Iam.Roles.List setPageSize(Integer pageSize)
```
    Optional limit on the number of roles to include in the response.
  - getPageToken
```
public String getPageToken()
```
    Optional pagination token returned in an earlier ListRolesResponse.
  - setPageToken
```
public Iam.Roles.List setPageToken(String pageToken)
```
    Optional pagination token returned in an earlier ListRolesResponse.
  - getParent
```
public String getParent()
```
    The `parent` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](/iam/docs/understanding- roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles` [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](/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.
  - setParent
```
public Iam.Roles.List setParent(String parent)
```
    The `parent` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](/iam/docs/understanding- roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](/iam/docs /understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](/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.
  - getShowDeleted
```
public Boolean getShowDeleted()
```
    Include Roles that have been deleted.
  - setShowDeleted
```
public Iam.Roles.List setShowDeleted(Boolean showDeleted)
```
    Include Roles that have been deleted.
  - getView
```
public String 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.
  - setView
```
public Iam.Roles.List setView(String view)
```
    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.
  - set
```
public Iam.Roles.List set(String parameterName,
                          Object value)
```
    Overrides:
    
    set in class IamRequest<ListRolesResponse>

Class Iam.Roles.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.iam.v1.IamRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getPageSize

setPageSize

getPageToken

setPageToken

getParent

setParent

getShowDeleted

setShowDeleted

getView

setView

set