Documentation

Google_Service_Bigquery_Resource_Datasets extends Google_Service_Resource
in package

The "datasets" collection of methods.

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

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 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)
get()  : Google_Service_Bigquery_Dataset
Returns the dataset specified by datasetID. (datasets.get)
insert()  : Google_Service_Bigquery_Dataset
Creates a new empty dataset. (datasets.insert)
listDatasets()  : Google_Service_Bigquery_DatasetList
Lists all datasets in the specified project to which you have been granted the READER dataset role. (datasets.listDatasets)
patch()  : Google_Service_Bigquery_Dataset
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)
update()  : Google_Service_Bigquery_Dataset
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)
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 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)

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

Project ID of the dataset being deleted

$datasetId : string

Dataset ID of dataset being deleted

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

Optional parameters.

Tags
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

Return values
mixed

get()

Returns the dataset specified by datasetID. (datasets.get)

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

Project ID of the requested dataset

$datasetId : string

Dataset ID of the requested dataset

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

Optional parameters.

Return values
Google_Service_Bigquery_Dataset

listDatasets()

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

public listDatasets(string $projectId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Bigquery_DatasetList
Parameters
$projectId : string

Project ID of the datasets to be listed

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

Optional parameters.

Tags
opt_param

string filter An expression for filtering the results of the request by label. The syntax is "labels.[:]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details.

opt_param

bool all Whether to list all datasets, including hidden ones

opt_param

string maxResults The maximum number of results to return

opt_param

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

Return values
Google_Service_Bigquery_DatasetList

patch()

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)

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

Project ID of the dataset being updated

$datasetId : string

Dataset ID of the dataset being updated

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

Optional parameters.

Return values
Google_Service_Bigquery_Dataset

update()

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)

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

Project ID of the dataset being updated

$datasetId : string

Dataset ID of the dataset being updated

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

Optional parameters.

Return values
Google_Service_Bigquery_Dataset

convertToArrayAndStripNulls()

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

Search results