modifyColumnFamilies method

Future<Table> modifyColumnFamilies(
  1. ModifyColumnFamiliesRequest request,
  2. String name, {
  3. String? $fields,
})

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.

request - The metadata request object.

Request parameters:

name - Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table}. Value must have pattern ^projects/\[^/\]+/instances/\[^/\]+/tables/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Table.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Table> modifyColumnFamilies(
  ModifyColumnFamiliesRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':modifyColumnFamilies';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return Table.fromJson(response_ as core.Map<core.String, core.dynamic>);
}