patch method
Updates an Entry.
request
- The metadata request object.
Request parameters:
name
- Identifier. The relative resource name of the entry, in the
format
projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/entryGroups/\[^/\]+/entries/.*$
.
allowMissing
- Optional. If set to true and the entry doesn't exist, the
service will create it.
aspectKeys
- Optional. The map keys of the Aspects which the service
should modify. It supports the following syntaxes: - matches an aspect of
the given type and empty path. @path - matches an aspect of the given type
and specified path. For example, to attach an aspect to a field that is
specified by the schema aspect, the path should have the format Schema..
@* - matches aspects of the given type for all paths. *@path - matches
aspects of all types on the given path.The service will not remove
existing aspects matching the syntax unless delete_missing_aspects is set
to true.If this field is left empty, the service treats it as specifying
exactly those Aspects present in the request.
deleteMissingAspects
- Optional. If set to true and the aspect_keys
specify aspect ranges, the service deletes any existing aspects from that
range that weren't provided in the request.
updateMask
- Optional. Mask of fields to update. To update Aspects, the
update_mask must contain the value "aspects".If the update_mask is empty,
the service will update all modifiable fields present in the request.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudDataplexV1Entry.
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<GoogleCloudDataplexV1Entry> patch(
GoogleCloudDataplexV1Entry request,
core.String name, {
core.bool? allowMissing,
core.List<core.String>? aspectKeys,
core.bool? deleteMissingAspects,
core.String? updateMask,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (allowMissing != null) 'allowMissing': ['${allowMissing}'],
if (aspectKeys != null) 'aspectKeys': aspectKeys,
if (deleteMissingAspects != null)
'deleteMissingAspects': ['${deleteMissingAspects}'],
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 GoogleCloudDataplexV1Entry.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}