Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::Datastore::Rest::ServiceStub (v0.18.0)

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::Datastore::Rest::ServiceStub.

REST service stub for the Datastore service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

  • Object

Methods

#allocate_ids

def allocate_ids(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Datastore::V1::AllocateIdsResponse

Baseline implementation for the allocate_ids REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#begin_transaction

def begin_transaction(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Datastore::V1::BeginTransactionResponse

Baseline implementation for the begin_transaction REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#commit

def commit(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Datastore::V1::CommitResponse

Baseline implementation for the commit REST call

Parameters
  • request_pb (::Google::Cloud::Datastore::V1::CommitRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
Returns

#lookup

def lookup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Datastore::V1::LookupResponse

Baseline implementation for the lookup REST call

Parameters
  • request_pb (::Google::Cloud::Datastore::V1::LookupRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#reserve_ids

def reserve_ids(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Datastore::V1::ReserveIdsResponse

Baseline implementation for the reserve_ids REST call

Parameters
  • request_pb (::Google::Cloud::Datastore::V1::ReserveIdsRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#rollback

def rollback(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Datastore::V1::RollbackResponse

Baseline implementation for the rollback REST call

Parameters
  • request_pb (::Google::Cloud::Datastore::V1::RollbackRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#run_aggregation_query

def run_aggregation_query(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Datastore::V1::RunAggregationQueryResponse

Baseline implementation for the run_aggregation_query REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#run_query

def run_query(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Datastore::V1::RunQueryResponse

Baseline implementation for the run_query REST call

Parameters
  • request_pb (::Google::Cloud::Datastore::V1::RunQueryRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)