Api roll 1: 2014-09-23

generated/googleapis_beta/lib/datastore/v1beta2.dart

 library googleapis_beta.datastore.v1beta2;
 
 import "dart:core" as core;
 import "dart:collection" as collection;
 import "dart:async" as async;
 import "dart:convert" as convert;
 
 import "package:crypto/crypto.dart" as crypto;
 import 'package:http/http.dart' as http;
 import '../src/common_internal.dart' as common_internal;
 import '../common/common.dart' as common;
 
 export '../common/common.dart' show ApiRequestError;
 export '../common/common.dart' show DetailedApiRequestError;
 
 /** API for accessing Google Cloud Datastore. */
 class DatastoreApi {
+  /** View and manage your data across Google Cloud Platform services */
+  static const CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform";
+
   /** View and manage your Google Cloud Datastore data */
   static const DatastoreScope = "https://www.googleapis.com/auth/datastore";
 
   /** View your email address */
   static const UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email";
 
 
   final common_internal.ApiRequester _requester;
 
   DatasetsResourceApi get datasets => new DatasetsResourceApi(_requester);
 
   DatastoreApi(http.Client client) : 
-      _requester = new common_internal.ApiRequester(client, "https://www.googleapis.com/", "/datastore/v1beta2/datasets/");
+      _requester = new common_internal.ApiRequester(client, "https://www.googleapis.com/", "datastore/v1beta2/datasets/");
 }
 
 
 /** Not documented yet. */
 class DatasetsResourceApi {
   final common_internal.ApiRequester _requester;
 
   DatasetsResourceApi(common_internal.ApiRequester client) : 
       _requester = client;
 
@@ skipping 504 matching lines @@
       _json["header"] = (header).toJson();
     }
     if (mutationResult != null) {
       _json["mutationResult"] = (mutationResult).toJson();
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/**
+ * A filter that merges the multiple other filters using the given operation.
+ */
 class CompositeFilter {
   /** The list of filters to combine. Must contain at least one filter. */
   core.List<Filter> filters;
 
   /**
    * The operator for combining multiple filters. Only "and" is currently
    * supported.
    * Possible string values are:
    * - "AND"
    */
@@ skipping 17 matching lines @@
       _json["filters"] = filters.map((value) => (value).toJson()).toList();
     }
     if (operator != null) {
       _json["operator"] = operator;
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** An entity. */
 class Entity {
   /**
    * The entity's key.
    *
    * An entity must have a key, unless otherwise documented (for example, an
    * entity in Value.entityValue may have no key). An entity's kind is its key's
    * path's last element's kind, or null if it has no key.
    */
   Key key;
 
@@ skipping 18 matching lines @@
       _json["key"] = (key).toJson();
     }
     if (properties != null) {
       _json["properties"] = common_internal.mapMap(properties, (item) => (item).toJson());
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** The result of fetching an entity from the datastore. */
 class EntityResult {
   /** The resulting entity. */
   Entity entity;
 
 
   EntityResult();
 
   EntityResult.fromJson(core.Map _json) {
     if (_json.containsKey("entity")) {
       entity = new Entity.fromJson(_json["entity"]);
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (entity != null) {
       _json["entity"] = (entity).toJson();
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** A holder for any type of filter. Exactly one field should be specified. */
 class Filter {
   /** A composite filter. */
   CompositeFilter compositeFilter;
 
   /** A filter on a property. */
   PropertyFilter propertyFilter;
 
 
   Filter();
 
@@ skipping 12 matching lines @@
       _json["compositeFilter"] = (compositeFilter).toJson();
     }
     if (propertyFilter != null) {
       _json["propertyFilter"] = (propertyFilter).toJson();
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** A GQL query. */
 class GqlQuery {
   /** When false, the query string must not contain a literal. */
   core.bool allowLiteral;
 
   /**
    * A named argument must set field GqlQueryArg.name. No two named arguments
    * may have the same name. For each non-reserved named binding site in the
    * query string, there must be a named argument with that name, but not
    * necessarily the inverse.
    */
   core.List<GqlQueryArg> nameArgs;
 
   /**
    * Numbered binding site @1 references the first numbered argument,
    * effectively using 1-based indexing, rather than the usual 0. A numbered
    * argument must NOT set field GqlQueryArg.name. For each binding site
    * numbered i in query_string, there must be an ith numbered argument. The
    * inverse must also be true.
    */
   core.List<GqlQueryArg> numberArgs;
 
-  /** Not documented yet. */
+  /** The query string. */
   core.String queryString;
 
 
   GqlQuery();
 
   GqlQuery.fromJson(core.Map _json) {
     if (_json.containsKey("allowLiteral")) {
       allowLiteral = _json["allowLiteral"];
     }
     if (_json.containsKey("nameArgs")) {
@@ skipping 19 matching lines @@
       _json["numberArgs"] = numberArgs.map((value) => (value).toJson()).toList();
     }
     if (queryString != null) {
       _json["queryString"] = queryString;
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** A binding argument for a GQL query. */
 class GqlQueryArg {
   /** Not documented yet. */
   core.String cursor;
 
   core.List<core.int> get cursorAsBytes {
     return crypto.CryptoUtils.base64StringToBytes(cursor);
   }
 
   void set cursorAsBytes(core.List<core.int> _bytes) {
     cursor = crypto.CryptoUtils.bytesToBase64(_bytes, urlSafe: true);
@@ skipping 32 matching lines @@
       _json["name"] = name;
     }
     if (value != null) {
       _json["value"] = (value).toJson();
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** A unique identifier for an entity. */
 class Key {
   /**
    * Entities are partitioned into subsets, currently identified by a dataset
    * (usually implicitly specified by the project) and namespace ID. Queries are
    * scoped to a single partition.
    */
   PartitionId partitionId;
 
   /**
    * The entity path. An entity path consists of one or more elements composed
@@ skipping 86 matching lines @@
       _json["kind"] = kind;
     }
     if (name != null) {
       _json["name"] = name;
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** A representation of a kind. */
 class KindExpression {
   /** The name of the kind. */
   core.String name;
 
 
   KindExpression();
 
   KindExpression.fromJson(core.Map _json) {
     if (_json.containsKey("name")) {
       name = _json["name"];
@@ skipping 87 matching lines @@
       _json["header"] = (header).toJson();
     }
     if (missing != null) {
       _json["missing"] = missing.map((value) => (value).toJson()).toList();
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** A set of changes to apply. */
 class Mutation {
   /**
    * Keys of entities to delete. Each key must have a complete key path and must
    * not be reserved/read-only.
    */
   core.List<Key> delete;
 
   /** Ignore a user specified read-only period. Optional. */
   core.bool force;
 
@@ skipping 99 matching lines @@
       _json["indexUpdates"] = indexUpdates;
     }
     if (insertAutoIdKeys != null) {
       _json["insertAutoIdKeys"] = insertAutoIdKeys.map((value) => (value).toJson()).toList();
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/**
+ * An identifier for a particular subset of entities.
+ *
+ * Entities are partitioned into various subsets, each used by different
+ * datasets and different namespaces within a dataset and so forth.
+ */
 class PartitionId {
   /** The dataset ID. */
   core.String datasetId;
 
   /** The namespace. */
   core.String namespace;
 
 
   PartitionId();
 
@@ skipping 12 matching lines @@
       _json["datasetId"] = datasetId;
     }
     if (namespace != null) {
       _json["namespace"] = namespace;
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** An entity property. */
 class Property {
   /** A blob key value. */
   core.String blobKeyValue;
 
   /** A blob value. May be a maximum of 1,000,000 bytes. */
   core.String blobValue;
 
   core.List<core.int> get blobValueAsBytes {
     return crypto.CryptoUtils.base64StringToBytes(blobValue);
   }
@@ skipping 125 matching lines @@
       _json["meaning"] = meaning;
     }
     if (stringValue != null) {
       _json["stringValue"] = stringValue;
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** A representation of a property in a projection. */
 class PropertyExpression {
   /**
    * The aggregation function to apply to the property. Optional. Can only be
    * used when grouping by at least one property. Must then be set on all
    * properties in the projection that are not being grouped by. Aggregation
    * functions: first selects the first result as determined by the query's
    * order.
    * Possible string values are:
    * - "FIRST"
    */
@@ skipping 20 matching lines @@
       _json["aggregationFunction"] = aggregationFunction;
     }
     if (property != null) {
       _json["property"] = (property).toJson();
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** A filter on a specific property. */
 class PropertyFilter {
   /**
    * The operator to filter by. One of lessThan, lessThanOrEqual, greaterThan,
    * greaterThanOrEqual, equal, or hasAncestor.
    * Possible string values are:
    * - "EQUAL"
    * - "GREATER_THAN"
    * - "GREATER_THAN_OR_EQUAL"
    * - "HAS_ANCESTOR"
    * - "LESS_THAN"
@@ skipping 31 matching lines @@
       _json["property"] = (property).toJson();
     }
     if (value != null) {
       _json["value"] = (value).toJson();
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** The desired order for a specific property. */
 class PropertyOrder {
   /**
    * The direction to order by. One of ascending or descending. Optional,
    * defaults to ascending.
    * Possible string values are:
    * - "ASCENDING"
    * - "DESCENDING"
    */
   core.String direction;
 
@@ skipping 18 matching lines @@
       _json["direction"] = direction;
     }
     if (property != null) {
       _json["property"] = (property).toJson();
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** A reference to a property relative to the kind expressions. */
 class PropertyReference {
   /** The name of the property. */
   core.String name;
 
 
   PropertyReference();
 
   PropertyReference.fromJson(core.Map _json) {
     if (_json.containsKey("name")) {
       name = _json["name"];
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (name != null) {
       _json["name"] = name;
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** A query. */
 class Query {
   /**
    * An ending point for the query results. Optional. Query cursors are returned
    * in query result batches.
    */
   core.String endCursor;
 
   core.List<core.int> get endCursorAsBytes {
     return crypto.CryptoUtils.base64StringToBytes(endCursor);
   }
@@ skipping 108 matching lines @@
       _json["projection"] = projection.map((value) => (value).toJson()).toList();
     }
     if (startCursor != null) {
       _json["startCursor"] = startCursor;
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/** A batch of results produced by a query. */
 class QueryResultBatch {
   /**
    * A cursor that points to the position after the last result in the batch.
-   * May be absent.
+   * May be absent. TODO(arfuller): Once all plans produce cursors update
+   * documentation here.
    */
   core.String endCursor;
 
   core.List<core.int> get endCursorAsBytes {
     return crypto.CryptoUtils.base64StringToBytes(endCursor);
   }
 
   void set endCursorAsBytes(core.List<core.int> _bytes) {
     endCursor = crypto.CryptoUtils.bytesToBase64(_bytes, urlSafe: true);
   }
@@ skipping 291 matching lines @@
       _json["batch"] = (batch).toJson();
     }
     if (header != null) {
       _json["header"] = (header).toJson();
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
+/**
+ * A message that can hold any of the supported value types and associated
+ * metadata.
+ */
 class Value {
   /** A blob key value. */
   core.String blobKeyValue;
 
   /** A blob value. May be a maximum of 1,000,000 bytes. */
   core.String blobValue;
 
   core.List<core.int> get blobValueAsBytes {
     return crypto.CryptoUtils.base64StringToBytes(blobValue);
   }
@@ skipping 125 matching lines @@
       _json["meaning"] = meaning;
     }
     if (stringValue != null) {
       _json["stringValue"] = stringValue;
     }
     return _json;
   }
 }