google-cloud-firestore-admin 0.a → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +11 -0
- data/AUTHENTICATION.md +151 -0
- data/README.md +104 -8
- data/lib/google/cloud/firestore/admin/version.rb +7 -2
- data/lib/google/cloud/firestore/admin.rb +148 -0
- data/lib/google-cloud-firestore-admin.rb +19 -0
- metadata +159 -12
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8deb248db4ad133b41cbc5da07f4d750942cf19a889b5738694f8e35197769f5
|
|
4
|
+
data.tar.gz: f0e1fa5f64e7cc27a95b0191fc40a46dc5e7540ff2e029cf40e974133690c5a1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bc61086219018c35e67b4c004c6f54e6a870c595fcb77d50a47efa2fd4bd2b60ff0be5cb02a3105e1f7e6f90bf825ebc3caff3a1e7009c62c187fa766e6bc426
|
|
7
|
+
data.tar.gz: 196efb5367f8e6c7df4a21c709fa9d2d61501044fcee86a996d870d27cb196b66a9198081d453f5c74d60e5cefd237b814e3944a288ed11acca2184f03d98de9
|
data/.yardopts
ADDED
data/AUTHENTICATION.md
ADDED
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
# Authentication
|
|
2
|
+
|
|
3
|
+
In general, the google-cloud-firestore-admin library uses
|
|
4
|
+
[Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
|
|
5
|
+
credentials to connect to Google Cloud services. When running within
|
|
6
|
+
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
|
7
|
+
credentials will be discovered automatically. When running on other
|
|
8
|
+
environments, the Service Account credentials can be specified by providing the
|
|
9
|
+
path to the
|
|
10
|
+
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
|
11
|
+
for the account (or the JSON itself) in
|
|
12
|
+
[environment variables](#environment-variables). Additionally, Cloud SDK
|
|
13
|
+
credentials can also be discovered automatically, but this is only recommended
|
|
14
|
+
during development.
|
|
15
|
+
|
|
16
|
+
## Quickstart
|
|
17
|
+
|
|
18
|
+
1. [Create a service account and credentials](#creating-a-service-account).
|
|
19
|
+
2. Set the [environment variable](#environment-variables).
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
export FIRESTORE_CREDENTIALS=path/to/keyfile.json
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
3. Initialize the client.
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require "google/cloud/firestore/admin"
|
|
29
|
+
|
|
30
|
+
client = Google::Cloud::Firestore::Admin.firestore_admin
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Credential Lookup
|
|
34
|
+
|
|
35
|
+
The google-cloud-firestore-admin library aims to make authentication
|
|
36
|
+
as simple as possible, and provides several mechanisms to configure your system
|
|
37
|
+
without requiring **Service Account Credentials** directly in code.
|
|
38
|
+
|
|
39
|
+
**Credentials** are discovered in the following order:
|
|
40
|
+
|
|
41
|
+
1. Specify credentials in method arguments
|
|
42
|
+
2. Specify credentials in configuration
|
|
43
|
+
3. Discover credentials path in environment variables
|
|
44
|
+
4. Discover credentials JSON in environment variables
|
|
45
|
+
5. Discover credentials file in the Cloud SDK's path
|
|
46
|
+
6. Discover GCP credentials
|
|
47
|
+
|
|
48
|
+
### Google Cloud Platform environments
|
|
49
|
+
|
|
50
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
|
51
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
|
52
|
+
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
|
53
|
+
Code should be written as if already authenticated.
|
|
54
|
+
|
|
55
|
+
### Environment Variables
|
|
56
|
+
|
|
57
|
+
The **Credentials JSON** can be placed in environment variables instead of
|
|
58
|
+
declaring them directly in code. Each service has its own environment variable,
|
|
59
|
+
allowing for different service accounts to be used for different services. (See
|
|
60
|
+
the READMEs for the individual service gems for details.) The path to the
|
|
61
|
+
**Credentials JSON** file can be stored in the environment variable, or the
|
|
62
|
+
**Credentials JSON** itself can be stored for environments such as Docker
|
|
63
|
+
containers where writing files is difficult or not encouraged.
|
|
64
|
+
|
|
65
|
+
The environment variables that google-cloud-firestore-admin
|
|
66
|
+
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
+
`::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Credentials`):
|
|
68
|
+
|
|
69
|
+
* `FIRESTORE_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
70
|
+
* `FIRESTORE_KEYFILE` - Path to JSON file, or JSON contents
|
|
71
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
72
|
+
* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
|
|
73
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
74
|
+
|
|
75
|
+
```ruby
|
|
76
|
+
require "google/cloud/firestore/admin"
|
|
77
|
+
|
|
78
|
+
ENV["FIRESTORE_CREDENTIALS"] = "path/to/keyfile.json"
|
|
79
|
+
|
|
80
|
+
client = Google::Cloud::Firestore::Admin.firestore_admin
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Configuration
|
|
84
|
+
|
|
85
|
+
The path to the **Credentials JSON** file can be configured instead of storing
|
|
86
|
+
it in an environment variable. Either on an individual client initialization:
|
|
87
|
+
|
|
88
|
+
```ruby
|
|
89
|
+
require "google/cloud/firestore/admin"
|
|
90
|
+
|
|
91
|
+
client = Google::Cloud::Firestore::Admin.firestore_admin do |config|
|
|
92
|
+
config.credentials = "path/to/keyfile.json"
|
|
93
|
+
end
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Or globally for all clients:
|
|
97
|
+
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/firestore/admin"
|
|
100
|
+
|
|
101
|
+
Google::Cloud::Firestore::Admin.configure do |config|
|
|
102
|
+
config.credentials = "path/to/keyfile.json"
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
client = Google::Cloud::Firestore::Admin.firestore_admin
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Cloud SDK
|
|
109
|
+
|
|
110
|
+
This option allows for an easy way to authenticate during development. If
|
|
111
|
+
credentials are not provided in code or in environment variables, then Cloud SDK
|
|
112
|
+
credentials are discovered.
|
|
113
|
+
|
|
114
|
+
To configure your system for this, simply:
|
|
115
|
+
|
|
116
|
+
1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
|
|
117
|
+
2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
|
|
118
|
+
3. Write code as if already authenticated.
|
|
119
|
+
|
|
120
|
+
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
|
121
|
+
*should* only be used during development.
|
|
122
|
+
|
|
123
|
+
## Creating a Service Account
|
|
124
|
+
|
|
125
|
+
Google Cloud requires **Service Account Credentials** to
|
|
126
|
+
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
+
connect to most services with google-cloud-firestore-admin.
|
|
128
|
+
|
|
129
|
+
If you are not running this client within
|
|
130
|
+
[Google Cloud Platform environments](#google-cloud-platform-environments), you
|
|
131
|
+
need a Google Developers service account.
|
|
132
|
+
|
|
133
|
+
1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
|
|
134
|
+
2. Create a new project or click on an existing project.
|
|
135
|
+
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
136
|
+
here, you will enable the APIs that your application requires.
|
|
137
|
+
|
|
138
|
+
*Note: You may need to enable billing in order to use these services.*
|
|
139
|
+
|
|
140
|
+
4. Select **Credentials** from the side navigation.
|
|
141
|
+
|
|
142
|
+
Find the "Create credentials" drop down near the top of the page, and select
|
|
143
|
+
"Service account" to be guided through downloading a new JSON key file.
|
|
144
|
+
|
|
145
|
+
If you want to re-use an existing service account, you can easily generate a
|
|
146
|
+
new key file. Just select the account you wish to re-use, click the pencil
|
|
147
|
+
tool on the right side to edit the service account, select the **Keys** tab,
|
|
148
|
+
and then select **Add Key**.
|
|
149
|
+
|
|
150
|
+
The key file you download will be used by this library to authenticate API
|
|
151
|
+
requests and should be stored in a secure location.
|
data/README.md
CHANGED
|
@@ -1,8 +1,104 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
# Ruby Client for the Cloud Firestore Admin API
|
|
2
|
+
|
|
3
|
+
API Client library for the Cloud Firestore Admin API
|
|
4
|
+
|
|
5
|
+
Cloud Firestore is a NoSQL document database built for automatic scaling, high performance, and ease of application development.
|
|
6
|
+
|
|
7
|
+
Actual client classes for the various versions of this API are defined in
|
|
8
|
+
_versioned_ client gems, with names of the form `google-cloud-firestore-admin-v*`.
|
|
9
|
+
The gem `google-cloud-firestore-admin` is the main client library that brings the
|
|
10
|
+
verisoned gems in as dependencies, and provides high-level methods for
|
|
11
|
+
constructing clients. More information on versioned clients can be found below
|
|
12
|
+
in the section titled *Which client should I use?*.
|
|
13
|
+
|
|
14
|
+
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin/latest)
|
|
15
|
+
for this library, google-cloud-firestore-admin, to see the convenience methods for
|
|
16
|
+
constructing client objects. Reference documentation for the client objects
|
|
17
|
+
themselves can be found in the client library documentation for the versioned
|
|
18
|
+
client gems:
|
|
19
|
+
[google-cloud-firestore-admin-v1](https://googleapis.dev/ruby/google-cloud-firestore-admin-v1/latest).
|
|
20
|
+
|
|
21
|
+
See also the [Product Documentation](https://cloud.google.com/firestore)
|
|
22
|
+
for more usage information.
|
|
23
|
+
|
|
24
|
+
## Quick Start
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
$ gem install google-cloud-firestore-admin
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
In order to use this library, you first need to go through the following steps:
|
|
31
|
+
|
|
32
|
+
1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
|
33
|
+
1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
|
34
|
+
1. [Enable the API.](https://console.cloud.google.com/apis/library/firestore.googleapis.com)
|
|
35
|
+
1. {file:AUTHENTICATION.md Set up authentication.}
|
|
36
|
+
|
|
37
|
+
## Supported Ruby Versions
|
|
38
|
+
|
|
39
|
+
This library is supported on Ruby 2.6+.
|
|
40
|
+
|
|
41
|
+
Google provides official support for Ruby versions that are actively supported
|
|
42
|
+
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
|
43
|
+
in security maintenance, and not end of life. Older versions of Ruby _may_
|
|
44
|
+
still work, but are unsupported and not recommended. See
|
|
45
|
+
https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
|
|
46
|
+
support schedule.
|
|
47
|
+
|
|
48
|
+
## Which client should I use?
|
|
49
|
+
|
|
50
|
+
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
|
51
|
+
client library with a name such as `google-cloud-firestore-admin`,
|
|
52
|
+
and lower-level _versioned_ client libraries with names such as
|
|
53
|
+
`google-cloud-firestore-admin-v1`.
|
|
54
|
+
_In most cases, you should install the main client._
|
|
55
|
+
|
|
56
|
+
### What's the difference between the main client and a versioned client?
|
|
57
|
+
|
|
58
|
+
A _versioned client_ provides a basic set of data types and client classes for
|
|
59
|
+
a _single version_ of a specific service. (That is, for a service with multiple
|
|
60
|
+
versions, there might be a separate versioned client for each service version.)
|
|
61
|
+
Most versioned clients are written and maintained by a code generator.
|
|
62
|
+
|
|
63
|
+
The _main client_ is designed to provide you with the _recommended_ client
|
|
64
|
+
interfaces for the service. There will be only one main client for any given
|
|
65
|
+
service, even a service with multiple versions. The main client includes
|
|
66
|
+
factory methods for constructing the client objects we recommend for most
|
|
67
|
+
users. In some cases, those will be classes provided by an underlying versioned
|
|
68
|
+
client; in other cases, they will be handwritten higher-level client objects
|
|
69
|
+
with additional capabilities, convenience methods, or best practices built in.
|
|
70
|
+
Generally, the main client will default to a recommended service version,
|
|
71
|
+
although in some cases you can override this if you need to talk to a specific
|
|
72
|
+
service version.
|
|
73
|
+
|
|
74
|
+
### Why would I want to use the main client?
|
|
75
|
+
|
|
76
|
+
We recommend that most users install the main client gem for a service. You can
|
|
77
|
+
identify this gem as the one _without_ a version in its name, e.g.
|
|
78
|
+
`google-cloud-firestore-admin`.
|
|
79
|
+
The main client is recommended because it will embody the best practices for
|
|
80
|
+
accessing the service, and may also provide more convenient interfaces or
|
|
81
|
+
tighter integration into frameworks and third-party libraries. In addition, the
|
|
82
|
+
documentation and samples published by Google will generally demonstrate use of
|
|
83
|
+
the main client.
|
|
84
|
+
|
|
85
|
+
### Why would I want to use a versioned client?
|
|
86
|
+
|
|
87
|
+
You can use a versioned client if you are content with a possibly lower-level
|
|
88
|
+
class interface, you explicitly want to avoid features provided by the main
|
|
89
|
+
client, or you want to access a specific service version not be covered by the
|
|
90
|
+
main client. You can identify versioned client gems because the service version
|
|
91
|
+
is part of the name, e.g. `google-cloud-firestore-admin-v1`.
|
|
92
|
+
|
|
93
|
+
### What about the google-apis-<name> clients?
|
|
94
|
+
|
|
95
|
+
Client library gems with names that begin with `google-apis-` are based on an
|
|
96
|
+
older code generation technology. They talk to a REST/JSON backend (whereas
|
|
97
|
+
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
|
98
|
+
not offer the same performance, features, and ease of use provided by more
|
|
99
|
+
modern clients.
|
|
100
|
+
|
|
101
|
+
The `google-apis-` clients have wide coverage across Google services, so you
|
|
102
|
+
might need to use one if there is no modern client available for the service.
|
|
103
|
+
However, if a modern client is available, we generally recommend it over the
|
|
104
|
+
older `google-apis-` clients.
|
|
@@ -1,10 +1,12 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
# Copyright 2023 Google LLC
|
|
2
4
|
#
|
|
3
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
6
|
# you may not use this file except in compliance with the License.
|
|
5
7
|
# You may obtain a copy of the License at
|
|
6
8
|
#
|
|
7
|
-
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
8
10
|
#
|
|
9
11
|
# Unless required by applicable law or agreed to in writing, software
|
|
10
12
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
@@ -12,11 +14,14 @@
|
|
|
12
14
|
# See the License for the specific language governing permissions and
|
|
13
15
|
# limitations under the License.
|
|
14
16
|
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
15
20
|
module Google
|
|
16
21
|
module Cloud
|
|
17
22
|
module Firestore
|
|
18
23
|
module Admin
|
|
19
|
-
VERSION = "0.
|
|
24
|
+
VERSION = "0.2.0"
|
|
20
25
|
end
|
|
21
26
|
end
|
|
22
27
|
end
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2023 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
# Require this file early so that the version constant gets defined before
|
|
20
|
+
# requiring "google/cloud". This is because google-cloud-core will load the
|
|
21
|
+
# entrypoint (gem name) file, which in turn re-requires this file (hence
|
|
22
|
+
# causing a require cycle) unless the version constant is already defined.
|
|
23
|
+
require "google/cloud/firestore/admin/version"
|
|
24
|
+
|
|
25
|
+
require "googleauth"
|
|
26
|
+
gem "google-cloud-core"
|
|
27
|
+
require "google/cloud" unless defined? ::Google::Cloud.new
|
|
28
|
+
require "google/cloud/config"
|
|
29
|
+
|
|
30
|
+
# Set the default configuration
|
|
31
|
+
::Google::Cloud.configure.add_config! :firestore_admin do |config|
|
|
32
|
+
config.add_field! :endpoint, "firestore.googleapis.com", match: ::String
|
|
33
|
+
config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
|
|
34
|
+
config.add_field! :scope, nil, match: [::Array, ::String]
|
|
35
|
+
config.add_field! :lib_name, nil, match: ::String
|
|
36
|
+
config.add_field! :lib_version, nil, match: ::String
|
|
37
|
+
config.add_field! :interceptors, nil, match: ::Array
|
|
38
|
+
config.add_field! :timeout, nil, match: ::Numeric
|
|
39
|
+
config.add_field! :metadata, nil, match: ::Hash
|
|
40
|
+
config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
|
|
41
|
+
config.add_field! :quota_project, nil, match: ::String
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
module Google
|
|
45
|
+
module Cloud
|
|
46
|
+
module Firestore
|
|
47
|
+
module Admin
|
|
48
|
+
##
|
|
49
|
+
# Create a new client object for FirestoreAdmin.
|
|
50
|
+
#
|
|
51
|
+
# By default, this returns an instance of
|
|
52
|
+
# [Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client](https://googleapis.dev/ruby/google-cloud-firestore-admin-v1/latest/Google/Cloud/Firestore/Admin/V1/FirestoreAdmin/Client.html)
|
|
53
|
+
# for a gRPC client for version V1 of the API.
|
|
54
|
+
# However, you can specify a different API version by passing it in the
|
|
55
|
+
# `version` parameter. If the FirestoreAdmin service is
|
|
56
|
+
# supported by that API version, and the corresponding gem is available, the
|
|
57
|
+
# appropriate versioned client will be returned.
|
|
58
|
+
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
|
59
|
+
# the `transport` parameter.
|
|
60
|
+
#
|
|
61
|
+
# ## About FirestoreAdmin
|
|
62
|
+
#
|
|
63
|
+
# The Cloud Firestore Admin API.
|
|
64
|
+
#
|
|
65
|
+
# This API provides several administrative services for Cloud Firestore.
|
|
66
|
+
#
|
|
67
|
+
# Project, Database, Namespace, Collection, Collection Group, and Document are
|
|
68
|
+
# used as defined in the Google Cloud Firestore API.
|
|
69
|
+
#
|
|
70
|
+
# Operation: An Operation represents work being performed in the background.
|
|
71
|
+
#
|
|
72
|
+
# The index service manages Cloud Firestore indexes.
|
|
73
|
+
#
|
|
74
|
+
# Index creation is performed asynchronously.
|
|
75
|
+
# An Operation resource is created for each such asynchronous operation.
|
|
76
|
+
# The state of the operation (including any errors encountered)
|
|
77
|
+
# may be queried via the Operation resource.
|
|
78
|
+
#
|
|
79
|
+
# The Operations collection provides a record of actions performed for the
|
|
80
|
+
# specified Project (including any Operations in progress). Operations are not
|
|
81
|
+
# created directly but through calls on other collections or resources.
|
|
82
|
+
#
|
|
83
|
+
# An Operation that is done may be deleted so that it is no longer listed as
|
|
84
|
+
# part of the Operation collection. Operations are garbage collected after
|
|
85
|
+
# 30 days. By default, ListOperations will only return in progress and failed
|
|
86
|
+
# operations. To list completed operation, issue a ListOperations request with
|
|
87
|
+
# the filter `done: true`.
|
|
88
|
+
#
|
|
89
|
+
# Operations are created by service `FirestoreAdmin`, but are accessed via
|
|
90
|
+
# service `google.longrunning.Operations`.
|
|
91
|
+
#
|
|
92
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
|
93
|
+
# Defaults to `:v1`.
|
|
94
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
|
95
|
+
# @return [::Object] A client object for the specified version.
|
|
96
|
+
#
|
|
97
|
+
def self.firestore_admin version: :v1, transport: :grpc, &block
|
|
98
|
+
require "google/cloud/firestore/admin/#{version.to_s.downcase}"
|
|
99
|
+
|
|
100
|
+
package_name = Google::Cloud::Firestore::Admin
|
|
101
|
+
.constants
|
|
102
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
|
103
|
+
.first
|
|
104
|
+
service_module = Google::Cloud::Firestore::Admin.const_get(package_name).const_get(:FirestoreAdmin)
|
|
105
|
+
service_module = service_module.const_get(:Rest) if transport == :rest
|
|
106
|
+
service_module.const_get(:Client).new(&block)
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
##
|
|
110
|
+
# Configure the google-cloud-firestore-admin library.
|
|
111
|
+
#
|
|
112
|
+
# The following configuration parameters are supported:
|
|
113
|
+
#
|
|
114
|
+
# * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
|
|
115
|
+
# The path to the keyfile as a String, the contents of the keyfile as a
|
|
116
|
+
# Hash, or a Google::Auth::Credentials object.
|
|
117
|
+
# * `lib_name` (*type:* `String`) -
|
|
118
|
+
# The library name as recorded in instrumentation and logging.
|
|
119
|
+
# * `lib_version` (*type:* `String`) -
|
|
120
|
+
# The library version as recorded in instrumentation and logging.
|
|
121
|
+
# * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
|
|
122
|
+
# An array of interceptors that are run before calls are executed.
|
|
123
|
+
# * `timeout` (*type:* `Numeric`) -
|
|
124
|
+
# Default timeout in seconds.
|
|
125
|
+
# * `metadata` (*type:* `Hash{Symbol=>String}`) -
|
|
126
|
+
# Additional headers to be sent with the call.
|
|
127
|
+
# * `retry_policy` (*type:* `Hash`) -
|
|
128
|
+
# The retry policy. The value is a hash with the following keys:
|
|
129
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
130
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
131
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
132
|
+
# * `:retry_codes` (*type:* `Array<String>`) -
|
|
133
|
+
# The error codes that should trigger a retry.
|
|
134
|
+
#
|
|
135
|
+
# @return [::Google::Cloud::Config] The default configuration used by this library
|
|
136
|
+
#
|
|
137
|
+
def self.configure
|
|
138
|
+
yield ::Google::Cloud.configure.firestore_admin if block_given?
|
|
139
|
+
|
|
140
|
+
::Google::Cloud.configure.firestore_admin
|
|
141
|
+
end
|
|
142
|
+
end
|
|
143
|
+
end
|
|
144
|
+
end
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
helper_path = ::File.join __dir__, "admin", "helpers.rb"
|
|
148
|
+
require "google/cloud/firestore/admin/helpers" if ::File.file? helper_path
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2023 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
require "google/cloud/firestore/admin" unless defined? Google::Cloud::Firestore::Admin::VERSION
|
metadata
CHANGED
|
@@ -1,27 +1,174 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-firestore-admin
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2023-
|
|
12
|
-
dependencies:
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
11
|
+
date: 2023-03-09 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: google-cloud-core
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '1.6'
|
|
20
|
+
type: :runtime
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '1.6'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: google-cloud-firestore-admin-v1
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - ">="
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '0.8'
|
|
34
|
+
- - "<"
|
|
35
|
+
- !ruby/object:Gem::Version
|
|
36
|
+
version: 2.a
|
|
37
|
+
type: :runtime
|
|
38
|
+
prerelease: false
|
|
39
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
40
|
+
requirements:
|
|
41
|
+
- - ">="
|
|
42
|
+
- !ruby/object:Gem::Version
|
|
43
|
+
version: '0.8'
|
|
44
|
+
- - "<"
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: 2.a
|
|
47
|
+
- !ruby/object:Gem::Dependency
|
|
48
|
+
name: google-style
|
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
|
50
|
+
requirements:
|
|
51
|
+
- - "~>"
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: 1.26.1
|
|
54
|
+
type: :development
|
|
55
|
+
prerelease: false
|
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
57
|
+
requirements:
|
|
58
|
+
- - "~>"
|
|
59
|
+
- !ruby/object:Gem::Version
|
|
60
|
+
version: 1.26.1
|
|
61
|
+
- !ruby/object:Gem::Dependency
|
|
62
|
+
name: minitest
|
|
63
|
+
requirement: !ruby/object:Gem::Requirement
|
|
64
|
+
requirements:
|
|
65
|
+
- - "~>"
|
|
66
|
+
- !ruby/object:Gem::Version
|
|
67
|
+
version: '5.16'
|
|
68
|
+
type: :development
|
|
69
|
+
prerelease: false
|
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
71
|
+
requirements:
|
|
72
|
+
- - "~>"
|
|
73
|
+
- !ruby/object:Gem::Version
|
|
74
|
+
version: '5.16'
|
|
75
|
+
- !ruby/object:Gem::Dependency
|
|
76
|
+
name: minitest-focus
|
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
|
78
|
+
requirements:
|
|
79
|
+
- - "~>"
|
|
80
|
+
- !ruby/object:Gem::Version
|
|
81
|
+
version: '1.1'
|
|
82
|
+
type: :development
|
|
83
|
+
prerelease: false
|
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
85
|
+
requirements:
|
|
86
|
+
- - "~>"
|
|
87
|
+
- !ruby/object:Gem::Version
|
|
88
|
+
version: '1.1'
|
|
89
|
+
- !ruby/object:Gem::Dependency
|
|
90
|
+
name: minitest-rg
|
|
91
|
+
requirement: !ruby/object:Gem::Requirement
|
|
92
|
+
requirements:
|
|
93
|
+
- - "~>"
|
|
94
|
+
- !ruby/object:Gem::Version
|
|
95
|
+
version: '5.2'
|
|
96
|
+
type: :development
|
|
97
|
+
prerelease: false
|
|
98
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
99
|
+
requirements:
|
|
100
|
+
- - "~>"
|
|
101
|
+
- !ruby/object:Gem::Version
|
|
102
|
+
version: '5.2'
|
|
103
|
+
- !ruby/object:Gem::Dependency
|
|
104
|
+
name: rake
|
|
105
|
+
requirement: !ruby/object:Gem::Requirement
|
|
106
|
+
requirements:
|
|
107
|
+
- - ">="
|
|
108
|
+
- !ruby/object:Gem::Version
|
|
109
|
+
version: '13.0'
|
|
110
|
+
type: :development
|
|
111
|
+
prerelease: false
|
|
112
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
113
|
+
requirements:
|
|
114
|
+
- - ">="
|
|
115
|
+
- !ruby/object:Gem::Version
|
|
116
|
+
version: '13.0'
|
|
117
|
+
- !ruby/object:Gem::Dependency
|
|
118
|
+
name: redcarpet
|
|
119
|
+
requirement: !ruby/object:Gem::Requirement
|
|
120
|
+
requirements:
|
|
121
|
+
- - "~>"
|
|
122
|
+
- !ruby/object:Gem::Version
|
|
123
|
+
version: '3.0'
|
|
124
|
+
type: :development
|
|
125
|
+
prerelease: false
|
|
126
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
127
|
+
requirements:
|
|
128
|
+
- - "~>"
|
|
129
|
+
- !ruby/object:Gem::Version
|
|
130
|
+
version: '3.0'
|
|
131
|
+
- !ruby/object:Gem::Dependency
|
|
132
|
+
name: simplecov
|
|
133
|
+
requirement: !ruby/object:Gem::Requirement
|
|
134
|
+
requirements:
|
|
135
|
+
- - "~>"
|
|
136
|
+
- !ruby/object:Gem::Version
|
|
137
|
+
version: '0.9'
|
|
138
|
+
type: :development
|
|
139
|
+
prerelease: false
|
|
140
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
141
|
+
requirements:
|
|
142
|
+
- - "~>"
|
|
143
|
+
- !ruby/object:Gem::Version
|
|
144
|
+
version: '0.9'
|
|
145
|
+
- !ruby/object:Gem::Dependency
|
|
146
|
+
name: yard
|
|
147
|
+
requirement: !ruby/object:Gem::Requirement
|
|
148
|
+
requirements:
|
|
149
|
+
- - "~>"
|
|
150
|
+
- !ruby/object:Gem::Version
|
|
151
|
+
version: '0.9'
|
|
152
|
+
type: :development
|
|
153
|
+
prerelease: false
|
|
154
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
155
|
+
requirements:
|
|
156
|
+
- - "~>"
|
|
157
|
+
- !ruby/object:Gem::Version
|
|
158
|
+
version: '0.9'
|
|
159
|
+
description: Cloud Firestore is a NoSQL document database built for automatic scaling,
|
|
160
|
+
high performance, and ease of application development.
|
|
18
161
|
email: googleapis-packages@google.com
|
|
19
162
|
executables: []
|
|
20
163
|
extensions: []
|
|
21
164
|
extra_rdoc_files: []
|
|
22
165
|
files:
|
|
166
|
+
- ".yardopts"
|
|
167
|
+
- AUTHENTICATION.md
|
|
23
168
|
- LICENSE.md
|
|
24
169
|
- README.md
|
|
170
|
+
- lib/google-cloud-firestore-admin.rb
|
|
171
|
+
- lib/google/cloud/firestore/admin.rb
|
|
25
172
|
- lib/google/cloud/firestore/admin/version.rb
|
|
26
173
|
homepage: https://github.com/googleapis/google-cloud-ruby
|
|
27
174
|
licenses:
|
|
@@ -35,15 +182,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
35
182
|
requirements:
|
|
36
183
|
- - ">="
|
|
37
184
|
- !ruby/object:Gem::Version
|
|
38
|
-
version: '
|
|
185
|
+
version: '2.6'
|
|
39
186
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
40
187
|
requirements:
|
|
41
|
-
- - "
|
|
188
|
+
- - ">="
|
|
42
189
|
- !ruby/object:Gem::Version
|
|
43
|
-
version:
|
|
190
|
+
version: '0'
|
|
44
191
|
requirements: []
|
|
45
192
|
rubygems_version: 3.4.2
|
|
46
193
|
signing_key:
|
|
47
194
|
specification_version: 4
|
|
48
|
-
summary:
|
|
195
|
+
summary: API Client library for the Cloud Firestore Admin API
|
|
49
196
|
test_files: []
|