Viewing file:  Datasets.php (5.63 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Bigquery\Resource;
use Google\Service\Bigquery\Dataset;
use Google\Service\Bigquery\DatasetList;
/**
* The "datasets" collection of methods.
* Typical usage is:
* <code>
* $bigqueryService = new Google\Service\Bigquery(...);
* $datasets = $bigqueryService->datasets;
* </code>
*/
class Datasets extends \Google\Service\Resource
{
/**
* 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)
*
* @param string $projectId Project ID of the dataset being deleted
* @param string $datasetId Dataset ID of dataset being deleted
* @param array $optParams Optional 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
*/
public function delete($projectId, $datasetId, $optParams = [])
{
$params = ['projectId' => $projectId, 'datasetId' => $datasetId];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Returns the dataset specified by datasetID. (datasets.get)
*
* @param string $projectId Project ID of the requested dataset
* @param string $datasetId Dataset ID of the requested dataset
* @param array $optParams Optional parameters.
* @return Dataset
*/
public function get($projectId, $datasetId, $optParams = [])
{
$params = ['projectId' => $projectId, 'datasetId' => $datasetId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Dataset::class);
}
/**
* Creates a new empty dataset. (datasets.insert)
*
* @param string $projectId Project ID of the new dataset
* @param Dataset $postBody
* @param array $optParams Optional parameters.
* @return Dataset
*/
public function insert($projectId, Dataset $postBody, $optParams = [])
{
$params = ['projectId' => $projectId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('insert', [$params], Dataset::class);
}
/**
* Lists all datasets in the specified project to which you have been granted
* the READER dataset role. (datasets.listDatasets)
*
* @param string $projectId Project ID of the datasets to be listed
* @param array $optParams Optional parameters.
*
* @opt_param bool all Whether to list all datasets, including hidden ones
* @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 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 DatasetList
*/
public function listDatasets($projectId, $optParams = [])
{
$params = ['projectId' => $projectId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], DatasetList::class);
}
/**
* 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)
*
* @param string $projectId Project ID of the dataset being updated
* @param string $datasetId Dataset ID of the dataset being updated
* @param Dataset $postBody
* @param array $optParams Optional parameters.
* @return Dataset
*/
public function patch($projectId, $datasetId, Dataset $postBody, $optParams = [])
{
$params = ['projectId' => $projectId, 'datasetId' => $datasetId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Dataset::class);
}
/**
* 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)
*
* @param string $projectId Project ID of the dataset being updated
* @param string $datasetId Dataset ID of the dataset being updated
* @param Dataset $postBody
* @param array $optParams Optional parameters.
* @return Dataset
*/
public function update($projectId, $datasetId, Dataset $postBody, $optParams = [])
{
$params = ['projectId' => $projectId, 'datasetId' => $datasetId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], Dataset::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Datasets::class, 'Google_Service_Bigquery_Resource_Datasets');
|