patch method

Future<GoogleCloudDatacatalogV1TagTemplateField> patch(GoogleCloudDatacatalogV1TagTemplateField request, String name, { String? updateMask, String? $fields, })

Updates a field in a tag template.

You can't update the field type with this method. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

request - The metadata request object.

Request parameters:

name - Required. The name of the tag template field. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/tagTemplates/\[^/\]+/fields/\[^/\]+$.

updateMask - Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable: * display_name * type.enum_type * is_required If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed. Additionally, updating a template field from optional to required is not allowed.

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

Completes with a GoogleCloudDatacatalogV1TagTemplateField.

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<GoogleCloudDatacatalogV1TagTemplateField> patch(
  GoogleCloudDatacatalogV1TagTemplateField request,
  core.String name, {
  core.String? updateMask,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (updateMask != null) 'updateMask': [updateMask],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

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