📄 Source: Tables.php
<?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\GetIamPolicyRequest;
use Google\Service\Bigquery\Policy;
use Google\Service\Bigquery\SetIamPolicyRequest;
use Google\Service\Bigquery\Table;
use Google\Service\Bigquery\TableList;
use Google\Service\Bigquery\TestIamPermissionsRequest;
use Google\Service\Bigquery\TestIamPermissionsResponse;
/**
* The "tables" collection of methods.
* Typical usage is:
* <code>
* $bigqueryService = new Google\Service\Bigquery(...);
* $tables = $bigqueryService->tables;
* </code>
*/
class Tables extends \Google\Service\Resource
{
/**
* Deletes the table specified by tableId from the dataset. If the table
* contains data, all the data will be deleted. (tables.delete)
*
* @param string $projectId Required. Project ID of the table to delete
* @param string $datasetId Required. Dataset ID of the table to delete
* @param string $tableId Required. Table ID of the table to delete
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function delete($projectId, $datasetId, $tableId, $optParams = [])
{
$params = ['projectId' => $projectId, 'datasetId' => $datasetId, 'tableId' => $tableId];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Gets the specified table resource by table ID. This method does not return
* the data in the table, it only returns the table resource, which describes
* the structure of this table. (tables.get)
*
* @param string $projectId Required. Project ID of the requested table
* @param string $datasetId Required. Dataset ID of the requested table
* @param string $tableId Required. Table ID of the requested table
* @param array $optParams Optional parameters.
*
* @opt_param string selectedFields List of table schema fields to return
* (comma-separated). If unspecified, all fields are returned. A fieldMask
* cannot be used here because the fields will automatically be converted from
* camelCase to snake_case and the conversion will fail if there are
* underscores. Since these are fields in BigQuery table schemas, underscores
* are allowed.
* @opt_param string view Optional. Specifies the view that determines which
* table information is returned. By default, basic table information and
* storage statistics (STORAGE_STATS) are returned.
* @return Table
* @throws \Google\Service\Exception
*/
public function get($projectId, $datasetId, $tableId, $optParams = [])
{
$params = ['projectId' => $projectId, 'datasetId' => $datasetId, 'tableId' => $tableId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Table::class);
}
/**
* Gets the access control policy for a resource. Returns an empty policy if the
* resource exists and does not have a policy set. (tables.getIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param GetIamPolicyRequest $postBody
* @param array $optParams Optional parameters.
* @return Policy
* @throws \Google\Service\Exception
*/
public function getIamPolicy($resource, GetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('getIamPolicy', [$params], Policy::class);
}
/**
* Creates a new, empty table in the dataset. (tables.insert)
*
* @param string $projectId Required. Project ID of the new table
* @param string $datasetId Required. Dataset ID of the new table
* @param Table $postBody
* @param array $optParams Optional parameters.
* @return Table
* @throws \Google\Service\Exception
*/
public function insert($projectId, $datasetId, Table $postBody, $optParams = [])
{
$params = ['projectId' => $projectId, 'datasetId' => $datasetId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('insert', [$params], Table::class);
}
/**
* Lists all tables in the specified dataset. Requires the READER dataset role.
* (tables.listTables)
*
* @param string $projectId Required. Project ID of the tables to list
* @param string $datasetId Required. Dataset ID of the tables to list
* @param array $optParams Optional parameters.
*
* @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.
* @opt_param string pageToken Page token, returned by a previous call, to
* request the next page of results
* @return TableList
* @throws \Google\Service\Exception
*/
public function listTables($projectId, $datasetId, $optParams = [])
{
$params = ['projectId' => $projectId, 'datasetId' => $datasetId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], TableList::class);
}
/**
* Updates information in an existing table. The update method replaces the
* entire table resource, whereas the patch method only replaces fields that are
* provided in the submitted table resource. This method supports RFC5789 patch
* semantics. (tables.patch)
*
* @param string $projectId Required. Project ID of the table to update
* @param string $datasetId Required. Dataset ID of the table to update
* @param string $tableId Required. Table ID of the table to update
* @param Table $postBody
* @param array $optParams Optional parameters.
*
* @opt_param bool autodetect_schema Optional. When true will autodetect
* schema, else will keep original schema
* @return Table
* @throws \Google\Service\Exception
*/
public function patch($projectId, $datasetId, $tableId, Table $postBody, $optParams = [])
{
$params = ['projectId' => $projectId, 'datasetId' => $datasetId, 'tableId' => $tableId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Table::class);
}
/**
* Sets the access control policy on the specified resource. Replaces any
* existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
* `PERMISSION_DENIED` errors. (tables.setIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* specified. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param SetIamPolicyRequest $postBody
* @param array $optParams Optional parameters.
* @return Policy
* @throws \Google\Service\Exception
*/
public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setIamPolicy', [$params], Policy::class);
}
/**
* Returns permissions that a caller has on the specified resource. If the
* resource does not exist, this will return an empty set of permissions, not a
* `NOT_FOUND` error. Note: This operation is designed to be used for building
* permission-aware UIs and command-line tools, not for authorization checking.
* This operation may "fail open" without warning. (tables.testIamPermissions)
*
* @param string $resource REQUIRED: The resource for which the policy detail is
* being requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param TestIamPermissionsRequest $postBody
* @param array $optParams Optional parameters.
* @return TestIamPermissionsResponse
* @throws \Google\Service\Exception
*/
public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
}
/**
* Updates information in an existing table. The update method replaces the
* entire Table resource, whereas the patch method only replaces fields that are
* provided in the submitted Table resource. (tables.update)
*
* @param string $projectId Required. Project ID of the table to update
* @param string $datasetId Required. Dataset ID of the table to update
* @param string $tableId Required. Table ID of the table to update
* @param Table $postBody
* @param array $optParams Optional parameters.
*
* @opt_param bool autodetect_schema Optional. When true will autodetect
* schema, else will keep original schema
* @return Table
* @throws \Google\Service\Exception
*/
public function update($projectId, $datasetId, $tableId, Table $postBody, $optParams = [])
{
$params = ['projectId' => $projectId, 'datasetId' => $datasetId, 'tableId' => $tableId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], Table::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Tables::class, 'Google_Service_Bigquery_Resource_Tables');
← Back