# frozen_string_literal: true # Copyright 2020 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/cloud/errors" require "google/firestore/admin/v1/firestore_admin_pb" require "google/cloud/location" module Google module Cloud module Firestore module Admin module V1 module FirestoreAdmin ## # Client for the FirestoreAdmin service. # # The Cloud Firestore Admin API. # # This API provides several administrative services for Cloud Firestore. # # Project, Database, Namespace, Collection, Collection Group, and Document are # used as defined in the Google Cloud Firestore API. # # Operation: An Operation represents work being performed in the background. # # The index service manages Cloud Firestore indexes. # # Index creation is performed asynchronously. # An Operation resource is created for each such asynchronous operation. # The state of the operation (including any errors encountered) # may be queried via the Operation resource. # # The Operations collection provides a record of actions performed for the # specified Project (including any Operations in progress). Operations are not # created directly but through calls on other collections or resources. # # An Operation that is done may be deleted so that it is no longer listed as # part of the Operation collection. Operations are garbage collected after # 30 days. By default, ListOperations will only return in progress and failed # operations. To list completed operation, issue a ListOperations request with # the filter `done: true`. # # Operations are created by service `FirestoreAdmin`, but are accessed via # service `google.longrunning.Operations`. # class Client # @private DEFAULT_ENDPOINT_TEMPLATE = "firestore.$UNIVERSE_DOMAIN$" include Paths # @private attr_reader :firestore_admin_stub ## # Configure the FirestoreAdmin Client class. # # See {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all FirestoreAdmin clients # ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Firestore", "Admin", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.create_index.timeout = 60.0 default_config.rpcs.list_indexes.timeout = 60.0 default_config.rpcs.list_indexes.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4] } default_config.rpcs.get_index.timeout = 60.0 default_config.rpcs.get_index.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4] } default_config.rpcs.delete_index.timeout = 60.0 default_config.rpcs.delete_index.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4] } default_config.rpcs.get_field.timeout = 60.0 default_config.rpcs.get_field.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4] } default_config.rpcs.update_field.timeout = 60.0 default_config.rpcs.list_fields.timeout = 60.0 default_config.rpcs.list_fields.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4] } default_config.rpcs.export_documents.timeout = 60.0 default_config.rpcs.import_documents.timeout = 60.0 default_config end yield @configure if block_given? @configure end ## # Configure the FirestoreAdmin Client instance. # # The configuration is set to the derived mode, meaning that values can be changed, # but structural changes (adding new fields, etc.) are not allowed. Structural changes # should be made on {Client.configure}. # # See {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # The effective universe domain # # @return [String] # def universe_domain @firestore_admin_stub.universe_domain end ## # Create a new FirestoreAdmin client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the FirestoreAdmin client. # @yieldparam config [Client::Configuration] # def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/firestore/admin/v1/firestore_admin_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @firestore_admin_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) @location_client = Google::Cloud::Location::Locations::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @firestore_admin_stub.endpoint config.universe_domain = @firestore_admin_stub.universe_domain end end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Operations] # attr_reader :operations_client ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Client] # attr_reader :location_client # Service calls ## # Creates a composite index. This returns a # {::Google::Longrunning::Operation google.longrunning.Operation} which may be # used to track the status of the creation. The metadata for the operation # will be the type # {::Google::Cloud::Firestore::Admin::V1::IndexOperationMetadata IndexOperationMetadata}. # # @overload create_index(request, options = nil) # Pass arguments to `create_index` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::CreateIndexRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::CreateIndexRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload create_index(parent: nil, index: nil) # Pass arguments to `create_index` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. A parent name of the form # `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` # @param index [::Google::Cloud::Firestore::Admin::V1::Index, ::Hash] # Required. The composite index to create. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::CreateIndexRequest.new # # # Call the create_index method. # result = client.create_index request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def create_index request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::CreateIndexRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_index.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_index.timeout, metadata: metadata, retry_policy: @config.rpcs.create_index.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :create_index, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Lists composite indexes. # # @overload list_indexes(request, options = nil) # Pass arguments to `list_indexes` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::ListIndexesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::ListIndexesRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload list_indexes(parent: nil, filter: nil, page_size: nil, page_token: nil) # Pass arguments to `list_indexes` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. A parent name of the form # `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` # @param filter [::String] # The filter to apply to list results. # @param page_size [::Integer] # The number of results to return. # @param page_token [::String] # A page token, returned from a previous call to # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_indexes FirestoreAdmin.ListIndexes}, # that may be used to get the next page of results. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Index>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Index>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::ListIndexesRequest.new # # # Call the list_indexes method. # result = client.list_indexes request # # # The returned object is of type Gapic::PagedEnumerable. You can iterate # # over elements, and API calls will be issued to fetch pages as needed. # result.each do |item| # # Each element is of type ::Google::Cloud::Firestore::Admin::V1::Index. # p item # end # def list_indexes request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::ListIndexesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_indexes.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_indexes.timeout, metadata: metadata, retry_policy: @config.rpcs.list_indexes.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :list_indexes, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @firestore_admin_stub, :list_indexes, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets a composite index. # # @overload get_index(request, options = nil) # Pass arguments to `get_index` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::GetIndexRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::GetIndexRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload get_index(name: nil) # Pass arguments to `get_index` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. A name of the form # `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Firestore::Admin::V1::Index] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Firestore::Admin::V1::Index] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::GetIndexRequest.new # # # Call the get_index method. # result = client.get_index request # # # The returned object is of type Google::Cloud::Firestore::Admin::V1::Index. # p result # def get_index request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::GetIndexRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_index.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_index.timeout, metadata: metadata, retry_policy: @config.rpcs.get_index.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :get_index, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes a composite index. # # @overload delete_index(request, options = nil) # Pass arguments to `delete_index` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload delete_index(name: nil) # Pass arguments to `delete_index` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. A name of the form # `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Protobuf::Empty] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Protobuf::Empty] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest.new # # # Call the delete_index method. # result = client.delete_index request # # # The returned object is of type Google::Protobuf::Empty. # p result # def delete_index request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_index.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_index.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_index.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :delete_index, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets the metadata and configuration for a Field. # # @overload get_field(request, options = nil) # Pass arguments to `get_field` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::GetFieldRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::GetFieldRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload get_field(name: nil) # Pass arguments to `get_field` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. A name of the form # `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Firestore::Admin::V1::Field] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Firestore::Admin::V1::Field] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::GetFieldRequest.new # # # Call the get_field method. # result = client.get_field request # # # The returned object is of type Google::Cloud::Firestore::Admin::V1::Field. # p result # def get_field request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::GetFieldRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_field.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_field.timeout, metadata: metadata, retry_policy: @config.rpcs.get_field.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :get_field, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Updates a field configuration. Currently, field updates apply only to # single field index configuration. However, calls to # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_field FirestoreAdmin.UpdateField} # should provide a field mask to avoid changing any configuration that the # caller isn't aware of. The field mask should be specified as: `{ paths: # "index_config" }`. # # This call returns a # {::Google::Longrunning::Operation google.longrunning.Operation} which may be # used to track the status of the field update. The metadata for the # operation will be the type # {::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata FieldOperationMetadata}. # # To configure the default field settings for the database, use # the special `Field` with resource name: # `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`. # # @overload update_field(request, options = nil) # Pass arguments to `update_field` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload update_field(field: nil, update_mask: nil) # Pass arguments to `update_field` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param field [::Google::Cloud::Firestore::Admin::V1::Field, ::Hash] # Required. The field to be updated. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # A mask, relative to the field. If specified, only configuration specified # by this field_mask will be updated in the field. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest.new # # # Call the update_field method. # result = client.update_field request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def update_field request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_field.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.field&.name header_params["field.name"] = request.field.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_field.timeout, metadata: metadata, retry_policy: @config.rpcs.update_field.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :update_field, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Lists the field configuration and metadata for this database. # # Currently, # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} # only supports listing fields that have been explicitly overridden. To issue # this query, call # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} # with the filter set to `indexConfig.usesAncestorConfig:false` or # `ttlConfig:*`. # # @overload list_fields(request, options = nil) # Pass arguments to `list_fields` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::ListFieldsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::ListFieldsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload list_fields(parent: nil, filter: nil, page_size: nil, page_token: nil) # Pass arguments to `list_fields` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. A parent name of the form # `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` # @param filter [::String] # The filter to apply to list results. Currently, # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} # only supports listing fields that have been explicitly overridden. To issue # this query, call # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} # with a filter that includes `indexConfig.usesAncestorConfig:false` . # @param page_size [::Integer] # The number of results to return. # @param page_token [::String] # A page token, returned from a previous call to # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields}, # that may be used to get the next page of results. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Field>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Field>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::ListFieldsRequest.new # # # Call the list_fields method. # result = client.list_fields request # # # The returned object is of type Gapic::PagedEnumerable. You can iterate # # over elements, and API calls will be issued to fetch pages as needed. # result.each do |item| # # Each element is of type ::Google::Cloud::Firestore::Admin::V1::Field. # p item # end # def list_fields request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::ListFieldsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_fields.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_fields.timeout, metadata: metadata, retry_policy: @config.rpcs.list_fields.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :list_fields, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @firestore_admin_stub, :list_fields, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Exports a copy of all or a subset of documents from Google Cloud Firestore # to another storage system, such as Google Cloud Storage. Recent updates to # documents may not be reflected in the export. The export occurs in the # background and its progress can be monitored and managed via the # Operation resource that is created. The output of an export may only be # used once the associated operation is done. If an export operation is # cancelled before completion it may leave partial data behind in Google # Cloud Storage. # # For more details on export behavior and output format, refer to: # https://cloud.google.com/firestore/docs/manage-data/export-import # # @overload export_documents(request, options = nil) # Pass arguments to `export_documents` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload export_documents(name: nil, collection_ids: nil, output_uri_prefix: nil, namespace_ids: nil, snapshot_time: nil) # Pass arguments to `export_documents` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. Database to export. Should be of the form: # `projects/{project_id}/databases/{database_id}`. # @param collection_ids [::Array<::String>] # Which collection ids to export. Unspecified means all collections. # @param output_uri_prefix [::String] # The output URI. Currently only supports Google Cloud Storage URIs of the # form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name # of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional # Google Cloud Storage namespace path. When # choosing a name, be sure to consider Google Cloud Storage naming # guidelines: https://cloud.google.com/storage/docs/naming. # If the URI is a bucket (without a namespace path), a prefix will be # generated based on the start time. # @param namespace_ids [::Array<::String>] # An empty list represents all namespaces. This is the preferred # usage for databases that don't use namespaces. # # An empty string element represents the default namespace. This should be # used if the database has data in non-default namespaces, but doesn't want # to include them. Each namespace in this list must be unique. # @param snapshot_time [::Google::Protobuf::Timestamp, ::Hash] # The timestamp that corresponds to the version of the database to be # exported. The timestamp must be in the past, rounded to the minute and not # older than # {::Google::Cloud::Firestore::Admin::V1::Database#earliest_version_time earliestVersionTime}. # If specified, then the exported documents will represent a consistent view # of the database at the provided time. Otherwise, there are no guarantees # about the consistency of the exported documents. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest.new # # # Call the export_documents method. # result = client.export_documents request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def export_documents request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.export_documents.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.export_documents.timeout, metadata: metadata, retry_policy: @config.rpcs.export_documents.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :export_documents, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Imports documents into Google Cloud Firestore. Existing documents with the # same name are overwritten. The import occurs in the background and its # progress can be monitored and managed via the Operation resource that is # created. If an ImportDocuments operation is cancelled, it is possible # that a subset of the data has already been imported to Cloud Firestore. # # @overload import_documents(request, options = nil) # Pass arguments to `import_documents` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload import_documents(name: nil, collection_ids: nil, input_uri_prefix: nil, namespace_ids: nil) # Pass arguments to `import_documents` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. Database to import into. Should be of the form: # `projects/{project_id}/databases/{database_id}`. # @param collection_ids [::Array<::String>] # Which collection ids to import. Unspecified means all collections included # in the import. # @param input_uri_prefix [::String] # Location of the exported files. # This must match the output_uri_prefix of an ExportDocumentsResponse from # an export that has completed successfully. # See: # {::Google::Cloud::Firestore::Admin::V1::ExportDocumentsResponse#output_uri_prefix google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix}. # @param namespace_ids [::Array<::String>] # An empty list represents all namespaces. This is the preferred # usage for databases that don't use namespaces. # # An empty string element represents the default namespace. This should be # used if the database has data in non-default namespaces, but doesn't want # to include them. Each namespace in this list must be unique. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest.new # # # Call the import_documents method. # result = client.import_documents request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def import_documents request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.import_documents.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.import_documents.timeout, metadata: metadata, retry_policy: @config.rpcs.import_documents.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :import_documents, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Create a database. # # @overload create_database(request, options = nil) # Pass arguments to `create_database` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload create_database(parent: nil, database: nil, database_id: nil) # Pass arguments to `create_database` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. A parent name of the form # `projects/{project_id}` # @param database [::Google::Cloud::Firestore::Admin::V1::Database, ::Hash] # Required. The Database to create. # @param database_id [::String] # Required. The ID to use for the database, which will become the final # component of the database's resource name. # # This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ # with first character a letter and the last a letter or a number. Must not # be UUID-like /[0-9a-f]\\{8}(-[0-9a-f]\\{4})\\{3}-[0-9a-f]\\{12}/. # # "(default)" database id is also valid. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest.new # # # Call the create_database method. # result = client.create_database request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def create_database request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_database.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_database.timeout, metadata: metadata, retry_policy: @config.rpcs.create_database.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :create_database, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets information about a database. # # @overload get_database(request, options = nil) # Pass arguments to `get_database` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload get_database(name: nil) # Pass arguments to `get_database` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. A name of the form # `projects/{project_id}/databases/{database_id}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Firestore::Admin::V1::Database] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Firestore::Admin::V1::Database] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest.new # # # Call the get_database method. # result = client.get_database request # # # The returned object is of type Google::Cloud::Firestore::Admin::V1::Database. # p result # def get_database request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_database.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_database.timeout, metadata: metadata, retry_policy: @config.rpcs.get_database.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :get_database, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # List all the databases in the project. # # @overload list_databases(request, options = nil) # Pass arguments to `list_databases` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload list_databases(parent: nil) # Pass arguments to `list_databases` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. A parent name of the form # `projects/{project_id}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest.new # # # Call the list_databases method. # result = client.list_databases request # # # The returned object is of type Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse. # p result # def list_databases request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_databases.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_databases.timeout, metadata: metadata, retry_policy: @config.rpcs.list_databases.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :list_databases, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Updates a database. # # @overload update_database(request, options = nil) # Pass arguments to `update_database` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload update_database(database: nil, update_mask: nil) # Pass arguments to `update_database` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param database [::Google::Cloud::Firestore::Admin::V1::Database, ::Hash] # Required. The database to update. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # The list of fields to be updated. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest.new # # # Call the update_database method. # result = client.update_database request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def update_database request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_database.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.database&.name header_params["database.name"] = request.database.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_database.timeout, metadata: metadata, retry_policy: @config.rpcs.update_database.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :update_database, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes a database. # # @overload delete_database(request, options = nil) # Pass arguments to `delete_database` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::DeleteDatabaseRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::DeleteDatabaseRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload delete_database(name: nil, etag: nil) # Pass arguments to `delete_database` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. A name of the form # `projects/{project_id}/databases/{database_id}` # @param etag [::String] # The current etag of the Database. # If an etag is provided and does not match the current etag of the database, # deletion will be blocked and a FAILED_PRECONDITION error will be returned. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::DeleteDatabaseRequest.new # # # Call the delete_database method. # result = client.delete_database request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def delete_database request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::DeleteDatabaseRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_database.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_database.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_database.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :delete_database, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets information about a backup. # # @overload get_backup(request, options = nil) # Pass arguments to `get_backup` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::GetBackupRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::GetBackupRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload get_backup(name: nil) # Pass arguments to `get_backup` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. Name of the backup to fetch. # # Format is `projects/{project}/locations/{location}/backups/{backup}`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Firestore::Admin::V1::Backup] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Firestore::Admin::V1::Backup] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::GetBackupRequest.new # # # Call the get_backup method. # result = client.get_backup request # # # The returned object is of type Google::Cloud::Firestore::Admin::V1::Backup. # p result # def get_backup request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::GetBackupRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_backup.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_backup.timeout, metadata: metadata, retry_policy: @config.rpcs.get_backup.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :get_backup, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Lists all the backups. # # @overload list_backups(request, options = nil) # Pass arguments to `list_backups` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::ListBackupsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::ListBackupsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload list_backups(parent: nil) # Pass arguments to `list_backups` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The location to list backups from. # # Format is `projects/{project}/locations/{location}`. # Use `{location} = '-'` to list backups from all locations for the given # project. This allows listing backups from a single location or from all # locations. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Firestore::Admin::V1::ListBackupsResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Firestore::Admin::V1::ListBackupsResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::ListBackupsRequest.new # # # Call the list_backups method. # result = client.list_backups request # # # The returned object is of type Google::Cloud::Firestore::Admin::V1::ListBackupsResponse. # p result # def list_backups request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::ListBackupsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_backups.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_backups.timeout, metadata: metadata, retry_policy: @config.rpcs.list_backups.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :list_backups, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes a backup. # # @overload delete_backup(request, options = nil) # Pass arguments to `delete_backup` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::DeleteBackupRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::DeleteBackupRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload delete_backup(name: nil) # Pass arguments to `delete_backup` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. Name of the backup to delete. # # format is `projects/{project}/locations/{location}/backups/{backup}`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Protobuf::Empty] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Protobuf::Empty] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::DeleteBackupRequest.new # # # Call the delete_backup method. # result = client.delete_backup request # # # The returned object is of type Google::Protobuf::Empty. # p result # def delete_backup request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::DeleteBackupRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_backup.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_backup.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_backup.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :delete_backup, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Creates a new database by restoring from an existing backup. # # The new database must be in the same cloud region or multi-region location # as the existing backup. This behaves similar to # [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] # except instead of creating a new empty database, a new database is created # with the database type, index configuration, and documents from an existing # backup. # # The {::Google::Longrunning::Operation long-running operation} can be used to # track the progress of the restore, with the Operation's # {::Google::Longrunning::Operation#metadata metadata} field type being the # {::Google::Cloud::Firestore::Admin::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}. # The {::Google::Longrunning::Operation#response response} type is the # {::Google::Cloud::Firestore::Admin::V1::Database Database} if the restore was # successful. The new database is not readable or writeable until the LRO has # completed. # # @overload restore_database(request, options = nil) # Pass arguments to `restore_database` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload restore_database(parent: nil, database_id: nil, backup: nil) # Pass arguments to `restore_database` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The project to restore the database in. Format is # `projects/{project_id}`. # @param database_id [::String] # Required. The ID to use for the database, which will become the final # component of the database's resource name. This database id must not be # associated with an existing database. # # This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ # with first character a letter and the last a letter or a number. Must not # be UUID-like /[0-9a-f]\\{8}(-[0-9a-f]\\{4})\\{3}-[0-9a-f]\\{12}/. # # "(default)" database id is also valid. # @param backup [::String] # Required. Backup to restore from. Must be from the same project as the # parent. # # Format is: `projects/{project_id}/locations/{location}/backups/{backup}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest.new # # # Call the restore_database method. # result = client.restore_database request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def restore_database request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.restore_database.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.restore_database.timeout, metadata: metadata, retry_policy: @config.rpcs.restore_database.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :restore_database, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Creates a backup schedule on a database. # At most two backup schedules can be configured on a database, one daily # backup schedule with retention up to 7 days and one weekly backup schedule # with retention up to 14 weeks. # # @overload create_backup_schedule(request, options = nil) # Pass arguments to `create_backup_schedule` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::CreateBackupScheduleRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::CreateBackupScheduleRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload create_backup_schedule(parent: nil, backup_schedule: nil) # Pass arguments to `create_backup_schedule` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The parent database. # # Format `projects/{project}/databases/{database}` # @param backup_schedule [::Google::Cloud::Firestore::Admin::V1::BackupSchedule, ::Hash] # Required. The backup schedule to create. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Firestore::Admin::V1::BackupSchedule] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Firestore::Admin::V1::BackupSchedule] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::CreateBackupScheduleRequest.new # # # Call the create_backup_schedule method. # result = client.create_backup_schedule request # # # The returned object is of type Google::Cloud::Firestore::Admin::V1::BackupSchedule. # p result # def create_backup_schedule request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::CreateBackupScheduleRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_backup_schedule.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_backup_schedule.timeout, metadata: metadata, retry_policy: @config.rpcs.create_backup_schedule.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :create_backup_schedule, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets information about a backup schedule. # # @overload get_backup_schedule(request, options = nil) # Pass arguments to `get_backup_schedule` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::GetBackupScheduleRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::GetBackupScheduleRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload get_backup_schedule(name: nil) # Pass arguments to `get_backup_schedule` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the backup schedule. # # Format # `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Firestore::Admin::V1::BackupSchedule] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Firestore::Admin::V1::BackupSchedule] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::GetBackupScheduleRequest.new # # # Call the get_backup_schedule method. # result = client.get_backup_schedule request # # # The returned object is of type Google::Cloud::Firestore::Admin::V1::BackupSchedule. # p result # def get_backup_schedule request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::GetBackupScheduleRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_backup_schedule.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_backup_schedule.timeout, metadata: metadata, retry_policy: @config.rpcs.get_backup_schedule.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :get_backup_schedule, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # List backup schedules. # # @overload list_backup_schedules(request, options = nil) # Pass arguments to `list_backup_schedules` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload list_backup_schedules(parent: nil) # Pass arguments to `list_backup_schedules` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The parent database. # # Format is `projects/{project}/databases/{database}`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesRequest.new # # # Call the list_backup_schedules method. # result = client.list_backup_schedules request # # # The returned object is of type Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse. # p result # def list_backup_schedules request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_backup_schedules.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_backup_schedules.timeout, metadata: metadata, retry_policy: @config.rpcs.list_backup_schedules.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :list_backup_schedules, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Updates a backup schedule. # # @overload update_backup_schedule(request, options = nil) # Pass arguments to `update_backup_schedule` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::UpdateBackupScheduleRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::UpdateBackupScheduleRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload update_backup_schedule(backup_schedule: nil, update_mask: nil) # Pass arguments to `update_backup_schedule` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param backup_schedule [::Google::Cloud::Firestore::Admin::V1::BackupSchedule, ::Hash] # Required. The backup schedule to update. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # The list of fields to be updated. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Firestore::Admin::V1::BackupSchedule] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Firestore::Admin::V1::BackupSchedule] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::UpdateBackupScheduleRequest.new # # # Call the update_backup_schedule method. # result = client.update_backup_schedule request # # # The returned object is of type Google::Cloud::Firestore::Admin::V1::BackupSchedule. # p result # def update_backup_schedule request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::UpdateBackupScheduleRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_backup_schedule.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.backup_schedule&.name header_params["backup_schedule.name"] = request.backup_schedule.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_backup_schedule.timeout, metadata: metadata, retry_policy: @config.rpcs.update_backup_schedule.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :update_backup_schedule, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes a backup schedule. # # @overload delete_backup_schedule(request, options = nil) # Pass arguments to `delete_backup_schedule` via a request object, either of type # {::Google::Cloud::Firestore::Admin::V1::DeleteBackupScheduleRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Firestore::Admin::V1::DeleteBackupScheduleRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload delete_backup_schedule(name: nil) # Pass arguments to `delete_backup_schedule` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of backup schedule. # # Format # `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Protobuf::Empty] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Protobuf::Empty] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/firestore/admin/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Firestore::Admin::V1::DeleteBackupScheduleRequest.new # # # Call the delete_backup_schedule method. # result = client.delete_backup_schedule request # # # The returned object is of type Google::Protobuf::Empty. # p result # def delete_backup_schedule request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::DeleteBackupScheduleRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_backup_schedule.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_backup_schedule.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_backup_schedule.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @firestore_admin_stub.call_rpc :delete_backup_schedule, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the FirestoreAdmin API. # # This class represents the configuration for FirestoreAdmin, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # create_index to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.create_index.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config| # config.timeout = 10.0 # config.rpcs.create_index.timeout = 20.0 # end # # @!attribute [rw] endpoint # A custom service endpoint, as a hostname or hostname:port. The default is # nil, indicating to use the default endpoint in the current universe domain. # @return [::String,nil] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`GRPC::Core::Channel`) a gRPC channel with included credentials # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] channel_args # Extra parameters passed to the gRPC channel. Note: this is ignored if a # `GRPC::Core::Channel` object is provided as the credential. # @return [::Hash] # @!attribute [rw] interceptors # An array of interceptors that are run before calls are executed. # @return [::Array<::GRPC::ClientInterceptor>] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional gRPC headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # @!attribute [rw] universe_domain # The universe domain within which to make requests. This determines the # default endpoint URL. The default value of nil uses the environment # universe (usually the default "googleapis.com" universe). # @return [::String,nil] # class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "firestore.googleapis.com" config_attr :endpoint, nil, ::String, nil config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration for the channel pool # @return [::Gapic::ServiceStub::ChannelPool::Configuration] # def channel_pool @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new end ## # Configuration RPC class for the FirestoreAdmin API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `create_index` # @return [::Gapic::Config::Method] # attr_reader :create_index ## # RPC-specific configuration for `list_indexes` # @return [::Gapic::Config::Method] # attr_reader :list_indexes ## # RPC-specific configuration for `get_index` # @return [::Gapic::Config::Method] # attr_reader :get_index ## # RPC-specific configuration for `delete_index` # @return [::Gapic::Config::Method] # attr_reader :delete_index ## # RPC-specific configuration for `get_field` # @return [::Gapic::Config::Method] # attr_reader :get_field ## # RPC-specific configuration for `update_field` # @return [::Gapic::Config::Method] # attr_reader :update_field ## # RPC-specific configuration for `list_fields` # @return [::Gapic::Config::Method] # attr_reader :list_fields ## # RPC-specific configuration for `export_documents` # @return [::Gapic::Config::Method] # attr_reader :export_documents ## # RPC-specific configuration for `import_documents` # @return [::Gapic::Config::Method] # attr_reader :import_documents ## # RPC-specific configuration for `create_database` # @return [::Gapic::Config::Method] # attr_reader :create_database ## # RPC-specific configuration for `get_database` # @return [::Gapic::Config::Method] # attr_reader :get_database ## # RPC-specific configuration for `list_databases` # @return [::Gapic::Config::Method] # attr_reader :list_databases ## # RPC-specific configuration for `update_database` # @return [::Gapic::Config::Method] # attr_reader :update_database ## # RPC-specific configuration for `delete_database` # @return [::Gapic::Config::Method] # attr_reader :delete_database ## # RPC-specific configuration for `get_backup` # @return [::Gapic::Config::Method] # attr_reader :get_backup ## # RPC-specific configuration for `list_backups` # @return [::Gapic::Config::Method] # attr_reader :list_backups ## # RPC-specific configuration for `delete_backup` # @return [::Gapic::Config::Method] # attr_reader :delete_backup ## # RPC-specific configuration for `restore_database` # @return [::Gapic::Config::Method] # attr_reader :restore_database ## # RPC-specific configuration for `create_backup_schedule` # @return [::Gapic::Config::Method] # attr_reader :create_backup_schedule ## # RPC-specific configuration for `get_backup_schedule` # @return [::Gapic::Config::Method] # attr_reader :get_backup_schedule ## # RPC-specific configuration for `list_backup_schedules` # @return [::Gapic::Config::Method] # attr_reader :list_backup_schedules ## # RPC-specific configuration for `update_backup_schedule` # @return [::Gapic::Config::Method] # attr_reader :update_backup_schedule ## # RPC-specific configuration for `delete_backup_schedule` # @return [::Gapic::Config::Method] # attr_reader :delete_backup_schedule # @private def initialize parent_rpcs = nil create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index @create_index = ::Gapic::Config::Method.new create_index_config list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes @list_indexes = ::Gapic::Config::Method.new list_indexes_config get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index @get_index = ::Gapic::Config::Method.new get_index_config delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index @delete_index = ::Gapic::Config::Method.new delete_index_config get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field @get_field = ::Gapic::Config::Method.new get_field_config update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field @update_field = ::Gapic::Config::Method.new update_field_config list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields @list_fields = ::Gapic::Config::Method.new list_fields_config export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents @export_documents = ::Gapic::Config::Method.new export_documents_config import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents @import_documents = ::Gapic::Config::Method.new import_documents_config create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database @create_database = ::Gapic::Config::Method.new create_database_config get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database @get_database = ::Gapic::Config::Method.new get_database_config list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases @list_databases = ::Gapic::Config::Method.new list_databases_config update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database @update_database = ::Gapic::Config::Method.new update_database_config delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database @delete_database = ::Gapic::Config::Method.new delete_database_config get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup @get_backup = ::Gapic::Config::Method.new get_backup_config list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups @list_backups = ::Gapic::Config::Method.new list_backups_config delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup @delete_backup = ::Gapic::Config::Method.new delete_backup_config restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database @restore_database = ::Gapic::Config::Method.new restore_database_config create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config yield self if block_given? end end end end end end end end end end