Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
Google_Service_Bigquery_Datasets_Resource Class Reference

The "datasets" collection of methods. More...

Inheritance diagram for Google_Service_Bigquery_Datasets_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($projectId, $datasetId, $optParams=array())
 Deletes the dataset specified by the datasetId value.
 
 get ($projectId, $datasetId, $optParams=array())
 Returns the dataset specified by datasetID.
 
 insert ($projectId, Google_Service_Bigquery_Dataset $postBody, $optParams=array())
 Creates a new empty dataset.
 
 listDatasets ($projectId, $optParams=array())
 Lists all datasets in the specified project to which you have been granted the READER dataset role.
 
 patch ($projectId, $datasetId, Google_Service_Bigquery_Dataset $postBody, $optParams=array())
 Updates information in an existing dataset.
 
 update ($projectId, $datasetId, Google_Service_Bigquery_Dataset $postBody, $optParams=array())
 Updates information in an existing dataset.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "datasets" collection of methods.

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

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_Bigquery_Datasets_Resource::delete ( $projectId,
$datasetId,
$optParams = array() )

Deletes the dataset specified by the datasetId value.

Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. (datasets.delete)

Parameters
string$projectIdProject ID of the dataset being deleted
string$datasetIdDataset ID of dataset being deleted
array$optParamsOptional parameters.

@opt_param bool deleteContents If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False

◆ get()

Google_Service_Bigquery_Datasets_Resource::get ( $projectId,
$datasetId,
$optParams = array() )

Returns the dataset specified by datasetID.

(datasets.get)

Parameters
string$projectIdProject ID of the requested dataset
string$datasetIdDataset ID of the requested dataset
array$optParamsOptional parameters.
Return values
Google_Service_Bigquery_Dataset

◆ insert()

Google_Service_Bigquery_Datasets_Resource::insert ( $projectId,
Google_Service_Bigquery_Dataset $postBody,
$optParams = array() )

Creates a new empty dataset.

(datasets.insert)

Parameters
string$projectIdProject ID of the new dataset
Google_Dataset$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Bigquery_Dataset

◆ listDatasets()

Google_Service_Bigquery_Datasets_Resource::listDatasets ( $projectId,
$optParams = array() )

Lists all datasets in the specified project to which you have been granted the READER dataset role.

(datasets.listDatasets)

Parameters
string$projectIdProject ID of the datasets to be listed
array$optParamsOptional parameters.

@opt_param string pageToken Page token, returned by a previous call, to request the next page of results @opt_param bool all Whether to list all datasets, including hidden ones @opt_param string maxResults The maximum number of results to return

Return values
Google_Service_Bigquery_DatasetList

◆ patch()

Google_Service_Bigquery_Datasets_Resource::patch ( $projectId,
$datasetId,
Google_Service_Bigquery_Dataset $postBody,
$optParams = array() )

Updates information in an existing dataset.

The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics. (datasets.patch)

Parameters
string$projectIdProject ID of the dataset being updated
string$datasetIdDataset ID of the dataset being updated
Google_Dataset$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Bigquery_Dataset

◆ update()

Google_Service_Bigquery_Datasets_Resource::update ( $projectId,
$datasetId,
Google_Service_Bigquery_Dataset $postBody,
$optParams = array() )

Updates information in an existing dataset.

The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. (datasets.update)

Parameters
string$projectIdProject ID of the dataset being updated
string$datasetIdDataset ID of the dataset being updated
Google_Dataset$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Bigquery_Dataset

The documentation for this class was generated from the following file: