Api-roll 47: 2017-03-27

generated/googleapis/lib/logging/v2.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.logging.v2;
 
 import 'dart:core' as core;
 import 'dart:async' as async;
 import 'dart:convert' as convert;
 
 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
 import 'package:http/http.dart' as http;
@@ skipping 109 matching lines @@
    * Request parameters:
    *
    * [parent] - Required. The resource name that owns the logs:
    * "projects/[PROJECT_ID]"
    * "organizations/[ORGANIZATION_ID]"
    * "billingAccounts/[BILLING_ACCOUNT_ID]"
    * "folders/[FOLDER_ID]"
    *
    * Value must have pattern "^billingAccounts/[^/]+$".
    *
+   * [pageSize] - Optional. The maximum number of results to return from this
+   * request. Non-positive values are ignored. The presence of nextPageToken in
+   * the response indicates that more results might be available.
+   *
    * [pageToken] - Optional. If present, then retrieve the next batch of results
    * from the preceding call to this method. pageToken must be the value of
    * nextPageToken from the previous response. The values of other method
    * parameters should be identical to those in the previous call.
    *
-   * [pageSize] - Optional. The maximum number of results to return from this
-   * request. Non-positive values are ignored. The presence of nextPageToken in
-   * the response indicates that more results might be available.
-   *
    * Completes with a [ListLogsResponse].
    *
    * 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<ListLogsResponse> list(core.String parent, {core.String pageToken, core.int pageSize}) {
+  async.Future<ListLogsResponse> list(core.String parent, {core.int pageSize, core.String pageToken}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (parent == null) {
       throw new core.ArgumentError("Parameter parent is required.");
     }
+    if (pageSize != null) {
+      _queryParams["pageSize"] = ["${pageSize}"];
+    }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
-    if (pageSize != null) {
-      _queryParams["pageSize"] = ["${pageSize}"];
-    }
 
     _url = 'v2/' + commons.Escaper.ecapeVariableReserved('$parent') + '/logs';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 341 matching lines @@
                                        "POST",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new ListLogEntriesResponse.fromJson(data));
   }
 
   /**
-   * Writes log entries to Stackdriver Logging. All log entries are written by
-   * this method.
+   * Writes log entries to Stackdriver Logging.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * Completes with a [WriteLogEntriesResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
@@ skipping 330 matching lines @@
    * Request parameters:
    *
    * [parent] - Required. The parent resource whose sinks are to be listed:
    * "projects/[PROJECT_ID]"
    * "organizations/[ORGANIZATION_ID]"
    * "billingAccounts/[BILLING_ACCOUNT_ID]"
    * "folders/[FOLDER_ID]"
    *
    * Value must have pattern "^folders/[^/]+$".
    *
+   * [pageSize] - Optional. The maximum number of results to return from this
+   * request. Non-positive values are ignored. The presence of nextPageToken in
+   * the response indicates that more results might be available.
+   *
    * [pageToken] - Optional. If present, then retrieve the next batch of results
    * from the preceding call to this method. pageToken must be the value of
    * nextPageToken from the previous response. The values of other method
    * parameters should be identical to those in the previous call.
    *
-   * [pageSize] - Optional. The maximum number of results to return from this
-   * request. Non-positive values are ignored. The presence of nextPageToken in
-   * the response indicates that more results might be available.
-   *
    * Completes with a [ListSinksResponse].
    *
    * 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<ListSinksResponse> list(core.String parent, {core.String pageToken, core.int pageSize}) {
+  async.Future<ListSinksResponse> list(core.String parent, {core.int pageSize, core.String pageToken}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (parent == null) {
       throw new core.ArgumentError("Parameter parent is required.");
     }
+    if (pageSize != null) {
+      _queryParams["pageSize"] = ["${pageSize}"];
+    }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
-    if (pageSize != null) {
-      _queryParams["pageSize"] = ["${pageSize}"];
-    }
 
     _url = 'v2/' + commons.Escaper.ecapeVariableReserved('$parent') + '/sinks';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 205 matching lines @@
    * Request parameters:
    *
    * [parent] - Required. The resource name that owns the logs:
    * "projects/[PROJECT_ID]"
    * "organizations/[ORGANIZATION_ID]"
    * "billingAccounts/[BILLING_ACCOUNT_ID]"
    * "folders/[FOLDER_ID]"
    *
    * Value must have pattern "^organizations/[^/]+$".
    *
+   * [pageSize] - Optional. The maximum number of results to return from this
+   * request. Non-positive values are ignored. The presence of nextPageToken in
+   * the response indicates that more results might be available.
+   *
    * [pageToken] - Optional. If present, then retrieve the next batch of results
    * from the preceding call to this method. pageToken must be the value of
    * nextPageToken from the previous response. The values of other method
    * parameters should be identical to those in the previous call.
    *
-   * [pageSize] - Optional. The maximum number of results to return from this
-   * request. Non-positive values are ignored. The presence of nextPageToken in
-   * the response indicates that more results might be available.
-   *
    * Completes with a [ListLogsResponse].
    *
    * 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<ListLogsResponse> list(core.String parent, {core.String pageToken, core.int pageSize}) {
+  async.Future<ListLogsResponse> list(core.String parent, {core.int pageSize, core.String pageToken}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (parent == null) {
       throw new core.ArgumentError("Parameter parent is required.");
     }
+    if (pageSize != null) {
+      _queryParams["pageSize"] = ["${pageSize}"];
+    }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
-    if (pageSize != null) {
-      _queryParams["pageSize"] = ["${pageSize}"];
-    }
 
     _url = 'v2/' + commons.Escaper.ecapeVariableReserved('$parent') + '/logs';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 175 matching lines @@
    * Request parameters:
    *
    * [parent] - Required. The parent resource whose sinks are to be listed:
    * "projects/[PROJECT_ID]"
    * "organizations/[ORGANIZATION_ID]"
    * "billingAccounts/[BILLING_ACCOUNT_ID]"
    * "folders/[FOLDER_ID]"
    *
    * Value must have pattern "^organizations/[^/]+$".
    *
+   * [pageSize] - Optional. The maximum number of results to return from this
+   * request. Non-positive values are ignored. The presence of nextPageToken in
+   * the response indicates that more results might be available.
+   *
    * [pageToken] - Optional. If present, then retrieve the next batch of results
    * from the preceding call to this method. pageToken must be the value of
    * nextPageToken from the previous response. The values of other method
    * parameters should be identical to those in the previous call.
    *
-   * [pageSize] - Optional. The maximum number of results to return from this
-   * request. Non-positive values are ignored. The presence of nextPageToken in
-   * the response indicates that more results might be available.
-   *
    * Completes with a [ListSinksResponse].
    *
    * 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<ListSinksResponse> list(core.String parent, {core.String pageToken, core.int pageSize}) {
+  async.Future<ListSinksResponse> list(core.String parent, {core.int pageSize, core.String pageToken}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (parent == null) {
       throw new core.ArgumentError("Parameter parent is required.");
     }
+    if (pageSize != null) {
+      _queryParams["pageSize"] = ["${pageSize}"];
+    }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
-    if (pageSize != null) {
-      _queryParams["pageSize"] = ["${pageSize}"];
-    }
 
     _url = 'v2/' + commons.Escaper.ecapeVariableReserved('$parent') + '/sinks';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 992 matching lines @@
    * cause the filter to return no results. The maximum length of the filter is
    * 20000 characters.
    */
   core.String filter;
   /**
    * Optional. How the results should be sorted. Presently, the only permitted
    * values are "timestamp asc" (default) and "timestamp desc". The first option
    * returns entries in order of increasing values of LogEntry.timestamp (oldest
    * first), and the second option returns entries in order of decreasing
    * timestamps (newest first). Entries with equal timestamps are returned in
-   * order of LogEntry.insertId.
+   * order of their insert_id values.
    */
   core.String orderBy;
   /**
    * Optional. The maximum number of results to return from this request.
-   * Non-positive values are ignored. The presence of nextPageToken in the
+   * Non-positive values are ignored. The presence of next_page_token in the
    * response indicates that more results might be available.
    */
   core.int pageSize;
   /**
    * Optional. If present, then retrieve the next batch of results from the
-   * preceding call to this method. pageToken must be the value of nextPageToken
-   * from the previous response. The values of other method parameters should be
-   * identical to those in the previous call.
+   * preceding call to this method. page_token must be the value of
+   * next_page_token from the previous response. The values of other method
+   * parameters should be identical to those in the previous call.
    */
   core.String pageToken;
   /**
    * Deprecated. Use resource_names instead. One or more project identifiers or
    * project numbers from which to retrieve log entries. Example:
    * "my-project-1A". If present, these project identifiers are converted to
    * resource name format and added to the list of resources in resource_names.
    */
   core.List<core.String> projectIds;
   /**
@@ skipping 234 matching lines @@
 }
 
 /** An individual entry in a log. */
 class LogEntry {
   /**
    * Optional. Information about the HTTP request associated with this log
    * entry, if applicable.
    */
   HttpRequest httpRequest;
   /**
-   * Optional. A unique ID for the log entry. If you provide this field, the
-   * logging service considers other log entries in the same project with the
-   * same ID as duplicates which can be removed. If omitted, Stackdriver Logging
-   * will generate a unique ID for this log entry.
+   * Optional. A unique identifier for the log entry. If you provide a value,
+   * then Stackdriver Logging considers other log entries in the same project,
+   * with the same timestamp, and with the same insert_id to be duplicates which
+   * can be removed. If omitted in new log entries, then Stackdriver Logging
+   * will insert its own unique identifier. The insert_id is used to order log
+   * entries that have the same timestamp value.
    */
   core.String insertId;
   /**
    * The log entry payload, represented as a structure that is expressed as a
    * JSON object.
    *
    * 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.Map<core.String, core.Object> jsonPayload;
@@ skipping 58 matching lines @@
   core.String severity;
   /**
    * Optional. Source code location information associated with the log entry,
    * if any.
    */
   LogEntrySourceLocation sourceLocation;
   /** The log entry payload, represented as a Unicode string (UTF-8). */
   core.String textPayload;
   /**
    * Optional. The time the event described by the log entry occurred. If
-   * omitted, Stackdriver Logging will use the time the log entry is received.
+   * omitted in a new log entry, Stackdriver Logging will insert the time the
+   * log entry is received. Stackdriver Logging might reject log entries whose
+   * time stamps are more than a couple of hours in the future. Log entries with
+   * time stamps in the past are accepted.
    */
   core.String timestamp;
   /**
    * Optional. Resource name of the trace associated with the log entry, if any.
    * If it contains a relative resource name, the name is assumed to be relative
    * to //tracing.googleapis.com. Example:
    * projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824
    */
   core.String trace;
 
@@ skipping 979 matching lines @@
       _json["revisionId"] = revisionId;
     }
     return _json;
   }
 }
 
 /** The parameters to WriteLogEntries. */
 class WriteLogEntriesRequest {
   /**
    * Required. The log entries to write. Values supplied for the fields
-   * log_name, resource, and labels in this entries.write request are added to
-   * those log entries that do not provide their own values for the fields.To
-   * improve throughput and to avoid exceeding the quota limit for calls to
-   * entries.write, you should write multiple log entries at once rather than
-   * calling this method for each individual log entry.
+   * log_name, resource, and labels in this entries.write request are inserted
+   * into those log entries in this list that do not provide their own
+   * values.Stackdriver Logging also creates and inserts values for timestamp
+   * and insert_id if the entries do not provide them. The created insert_id for
+   * the N'th entry in this list will be greater than earlier entries and less
+   * than later entries. Otherwise, the order of log entries in this list does
+   * not matter.To improve throughput and to avoid exceeding the quota limit for
+   * calls to entries.write, you should write multiple log entries at once
+   * rather than calling this method for each individual log entry.
    */
   core.List<LogEntry> entries;
   /**
    * Optional. Default labels that are added to the labels field of all log
    * entries in entries. If a log entry already has a label with the same key as
    * a label in this parameter, then the log entry's label is not changed. See
    * LogEntry.
    */
   core.Map<core.String, core.String> labels;
   /**
    * Optional. A default log resource name that is assigned to all log entries
    * in entries that do not specify a value for log_name:
    * "projects/[PROJECT_ID]/logs/[LOG_ID]"
    * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
    * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
    * "folders/[FOLDER_ID]/logs/[LOG_ID]"
    * [LOG_ID] must be URL-encoded. For example,
    * "projects/my-project-id/logs/syslog" or
    * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity".
    * For more information about log names, see LogEntry.
    */
   core.String logName;
   /**
    * Optional. Whether valid entries should be written even if some other
    * entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
-   * entry is not written, the response status will be the error associated with
-   * one of the failed entries and include error details in the form of
-   * WriteLogEntriesPartialErrors.
+   * entry is not written, then the response status is the error associated with
+   * one of the failed entries and the response includes error details keyed by
+   * the entries' zero-based index in the entries.write method.
    */
   core.bool partialSuccess;
   /**
    * Optional. A default monitored resource object that is assigned to all log
    * entries in entries that do not specify a value for resource. Example:
    * { "type": "gce_instance",
    *   "labels": {
    *     "zone": "us-central1-a", "instance_id": "00000000000000000000" }}
    * See LogEntry.
    */
@@ skipping 46 matching lines @@
   WriteLogEntriesResponse();
 
   WriteLogEntriesResponse.fromJson(core.Map _json) {
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     return _json;
   }
 }