Class: Google::Apis::DatastoreV1::DatastoreService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/datastore_v1/service.rb

Overview

Cloud Datastore API

Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.

Examples:

require 'google/apis/datastore_v1'

Datastore = Google::Apis::DatastoreV1 # Alias the module
service = Datastore::DatastoreService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeDatastoreService


46
47
48
49
# File 'generated/google/apis/datastore_v1/service.rb', line 46

def initialize
  super('https://datastore.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString


39
40
41
# File 'generated/google/apis/datastore_v1/service.rb', line 39

def key
  @key
end

#quota_userString


44
45
46
# File 'generated/google/apis/datastore_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#allocate_project_ids(project_id, allocate_ids_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::AllocateIdsResponse

Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


73
74
75
76
77
78
79
80
81
82
83
# File 'generated/google/apis/datastore_v1/service.rb', line 73

def allocate_project_ids(project_id, allocate_ids_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects/{projectId}:allocateIds', options)
  command.request_representation = Google::Apis::DatastoreV1::AllocateIdsRequest::Representation
  command.request_object = allocate_ids_request_object
  command.response_representation = Google::Apis::DatastoreV1::AllocateIdsResponse::Representation
  command.response_class = Google::Apis::DatastoreV1::AllocateIdsResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#begin_project_transaction(project_id, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::BeginTransactionResponse

Begins a new transaction.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


106
107
108
109
110
111
112
113
114
115
116
# File 'generated/google/apis/datastore_v1/service.rb', line 106

def begin_project_transaction(project_id, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects/{projectId}:beginTransaction', options)
  command.request_representation = Google::Apis::DatastoreV1::BeginTransactionRequest::Representation
  command.request_object = begin_transaction_request_object
  command.response_representation = Google::Apis::DatastoreV1::BeginTransactionResponse::Representation
  command.response_class = Google::Apis::DatastoreV1::BeginTransactionResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


465
466
467
468
469
470
471
472
473
# File 'generated/google/apis/datastore_v1/service.rb', line 465

def cancel_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::DatastoreV1::Empty::Representation
  command.response_class = Google::Apis::DatastoreV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#commit_project(project_id, commit_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::CommitResponse

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


140
141
142
143
144
145
146
147
148
149
150
# File 'generated/google/apis/datastore_v1/service.rb', line 140

def commit_project(project_id, commit_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects/{projectId}:commit', options)
  command.request_representation = Google::Apis::DatastoreV1::CommitRequest::Representation
  command.request_object = commit_request_object
  command.response_representation = Google::Apis::DatastoreV1::CommitResponse::Representation
  command.response_class = Google::Apis::DatastoreV1::CommitResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


498
499
500
501
502
503
504
505
506
# File 'generated/google/apis/datastore_v1/service.rb', line 498

def delete_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DatastoreV1::Empty::Representation
  command.response_class = Google::Apis::DatastoreV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project(project_id, google_datastore_admin_v1_export_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::GoogleLongrunningOperation

Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage. Recent updates to entities may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


180
181
182
183
184
185
186
187
188
189
190
# File 'generated/google/apis/datastore_v1/service.rb', line 180

def export_project(project_id, google_datastore_admin_v1_export_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects/{projectId}:export', options)
  command.request_representation = Google::Apis::DatastoreV1::GoogleDatastoreAdminV1ExportEntitiesRequest::Representation
  command.request_object = google_datastore_admin_v1_export_entities_request_object
  command.response_representation = Google::Apis::DatastoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DatastoreV1::GoogleLongrunningOperation
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_index(project_id, index_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::GoogleDatastoreAdminV1Index

Gets an index.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


384
385
386
387
388
389
390
391
392
393
# File 'generated/google/apis/datastore_v1/service.rb', line 384

def get_project_index(project_id, index_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects/{projectId}/indexes/{indexId}', options)
  command.response_representation = Google::Apis::DatastoreV1::GoogleDatastoreAdminV1Index::Representation
  command.response_class = Google::Apis::DatastoreV1::GoogleDatastoreAdminV1Index
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['indexId'] = index_id unless index_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


530
531
532
533
534
535
536
537
538
# File 'generated/google/apis/datastore_v1/service.rb', line 530

def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DatastoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DatastoreV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project(project_id, google_datastore_admin_v1_import_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::GoogleLongrunningOperation

Imports entities into Google Cloud Datastore. Existing entities with the same key are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportEntities operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


217
218
219
220
221
222
223
224
225
226
227
# File 'generated/google/apis/datastore_v1/service.rb', line 217

def import_project(project_id, google_datastore_admin_v1_import_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects/{projectId}:import', options)
  command.request_representation = Google::Apis::DatastoreV1::GoogleDatastoreAdminV1ImportEntitiesRequest::Representation
  command.request_object = google_datastore_admin_v1_import_entities_request_object
  command.response_representation = Google::Apis::DatastoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DatastoreV1::GoogleLongrunningOperation
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_indexes(project_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::GoogleDatastoreAdminV1ListIndexesResponse

Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


423
424
425
426
427
428
429
430
431
432
433
434
# File 'generated/google/apis/datastore_v1/service.rb', line 423

def list_project_indexes(project_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects/{projectId}/indexes', options)
  command.response_representation = Google::Apis::DatastoreV1::GoogleDatastoreAdminV1ListIndexesResponse::Representation
  command.response_class = Google::Apis::DatastoreV1::GoogleDatastoreAdminV1ListIndexesResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


574
575
576
577
578
579
580
581
582
583
584
585
# File 'generated/google/apis/datastore_v1/service.rb', line 574

def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DatastoreV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DatastoreV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_project(project_id, lookup_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::LookupResponse

Looks up entities by key.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


250
251
252
253
254
255
256
257
258
259
260
# File 'generated/google/apis/datastore_v1/service.rb', line 250

def lookup_project(project_id, lookup_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects/{projectId}:lookup', options)
  command.request_representation = Google::Apis::DatastoreV1::LookupRequest::Representation
  command.request_object = lookup_request_object
  command.response_representation = Google::Apis::DatastoreV1::LookupResponse::Representation
  command.response_class = Google::Apis::DatastoreV1::LookupResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reserve_project_ids(project_id, reserve_ids_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::ReserveIdsResponse

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


284
285
286
287
288
289
290
291
292
293
294
# File 'generated/google/apis/datastore_v1/service.rb', line 284

def reserve_project_ids(project_id, reserve_ids_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects/{projectId}:reserveIds', options)
  command.request_representation = Google::Apis::DatastoreV1::ReserveIdsRequest::Representation
  command.request_object = reserve_ids_request_object
  command.response_representation = Google::Apis::DatastoreV1::ReserveIdsResponse::Representation
  command.response_class = Google::Apis::DatastoreV1::ReserveIdsResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rollback_project(project_id, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::RollbackResponse

Rolls back a transaction.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


317
318
319
320
321
322
323
324
325
326
327
# File 'generated/google/apis/datastore_v1/service.rb', line 317

def rollback_project(project_id, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects/{projectId}:rollback', options)
  command.request_representation = Google::Apis::DatastoreV1::RollbackRequest::Representation
  command.request_object = rollback_request_object
  command.response_representation = Google::Apis::DatastoreV1::RollbackResponse::Representation
  command.response_class = Google::Apis::DatastoreV1::RollbackResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_project_query(project_id, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DatastoreV1::RunQueryResponse

Queries for entities.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


350
351
352
353
354
355
356
357
358
359
360
# File 'generated/google/apis/datastore_v1/service.rb', line 350

def run_project_query(project_id, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects/{projectId}:runQuery', options)
  command.request_representation = Google::Apis::DatastoreV1::RunQueryRequest::Representation
  command.request_object = run_query_request_object
  command.response_representation = Google::Apis::DatastoreV1::RunQueryResponse::Representation
  command.response_class = Google::Apis::DatastoreV1::RunQueryResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end