patch method
- GoogleCloudDialogflowV2Document request,
- String name, {
- String? updateMask,
- String? $fields,
Updates the specified document.
This method is a [long-running
operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
The returned Operation
type has the following method-specific fields: -
metadata
: KnowledgeOperationMetadata - response
: Document
request
- The metadata request object.
Request parameters:
name
- Optional. The document resource name. The name must be empty when
creating a document. Format:
projects//locations//knowledgeBases//documents/
.
Value must have pattern
^projects/\[^/\]+/knowledgeBases/\[^/\]+/documents/\[^/\]+$
.
updateMask
- Optional. Not specified means update all
. Currently, only
display_name
can be updated, an InvalidArgument will be returned for
attempting to update other fields.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleLongrunningOperation.
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<GoogleLongrunningOperation> patch(
GoogleCloudDialogflowV2Document 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_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'PATCH',
body: body_,
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}