patch method
- GoogleCloudDatacatalogV1beta1TagTemplateField request,
- String name, {
- String? updateMask,
- String? $fields,
Updates a field in a tag template.
This method cannot be used to update the field type. Users should enable
the Data Catalog API in the project identified by the name
parameter
(see
Data Catalog Resource Project
for more information).
request
- The metadata request object.
Request parameters:
name
- Required. The name of the tag template field. Example: *
projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
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 GoogleCloudDatacatalogV1beta1TagTemplateField.
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<GoogleCloudDatacatalogV1beta1TagTemplateField> patch(
GoogleCloudDatacatalogV1beta1TagTemplateField request,
core.String name, {
core.String? updateMask,
core.String? $fields,
}) async {
final _body = convert.json.encode(request.toJson());
final _queryParams = <core.String, core.List<core.String>>{
if (updateMask != null) 'updateMask': [updateMask],
if ($fields != null) 'fields': [$fields],
};
final _url = 'v1beta1/' + core.Uri.encodeFull('$name');
final _response = await _requester.request(
_url,
'PATCH',
body: _body,
queryParams: _queryParams,
);
return GoogleCloudDatacatalogV1beta1TagTemplateField.fromJson(
_response as core.Map<core.String, core.dynamic>);
}