Iam.Locations.WorkforcePools.List (Identity and Access Management (IAM) API v1-rev20230803-2.0.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<ListWorkforcePoolsResponse>
        
        com.google.api.services.iam.v1.Iam.Locations.WorkforcePools.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Iam.Locations.WorkforcePools
```
public class Iam.Locations.WorkforcePools.List
extends IamRequest<ListWorkforcePoolsResponse>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.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(String location)
Lists all non-deleted WorkforcePools under the specified parent.

Constructors
Modifier	Constructor and Description
`protected`	`List(String location)` Lists all non-deleted WorkforcePools under the specified parent.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`String`	`getLocation()` The location of the pool.
`Integer`	`getPageSize()` The maximum number of pools to return.
`String`	`getPageToken()` A page token, received from a previous `ListWorkforcePools` call.
`String`	`getParent()` Required.
`Boolean`	`getShowDeleted()` Whether to return soft-deleted pools.
`Iam.Locations.WorkforcePools.List`	`set(String parameterName, Object value)`
`Iam.Locations.WorkforcePools.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Iam.Locations.WorkforcePools.List`	`setAccessToken(String accessToken)` OAuth access token.
`Iam.Locations.WorkforcePools.List`	`setAlt(String alt)` Data format for response.
`Iam.Locations.WorkforcePools.List`	`setCallback(String callback)` JSONP
`Iam.Locations.WorkforcePools.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Iam.Locations.WorkforcePools.List`	`setKey(String key)` API key.
`Iam.Locations.WorkforcePools.List`	`setLocation(String location)` The location of the pool.
`Iam.Locations.WorkforcePools.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Iam.Locations.WorkforcePools.List`	`setPageSize(Integer pageSize)` The maximum number of pools to return.
`Iam.Locations.WorkforcePools.List`	`setPageToken(String pageToken)` A page token, received from a previous `ListWorkforcePools` call.
`Iam.Locations.WorkforcePools.List`	`setParent(String parent)` Required.
`Iam.Locations.WorkforcePools.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Iam.Locations.WorkforcePools.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Iam.Locations.WorkforcePools.List`	`setShowDeleted(Boolean showDeleted)` Whether to return soft-deleted pools.
`Iam.Locations.WorkforcePools.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Iam.Locations.WorkforcePools.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, 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(String location)
```
    Lists all non-deleted WorkforcePools under the specified parent. If `show_deleted` is set to `true`, then deleted pools are also listed. Create a request for the method "workforcePools.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.
    
    Parameters:
    
    location - The location of the pool. Format: `locations/{location}`.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListWorkforcePoolsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListWorkforcePoolsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Iam.Locations.WorkforcePools.List set$Xgafv(String $Xgafv)
```
    Description copied from class: IamRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class IamRequest<ListWorkforcePoolsResponse>
  - setAccessToken
```
public Iam.Locations.WorkforcePools.List setAccessToken(String accessToken)
```
    Description copied from class: IamRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class IamRequest<ListWorkforcePoolsResponse>
  - setAlt
```
public Iam.Locations.WorkforcePools.List setAlt(String alt)
```
    Description copied from class: IamRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class IamRequest<ListWorkforcePoolsResponse>
  - setCallback
```
public Iam.Locations.WorkforcePools.List setCallback(String callback)
```
    Description copied from class: IamRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class IamRequest<ListWorkforcePoolsResponse>
  - setFields
```
public Iam.Locations.WorkforcePools.List setFields(String fields)
```
    Description copied from class: IamRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class IamRequest<ListWorkforcePoolsResponse>
  - setKey
```
public Iam.Locations.WorkforcePools.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<ListWorkforcePoolsResponse>
  - setOauthToken
```
public Iam.Locations.WorkforcePools.List setOauthToken(String oauthToken)
```
    Description copied from class: IamRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class IamRequest<ListWorkforcePoolsResponse>
  - setPrettyPrint
```
public Iam.Locations.WorkforcePools.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: IamRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class IamRequest<ListWorkforcePoolsResponse>
  - setQuotaUser
```
public Iam.Locations.WorkforcePools.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<ListWorkforcePoolsResponse>
  - setUploadType
```
public Iam.Locations.WorkforcePools.List setUploadType(String uploadType)
```
    Description copied from class: IamRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class IamRequest<ListWorkforcePoolsResponse>
  - setUploadProtocol
```
public Iam.Locations.WorkforcePools.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: IamRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class IamRequest<ListWorkforcePoolsResponse>
  - getLocation
```
public String getLocation()
```
    The location of the pool. Format: `locations/{location}`.
  - setLocation
```
public Iam.Locations.WorkforcePools.List setLocation(String location)
```
    The location of the pool. Format: `locations/{location}`.
  - getPageSize
```
public Integer getPageSize()
```
    The maximum number of pools to return. If unspecified, at most 50 pools will be returned. The maximum value is 1000; values above 1000 are truncated to 1000.
  - setPageSize
```
public Iam.Locations.WorkforcePools.List setPageSize(Integer pageSize)
```
    The maximum number of pools to return. If unspecified, at most 50 pools will be returned. The maximum value is 1000; values above 1000 are truncated to 1000.
  - getPageToken
```
public String getPageToken()
```
    A page token, received from a previous `ListWorkforcePools` call. Provide this to retrieve the subsequent page.
  - setPageToken
```
public Iam.Locations.WorkforcePools.List setPageToken(String pageToken)
```
    A page token, received from a previous `ListWorkforcePools` call. Provide this to retrieve the subsequent page.
  - getParent
```
public String getParent()
```
    Required. The parent resource to list pools for. Format: `organizations/{org-id}`.
  - setParent
```
public Iam.Locations.WorkforcePools.List setParent(String parent)
```
    Required. The parent resource to list pools for. Format: `organizations/{org-id}`.
  - getShowDeleted
```
public Boolean getShowDeleted()
```
    Whether to return soft-deleted pools.
  - setShowDeleted
```
public Iam.Locations.WorkforcePools.List setShowDeleted(Boolean showDeleted)
```
    Whether to return soft-deleted pools.
  - set
```
public Iam.Locations.WorkforcePools.List set(String parameterName,
                                             Object value)
```
    Overrides:
    
    set in class IamRequest<ListWorkforcePoolsResponse>

Class Iam.Locations.WorkforcePools.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

getLocation

setLocation

getPageSize

setPageSize

getPageToken

setPageToken

getParent

setParent

getShowDeleted

setShowDeleted

set