Blame - docs/dyn/datastore_v1beta3.projects.html - platform/external/python/google-api-python-client

2020-11-16 11:05:03 -0700

[diff] [blame^]

114

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

115

"projectId": "A String", # The ID of the project to which the entities belong.

116

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

117

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

118

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

119

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

120

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

121

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

122

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

123

},

124

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

136

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

137

{ # The response for Datastore.AllocateIds.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

138

"keys": [ # The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.

139

{ # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

140

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

141

"projectId": "A String", # The ID of the project to which the entities belong.

142

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

143

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

144

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

145

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

146

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

147

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

148

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

149

},

150

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

157

<code class="details" id="beginTransaction">beginTransaction(projectId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

158

<pre>Begins a new transaction.

159

160

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

161

projectId: string, Required. The ID of the project against which to make the request. (required)

162

body: object, The request body.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

163

The object takes the form of:

164

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

165

{ # The request for Datastore.BeginTransaction.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

166

"transactionOptions": { # Options for beginning a new transaction. Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests. # Options for a new transaction.

167

"readOnly": { # Options specific to read-only transactions. # The transaction should only allow reads.

168

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

169

"readWrite": { # Options specific to read / write transactions. # The transaction should allow both reads and writes.

170

"previousTransaction": "A String", # The transaction identifier of the transaction being retried.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

171

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

172

},

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

173

}

174

175

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

182

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

183

{ # The response for Datastore.BeginTransaction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

184

"transaction": "A String", # The transaction identifier (always present).

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

189

<code class="details" id="close">close()</code>

190

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

194

<code class="details" id="commit">commit(projectId, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

195

<pre>Commits a transaction, optionally creating, deleting or modifying some entities.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

196

197

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

198

projectId: string, Required. The ID of the project against which to make the request. (required)

199

body: object, The request body.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

200

The object takes the form of:

201

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

202

{ # The request for Datastore.Commit.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

203

"mutations": [ # The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

204

{ # A mutation to apply to an entity.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

205

"upsert": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

206

"key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

207

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

208

"projectId": "A String", # The ID of the project to which the entities belong.

209

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

210

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

211

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

212

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

213

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

214

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

215

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

216

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

217

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

218

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

219

"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

220

"a_key": # Object with schema name: Value

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

221

},

222

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

223

"update": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to update. The entity must already exist. Must have a complete key path.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

224

"key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

225

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

226

"projectId": "A String", # The ID of the project to which the entities belong.

227

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

228

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

229

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

230

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

231

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

232

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

233

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

234

},

235

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

236

},

237

"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.

238

"a_key": # Object with schema name: Value

239

},

240

},

241

"insert": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete.

242

"key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

243

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

244

"projectId": "A String", # The ID of the project to which the entities belong.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

245

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

246

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

247

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

248

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

249

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

250

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

251

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

},

],

},

"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.

256

"a_key": # Object with schema name: Value

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

257

},

258

},

259

"delete": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

260

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

261

"projectId": "A String", # The ID of the project to which the entities belong.

262

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

263

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

264

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

265

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

266

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

267

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

268

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

269

},

270

],

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

271

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

272

"baseVersion": "A String", # The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

273

},

274

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

275

"mode": "A String", # The type of commit to perform. Defaults to `TRANSACTIONAL`.

276

"transaction": "A String", # The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

277

}

278

279

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

286

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

287

{ # The response for Datastore.Commit.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

288

"mutationResults": [ # The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

289

{ # The result of applying a mutation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

290

"conflictDetected": True or False, # Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation.

291

"key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The automatically allocated key. Set only when the mutation allocated a key.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

292

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

293

"projectId": "A String", # The ID of the project to which the entities belong.

294

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

295

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

296

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

297

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

298

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

299

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

300

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

301

},

302

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

303

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

304

"version": "A String", # The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

305

},

306

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

307

"indexUpdates": 42, # The number of index entries updated during the commit, or zero if none were updated.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

312

<code class="details" id="lookup">lookup(projectId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

313

<pre>Looks up entities by key.

314

315

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

316

projectId: string, Required. The ID of the project against which to make the request. (required)

317

body: object, The request body.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

318

The object takes the form of:

319

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

320

{ # The request for Datastore.Lookup.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

321

"keys": [ # Required. Keys of entities to look up.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

322

{ # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

323

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

324

"projectId": "A String", # The ID of the project to which the entities belong.

325

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

326

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

327

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

328

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

329

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

330

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

331

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

332

},

333

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

334

},

335

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

336

"readOptions": { # The options shared by read requests. # The options for this lookup request.

337

"readConsistency": "A String", # The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries.

338

"transaction": "A String", # The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.

339

},

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

340

}

341

342

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

349

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

350

{ # The response for Datastore.Lookup.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

351

"missing": [ # Entities not found as `ResultType.KEY_ONLY` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.

352

{ # The result of fetching an entity from Datastore.

353

"cursor": "A String", # A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message.

354

"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.

355

"entity": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The resulting entity.

356

"key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

357

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

358

"projectId": "A String", # The ID of the project to which the entities belong.

359

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

360

},

361

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

362

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

363

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

364

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

365

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

},

],

},

"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.

370

"a_key": # Object with schema name: Value

},

},

},

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

375

"found": [ # Entities found as `ResultType.FULL` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.

376

{ # The result of fetching an entity from Datastore.

377

"cursor": "A String", # A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

378

"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

379

"entity": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The resulting entity.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

380

"key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

381

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

382

"projectId": "A String", # The ID of the project to which the entities belong.

383

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

384

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

385

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

386

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

387

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

388

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

389

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

390

},

391

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

392

},

393

"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.

394

"a_key": # Object with schema name: Value

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

395

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

396

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

397

},

398

],

399

"deferred": [ # A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input.

400

{ # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

401

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

402

"projectId": "A String", # The ID of the project to which the entities belong.

403

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

404

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

405

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

406

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

407

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

408

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

409

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

410

},

411

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

412

},

413

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

418

<code class="details" id="reserveIds">reserveIds(projectId, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

419

<pre>Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

420

421

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

422

projectId: string, Required. The ID of the project against which to make the request. (required)

423

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

424

The object takes the form of:

425

426

{ # The request for Datastore.ReserveIds.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

427

"keys": [ # Required. A list of keys with complete key paths whose numeric IDs should not be auto-allocated.

428

{ # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

429

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

430

"projectId": "A String", # The ID of the project to which the entities belong.

431

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

432

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

433

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

434

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

435

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

436

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

437

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

438

},

439

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

440

},

441

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

442

"databaseId": "A String", # If not empty, the ID of the database against which to make the request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

443

}

444

445

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

452

453

{ # The response for Datastore.ReserveIds.

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

458

<code class="details" id="rollback">rollback(projectId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

459

<pre>Rolls back a transaction.

460

461

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

462

projectId: string, Required. The ID of the project against which to make the request. (required)

463

body: object, The request body.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

464

The object takes the form of:

465

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

466

{ # The request for Datastore.Rollback.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

467

"transaction": "A String", # Required. The transaction identifier, returned by a call to Datastore.BeginTransaction.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

468

}

469

470

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

477

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

478

{ # The response for Datastore.Rollback. (an empty message).

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

483

<code class="details" id="runQuery">runQuery(projectId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

484

<pre>Queries for entities.

485

486

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

487

projectId: string, Required. The ID of the project against which to make the request. (required)

488

body: object, The request body.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

489

The object takes the form of:

490

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

491

{ # The request for Datastore.RunQuery.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

492

"query": { # A query for entities. # The query to run.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

493

"startCursor": "A String", # A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

494

"kind": [ # The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

495

{ # A representation of a kind.

496

"name": "A String", # The name of the kind.

497

},

498

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

499

"distinctOn": [ # The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

500

{ # A reference to a property relative to the kind expressions.

501

"name": "A String", # The name of the property. If name includes "."s, it may be interpreted as a property name path.

502

},

503

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

504

"endCursor": "A String", # An ending point for the query results. Query cursors are returned in query result batches and [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).

505

"order": [ # The order to apply to the query results (if empty, order is unspecified).

506

{ # The desired order for a specific property.

507

"direction": "A String", # The direction to order by. Defaults to `ASCENDING`.

508

"property": { # A reference to a property relative to the kind expressions. # The property to order by.

509

"name": "A String", # The name of the property. If name includes "."s, it may be interpreted as a property name path.

},

},

],

"limit": 42, # The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.

514

"filter": { # A holder for any type of filter. # The filter to apply.

515

"compositeFilter": { # A filter that merges multiple other filters using the given operator. # A composite filter.

516

"filters": [ # The list of filters to combine. Must contain at least one filter.

517

# Object with schema name: Filter

518

],

519

"op": "A String", # The operator for combining multiple filters.

520

},

521

"propertyFilter": { # A filter on a specific property. # A filter on a property.

522

"op": "A String", # The operator to filter by.

523

"property": { # A reference to a property relative to the kind expressions. # The property to filter by.

524

"name": "A String", # The name of the property. If name includes "."s, it may be interpreted as a property name path.

525

},

526

"value": { # A message that can hold any of the supported value types and associated metadata. # The value to compare the property to.

527

"doubleValue": 3.14, # A double value.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

528

"stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

529

"nullValue": "A String", # A null value.

530

"integerValue": "A String", # An integer value.

531

"entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.

532

"key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

533

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

534

"projectId": "A String", # The ID of the project to which the entities belong.

535

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

536

},

537

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

538

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

539

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

540

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

541

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

},

],

},

"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.

546

"a_key": # Object with schema name: Value

547

},

548

},

549

"keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.

550

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

551

"projectId": "A String", # The ID of the project to which the entities belong.

552

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

553

},

554

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

555

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

556

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

557

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

558

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

},

],

},

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.

563

"meaning": 42, # The `meaning` field should only be populated for backwards compatibility.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

564

"geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.

565

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

566

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

567

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

568

"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

569

"booleanValue": True or False, # A boolean value.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

570

"timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

571

"arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.

572

"values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.

573

# Object with schema name: Value

574

],

575

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

576

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

577

},

578

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

579

"offset": 42, # The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.

580

"projection": [ # The projection to return. Defaults to returning all properties.

581

{ # A representation of a property in a projection.

582

"property": { # A reference to a property relative to the kind expressions. # The property to project.

583

"name": "A String", # The name of the property. If name includes "."s, it may be interpreted as a property name path.

},

},

],

},

"readOptions": { # The options shared by read requests. # The options for this query.

589

"readConsistency": "A String", # The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries.

590

"transaction": "A String", # The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.

591

},

592

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.

593

"projectId": "A String", # The ID of the project to which the entities belong.

594

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

595

},

596

"gqlQuery": { # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). # The GQL query to run.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

597

"allowLiterals": True or False, # When false, the query string must not contain any literals and instead must bind all values. For example, `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while `SELECT * FROM Kind WHERE a = @value` is.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

598

"queryString": "A String", # A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

599

"positionalBindings": [ # Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0. For each binding site numbered i in `query_string`, there must be an i-th numbered parameter. The inverse must also be true.

600

{ # A binding parameter for a GQL query.

601

"value": { # A message that can hold any of the supported value types and associated metadata. # A value parameter.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

602

"doubleValue": 3.14, # A double value.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

603

"stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

604

"nullValue": "A String", # A null value.

605

"integerValue": "A String", # An integer value.

606

"entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.

607

"key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

608

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

609

"projectId": "A String", # The ID of the project to which the entities belong.

610

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

611

},

612

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

613

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

614

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

615

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

616

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

},

],

},

"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.

621

"a_key": # Object with schema name: Value

622

},

623

},

624

"keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.

625

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

626

"projectId": "A String", # The ID of the project to which the entities belong.

627

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

628

},

629

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

630

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

631

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

632

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

633

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

},

],

},

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.

638

"meaning": 42, # The `meaning` field should only be populated for backwards compatibility.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

639

"geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.

640

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

641

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

642

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

643

"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

644

"booleanValue": True or False, # A boolean value.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

645

"timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

646

"arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.

647

"values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.

648

# Object with schema name: Value

649

],

650

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

651

},

652

"cursor": "A String", # A query cursor. Query cursors are returned in query result batches.

653

},

654

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

655

"namedBindings": { # For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not be `""`.

656

"a_key": { # A binding parameter for a GQL query.

657

"value": { # A message that can hold any of the supported value types and associated metadata. # A value parameter.

658

"doubleValue": 3.14, # A double value.

659

"stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.

660

"nullValue": "A String", # A null value.

661

"integerValue": "A String", # An integer value.

662

"entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.

663

"key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

664

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

665

"projectId": "A String", # The ID of the project to which the entities belong.

666

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

667

},

668

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

669

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

670

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

671

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

672

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

},

],

},

"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.

677

"a_key": # Object with schema name: Value

678

},

679

},

680

"keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.

681

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

682

"projectId": "A String", # The ID of the project to which the entities belong.

683

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

684

},

685

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

686

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

687

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

688

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

689

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

},

],

},

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.

694

"meaning": 42, # The `meaning` field should only be populated for backwards compatibility.

695

"geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.

696

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

697

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

698

},

699

"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.

700

"booleanValue": True or False, # A boolean value.

701

"timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

702

"arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.

703

"values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.

704

# Object with schema name: Value

],

},

},

"cursor": "A String", # A query cursor. Query cursors are returned in query result batches.

709

},

710

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

711

},

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

712

}

713

714

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

721

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

722

{ # The response for Datastore.RunQuery.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

723

"query": { # A query for entities. # The parsed form of the `GqlQuery` from the request, if it was set.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

724

"startCursor": "A String", # A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

725

"kind": [ # The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

726

{ # A representation of a kind.

727

"name": "A String", # The name of the kind.

728

},

729

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

730

"distinctOn": [ # The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

731

{ # A reference to a property relative to the kind expressions.

732

"name": "A String", # The name of the property. If name includes "."s, it may be interpreted as a property name path.

733

},

734

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

735

"endCursor": "A String", # An ending point for the query results. Query cursors are returned in query result batches and [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).

736

"order": [ # The order to apply to the query results (if empty, order is unspecified).

737

{ # The desired order for a specific property.

738

"direction": "A String", # The direction to order by. Defaults to `ASCENDING`.

739

"property": { # A reference to a property relative to the kind expressions. # The property to order by.

740

"name": "A String", # The name of the property. If name includes "."s, it may be interpreted as a property name path.

},

},

],

"limit": 42, # The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.

745

"filter": { # A holder for any type of filter. # The filter to apply.

746

"compositeFilter": { # A filter that merges multiple other filters using the given operator. # A composite filter.

747

"filters": [ # The list of filters to combine. Must contain at least one filter.

748

# Object with schema name: Filter

749

],

750

"op": "A String", # The operator for combining multiple filters.

751

},

752

"propertyFilter": { # A filter on a specific property. # A filter on a property.

753

"op": "A String", # The operator to filter by.

754

"property": { # A reference to a property relative to the kind expressions. # The property to filter by.

755

"name": "A String", # The name of the property. If name includes "."s, it may be interpreted as a property name path.

756

},

757

"value": { # A message that can hold any of the supported value types and associated metadata. # The value to compare the property to.

758

"doubleValue": 3.14, # A double value.

759

"stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.

760

"nullValue": "A String", # A null value.

761

"integerValue": "A String", # An integer value.

762

"entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.

763

"key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

764

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

765

"projectId": "A String", # The ID of the project to which the entities belong.

766

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

767

},

768

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

769

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

770

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

771

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

772

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

},

],

},

"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.

777

"a_key": # Object with schema name: Value

778

},

779

},

780

"keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.

781

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

782

"projectId": "A String", # The ID of the project to which the entities belong.

783

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

784

},

785

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

786

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

787

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

788

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

789

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

},

],

},

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.

794

"meaning": 42, # The `meaning` field should only be populated for backwards compatibility.

795

"geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.

796

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

797

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

798

},

799

"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.

800

"booleanValue": True or False, # A boolean value.

801

"timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

802

"arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.

803

"values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.

804

# Object with schema name: Value

],

},

},

},

},

"offset": 42, # The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.

811

"projection": [ # The projection to return. Defaults to returning all properties.

812

{ # A representation of a property in a projection.

813

"property": { # A reference to a property relative to the kind expressions. # The property to project.

814

"name": "A String", # The name of the property. If name includes "."s, it may be interpreted as a property name path.

815

},

816

},

817

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

818

},

819

"batch": { # A batch of results produced by a query. # A batch of query results (always present).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

820

"snapshotVersion": "A String", # The version number of the snapshot this batch was returned from. This applies to the range of results from the query's `start_cursor` (or the beginning of the query if no cursor was given) to this batch's `end_cursor` (not the query's `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries.

821

"skippedCursor": "A String", # A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

822

"entityResults": [ # The results for this batch.

823

{ # The result of fetching an entity from Datastore.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

824

"cursor": "A String", # A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

825

"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

826

"entity": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The resulting entity.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

827

"key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

828

"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

829

"projectId": "A String", # The ID of the project to which the entities belong.

830

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

831

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

832

"path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

833

{ # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

834

"name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

835

"kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.

836

"id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

837

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

838

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

839

},

840

"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.

841

"a_key": # Object with schema name: Value

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

842

},

843

},

Bu Sun Kim