patch method
Updates the parameters of a single Connector, and creates a new ConnectorRevision with the updated Connector.
The operations are validated against and must be compatible with the live schema. If the operations and schema are not compatible or if the schema is not present, this will result in an error.
request
- The metadata request object.
Request parameters:
name
- Identifier. The relative resource name of the connector, in the
format: ```
projects/{project}/locations/{location}/services/{service}/connectors/{connector}
Value must have pattern
`^projects/\[^/\]+/locations/\[^/\]+/services/\[^/\]+/connectors/\[^/\]+$`.
[allowMissing] - Optional. If true and the Connector is not found, a new
Connector will be created. In this case, `update_mask` is ignored.
[requestId] - Optional. An optional request ID to identify requests.
Specify a unique request ID so that if you must retry your request, the
server will know to ignore the request if it has already been completed.
The server will guarantee that for at least 60 minutes since the first
request. For example, consider a situation where you make an initial
request and the request times out. If you make the request again with the
same request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments. The
request ID must be a valid UUID with the exception that zero UUID is not
supported (00000000-0000-0000-0000-000000000000).
[updateMask] - Optional. Field mask is used to specify the fields to be
overwritten in the Connector resource by the update. The fields specified
in the update_mask are relative to the resource, not the full request. A
field will be overwritten if it is in the mask. If the user does not
provide a mask then all fields will be overwritten.
[validateOnly] - Optional. If set, validate the request and preview the
Connector, but do not actually update it.
[$fields] - Selector specifying which fields to include in a partial
response.
Completes with a [Operation].
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<Operation> patch(
Connector request,
core.String name, {
core.bool? allowMissing,
core.String? requestId,
core.String? updateMask,
core.bool? validateOnly,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (allowMissing != null) 'allowMissing': ['${allowMissing}'],
if (requestId != null) 'requestId': [requestId],
if (updateMask != null) 'updateMask': [updateMask],
if (validateOnly != null) 'validateOnly': ['${validateOnly}'],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'PATCH',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}