Documentation

Google_Service_Bigquery_Resource_Routines extends Google_Service_Resource
in package

The "routines" collection of methods.

Typical usage is: $bigqueryService = new Google_Service_Bigquery(...); $routines = $bigqueryService->routines;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes the routine specified by routineId from the dataset.
get()  : Google_Service_Bigquery_Routine
Gets the specified routine resource by routine ID. (routines.get)
insert()  : Google_Service_Bigquery_Routine
Creates a new routine in the dataset. (routines.insert)
listRoutines()  : Google_Service_Bigquery_ListRoutinesResponse
Lists all routines in the specified dataset. Requires the READER dataset role. (routines.listRoutines)
update()  : Google_Service_Bigquery_Routine
Updates information in an existing routine. The update method replaces the entire Routine resource. (routines.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes the routine specified by routineId from the dataset.

public delete(string $projectId, string $datasetId, string $routineId[, array<string|int, mixed> $optParams = array() ]) : mixed

(routines.delete)

Parameters
$projectId : string

Required. Project ID of the routine to delete

$datasetId : string

Required. Dataset ID of the routine to delete

$routineId : string

Required. Routine ID of the routine to delete

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed

get()

Gets the specified routine resource by routine ID. (routines.get)

public get(string $projectId, string $datasetId, string $routineId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Bigquery_Routine
Parameters
$projectId : string

Required. Project ID of the requested routine

$datasetId : string

Required. Dataset ID of the requested routine

$routineId : string

Required. Routine ID of the requested routine

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string readMask If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.

Return values
Google_Service_Bigquery_Routine

insert()

Creates a new routine in the dataset. (routines.insert)

public insert(string $projectId, string $datasetId, Google_Service_Bigquery_Routine $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Bigquery_Routine
Parameters
$projectId : string

Required. Project ID of the new routine

$datasetId : string

Required. Dataset ID of the new routine

$postBody : Google_Service_Bigquery_Routine
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Bigquery_Routine

listRoutines()

Lists all routines in the specified dataset. Requires the READER dataset role. (routines.listRoutines)

public listRoutines(string $projectId, string $datasetId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Bigquery_ListRoutinesResponse
Parameters
$projectId : string

Required. Project ID of the routines to list

$datasetId : string

Required. Dataset ID of the routines to list

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

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.

opt_param

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

opt_param

string filter If set, then only the Routines matching this filter are returned. The current supported form is either "routine_type:" or "routineType:", where is a RoutineType enum. Example: "routineType:SCALAR_FUNCTION".

opt_param

string maxResults The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

Return values
Google_Service_Bigquery_ListRoutinesResponse

update()

Updates information in an existing routine. The update method replaces the entire Routine resource. (routines.update)

public update(string $projectId, string $datasetId, string $routineId, Google_Service_Bigquery_Routine $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Bigquery_Routine
Parameters
$projectId : string

Required. Project ID of the routine to update

$datasetId : string

Required. Dataset ID of the routine to update

$routineId : string

Required. Routine ID of the routine to update

$postBody : Google_Service_Bigquery_Routine
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Bigquery_Routine

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results