# 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"
module Google
module Cloud
module Firestore
module Admin
module V1
module FirestoreAdmin
##
# Client for the FirestoreAdmin service.
#
# Operations are created by service `FirestoreAdmin`, but are accessed via
# service `google.longrunning.Operations`.
#
class Client
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
#
# To 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
##
# Create a new FirestoreAdmin client object.
#
# ## Examples
#
# To create a new FirestoreAdmin client with the default
# configuration:
#
# client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
#
# To create a new FirestoreAdmin client with 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
credentials ||= Credentials.default scope: @config.scope
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.endpoint = @config.endpoint
end
@firestore_admin_stub = ::Gapic::ServiceStub.new(
::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Stub,
credentials: credentials,
endpoint: @config.endpoint,
channel_args: @config.channel_args,
interceptors: @config.interceptors
)
end
##
# Get the associated client for long-running operations.
#
# @return [::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Operations]
#
attr_reader :operations_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.
#
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 = {
"parent" => request.parent
}
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 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.
#
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 = {
"parent" => request.parent
}
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 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.
#
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 = {
"name" => request.name
}
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 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.
#
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 = {
"name" => request.name
}
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 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.
#
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 = {
"name" => request.name
}
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 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.
#
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 = {
"field.name" => request.field.name
}
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 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`.
#
# @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 the filter set to
# `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.
#
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 = {
"parent" => request.parent
}
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 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.
#
# @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)
# 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.
#
# @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.
#
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 = {
"name" => request.name
}
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 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)
# 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}.
#
# @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.
#
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 = {
"name" => request.name
}
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 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
##
# 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.
#
# # Examples
#
# To 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
#
# To 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
# The hostname or hostname:port of the service endpoint.
# Defaults to `"firestore.googleapis.com"`.
# @return [::String]
# @!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://googleapis.dev/ruby/googleauth/latest/index.html))
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
# * (`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<String>`) - The error codes that should
# trigger a retry.
# @return [::Hash]
# @!attribute [rw] quota_project
# A separate project against which to charge quota.
# @return [::String]
#
class Configuration
extend ::Gapic::Config
config_attr :endpoint, "firestore.googleapis.com", ::String
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
# @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 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<String>`) - 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
# @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
yield self if block_given?
end
end
end
end
end
end
end
end
end
end