split method

Future<SplitCapacityCommitmentResponse> split(
  1. SplitCapacityCommitmentRequest request,
  2. String name, {
  3. String? $fields,
})

Splits capacity commitment to two commitments of the same plan and commitment_end_time.

A common use case is to enable downgrading commitments. For example, in order to downgrade from 10000 slots to 8000, you might split a 10000 capacity commitment into commitments of 2000 and 8000. Then, you delete the first one after the commitment end time passes.

request - The metadata request object.

Request parameters:

name - Required. The resource name e.g.,: projects/myproject/locations/US/capacityCommitments/123 Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/capacityCommitments/\[^/\]+$.

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

Completes with a SplitCapacityCommitmentResponse.

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<SplitCapacityCommitmentResponse> split(
  SplitCapacityCommitmentRequest 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_ = 'v1/' + core.Uri.encodeFull('$name') + ':split';

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