com.google.api.services.bigquery

Class Bigquery.Routines.List

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<ListRoutinesResponse>

com.google.api.services.bigquery.Bigquery.Routines.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Bigquery.Routines

public class Bigquery.Routines.List
extends BigqueryRequest<ListRoutinesResponse>

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, String datasetId) Lists all routines in the specified dataset.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getDatasetId() Required.
String	getFilter() If set, then only the Routines matching this filter are returned.
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.
String	getReadMask() If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response.
Bigquery.Routines.List	set(String parameterName, Object value)
Bigquery.Routines.List	set$Xgafv(String $Xgafv) V1 error format.
Bigquery.Routines.List	setAccessToken(String accessToken) OAuth access token.
Bigquery.Routines.List	setAlt(String alt) Data format for response.
Bigquery.Routines.List	setCallback(String callback) JSONP
Bigquery.Routines.List	setDatasetId(String datasetId) Required.
Bigquery.Routines.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Bigquery.Routines.List	setFilter(String filter) If set, then only the Routines matching this filter are returned.
Bigquery.Routines.List	setKey(String key) API key.
Bigquery.Routines.List	setMaxResults(Long maxResults) The maximum number of results to return in a single response page.
Bigquery.Routines.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Bigquery.Routines.List	setPageToken(String pageToken) Page token, returned by a previous call, to request the next page of results
Bigquery.Routines.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Bigquery.Routines.List	setProjectId(String projectId) Required.
Bigquery.Routines.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Bigquery.Routines.List	setReadMask(String readMask) If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response.
Bigquery.Routines.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Bigquery.Routines.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,
               String datasetId)

Lists all routines in the specified dataset. Requires the READER dataset role. Create a request for the method "routines.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 routines to list

datasetId - Required. Dataset ID of the routines to list

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<ListRoutinesResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListRoutinesResponse>

Throws:

IOException

set$Xgafv

public Bigquery.Routines.List set$Xgafv(String $Xgafv)

Description copied from class: BigqueryRequest

V1 error format.

Overrides:

set$Xgafv in class BigqueryRequest<ListRoutinesResponse>

setAccessToken

public Bigquery.Routines.List setAccessToken(String accessToken)

Description copied from class: BigqueryRequest

OAuth access token.

Overrides:

setAccessToken in class BigqueryRequest<ListRoutinesResponse>

setAlt

public Bigquery.Routines.List setAlt(String alt)

Description copied from class: BigqueryRequest

Data format for response.

Overrides:

setAlt in class BigqueryRequest<ListRoutinesResponse>

setCallback

public Bigquery.Routines.List setCallback(String callback)

Description copied from class: BigqueryRequest

JSONP

Overrides:

setCallback in class BigqueryRequest<ListRoutinesResponse>

setFields

public Bigquery.Routines.List setFields(String fields)

Description copied from class: BigqueryRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class BigqueryRequest<ListRoutinesResponse>

setKey

public Bigquery.Routines.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<ListRoutinesResponse>

setOauthToken

public Bigquery.Routines.List setOauthToken(String oauthToken)

Description copied from class: BigqueryRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class BigqueryRequest<ListRoutinesResponse>

setPrettyPrint

public Bigquery.Routines.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: BigqueryRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class BigqueryRequest<ListRoutinesResponse>

setQuotaUser

public Bigquery.Routines.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<ListRoutinesResponse>

setUploadType

public Bigquery.Routines.List setUploadType(String uploadType)

Description copied from class: BigqueryRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class BigqueryRequest<ListRoutinesResponse>

setUploadProtocol

public Bigquery.Routines.List setUploadProtocol(String uploadProtocol)

Description copied from class: BigqueryRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class BigqueryRequest<ListRoutinesResponse>

getProjectId

public String getProjectId()

Required. Project ID of the routines to list

setProjectId

public Bigquery.Routines.List setProjectId(String projectId)

Required. Project ID of the routines to list

getDatasetId

public String getDatasetId()

Required. Dataset ID of the routines to list

setDatasetId

public Bigquery.Routines.List setDatasetId(String datasetId)

Required. Dataset ID of the routines to list

getFilter

public String getFilter()

If set, then only the Routines matching this filter are returned. The supported format is `routineType:{RoutineType}`, where `{RoutineType}` is a RoutineType enum. For example: `routineType:SCALAR_FUNCTION`.

setFilter

public Bigquery.Routines.List setFilter(String filter)

If set, then only the Routines matching this filter are returned. The supported format is `routineType:{RoutineType}`, where `{RoutineType}` is a RoutineType enum. For example: `routineType:SCALAR_FUNCTION`.

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.Routines.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.Routines.List setPageToken(String pageToken)

Page token, returned by a previous call, to request the next page of results

getReadMask

public String getReadMask()

If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.

setReadMask

public Bigquery.Routines.List setReadMask(String readMask)

If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.

set

public Bigquery.Routines.List set(String parameterName,
                                  Object value)

Overrides:

set in class BigqueryRequest<ListRoutinesResponse>