Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(182)

Unified Diff: generated/googleapis/lib/admin/reports_v1.dart

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « generated/googleapis/lib/admin/directory_v1.dart ('k') | generated/googleapis/lib/adsense/v1_4.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: generated/googleapis/lib/admin/reports_v1.dart
diff --git a/generated/googleapis/lib/admin/reports_v1.dart b/generated/googleapis/lib/admin/reports_v1.dart
index 60aae5cc4db6d13ed9a21aff9cc13b65ac5913c1..ca7cdd0adcfaa9b6e640c02ed84b49181f8d360a 100644
--- a/generated/googleapis/lib/admin/reports_v1.dart
+++ b/generated/googleapis/lib/admin/reports_v1.dart
@@ -9,90 +9,101 @@ import 'dart:convert' as convert;
import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;
-export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
- ApiRequestError, DetailedApiRequestError;
+export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
+ show ApiRequestError, DetailedApiRequestError;
const core.String USER_AGENT = 'dart-api-client admin/reports_v1';
-/**
- * Fetches reports for the administrators of G Suite customers about the usage,
- * collaboration, security, and risk for their users.
- */
+/// Fetches reports for the administrators of G Suite customers about the
+/// usage, collaboration, security, and risk for their users.
class AdminApi {
- /** View audit reports for your G Suite domain */
- static const AdminReportsAuditReadonlyScope = "https://www.googleapis.com/auth/admin.reports.audit.readonly";
-
- /** View usage reports for your G Suite domain */
- static const AdminReportsUsageReadonlyScope = "https://www.googleapis.com/auth/admin.reports.usage.readonly";
+ /// View audit reports for your G Suite domain
+ static const AdminReportsAuditReadonlyScope =
+ "https://www.googleapis.com/auth/admin.reports.audit.readonly";
+ /// View usage reports for your G Suite domain
+ static const AdminReportsUsageReadonlyScope =
+ "https://www.googleapis.com/auth/admin.reports.usage.readonly";
final commons.ApiRequester _requester;
ActivitiesResourceApi get activities => new ActivitiesResourceApi(_requester);
ChannelsResourceApi get channels => new ChannelsResourceApi(_requester);
- CustomerUsageReportsResourceApi get customerUsageReports => new CustomerUsageReportsResourceApi(_requester);
- UserUsageReportResourceApi get userUsageReport => new UserUsageReportResourceApi(_requester);
-
- AdminApi(http.Client client, {core.String rootUrl: "https://www.googleapis.com/", core.String servicePath: "admin/reports/v1/"}) :
- _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
+ CustomerUsageReportsResourceApi get customerUsageReports =>
+ new CustomerUsageReportsResourceApi(_requester);
+ UserUsageReportResourceApi get userUsageReport =>
+ new UserUsageReportResourceApi(_requester);
+
+ AdminApi(http.Client client,
+ {core.String rootUrl: "https://www.googleapis.com/",
+ core.String servicePath: "admin/reports/v1/"})
+ : _requester =
+ new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
}
-
class ActivitiesResourceApi {
final commons.ApiRequester _requester;
- ActivitiesResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Retrieves a list of activities for a specific customer and application.
- *
- * Request parameters:
- *
- * [userKey] - Represents the profile id or the user email for which the data
- * should be filtered. When 'all' is specified as the userKey, it returns
- * usageReports for all users.
- *
- * [applicationName] - Application name for which the events are to be
- * retrieved.
- * Value must have pattern
- * "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)".
- *
- * [actorIpAddress] - IP Address of host where the event was performed.
- * Supports both IPv4 and IPv6 addresses.
- *
- * [customerId] - Represents the customer for which the data is to be fetched.
- * Value must have pattern "C.+".
- *
- * [endTime] - Return events which occurred at or before this time.
- * Value must have pattern
- * "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\d):(\d\d))".
- *
- * [eventName] - Name of the event being queried.
- *
- * [filters] - Event parameters in the form [parameter1
- * name][operator][parameter1 value],[parameter2 name][operator][parameter2
- * value],...
- * Value must have pattern "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)".
- *
- * [maxResults] - Number of activity records to be shown in each page.
- * Value must be between "1" and "1000".
- *
- * [pageToken] - Token to specify next page.
- *
- * [startTime] - Return events which occurred at or after this time.
- * Value must have pattern
- * "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\d):(\d\d))".
- *
- * Completes with a [Activities].
- *
- * 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.
- */
- async.Future<Activities> list(core.String userKey, core.String applicationName, {core.String actorIpAddress, core.String customerId, core.String endTime, core.String eventName, core.String filters, core.int maxResults, core.String pageToken, core.String startTime}) {
+ ActivitiesResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// Retrieves a list of activities for a specific customer and application.
+ ///
+ /// Request parameters:
+ ///
+ /// [userKey] - Represents the profile id or the user email for which the
+ /// data should be filtered. When 'all' is specified as the userKey, it
+ /// returns usageReports for all users.
+ ///
+ /// [applicationName] - Application name for which the events are to be
+ /// retrieved.
+ /// Value must have pattern
+ /// "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)".
+ ///
+ /// [actorIpAddress] - IP Address of host where the event was performed.
+ /// Supports both IPv4 and IPv6 addresses.
+ ///
+ /// [customerId] - Represents the customer for which the data is to be
+ /// fetched.
+ /// Value must have pattern "C.+".
+ ///
+ /// [endTime] - Return events which occurred at or before this time.
+ /// Value must have pattern
+ /// "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\d):(\d\d))".
+ ///
+ /// [eventName] - Name of the event being queried.
+ ///
+ /// [filters] - Event parameters in the form [parameter1
+ /// name][operator][parameter1 value],[parameter2 name][operator][parameter2
+ /// value],...
+ /// Value must have pattern
+ /// "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)".
+ ///
+ /// [maxResults] - Number of activity records to be shown in each page.
+ /// Value must be between "1" and "1000".
+ ///
+ /// [pageToken] - Token to specify next page.
+ ///
+ /// [startTime] - Return events which occurred at or after this time.
+ /// Value must have pattern
+ /// "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\d):(\d\d))".
+ ///
+ /// Completes with a [Activities].
+ ///
+ /// 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.
+ async.Future<Activities> list(
+ core.String userKey, core.String applicationName,
+ {core.String actorIpAddress,
+ core.String customerId,
+ core.String endTime,
+ core.String eventName,
+ core.String filters,
+ core.int maxResults,
+ core.String pageToken,
+ core.String startTime}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -131,69 +142,80 @@ class ActivitiesResourceApi {
_queryParams["startTime"] = [startTime];
}
- _url = 'activity/users/' + commons.Escaper.ecapeVariable('$userKey') + '/applications/' + commons.Escaper.ecapeVariable('$applicationName');
+ _url = 'activity/users/' +
+ commons.Escaper.ecapeVariable('$userKey') +
+ '/applications/' +
+ commons.Escaper.ecapeVariable('$applicationName');
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Activities.fromJson(data));
}
- /**
- * Push changes to activities
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [userKey] - Represents the profile id or the user email for which the data
- * should be filtered. When 'all' is specified as the userKey, it returns
- * usageReports for all users.
- *
- * [applicationName] - Application name for which the events are to be
- * retrieved.
- * Value must have pattern
- * "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)".
- *
- * [actorIpAddress] - IP Address of host where the event was performed.
- * Supports both IPv4 and IPv6 addresses.
- *
- * [customerId] - Represents the customer for which the data is to be fetched.
- * Value must have pattern "C.+".
- *
- * [endTime] - Return events which occurred at or before this time.
- * Value must have pattern
- * "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\d):(\d\d))".
- *
- * [eventName] - Name of the event being queried.
- *
- * [filters] - Event parameters in the form [parameter1
- * name][operator][parameter1 value],[parameter2 name][operator][parameter2
- * value],...
- * Value must have pattern "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)".
- *
- * [maxResults] - Number of activity records to be shown in each page.
- * Value must be between "1" and "1000".
- *
- * [pageToken] - Token to specify next page.
- *
- * [startTime] - Return events which occurred at or after this time.
- * Value must have pattern
- * "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\d):(\d\d))".
- *
- * Completes with a [Channel].
- *
- * 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.
- */
- async.Future<Channel> watch(Channel request, core.String userKey, core.String applicationName, {core.String actorIpAddress, core.String customerId, core.String endTime, core.String eventName, core.String filters, core.int maxResults, core.String pageToken, core.String startTime}) {
+ /// Push changes to activities
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [userKey] - Represents the profile id or the user email for which the
+ /// data should be filtered. When 'all' is specified as the userKey, it
+ /// returns usageReports for all users.
+ ///
+ /// [applicationName] - Application name for which the events are to be
+ /// retrieved.
+ /// Value must have pattern
+ /// "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)".
+ ///
+ /// [actorIpAddress] - IP Address of host where the event was performed.
+ /// Supports both IPv4 and IPv6 addresses.
+ ///
+ /// [customerId] - Represents the customer for which the data is to be
+ /// fetched.
+ /// Value must have pattern "C.+".
+ ///
+ /// [endTime] - Return events which occurred at or before this time.
+ /// Value must have pattern
+ /// "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\d):(\d\d))".
+ ///
+ /// [eventName] - Name of the event being queried.
+ ///
+ /// [filters] - Event parameters in the form [parameter1
+ /// name][operator][parameter1 value],[parameter2 name][operator][parameter2
+ /// value],...
+ /// Value must have pattern
+ /// "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)".
+ ///
+ /// [maxResults] - Number of activity records to be shown in each page.
+ /// Value must be between "1" and "1000".
+ ///
+ /// [pageToken] - Token to specify next page.
+ ///
+ /// [startTime] - Return events which occurred at or after this time.
+ /// Value must have pattern
+ /// "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\d):(\d\d))".
+ ///
+ /// Completes with a [Channel].
+ ///
+ /// 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.
+ async.Future<Channel> watch(
+ Channel request, core.String userKey, core.String applicationName,
+ {core.String actorIpAddress,
+ core.String customerId,
+ core.String endTime,
+ core.String eventName,
+ core.String filters,
+ core.int maxResults,
+ core.String pageToken,
+ core.String startTime}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -235,40 +257,38 @@ class ActivitiesResourceApi {
_queryParams["startTime"] = [startTime];
}
- _url = 'activity/users/' + commons.Escaper.ecapeVariable('$userKey') + '/applications/' + commons.Escaper.ecapeVariable('$applicationName') + '/watch';
+ _url = 'activity/users/' +
+ commons.Escaper.ecapeVariable('$userKey') +
+ '/applications/' +
+ commons.Escaper.ecapeVariable('$applicationName') +
+ '/watch';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Channel.fromJson(data));
}
-
}
-
class ChannelsResourceApi {
final commons.ApiRequester _requester;
- ChannelsResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Stop watching resources through this channel
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * 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.
- */
+ ChannelsResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// Stop watching resources through this channel
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// 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.
async.Future stop(Channel request) {
var _url = null;
var _queryParams = new core.Map();
@@ -285,54 +305,51 @@ class ChannelsResourceApi {
_url = '/admin/reports_v1/channels/stop';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => null);
}
-
}
-
class CustomerUsageReportsResourceApi {
final commons.ApiRequester _requester;
- CustomerUsageReportsResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Retrieves a report which is a collection of properties / statistics for a
- * specific customer.
- *
- * Request parameters:
- *
- * [date] - Represents the date in yyyy-mm-dd format for which the data is to
- * be fetched.
- * Value must have pattern "(\d){4}-(\d){2}-(\d){2}".
- *
- * [customerId] - Represents the customer for which the data is to be fetched.
- * Value must have pattern "C.+".
- *
- * [pageToken] - Token to specify next page.
- *
- * [parameters] - Represents the application name, parameter name pairs to
- * fetch in csv as app_name1:param_name1, app_name2:param_name2.
- * Value must have pattern
- * "(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)".
- *
- * Completes with a [UsageReports].
- *
- * 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.
- */
- async.Future<UsageReports> get(core.String date, {core.String customerId, core.String pageToken, core.String parameters}) {
+ CustomerUsageReportsResourceApi(commons.ApiRequester client)
+ : _requester = client;
+
+ /// Retrieves a report which is a collection of properties / statistics for a
+ /// specific customer.
+ ///
+ /// Request parameters:
+ ///
+ /// [date] - Represents the date in yyyy-mm-dd format for which the data is
+ /// to be fetched.
+ /// Value must have pattern "(\d){4}-(\d){2}-(\d){2}".
+ ///
+ /// [customerId] - Represents the customer for which the data is to be
+ /// fetched.
+ /// Value must have pattern "C.+".
+ ///
+ /// [pageToken] - Token to specify next page.
+ ///
+ /// [parameters] - Represents the application name, parameter name pairs to
+ /// fetch in csv as app_name1:param_name1, app_name2:param_name2.
+ /// Value must have pattern
+ /// "(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)".
+ ///
+ /// Completes with a [UsageReports].
+ ///
+ /// 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.
+ async.Future<UsageReports> get(core.String date,
+ {core.String customerId, core.String pageToken, core.String parameters}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -355,64 +372,65 @@ class CustomerUsageReportsResourceApi {
_url = 'usage/dates/' + commons.Escaper.ecapeVariable('$date');
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new UsageReports.fromJson(data));
}
-
}
-
class UserUsageReportResourceApi {
final commons.ApiRequester _requester;
- UserUsageReportResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Retrieves a report which is a collection of properties / statistics for a
- * set of users.
- *
- * Request parameters:
- *
- * [userKey] - Represents the profile id or the user email for which the data
- * should be filtered.
- *
- * [date] - Represents the date in yyyy-mm-dd format for which the data is to
- * be fetched.
- * Value must have pattern "(\d){4}-(\d){2}-(\d){2}".
- *
- * [customerId] - Represents the customer for which the data is to be fetched.
- * Value must have pattern "C.+".
- *
- * [filters] - Represents the set of filters including parameter operator
- * value.
- * Value must have pattern
- * "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)".
- *
- * [maxResults] - Maximum number of results to return. Maximum allowed is 1000
- *
- * [pageToken] - Token to specify next page.
- *
- * [parameters] - Represents the application name, parameter name pairs to
- * fetch in csv as app_name1:param_name1, app_name2:param_name2.
- * Value must have pattern
- * "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)".
- *
- * Completes with a [UsageReports].
- *
- * 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.
- */
- async.Future<UsageReports> get(core.String userKey, core.String date, {core.String customerId, core.String filters, core.int maxResults, core.String pageToken, core.String parameters}) {
+ UserUsageReportResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// Retrieves a report which is a collection of properties / statistics for a
+ /// set of users.
+ ///
+ /// Request parameters:
+ ///
+ /// [userKey] - Represents the profile id or the user email for which the
+ /// data should be filtered.
+ ///
+ /// [date] - Represents the date in yyyy-mm-dd format for which the data is
+ /// to be fetched.
+ /// Value must have pattern "(\d){4}-(\d){2}-(\d){2}".
+ ///
+ /// [customerId] - Represents the customer for which the data is to be
+ /// fetched.
+ /// Value must have pattern "C.+".
+ ///
+ /// [filters] - Represents the set of filters including parameter operator
+ /// value.
+ /// Value must have pattern
+ /// "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)".
+ ///
+ /// [maxResults] - Maximum number of results to return. Maximum allowed is
+ /// 1000
+ ///
+ /// [pageToken] - Token to specify next page.
+ ///
+ /// [parameters] - Represents the application name, parameter name pairs to
+ /// fetch in csv as app_name1:param_name1, app_name2:param_name2.
+ /// Value must have pattern
+ /// "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)".
+ ///
+ /// Completes with a [UsageReports].
+ ///
+ /// 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.
+ async.Future<UsageReports> get(core.String userKey, core.String date,
+ {core.String customerId,
+ core.String filters,
+ core.int maxResults,
+ core.String pageToken,
+ core.String parameters}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -442,31 +460,33 @@ class UserUsageReportResourceApi {
_queryParams["parameters"] = [parameters];
}
- _url = 'usage/users/' + commons.Escaper.ecapeVariable('$userKey') + '/dates/' + commons.Escaper.ecapeVariable('$date');
+ _url = 'usage/users/' +
+ commons.Escaper.ecapeVariable('$userKey') +
+ '/dates/' +
+ commons.Escaper.ecapeVariable('$date');
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new UsageReports.fromJson(data));
}
-
}
-
-
-/** JSON template for a collection of activites. */
+/// JSON template for a collection of activites.
class Activities {
- /** ETag of the resource. */
+ /// ETag of the resource.
core.String etag;
- /** Each record in read response. */
+
+ /// Each record in read response.
core.List<Activity> items;
- /** Kind of list response this is. */
+
+ /// Kind of list response this is.
core.String kind;
- /** Token for retrieving the next page */
+
+ /// Token for retrieving the next page
core.String nextPageToken;
Activities();
@@ -476,7 +496,8 @@ class Activities {
etag = _json["etag"];
}
if (_json.containsKey("items")) {
- items = _json["items"].map((value) => new Activity.fromJson(value)).toList();
+ items =
+ _json["items"].map((value) => new Activity.fromJson(value)).toList();
}
if (_json.containsKey("kind")) {
kind = _json["kind"];
@@ -487,7 +508,8 @@ class Activities {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (etag != null) {
_json["etag"] = etag;
}
@@ -504,15 +526,18 @@ class Activities {
}
}
-/** User doing the action. */
+/// User doing the action.
class ActivityActor {
- /** User or OAuth 2LO request. */
+ /// User or OAuth 2LO request.
core.String callerType;
- /** Email address of the user. */
+
+ /// Email address of the user.
core.String email;
- /** For OAuth 2LO API requests, consumer_key of the requestor. */
+
+ /// For OAuth 2LO API requests, consumer_key of the requestor.
core.String key;
- /** Obfuscated user id of the user. */
+
+ /// Obfuscated user id of the user.
core.String profileId;
ActivityActor();
@@ -533,7 +558,8 @@ class ActivityActor {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (callerType != null) {
_json["callerType"] = callerType;
}
@@ -551,17 +577,22 @@ class ActivityActor {
}
class ActivityEventsParameters {
- /** Boolean value of the parameter. */
+ /// Boolean value of the parameter.
core.bool boolValue;
- /** Integral value of the parameter. */
+
+ /// Integral value of the parameter.
core.String intValue;
- /** Multi-int value of the parameter. */
+
+ /// Multi-int value of the parameter.
core.List<core.String> multiIntValue;
- /** Multi-string value of the parameter. */
+
+ /// Multi-string value of the parameter.
core.List<core.String> multiValue;
- /** The name of the parameter. */
+
+ /// The name of the parameter.
core.String name;
- /** String value of the parameter. */
+
+ /// String value of the parameter.
core.String value;
ActivityEventsParameters();
@@ -588,7 +619,8 @@ class ActivityEventsParameters {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (boolValue != null) {
_json["boolValue"] = boolValue;
}
@@ -612,11 +644,13 @@ class ActivityEventsParameters {
}
class ActivityEvents {
- /** Name of event. */
+ /// Name of event.
core.String name;
- /** Parameter value pairs for various applications. */
+
+ /// Parameter value pairs for various applications.
core.List<ActivityEventsParameters> parameters;
- /** Type of event. */
+
+ /// Type of event.
core.String type;
ActivityEvents();
@@ -626,7 +660,9 @@ class ActivityEvents {
name = _json["name"];
}
if (_json.containsKey("parameters")) {
- parameters = _json["parameters"].map((value) => new ActivityEventsParameters.fromJson(value)).toList();
+ parameters = _json["parameters"]
+ .map((value) => new ActivityEventsParameters.fromJson(value))
+ .toList();
}
if (_json.containsKey("type")) {
type = _json["type"];
@@ -634,12 +670,14 @@ class ActivityEvents {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (name != null) {
_json["name"] = name;
}
if (parameters != null) {
- _json["parameters"] = parameters.map((value) => (value).toJson()).toList();
+ _json["parameters"] =
+ parameters.map((value) => (value).toJson()).toList();
}
if (type != null) {
_json["type"] = type;
@@ -648,15 +686,18 @@ class ActivityEvents {
}
}
-/** Unique identifier for each activity record. */
+/// Unique identifier for each activity record.
class ActivityId {
- /** Application name to which the event belongs. */
+ /// Application name to which the event belongs.
core.String applicationName;
- /** Obfuscated customer ID of the source customer. */
+
+ /// Obfuscated customer ID of the source customer.
core.String customerId;
- /** Time of occurrence of the activity. */
+
+ /// Time of occurrence of the activity.
core.DateTime time;
- /** Unique qualifier if multiple events have the same time. */
+
+ /// Unique qualifier if multiple events have the same time.
core.String uniqueQualifier;
ActivityId();
@@ -677,7 +718,8 @@ class ActivityId {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (applicationName != null) {
_json["applicationName"] = applicationName;
}
@@ -694,21 +736,27 @@ class ActivityId {
}
}
-/** JSON template for the activity resource. */
+/// JSON template for the activity resource.
class Activity {
- /** User doing the action. */
+ /// User doing the action.
ActivityActor actor;
- /** ETag of the entry. */
+
+ /// ETag of the entry.
core.String etag;
- /** Activity events. */
+
+ /// Activity events.
core.List<ActivityEvents> events;
- /** Unique identifier for each activity record. */
+
+ /// Unique identifier for each activity record.
ActivityId id;
- /** IP Address of the user doing the action. */
+
+ /// IP Address of the user doing the action.
core.String ipAddress;
- /** Kind of resource this is. */
+
+ /// Kind of resource this is.
core.String kind;
- /** Domain of source customer. */
+
+ /// Domain of source customer.
core.String ownerDomain;
Activity();
@@ -721,7 +769,9 @@ class Activity {
etag = _json["etag"];
}
if (_json.containsKey("events")) {
- events = _json["events"].map((value) => new ActivityEvents.fromJson(value)).toList();
+ events = _json["events"]
+ .map((value) => new ActivityEvents.fromJson(value))
+ .toList();
}
if (_json.containsKey("id")) {
id = new ActivityId.fromJson(_json["id"]);
@@ -738,7 +788,8 @@ class Activity {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (actor != null) {
_json["actor"] = (actor).toJson();
}
@@ -764,39 +815,40 @@ class Activity {
}
}
-/** An notification channel used to watch for resource changes. */
+/// An notification channel used to watch for resource changes.
class Channel {
- /** The address where notifications are delivered for this channel. */
+ /// The address where notifications are delivered for this channel.
core.String address;
- /**
- * Date and time of notification channel expiration, expressed as a Unix
- * timestamp, in milliseconds. Optional.
- */
+
+ /// Date and time of notification channel expiration, expressed as a Unix
+ /// timestamp, in milliseconds. Optional.
core.String expiration;
- /** A UUID or similar unique string that identifies this channel. */
+
+ /// A UUID or similar unique string that identifies this channel.
core.String id;
- /**
- * Identifies this as a notification channel used to watch for changes to a
- * resource. Value: the fixed string "api#channel".
- */
+
+ /// Identifies this as a notification channel used to watch for changes to a
+ /// resource. Value: the fixed string "api#channel".
core.String kind;
- /** Additional parameters controlling delivery channel behavior. Optional. */
+
+ /// Additional parameters controlling delivery channel behavior. Optional.
core.Map<core.String, core.String> params;
- /** A Boolean value to indicate whether payload is wanted. Optional. */
+
+ /// A Boolean value to indicate whether payload is wanted. Optional.
core.bool payload;
- /**
- * An opaque ID that identifies the resource being watched on this channel.
- * Stable across different API versions.
- */
+
+ /// An opaque ID that identifies the resource being watched on this channel.
+ /// Stable across different API versions.
core.String resourceId;
- /** A version-specific identifier for the watched resource. */
+
+ /// A version-specific identifier for the watched resource.
core.String resourceUri;
- /**
- * An arbitrary string delivered to the target address with each notification
- * delivered over this channel. Optional.
- */
+
+ /// An arbitrary string delivered to the target address with each
+ /// notification delivered over this channel. Optional.
core.String token;
- /** The type of delivery mechanism used for this channel. */
+
+ /// The type of delivery mechanism used for this channel.
core.String type;
Channel();
@@ -835,7 +887,8 @@ class Channel {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (address != null) {
_json["address"] = address;
}
@@ -870,15 +923,18 @@ class Channel {
}
}
-/** Information about the type of the item. */
+/// Information about the type of the item.
class UsageReportEntity {
- /** Obfuscated customer id for the record. */
+ /// Obfuscated customer id for the record.
core.String customerId;
- /** Obfuscated user id for the record. */
+
+ /// Obfuscated user id for the record.
core.String profileId;
- /** The type of item, can be a customer or user. */
+
+ /// The type of item, can be a customer or user.
core.String type;
- /** user's email. */
+
+ /// user's email.
core.String userEmail;
UsageReportEntity();
@@ -899,7 +955,8 @@ class UsageReportEntity {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (customerId != null) {
_json["customerId"] = customerId;
}
@@ -917,22 +974,25 @@ class UsageReportEntity {
}
class UsageReportParameters {
- /** Boolean value of the parameter. */
+ /// Boolean value of the parameter.
core.bool boolValue;
- /** RFC 3339 formatted value of the parameter. */
+
+ /// RFC 3339 formatted value of the parameter.
core.DateTime datetimeValue;
- /** Integral value of the parameter. */
+
+ /// Integral value of the parameter.
core.String intValue;
- /**
- * Nested message value of the parameter.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// Nested message value of the parameter.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.List<core.Map<core.String, core.Object>> msgValue;
- /** The name of the parameter. */
+
+ /// The name of the parameter.
core.String name;
- /** String value of the parameter. */
+
+ /// String value of the parameter.
core.String stringValue;
UsageReportParameters();
@@ -959,7 +1019,8 @@ class UsageReportParameters {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (boolValue != null) {
_json["boolValue"] = boolValue;
}
@@ -982,17 +1043,21 @@ class UsageReportParameters {
}
}
-/** JSON template for a usage report. */
+/// JSON template for a usage report.
class UsageReport {
- /** The date to which the record belongs. */
+ /// The date to which the record belongs.
core.String date;
- /** Information about the type of the item. */
+
+ /// Information about the type of the item.
UsageReportEntity entity;
- /** ETag of the resource. */
+
+ /// ETag of the resource.
core.String etag;
- /** The kind of object. */
+
+ /// The kind of object.
core.String kind;
- /** Parameter value pairs for various applications. */
+
+ /// Parameter value pairs for various applications.
core.List<UsageReportParameters> parameters;
UsageReport();
@@ -1011,12 +1076,15 @@ class UsageReport {
kind = _json["kind"];
}
if (_json.containsKey("parameters")) {
- parameters = _json["parameters"].map((value) => new UsageReportParameters.fromJson(value)).toList();
+ parameters = _json["parameters"]
+ .map((value) => new UsageReportParameters.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (date != null) {
_json["date"] = date;
}
@@ -1030,22 +1098,20 @@ class UsageReport {
_json["kind"] = kind;
}
if (parameters != null) {
- _json["parameters"] = parameters.map((value) => (value).toJson()).toList();
+ _json["parameters"] =
+ parameters.map((value) => (value).toJson()).toList();
}
return _json;
}
}
class UsageReportsWarningsData {
- /**
- * Key associated with a key-value pair to give detailed information on the
- * warning.
- */
+ /// Key associated with a key-value pair to give detailed information on the
+ /// warning.
core.String key;
- /**
- * Value associated with a key-value pair to give detailed information on the
- * warning.
- */
+
+ /// Value associated with a key-value pair to give detailed information on
+ /// the warning.
core.String value;
UsageReportsWarningsData();
@@ -1060,7 +1126,8 @@ class UsageReportsWarningsData {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (key != null) {
_json["key"] = key;
}
@@ -1072,11 +1139,13 @@ class UsageReportsWarningsData {
}
class UsageReportsWarnings {
- /** Machine readable code / warning type. */
+ /// Machine readable code / warning type.
core.String code;
- /** Key-Value pairs to give detailed information on the warning. */
+
+ /// Key-Value pairs to give detailed information on the warning.
core.List<UsageReportsWarningsData> data;
- /** Human readable message for the warning. */
+
+ /// Human readable message for the warning.
core.String message;
UsageReportsWarnings();
@@ -1086,7 +1155,9 @@ class UsageReportsWarnings {
code = _json["code"];
}
if (_json.containsKey("data")) {
- data = _json["data"].map((value) => new UsageReportsWarningsData.fromJson(value)).toList();
+ data = _json["data"]
+ .map((value) => new UsageReportsWarningsData.fromJson(value))
+ .toList();
}
if (_json.containsKey("message")) {
message = _json["message"];
@@ -1094,7 +1165,8 @@ class UsageReportsWarnings {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (code != null) {
_json["code"] = code;
}
@@ -1108,17 +1180,21 @@ class UsageReportsWarnings {
}
}
-/** JSON template for a collection of usage reports. */
+/// JSON template for a collection of usage reports.
class UsageReports {
- /** ETag of the resource. */
+ /// ETag of the resource.
core.String etag;
- /** The kind of object. */
+
+ /// The kind of object.
core.String kind;
- /** Token for retrieving the next page */
+
+ /// Token for retrieving the next page
core.String nextPageToken;
- /** Various application parameter records. */
+
+ /// Various application parameter records.
core.List<UsageReport> usageReports;
- /** Warnings if any. */
+
+ /// Warnings if any.
core.List<UsageReportsWarnings> warnings;
UsageReports();
@@ -1134,15 +1210,20 @@ class UsageReports {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("usageReports")) {
- usageReports = _json["usageReports"].map((value) => new UsageReport.fromJson(value)).toList();
+ usageReports = _json["usageReports"]
+ .map((value) => new UsageReport.fromJson(value))
+ .toList();
}
if (_json.containsKey("warnings")) {
- warnings = _json["warnings"].map((value) => new UsageReportsWarnings.fromJson(value)).toList();
+ warnings = _json["warnings"]
+ .map((value) => new UsageReportsWarnings.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (etag != null) {
_json["etag"] = etag;
}
@@ -1153,7 +1234,8 @@ class UsageReports {
_json["nextPageToken"] = nextPageToken;
}
if (usageReports != null) {
- _json["usageReports"] = usageReports.map((value) => (value).toJson()).toList();
+ _json["usageReports"] =
+ usageReports.map((value) => (value).toJson()).toList();
}
if (warnings != null) {
_json["warnings"] = warnings.map((value) => (value).toJson()).toList();
« no previous file with comments | « generated/googleapis/lib/admin/directory_v1.dart ('k') | generated/googleapis/lib/adsense/v1_4.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698