Bigquery.Datasets.List (BigQuery API v2-rev20251012-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.bigquery.BigqueryRequest<DatasetList>
        
        com.google.api.services.bigquery.Bigquery.Datasets.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Bigquery.Datasets
```
public class Bigquery.Datasets.List
extends BigqueryRequest<DatasetList>
```

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
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(String projectId)
Lists all datasets in the specified project to which the user has been granted the READER dataset role.

Constructors
Modifier	Constructor and Description
`protected`	`List(String projectId)` Lists all datasets in the specified project to which the user has been granted the READER dataset role.

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()`
`Boolean`	`getAll()` Whether to list all datasets, including hidden ones
`String`	`getFilter()` An expression for filtering the results of the request by label.
`Long`	`getMaxResults()` The maximum number of results to return in a single response page.
`String`	`getPageToken()` Page token, returned by a previous call, to request the next page of results
`String`	`getProjectId()` Required.
`Bigquery.Datasets.List`	`set(String parameterName, Object value)`
`Bigquery.Datasets.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Bigquery.Datasets.List`	`setAccessToken(String accessToken)` OAuth access token.
`Bigquery.Datasets.List`	`setAll(Boolean all)` Whether to list all datasets, including hidden ones
`Bigquery.Datasets.List`	`setAlt(String alt)` Data format for response.
`Bigquery.Datasets.List`	`setCallback(String callback)` JSONP
`Bigquery.Datasets.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Bigquery.Datasets.List`	`setFilter(String filter)` An expression for filtering the results of the request by label.
`Bigquery.Datasets.List`	`setKey(String key)` API key.
`Bigquery.Datasets.List`	`setMaxResults(Long maxResults)` The maximum number of results to return in a single response page.
`Bigquery.Datasets.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Bigquery.Datasets.List`	`setPageToken(String pageToken)` Page token, returned by a previous call, to request the next page of results
`Bigquery.Datasets.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Bigquery.Datasets.List`	`setProjectId(String projectId)` Required.
`Bigquery.Datasets.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Bigquery.Datasets.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Bigquery.Datasets.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.bigquery.BigqueryRequest
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 projectId)
```
    Lists all datasets in the specified project to which the user has been granted the READER dataset role. Create a request for the method "datasets.list". This request holds the parameters needed by the the bigquery server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Bigquery.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    projectId - Required. Project ID of the datasets to be listed
    
    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<DatasetList>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<DatasetList>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Bigquery.Datasets.List set$Xgafv(String $Xgafv)
```
    Description copied from class: BigqueryRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class BigqueryRequest<DatasetList>
  - setAccessToken
```
public Bigquery.Datasets.List setAccessToken(String accessToken)
```
    Description copied from class: BigqueryRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class BigqueryRequest<DatasetList>
  - setAlt
```
public Bigquery.Datasets.List setAlt(String alt)
```
    Description copied from class: BigqueryRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class BigqueryRequest<DatasetList>
  - setCallback
```
public Bigquery.Datasets.List setCallback(String callback)
```
    Description copied from class: BigqueryRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class BigqueryRequest<DatasetList>
  - setFields
```
public Bigquery.Datasets.List setFields(String fields)
```
    Description copied from class: BigqueryRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class BigqueryRequest<DatasetList>
  - setKey
```
public Bigquery.Datasets.List setKey(String key)
```
    Description copied from class: BigqueryRequest
    
    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 BigqueryRequest<DatasetList>
  - setOauthToken
```
public Bigquery.Datasets.List setOauthToken(String oauthToken)
```
    Description copied from class: BigqueryRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class BigqueryRequest<DatasetList>
  - setPrettyPrint
```
public Bigquery.Datasets.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: BigqueryRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class BigqueryRequest<DatasetList>
  - setQuotaUser
```
public Bigquery.Datasets.List setQuotaUser(String quotaUser)
```
    Description copied from class: BigqueryRequest
    
    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 BigqueryRequest<DatasetList>
  - setUploadType
```
public Bigquery.Datasets.List setUploadType(String uploadType)
```
    Description copied from class: BigqueryRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class BigqueryRequest<DatasetList>
  - setUploadProtocol
```
public Bigquery.Datasets.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: BigqueryRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class BigqueryRequest<DatasetList>
  - getProjectId
```
public String getProjectId()
```
    Required. Project ID of the datasets to be listed
  - setProjectId
```
public Bigquery.Datasets.List setProjectId(String projectId)
```
    Required. Project ID of the datasets to be listed
  - getAll
```
public Boolean getAll()
```
    Whether to list all datasets, including hidden ones
  - setAll
```
public Bigquery.Datasets.List setAll(Boolean all)
```
    Whether to list all datasets, including hidden ones
  - getFilter
```
public String getFilter()
```
    An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be AND-ed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details.
  - setFilter
```
public Bigquery.Datasets.List setFilter(String filter)
```
    An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be AND-ed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering- labels#filtering_datasets_using_labels) for details.
  - getMaxResults
```
public Long getMaxResults()
```
    The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
  - setMaxResults
```
public Bigquery.Datasets.List setMaxResults(Long maxResults)
```
    The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
  - getPageToken
```
public String getPageToken()
```
    Page token, returned by a previous call, to request the next page of results
  - setPageToken
```
public Bigquery.Datasets.List setPageToken(String pageToken)
```
    Page token, returned by a previous call, to request the next page of results
  - set
```
public Bigquery.Datasets.List set(String parameterName,
                                  Object value)
```
    Overrides:
    
    set in class BigqueryRequest<DatasetList>

Class Bigquery.Datasets.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.bigquery.BigqueryRequest

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

getAll

setAll

getFilter

setFilter

getMaxResults

setMaxResults

getPageToken

setPageToken

set