validate method

Future<ValidateConsumerConfigResponse> validate(
  1. ValidateConsumerConfigRequest request,
  2. String parent, {
  3. String? $fields,
})

Service producers use this method to validate if the consumer provided network, project and requested range are valid.

This allows them to use a fail-fast mechanism for consumer requests, and not have to wait for AddSubnetwork operation completion to determine if user request is invalid.

request - The metadata request object.

Request parameters:

parent - Required. This is in a form services/{service} where {service} is the name of the private access management service. For example 'service-peering.example.com'. Value must have pattern ^services/\[^/\]+$.

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

Completes with a ValidateConsumerConfigResponse.

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<ValidateConsumerConfigResponse> validate(
  ValidateConsumerConfigRequest request,
  core.String parent, {
  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('$parent') + ':validate';

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