* $bigtableadminService = new Google\Service\BigtableAdmin(...); * $tables = $bigtableadminService->projects_instances_tables; * */ class ProjectsInstancesTables extends \Google\Service\Resource { /** * Checks replication consistency based on a consistency token, that is, if * replication has caught up based on the conditions specified in the token and * the check request. (tables.checkConsistency) * * @param string $name Required. The unique name of the Table for which to check * replication consistency. Values are of the form * `projects/{project}/instances/{instance}/tables/{table}`. * @param CheckConsistencyRequest $postBody * @param array $optParams Optional parameters. * @return CheckConsistencyResponse * @throws \Google\Service\Exception */ public function checkConsistency($name, CheckConsistencyRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('checkConsistency', [$params], CheckConsistencyResponse::class); } /** * Creates a new table in the specified instance. The table can be created with * a full set of initial column families, specified in the request. * (tables.create) * * @param string $parent Required. The unique name of the instance in which to * create the table. Values are of the form * `projects/{project}/instances/{instance}`. * @param CreateTableRequest $postBody * @param array $optParams Optional parameters. * @return Table * @throws \Google\Service\Exception */ public function create($parent, CreateTableRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], Table::class); } /** * Permanently deletes a specified table and all of its data. (tables.delete) * * @param string $name Required. The unique name of the table to be deleted. * Values are of the form * `projects/{project}/instances/{instance}/tables/{table}`. * @param array $optParams Optional parameters. * @return BigtableadminEmpty * @throws \Google\Service\Exception */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], BigtableadminEmpty::class); } /** * Permanently drop/delete a row range from a specified table. The request can * specify whether to delete all rows in a table, or only those that match a * particular prefix. Note that row key prefixes used here are treated as * service data. For more information about how service data is handled, see the * [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy- * notice). (tables.dropRowRange) * * @param string $name Required. The unique name of the table on which to drop a * range of rows. Values are of the form * `projects/{project}/instances/{instance}/tables/{table}`. * @param DropRowRangeRequest $postBody * @param array $optParams Optional parameters. * @return BigtableadminEmpty * @throws \Google\Service\Exception */ public function dropRowRange($name, DropRowRangeRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('dropRowRange', [$params], BigtableadminEmpty::class); } /** * Generates a consistency token for a Table, which can be used in * CheckConsistency to check whether mutations to the table that finished before * this call started have been replicated. The tokens will be available for 90 * days. (tables.generateConsistencyToken) * * @param string $name Required. The unique name of the Table for which to * create a consistency token. Values are of the form * `projects/{project}/instances/{instance}/tables/{table}`. * @param GenerateConsistencyTokenRequest $postBody * @param array $optParams Optional parameters. * @return GenerateConsistencyTokenResponse * @throws \Google\Service\Exception */ public function generateConsistencyToken($name, GenerateConsistencyTokenRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('generateConsistencyToken', [$params], GenerateConsistencyTokenResponse::class); } /** * Gets metadata information about the specified table. (tables.get) * * @param string $name Required. The unique name of the requested table. Values * are of the form `projects/{project}/instances/{instance}/tables/{table}`. * @param array $optParams Optional parameters. * * @opt_param string view The view to be applied to the returned table's fields. * Defaults to `SCHEMA_VIEW` if unspecified. * @return Table * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], Table::class); } /** * Gets the access control policy for a Bigtable resource. Returns an empty * policy if the resource exists but 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); } /** * Lists all tables served from a specified instance. * (tables.listProjectsInstancesTables) * * @param string $parent Required. The unique name of the instance for which * tables should be listed. Values are of the form * `projects/{project}/instances/{instance}`. * @param array $optParams Optional parameters. * * @opt_param int pageSize Maximum number of results per page. A page_size of * zero lets the server choose the number of items to return. A page_size which * is strictly positive will return at most that many items. A negative * page_size will cause an error. Following the first request, subsequent * paginated calls are not required to pass a page_size. If a page_size is set * in subsequent calls, it must match the page_size given in the first request. * @opt_param string pageToken The value of `next_page_token` returned by a * previous call. * @opt_param string view The view to be applied to the returned tables' fields. * Only NAME_ONLY view (default), REPLICATION_VIEW and ENCRYPTION_VIEW are * supported. * @return ListTablesResponse * @throws \Google\Service\Exception */ public function listProjectsInstancesTables($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListTablesResponse::class); } /** * Performs a series of column family modifications on the specified table. * Either all or none of the modifications will occur before this method * returns, but data requests received prior to that point may see a table where * only some modifications have taken effect. (tables.modifyColumnFamilies) * * @param string $name Required. The unique name of the table whose families * should be modified. Values are of the form * `projects/{project}/instances/{instance}/tables/{table}`. * @param ModifyColumnFamiliesRequest $postBody * @param array $optParams Optional parameters. * @return Table * @throws \Google\Service\Exception */ public function modifyColumnFamilies($name, ModifyColumnFamiliesRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('modifyColumnFamilies', [$params], Table::class); } /** * Updates a specified table. (tables.patch) * * @param string $name The unique name of the table. Values are of the form * `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: * `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL` * @param Table $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask Required. The list of fields to update. A mask * specifying which fields (e.g. `change_stream_config`) in the `table` field * should be updated. This mask is relative to the `table` field, not to the * request message. The wildcard (*) path is currently not supported. Currently * UpdateTable is only supported for the following fields: * * `change_stream_config` * `change_stream_config.retention_period` * * `deletion_protection` If `column_families` is set in `update_mask`, it will * return an UNIMPLEMENTED error. * @return Operation * @throws \Google\Service\Exception */ public function patch($name, Table $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], Operation::class); } /** * Create a new table by restoring from a completed backup. The returned table * long-running operation can be used to track the progress of the operation, * and to cancel it. The metadata field type is RestoreTableMetadata. The * response type is Table, if successful. (tables.restore) * * @param string $parent Required. The name of the instance in which to create * the restored table. Values are of the form `projects//instances/`. * @param RestoreTableRequest $postBody * @param array $optParams Optional parameters. * @return Operation * @throws \Google\Service\Exception */ public function restore($parent, RestoreTableRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('restore', [$params], Operation::class); } /** * Sets the access control policy on a Bigtable resource. Replaces any existing * policy. (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 the caller has on the specified Bigtable resource. * (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); } /** * Restores a specified table which was accidentally deleted. (tables.undelete) * * @param string $name Required. The unique name of the table to be restored. * Values are of the form * `projects/{project}/instances/{instance}/tables/{table}`. * @param UndeleteTableRequest $postBody * @param array $optParams Optional parameters. * @return Operation * @throws \Google\Service\Exception */ public function undelete($name, UndeleteTableRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('undelete', [$params], Operation::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsInstancesTables::class, 'Google_Service_BigtableAdmin_Resource_ProjectsInstancesTables');