Dataproc.Projects.Regions.Clusters.List (Cloud Dataproc API v1beta2-rev20210825-1.32.1)

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.dataproc.v1beta2.DataprocRequest<ListClustersResponse>
        
        com.google.api.services.dataproc.v1beta2.Dataproc.Projects.Regions.Clusters.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dataproc.Projects.Regions.Clusters
```
public class Dataproc.Projects.Regions.Clusters.List
extends DataprocRequest<ListClustersResponse>
```

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(String projectId, String region)
Lists all regions/{region}/clusters in a project alphabetically.

Constructors
Modifier	Constructor and Description
`protected`	`List(String projectId, String region)` Lists all regions/{region}/clusters in a project alphabetically.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getFilter()` Optional.
`Integer`	`getPageSize()` Optional.
`String`	`getPageToken()` Optional.
`String`	`getProjectId()` Required.
`String`	`getRegion()` Required.
`Dataproc.Projects.Regions.Clusters.List`	`set(String parameterName, Object value)`
`Dataproc.Projects.Regions.Clusters.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Dataproc.Projects.Regions.Clusters.List`	`setAccessToken(String accessToken)` OAuth access token.
`Dataproc.Projects.Regions.Clusters.List`	`setAlt(String alt)` Data format for response.
`Dataproc.Projects.Regions.Clusters.List`	`setCallback(String callback)` JSONP
`Dataproc.Projects.Regions.Clusters.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Dataproc.Projects.Regions.Clusters.List`	`setFilter(String filter)` Optional.
`Dataproc.Projects.Regions.Clusters.List`	`setKey(String key)` API key.
`Dataproc.Projects.Regions.Clusters.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Dataproc.Projects.Regions.Clusters.List`	`setPageSize(Integer pageSize)` Optional.
`Dataproc.Projects.Regions.Clusters.List`	`setPageToken(String pageToken)` Optional.
`Dataproc.Projects.Regions.Clusters.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dataproc.Projects.Regions.Clusters.List`	`setProjectId(String projectId)` Required.
`Dataproc.Projects.Regions.Clusters.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Dataproc.Projects.Regions.Clusters.List`	`setRegion(String region)` Required.
`Dataproc.Projects.Regions.Clusters.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Dataproc.Projects.Regions.Clusters.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.dataproc.v1beta2.DataprocRequest
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.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 projectId,
               String region)
```
    Lists all regions/{region}/clusters in a project alphabetically. Create a request for the method "clusters.list". This request holds the parameters needed by the the dataproc server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Dataproc.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    projectId - Required. The ID of the Google Cloud Platform project that the cluster belongs to.
    
    region - Required. The Dataproc region in which to handle the request.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<ListClustersResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListClustersResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Dataproc.Projects.Regions.Clusters.List set$Xgafv(String $Xgafv)
```
    Description copied from class: DataprocRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DataprocRequest<ListClustersResponse>
  - setAccessToken
```
public Dataproc.Projects.Regions.Clusters.List setAccessToken(String accessToken)
```
    Description copied from class: DataprocRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DataprocRequest<ListClustersResponse>
  - setAlt
```
public Dataproc.Projects.Regions.Clusters.List setAlt(String alt)
```
    Description copied from class: DataprocRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DataprocRequest<ListClustersResponse>
  - setCallback
```
public Dataproc.Projects.Regions.Clusters.List setCallback(String callback)
```
    Description copied from class: DataprocRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DataprocRequest<ListClustersResponse>
  - setFields
```
public Dataproc.Projects.Regions.Clusters.List setFields(String fields)
```
    Description copied from class: DataprocRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DataprocRequest<ListClustersResponse>
  - setKey
```
public Dataproc.Projects.Regions.Clusters.List setKey(String key)
```
    Description copied from class: DataprocRequest
    
    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 DataprocRequest<ListClustersResponse>
  - setOauthToken
```
public Dataproc.Projects.Regions.Clusters.List setOauthToken(String oauthToken)
```
    Description copied from class: DataprocRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DataprocRequest<ListClustersResponse>
  - setPrettyPrint
```
public Dataproc.Projects.Regions.Clusters.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DataprocRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DataprocRequest<ListClustersResponse>
  - setQuotaUser
```
public Dataproc.Projects.Regions.Clusters.List setQuotaUser(String quotaUser)
```
    Description copied from class: DataprocRequest
    
    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 DataprocRequest<ListClustersResponse>
  - setUploadType
```
public Dataproc.Projects.Regions.Clusters.List setUploadType(String uploadType)
```
    Description copied from class: DataprocRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DataprocRequest<ListClustersResponse>
  - setUploadProtocol
```
public Dataproc.Projects.Regions.Clusters.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DataprocRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DataprocRequest<ListClustersResponse>
  - getProjectId
```
public String getProjectId()
```
    Required. The ID of the Google Cloud Platform project that the cluster belongs to.
  - setProjectId
```
public Dataproc.Projects.Regions.Clusters.List setProjectId(String projectId)
```
    Required. The ID of the Google Cloud Platform project that the cluster belongs to.
  - getRegion
```
public String getRegion()
```
    Required. The Dataproc region in which to handle the request.
  - setRegion
```
public Dataproc.Projects.Regions.Clusters.List setRegion(String region)
```
    Required. The Dataproc region in which to handle the request.
  - getFilter
```
public String getFilter()
```
    Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *
  - setFilter
```
public Dataproc.Projects.Regions.Clusters.List setFilter(String filter)
```
    Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *
  - getPageSize
```
public Integer getPageSize()
```
    Optional. The standard List page size.
  - setPageSize
```
public Dataproc.Projects.Regions.Clusters.List setPageSize(Integer pageSize)
```
    Optional. The standard List page size.
  - getPageToken
```
public String getPageToken()
```
    Optional. The standard List page token.
  - setPageToken
```
public Dataproc.Projects.Regions.Clusters.List setPageToken(String pageToken)
```
    Optional. The standard List page token.
  - set
```
public Dataproc.Projects.Regions.Clusters.List set(String parameterName,
                                                   Object value)
```
    Overrides:
    
    set in class DataprocRequest<ListClustersResponse>

Class Dataproc.Projects.Regions.Clusters.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.dataproc.v1beta2.DataprocRequest

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

getProjectId

setProjectId

getRegion

setRegion

getFilter

setFilter

getPageSize

setPageSize

getPageToken

setPageToken

set