get method

Future<GoogleCloudApigeeV1Export> get(
  1. String name, {
  2. String? $fields,
})

Gets the details and status of an analytics export job.

If the export job is still in progress, its state is set to "running". After the export job has completed successfully, its state is set to "completed". If the export job fails, its state is set to failed.

Request parameters:

name - Required. Resource name of the export to get. Value must have pattern ^organizations/\[^/\]+/environments/\[^/\]+/analytics/exports/\[^/\]+$.

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

Completes with a GoogleCloudApigeeV1Export.

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<GoogleCloudApigeeV1Export> get(
  core.String name, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GoogleCloudApigeeV1Export.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}