getMetadata method

Future<AlertMetadata> getMetadata(
  1. String alertId, {
  2. String? customerId,
  3. String? $fields,
})

Returns the metadata of an alert.

Attempting to get metadata for a non-existent alert returns NOT_FOUND error.

Request parameters:

alertId - Required. The identifier of the alert this metadata belongs to.

customerId - Optional. The unique identifier of the Google Workspace organization account of the customer the alert metadata is associated with. Inferred from the caller identity if not provided.

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

Completes with a AlertMetadata.

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<AlertMetadata> getMetadata(
  core.String alertId, {
  core.String? customerId,
  core.String? $fields,
}) async {
  final _queryParams = <core.String, core.List<core.String>>{
    if (customerId != null) 'customerId': [customerId],
    if ($fields != null) 'fields': [$fields],
  };

  final _url =
      'v1beta1/alerts/' + commons.escapeVariable('$alertId') + '/metadata';

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