Api-Roll 53: 2017-08-21

generated/googleapis/lib/spanner/v1.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.spanner.v1;
 
 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 384 matching lines @@
   /**
    * Lists all instances in the given project.
    *
    * Request parameters:
    *
    * [parent] - Required. The name of the project for which a list of instances
    * is
    * requested. Values are of the form `projects/<project>`.
    * Value must have pattern "^projects/[^/]+$".
    *
+   * [pageToken] - If non-empty, `page_token` should contain a
+   * next_page_token from a
+   * previous ListInstancesResponse.
+   *
+   * [pageSize] - Number of instances to be returned in the response. If 0 or
+   * less, defaults
+   * to the server's maximum allowed page size.
+   *
    * [filter] - An expression for filtering the results of the request. Filter
    * rules are
    * case insensitive. The fields eligible for filtering are:
    *
    *   * name
    *   * display_name
    *   * labels.key where key is the name of a label
    *
    * Some examples of using filters are:
    *
    *   * name:* --> The instance has a name.
    *   * name:Howl --> The instance's name contains the string "howl".
    *   * name:HOWL --> Equivalent to above.
    *   * NAME:howl --> Equivalent to above.
    *   * labels.env:* --> The instance has the label "env".
    *   * labels.env:dev --> The instance has the label "env" and the value of
    *                        the label contains the string "dev".
    *   * name:howl labels.env:dev --> The instance's name contains "howl" and
    *                                  it has the label "env" with its value
    *                                  containing "dev".
    *
-   * [pageToken] - If non-empty, `page_token` should contain a
-   * next_page_token from a
-   * previous ListInstancesResponse.
-   *
-   * [pageSize] - Number of instances to be returned in the response. If 0 or
-   * less, defaults
-   * to the server's maximum allowed page size.
-   *
    * Completes with a [ListInstancesResponse].
    *
    * 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<ListInstancesResponse> list(core.String parent, {core.String filter, core.String pageToken, core.int pageSize}) {
+  async.Future<ListInstancesResponse> list(core.String parent, {core.String pageToken, core.int pageSize, core.String filter}) {
     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 (filter != null) {
-      _queryParams["filter"] = [filter];
-    }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
     if (pageSize != null) {
       _queryParams["pageSize"] = ["${pageSize}"];
     }
+    if (filter != null) {
+      _queryParams["filter"] = [filter];
+    }
 
     _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/instances';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 1745 matching lines @@
     if (exemptedMembers != null) {
       _json["exemptedMembers"] = exemptedMembers;
     }
     if (logType != null) {
       _json["logType"] = logType;
     }
     return _json;
   }
 }
 
+/** Authorization-related information used by Cloud Audit Logging. */
+class AuthorizationLoggingOptions {
+  /**
+   * The type of the permission that was checked.
+   * Possible string values are:
+   * - "PERMISSION_TYPE_UNSPECIFIED" : Default. Should not be used.
+   * - "ADMIN_READ" : A read of admin (meta) data.
+   * - "ADMIN_WRITE" : A write of admin (meta) data.
+   * - "DATA_READ" : A read of standard data.
+   * - "DATA_WRITE" : A write of standard data.
+   */
+  core.String permissionType;
+
+  AuthorizationLoggingOptions();
+
+  AuthorizationLoggingOptions.fromJson(core.Map _json) {
+    if (_json.containsKey("permissionType")) {
+      permissionType = _json["permissionType"];
+    }
+  }
+
+  core.Map<core.String, core.Object> toJson() {
+    final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+    if (permissionType != null) {
+      _json["permissionType"] = permissionType;
+    }
+    return _json;
+  }
+}
+
 /** The request for BeginTransaction. */
 class BeginTransactionRequest {
   /** Required. Options for the new transaction. */
   TransactionOptions options;
 
   BeginTransactionRequest();
 
   BeginTransactionRequest.fromJson(core.Map _json) {
     if (_json.containsKey("options")) {
       options = new TransactionOptions.fromJson(_json["options"]);
@@ skipping 130 matching lines @@
     }
     if (variable != null) {
       _json["variable"] = variable;
     }
     return _json;
   }
 }
 
 /** Write a Cloud Audit log */
 class CloudAuditOptions {
+  /** Information used by the Cloud Audit Logging pipeline. */
+  AuthorizationLoggingOptions authorizationLoggingOptions;
   /**
    * The log_name to populate in the Cloud Audit Record.
    * Possible string values are:
    * - "UNSPECIFIED_LOG_NAME" : Default. Should not be used.
    * - "ADMIN_ACTIVITY" : Corresponds to "cloudaudit.googleapis.com/activity"
    * - "DATA_ACCESS" : Corresponds to "cloudaudit.googleapis.com/data_access"
    */
   core.String logName;
 
   CloudAuditOptions();
 
   CloudAuditOptions.fromJson(core.Map _json) {
+    if (_json.containsKey("authorizationLoggingOptions")) {
+      authorizationLoggingOptions = new AuthorizationLoggingOptions.fromJson(_json["authorizationLoggingOptions"]);
+    }
     if (_json.containsKey("logName")) {
       logName = _json["logName"];
     }
   }
 
   core.Map<core.String, core.Object> toJson() {
     final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+    if (authorizationLoggingOptions != null) {
+      _json["authorizationLoggingOptions"] = (authorizationLoggingOptions).toJson();
+    }
     if (logName != null) {
       _json["logName"] = logName;
     }
     return _json;
   }
 }
 
 /** The request for Commit. */
 class CommitRequest {
   /**
@@ skipping 623 matching lines @@
  *     expression: "size(request.user) > 0"
  */
 class Expr {
   /**
    * An optional description of the expression. This is a longer text which
    * describes the expression, e.g. when hovered over it in a UI.
    */
   core.String description;
   /**
    * Textual representation of an expression in
-   * [Common Expression Language](http://go/api-expr) syntax.
+   * Common Expression Language syntax.
    *
    * The application context of the containing message determines which
    * well-known feature set of CEL is supported.
    */
   core.String expression;
   /**
    * An optional string indicating the location of the expression for error
    * reporting, e.g. a file name and a position in the file.
    */
   core.String location;
@@ skipping 159 matching lines @@
   /**
    * Required. A unique identifier for the instance, which cannot be changed
    * after the instance is created. Values are of the form
    * `projects/<project>/instances/a-z*[a-z0-9]`. The final
    * segment of the name must be between 6 and 30 characters in length.
    */
   core.String name;
   /**
    * Required. The number of nodes allocated to this instance. This may be zero
    * in API responses for instances that are not yet in state `READY`.
+   *
+   * Each Spanner node can provide up to 10,000 QPS of reads or 2000 QPS of
+   * writes (writing single rows at 1KB data per row), and 2 TiB storage.
+   *
+   * For optimal performance, we recommend provisioning enough nodes to keep
+   * overall CPU utilization under 75%.
+   *
+   * A minimum of 3 nodes is recommended for production environments.  This
+   * minimum is required for SLAs to apply to your instance.
+   *
+   * Note that Cloud Spanner performance is highly dependent on workload, schema
+   * design, and dataset characteristics. The performance numbers above are
+   * estimates, and assume [best
+   * practices](https://cloud.google.com/spanner/docs/bulk-loading)
+   * are followed.
    */
   core.int nodeCount;
   /**
    * Output only. The current instance state. For
    * CreateInstance, the state must be
    * either omitted or set to `CREATING`. For
    * UpdateInstance, the state must be
    * either omitted or set to `READY`.
    * Possible string values are:
    * - "STATE_UNSPECIFIED" : Not specified.
@@ skipping 432 matching lines @@
     if (nextPageToken != null) {
       _json["nextPageToken"] = nextPageToken;
     }
     if (operations != null) {
       _json["operations"] = operations.map((value) => (value).toJson()).toList();
     }
     return _json;
   }
 }
 
-/** Specifies what kind of log the caller must write */
+/**
+ * Specifies what kind of log the caller must write
+ * Increment a streamz counter with the specified metric and field names.
+ *
+ * Metric names should start with a '/', generally be lowercase-only,
+ * and end in "_count". Field names should not contain an initial slash.
+ * The actual exported metric names will have "/iam/policy" prepended.
+ *
+ * Field names correspond to IAM request parameters and field values are
+ * their respective values.
+ *
+ * At present the only supported field names are
+ *    - "iam_principal", corresponding to IAMContext.principal;
+ *    - "" (empty string), resulting in one aggretated counter with no field.
+ *
+ * Examples:
+ *   counter { metric: "/debug_access_count"  field: "iam_principal" }
+ *   ==> increment counter /iam/policy/backend_debug_access_count
+ *                         {iam_principal=[value of IAMContext.principal]}
+ *
+ * At this time we do not support:
+ * * multiple field names (though this may be supported in the future)
+ * * decrementing the counter
+ * * incrementing it by anything other than 1
+ */
 class LogConfig {
   /** Cloud audit options. */
   CloudAuditOptions cloudAudit;
   /** Counter options. */
   CounterOptions counter;
   /** Data access options. */
   DataAccessOptions dataAccess;
 
   LogConfig();
 
@@ skipping 1264 matching lines @@
  *     results in its response, the status of those operations should be
  *     represented directly using the `Status` message.
  *
  * - Logging. If some API errors are stored in logs, the message `Status` could
  * be used directly after any stripping needed for security/privacy reasons.
  */
 class Status {
   /** The status code, which should be an enum value of google.rpc.Code. */
   core.int code;
   /**
-   * A list of messages that carry the error details.  There will be a
-   * common set of message types for APIs to use.
+   * A list of messages that carry the error details.  There is a common set of
+   * message types for APIs to use.
    *
    * 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>> details;
   /**
    * A developer-facing error message, which should be in English. Any
    * user-facing error message should be localized and sent in the
    * google.rpc.Status.details field, or localized by the client.
    */
@@ skipping 809 matching lines @@
     }
     if (table != null) {
       _json["table"] = table;
     }
     if (values != null) {
       _json["values"] = values;
     }
     return _json;
   }
 }