Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::ServiceStub (v1.1.0)

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

#bulk_delete_documents

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

Baseline implementation for the bulk_delete_documents REST call

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

#create_backup_schedule

def create_backup_schedule(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule

Baseline implementation for the create_backup_schedule REST call

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

#create_database

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

Baseline implementation for the create_database REST call

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

#create_index

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

Baseline implementation for the create_index REST call

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

#delete_backup

def delete_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_backup REST call

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

#delete_backup_schedule

def delete_backup_schedule(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_backup_schedule REST call

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

#delete_database

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

Baseline implementation for the delete_database REST call

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

#delete_index

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

Baseline implementation for the delete_index REST call

Parameters
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)

#export_documents

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

Baseline implementation for the export_documents REST call

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

#get_backup

def get_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::Admin::V1::Backup

Baseline implementation for the get_backup REST call

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

#get_backup_schedule

def get_backup_schedule(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule

Baseline implementation for the get_backup_schedule REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

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

#import_documents

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

Baseline implementation for the import_documents REST call

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

#initialize

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

#list_backup_schedules

def list_backup_schedules(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse

Baseline implementation for the list_backup_schedules REST call

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

#list_backups

def list_backups(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::Admin::V1::ListBackupsResponse

Baseline implementation for the list_backups REST call

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

#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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

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

#restore_database

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

Baseline implementation for the restore_database REST call

Parameters
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)

#update_backup_schedule

def update_backup_schedule(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule

Baseline implementation for the update_backup_schedule REST call

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

#update_database

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

Baseline implementation for the update_database REST call

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

#update_field

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

Baseline implementation for the update_field REST call

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