removeCatalogAttribute method

Future<GoogleCloudRetailV2AttributesConfig> removeCatalogAttribute(
  1. GoogleCloudRetailV2RemoveCatalogAttributeRequest request,
  2. String attributesConfig, {
  3. String? $fields,
})

Removes the specified CatalogAttribute from the AttributesConfig.

If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.

request - The metadata request object.

Request parameters:

attributesConfig - Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/catalogs/\[^/\]+/attributesConfig$.

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

Completes with a GoogleCloudRetailV2AttributesConfig.

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<GoogleCloudRetailV2AttributesConfig> removeCatalogAttribute(
  GoogleCloudRetailV2RemoveCatalogAttributeRequest request,
  core.String attributesConfig, {
  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('$attributesConfig') +
      ':removeCatalogAttribute';

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