updateDataRetentionSettings method

Future<GoogleAnalyticsAdminV1alphaDataRetentionSettings> updateDataRetentionSettings(GoogleAnalyticsAdminV1alphaDataRetentionSettings request, String name, { String? updateMask, String? $fields, })

Updates the singleton data retention settings for this property.

request - The metadata request object.

Request parameters:

name - Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings Value must have pattern ^properties/\[^/\]+/dataRetentionSettings$.

updateMask - Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

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

Completes with a GoogleAnalyticsAdminV1alphaDataRetentionSettings.

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<GoogleAnalyticsAdminV1alphaDataRetentionSettings>
    updateDataRetentionSettings(
  GoogleAnalyticsAdminV1alphaDataRetentionSettings 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 = 'v1alpha/' + core.Uri.encodeFull('$name');

  final _response = await _requester.request(
    _url,
    'PATCH',
    body: _body,
    queryParams: _queryParams,
  );
  return GoogleAnalyticsAdminV1alphaDataRetentionSettings.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}