Firestore in Datastore mode Admin V1 API - Class Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::ServiceStub (v1.0.1)

Version latest

• 1.0.1 (latest)
• 1.0.0
• 0.12.0
• 0.11.2
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.5

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

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

Inherits

• Object

Methods

#create_index

def create_index(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_index REST call

Parameters

• request_pb (::Google::Cloud::Datastore::Admin::V1::CreateIndexRequest) — 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

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_index

def delete_index(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_index REST call

Parameters

• request_pb (::Google::Cloud::Datastore::Admin::V1::DeleteIndexRequest) — 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

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#export_entities

def export_entities(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the export_entities REST call

Parameters

• request_pb (::Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest) — 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

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_index

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

Baseline implementation for the get_index REST call

Parameters

• request_pb (::Google::Cloud::Datastore::Admin::V1::GetIndexRequest) — 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

• result (::Google::Cloud::Datastore::Admin::V1::Index)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Datastore::Admin::V1::Index) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#import_entities

def import_entities(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the import_entities REST call

Parameters

• request_pb (::Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest) — 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

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

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

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_indexes

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

Baseline implementation for the list_indexes REST call

Parameters

• request_pb (::Google::Cloud::Datastore::Admin::V1::ListIndexesRequest) — 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

• result (::Google::Cloud::Datastore::Admin::V1::ListIndexesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Datastore::Admin::V1::ListIndexesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)