Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::ServiceStub.
REST service stub for the FirestoreAdmin service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.
Inherits
- Object
Methods
#create_database
def create_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_database REST call
- request_pb (::Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_index
def create_index(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_index REST call
- request_pb (::Google::Cloud::Firestore::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_database
def delete_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_database REST call
- request_pb (::Google::Cloud::Firestore::Admin::V1::DeleteDatabaseRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_index
def delete_index(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_index REST call
- request_pb (::Google::Cloud::Firestore::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#export_documents
def export_documents(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the export_documents REST call
- request_pb (::Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_database
def get_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::Admin::V1::Database
Baseline implementation for the get_database REST call
- request_pb (::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::Admin::V1::Database)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::Admin::V1::Database) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_field
def get_field(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::Admin::V1::Field
Baseline implementation for the get_field REST call
- request_pb (::Google::Cloud::Firestore::Admin::V1::GetFieldRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::Admin::V1::Field)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::Admin::V1::Field) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_index
def get_index(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::Admin::V1::Index
Baseline implementation for the get_index REST call
- request_pb (::Google::Cloud::Firestore::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::Admin::V1::Index)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::Admin::V1::Index) — A result object deserialized from the server's reply
- (::ArgumentError)
#import_documents
def import_documents(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the import_documents REST call
- request_pb (::Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
- (ServiceStub) — a new instance of ServiceStub
#list_databases
def list_databases(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse
Baseline implementation for the list_databases REST call
- request_pb (::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_fields
def list_fields(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::Admin::V1::ListFieldsResponse
Baseline implementation for the list_fields REST call
- request_pb (::Google::Cloud::Firestore::Admin::V1::ListFieldsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::Admin::V1::ListFieldsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::Admin::V1::ListFieldsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_indexes
def list_indexes(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::Admin::V1::ListIndexesResponse
Baseline implementation for the list_indexes REST call
- request_pb (::Google::Cloud::Firestore::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::Admin::V1::ListIndexesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::Admin::V1::ListIndexesResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_database
def update_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_database REST call
- request_pb (::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_field
def update_field(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_field REST call
- request_pb (::Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)