# frozen_string_literal: true
# Copyright 2023 Google LLC
#
# 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
#
# https://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.
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
require "google/firestore/admin/v1/firestore_admin_pb"
module Google
module Cloud
module Firestore
module Admin
module V1
module FirestoreAdmin
module Rest
##
# REST service stub for the FirestoreAdmin service.
# Service stub contains baseline method implementations
# including transcoding, making the REST call, and deserialing the response.
#
class ServiceStub
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
# These require statements are intentionally placed here to initialize
# the REST modules only when it's required.
require "gapic/rest"
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
endpoint_template: endpoint_template,
universe_domain: universe_domain,
credentials: credentials,
numeric_enums: true,
raise_faraday_errors: false
end
##
# The effective universe domain
#
# @return [String]
#
def universe_domain
@client_stub.universe_domain
end
##
# The effective endpoint
#
# @return [String]
#
def endpoint
@client_stub.endpoint
end
##
# Baseline implementation for the create_index REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::CreateIndexRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def create_index request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_create_index_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the list_indexes REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ListIndexesRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Firestore::Admin::V1::ListIndexesResponse]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Firestore::Admin::V1::ListIndexesResponse]
# A result object deserialized from the server's reply
def list_indexes request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_list_indexes_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Cloud::Firestore::Admin::V1::ListIndexesResponse.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the get_index REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::GetIndexRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Firestore::Admin::V1::Index]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Firestore::Admin::V1::Index]
# A result object deserialized from the server's reply
def get_index request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_get_index_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Cloud::Firestore::Admin::V1::Index.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the delete_index REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Protobuf::Empty]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Protobuf::Empty]
# A result object deserialized from the server's reply
def delete_index request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_delete_index_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the get_field REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::GetFieldRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Firestore::Admin::V1::Field]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Firestore::Admin::V1::Field]
# A result object deserialized from the server's reply
def get_field request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_get_field_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Cloud::Firestore::Admin::V1::Field.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the update_field REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def update_field request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_update_field_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the list_fields REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ListFieldsRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Firestore::Admin::V1::ListFieldsResponse]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Firestore::Admin::V1::ListFieldsResponse]
# A result object deserialized from the server's reply
def list_fields request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_list_fields_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Cloud::Firestore::Admin::V1::ListFieldsResponse.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the export_documents REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def export_documents request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_export_documents_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the import_documents REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def import_documents request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_import_documents_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the bulk_delete_documents REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def bulk_delete_documents request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_bulk_delete_documents_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the create_database REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def create_database request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_create_database_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the get_database REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Firestore::Admin::V1::Database]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Firestore::Admin::V1::Database]
# A result object deserialized from the server's reply
def get_database request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_get_database_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Cloud::Firestore::Admin::V1::Database.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the list_databases REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse]
# A result object deserialized from the server's reply
def list_databases request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_list_databases_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the update_database REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def update_database request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_update_database_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the delete_database REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::DeleteDatabaseRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def delete_database request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_delete_database_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the get_backup REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::GetBackupRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Firestore::Admin::V1::Backup]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Firestore::Admin::V1::Backup]
# A result object deserialized from the server's reply
def get_backup request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_get_backup_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Cloud::Firestore::Admin::V1::Backup.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the list_backups REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ListBackupsRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Firestore::Admin::V1::ListBackupsResponse]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Firestore::Admin::V1::ListBackupsResponse]
# A result object deserialized from the server's reply
def list_backups request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_list_backups_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Cloud::Firestore::Admin::V1::ListBackupsResponse.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the delete_backup REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::DeleteBackupRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Protobuf::Empty]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Protobuf::Empty]
# A result object deserialized from the server's reply
def delete_backup request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_delete_backup_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the restore_database REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def restore_database request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_restore_database_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the create_backup_schedule REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::CreateBackupScheduleRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Firestore::Admin::V1::BackupSchedule]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Firestore::Admin::V1::BackupSchedule]
# A result object deserialized from the server's reply
def create_backup_schedule request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_create_backup_schedule_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Cloud::Firestore::Admin::V1::BackupSchedule.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the get_backup_schedule REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::GetBackupScheduleRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Firestore::Admin::V1::BackupSchedule]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Firestore::Admin::V1::BackupSchedule]
# A result object deserialized from the server's reply
def get_backup_schedule request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_get_backup_schedule_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Cloud::Firestore::Admin::V1::BackupSchedule.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the list_backup_schedules REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse]
# A result object deserialized from the server's reply
def list_backup_schedules request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_list_backup_schedules_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the update_backup_schedule REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::UpdateBackupScheduleRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Firestore::Admin::V1::BackupSchedule]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Firestore::Admin::V1::BackupSchedule]
# A result object deserialized from the server's reply
def update_backup_schedule request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_update_backup_schedule_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Cloud::Firestore::Admin::V1::BackupSchedule.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the delete_backup_schedule REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::DeleteBackupScheduleRequest]
# A request object representing the call parameters. Required.
# @param options [::Gapic::CallOptions]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Protobuf::Empty]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Protobuf::Empty]
# A result object deserialized from the server's reply
def delete_backup_schedule request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_delete_backup_schedule_request request_pb
query_string_params = if query_string_params.any?
query_string_params.to_h { |p| p.split "=", 2 }
else
{}
end
response = @client_stub.make_http_request(
verb,
uri: uri,
body: body || "",
params: query_string_params,
options: options
)
operation = ::Gapic::Rest::TransportOperation.new response
result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# @private
#
# GRPC transcoding helper method for the create_index REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::CreateIndexRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_create_index_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :post,
uri_template: "/v1/{parent}/indexes",
body: "index",
matches: [
["parent", %r{^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the list_indexes REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ListIndexesRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_list_indexes_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v1/{parent}/indexes",
matches: [
["parent", %r{^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the get_index REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::GetIndexRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_get_index_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v1/{name}",
matches: [
["name", %r{^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/indexes/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the delete_index REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_delete_index_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :delete,
uri_template: "/v1/{name}",
matches: [
["name", %r{^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/indexes/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the get_field REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::GetFieldRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_get_field_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v1/{name}",
matches: [
["name", %r{^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/fields/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the update_field REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_update_field_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :patch,
uri_template: "/v1/{field.name}",
body: "field",
matches: [
["field.name", %r{^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/fields/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the list_fields REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ListFieldsRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_list_fields_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v1/{parent}/fields",
matches: [
["parent", %r{^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the export_documents REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_export_documents_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :post,
uri_template: "/v1/{name}:exportDocuments",
body: "*",
matches: [
["name", %r{^projects/[^/]+/databases/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the import_documents REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_import_documents_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :post,
uri_template: "/v1/{name}:importDocuments",
body: "*",
matches: [
["name", %r{^projects/[^/]+/databases/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the bulk_delete_documents REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_bulk_delete_documents_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :post,
uri_template: "/v1/{name}:bulkDeleteDocuments",
body: "*",
matches: [
["name", %r{^projects/[^/]+/databases/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the create_database REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_create_database_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :post,
uri_template: "/v1/{parent}/databases",
body: "database",
matches: [
["parent", %r{^projects/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the get_database REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_get_database_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v1/{name}",
matches: [
["name", %r{^projects/[^/]+/databases/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the list_databases REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_list_databases_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v1/{parent}/databases",
matches: [
["parent", %r{^projects/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the update_database REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_update_database_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :patch,
uri_template: "/v1/{database.name}",
body: "database",
matches: [
["database.name", %r{^projects/[^/]+/databases/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the delete_database REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::DeleteDatabaseRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_delete_database_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :delete,
uri_template: "/v1/{name}",
matches: [
["name", %r{^projects/[^/]+/databases/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the get_backup REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::GetBackupRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_get_backup_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v1/{name}",
matches: [
["name", %r{^projects/[^/]+/locations/[^/]+/backups/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the list_backups REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ListBackupsRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_list_backups_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v1/{parent}/backups",
matches: [
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the delete_backup REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::DeleteBackupRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_delete_backup_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :delete,
uri_template: "/v1/{name}",
matches: [
["name", %r{^projects/[^/]+/locations/[^/]+/backups/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the restore_database REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_restore_database_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :post,
uri_template: "/v1/{parent}/databases:restore",
body: "*",
matches: [
["parent", %r{^projects/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the create_backup_schedule REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::CreateBackupScheduleRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_create_backup_schedule_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :post,
uri_template: "/v1/{parent}/backupSchedules",
body: "backup_schedule",
matches: [
["parent", %r{^projects/[^/]+/databases/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the get_backup_schedule REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::GetBackupScheduleRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_get_backup_schedule_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v1/{name}",
matches: [
["name", %r{^projects/[^/]+/databases/[^/]+/backupSchedules/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the list_backup_schedules REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_list_backup_schedules_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v1/{parent}/backupSchedules",
matches: [
["parent", %r{^projects/[^/]+/databases/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the update_backup_schedule REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::UpdateBackupScheduleRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_update_backup_schedule_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :patch,
uri_template: "/v1/{backup_schedule.name}",
body: "backup_schedule",
matches: [
["backup_schedule.name", %r{^projects/[^/]+/databases/[^/]+/backupSchedules/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the delete_backup_schedule REST call
#
# @param request_pb [::Google::Cloud::Firestore::Admin::V1::DeleteBackupScheduleRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_delete_backup_schedule_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :delete,
uri_template: "/v1/{name}",
matches: [
["name", %r{^projects/[^/]+/databases/[^/]+/backupSchedules/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
end
end
end
end
end
end
end
end