google-api-ruby-client/generated/google/apis/datastore_v1/service.rb

260 lines
15 KiB
Ruby
Raw Normal View History

2016-09-20 18:55:45 +00:00
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module DatastoreV1
# Google Cloud Datastore API
#
# Accesses the schemaless NoSQL database to provide fully managed, robust,
# scalable storage for your application.
#
# @example
# require 'google/apis/datastore_v1'
#
# Datastore = Google::Apis::DatastoreV1 # Alias the module
# service = Datastore::DatastoreService.new
#
# @see https://cloud.google.com/datastore/
class DatastoreService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://datastore.googleapis.com/', '')
end
2017-03-30 22:30:51 +00:00
# Allocates IDs for the given keys, which is useful for referencing an entity
# before it is inserted.
2016-09-20 18:55:45 +00:00
# @param [String] project_id
# The ID of the project against which to make the request.
2017-03-30 22:30:51 +00:00
# @param [Google::Apis::DatastoreV1::AllocateIdsRequest] allocate_ids_request_object
2016-09-20 18:55:45 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-09-20 18:55:45 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-30 22:30:51 +00:00
# @yieldparam result [Google::Apis::DatastoreV1::AllocateIdsResponse] parsed result object
2016-09-20 18:55:45 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-30 22:30:51 +00:00
# @return [Google::Apis::DatastoreV1::AllocateIdsResponse]
2016-09-20 18:55:45 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def allocate_project_ids(project_id, allocate_ids_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
2017-03-30 22:30:51 +00:00
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
2016-09-20 18:55:45 +00:00
command.params['projectId'] = project_id unless project_id.nil?
2017-03-30 22:30:51 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-09-20 18:55:45 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Begins a new transaction.
2016-09-20 18:55:45 +00:00
# @param [String] project_id
# The ID of the project against which to make the request.
2017-03-31 19:53:27 +00:00
# @param [Google::Apis::DatastoreV1::BeginTransactionRequest] begin_transaction_request_object
2016-09-20 18:55:45 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-09-20 18:55:45 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DatastoreV1::BeginTransactionResponse] parsed result object
2016-09-20 18:55:45 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DatastoreV1::BeginTransactionResponse]
2016-09-20 18:55:45 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def begin_project_transaction(project_id, begin_transaction_request_object = nil, quota_user: nil, fields: 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
2016-09-20 18:55:45 +00:00
command.params['projectId'] = project_id unless project_id.nil?
2017-03-30 22:30:51 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-09-20 18:55:45 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Commits a transaction, optionally creating, deleting or modifying some
# entities.
2016-09-20 18:55:45 +00:00
# @param [String] project_id
# The ID of the project against which to make the request.
2017-03-31 19:53:27 +00:00
# @param [Google::Apis::DatastoreV1::CommitRequest] commit_request_object
2016-09-20 18:55:45 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-09-20 18:55:45 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DatastoreV1::CommitResponse] parsed result object
2016-09-20 18:55:45 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DatastoreV1::CommitResponse]
2016-09-20 18:55:45 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def commit_project(project_id, commit_request_object = nil, quota_user: nil, fields: 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
2016-09-20 18:55:45 +00:00
command.params['projectId'] = project_id unless project_id.nil?
2017-03-30 22:30:51 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-09-20 18:55:45 +00:00
execute_or_queue_command(command, &block)
end
2017-03-30 22:30:51 +00:00
# Queries for entities.
2016-09-20 18:55:45 +00:00
# @param [String] project_id
# The ID of the project against which to make the request.
2017-03-30 22:30:51 +00:00
# @param [Google::Apis::DatastoreV1::RunQueryRequest] run_query_request_object
2016-09-20 18:55:45 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-09-20 18:55:45 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-30 22:30:51 +00:00
# @yieldparam result [Google::Apis::DatastoreV1::RunQueryResponse] parsed result object
2016-09-20 18:55:45 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-30 22:30:51 +00:00
# @return [Google::Apis::DatastoreV1::RunQueryResponse]
2016-09-20 18:55:45 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def run_project_query(project_id, run_query_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
2017-03-30 22:30:51 +00:00
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
2016-09-20 18:55:45 +00:00
command.params['projectId'] = project_id unless project_id.nil?
2017-03-30 22:30:51 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-09-20 18:55:45 +00:00
execute_or_queue_command(command, &block)
end
2017-03-30 22:30:51 +00:00
# Rolls back a transaction.
2016-09-20 18:55:45 +00:00
# @param [String] project_id
# The ID of the project against which to make the request.
2017-03-30 22:30:51 +00:00
# @param [Google::Apis::DatastoreV1::RollbackRequest] rollback_request_object
2016-09-20 18:55:45 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-09-20 18:55:45 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-30 22:30:51 +00:00
# @yieldparam result [Google::Apis::DatastoreV1::RollbackResponse] parsed result object
2016-09-20 18:55:45 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-30 22:30:51 +00:00
# @return [Google::Apis::DatastoreV1::RollbackResponse]
2016-09-20 18:55:45 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def rollback_project(project_id, rollback_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
2017-03-30 22:30:51 +00:00
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
2016-09-20 18:55:45 +00:00
command.params['projectId'] = project_id unless project_id.nil?
2017-03-30 22:30:51 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-09-20 18:55:45 +00:00
execute_or_queue_command(command, &block)
end
2017-03-30 22:30:51 +00:00
# Looks up entities by key.
2016-09-20 18:55:45 +00:00
# @param [String] project_id
# The ID of the project against which to make the request.
2017-03-30 22:30:51 +00:00
# @param [Google::Apis::DatastoreV1::LookupRequest] lookup_request_object
2016-09-20 18:55:45 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-09-20 18:55:45 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-30 22:30:51 +00:00
# @yieldparam result [Google::Apis::DatastoreV1::LookupResponse] parsed result object
2016-09-20 18:55:45 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-30 22:30:51 +00:00
# @return [Google::Apis::DatastoreV1::LookupResponse]
2016-09-20 18:55:45 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def lookup_project(project_id, lookup_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
2017-03-30 22:30:51 +00:00
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
2016-09-20 18:55:45 +00:00
command.params['projectId'] = project_id unless project_id.nil?
2017-03-30 22:30:51 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-09-20 18:55:45 +00:00
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end