google-cloud-firestore-admin-v1 0.3.2 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/README.md +3 -3
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb +595 -73
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb +145 -33
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/paths.rb +14 -0
- data/lib/google/cloud/firestore/admin/v1/firestore_admin.rb +26 -0
- data/lib/google/cloud/firestore/admin/v1/version.rb +1 -1
- data/lib/google/firestore/admin/v1/database_pb.rb +46 -0
- data/lib/google/firestore/admin/v1/field_pb.rb +3 -2
- data/lib/google/firestore/admin/v1/firestore_admin_pb.rb +25 -2
- data/lib/google/firestore/admin/v1/firestore_admin_services_pb.rb +38 -4
- data/lib/google/firestore/admin/v1/index_pb.rb +2 -2
- data/lib/google/firestore/admin/v1/location_pb.rb +2 -2
- data/lib/google/firestore/admin/v1/operation_pb.rb +2 -2
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/firestore/admin/v1/database.rb +91 -0
- data/proto_docs/google/firestore/admin/v1/field.rb +1 -1
- data/proto_docs/google/firestore/admin/v1/firestore_admin.rb +49 -2
- data/proto_docs/google/firestore/admin/v1/index.rb +1 -1
- metadata +8 -7
@@ -33,11 +33,7 @@ module Google
|
|
33
33
|
# // For Kubernetes resources, the format is {api group}/{kind}.
|
34
34
|
# option (google.api.resource) = {
|
35
35
|
# type: "pubsub.googleapis.com/Topic"
|
36
|
-
#
|
37
|
-
# pattern: "projects/{project}/topics/{topic}"
|
38
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
39
|
-
# parent_name_extractor: "projects/{project}"
|
40
|
-
# }
|
36
|
+
# pattern: "projects/{project}/topics/{topic}"
|
41
37
|
# };
|
42
38
|
# }
|
43
39
|
#
|
@@ -45,10 +41,7 @@ module Google
|
|
45
41
|
#
|
46
42
|
# resources:
|
47
43
|
# - type: "pubsub.googleapis.com/Topic"
|
48
|
-
#
|
49
|
-
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
-
# parent_name_extractor: "projects/{project}"
|
44
|
+
# pattern: "projects/{project}/topics/{topic}"
|
52
45
|
#
|
53
46
|
# Sometimes, resources have multiple patterns, typically because they can
|
54
47
|
# live under multiple parents.
|
@@ -58,26 +51,10 @@ module Google
|
|
58
51
|
# message LogEntry {
|
59
52
|
# option (google.api.resource) = {
|
60
53
|
# type: "logging.googleapis.com/LogEntry"
|
61
|
-
#
|
62
|
-
#
|
63
|
-
#
|
64
|
-
#
|
65
|
-
# }
|
66
|
-
# name_descriptor: {
|
67
|
-
# pattern: "folders/{folder}/logs/{log}"
|
68
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
69
|
-
# parent_name_extractor: "folders/{folder}"
|
70
|
-
# }
|
71
|
-
# name_descriptor: {
|
72
|
-
# pattern: "organizations/{organization}/logs/{log}"
|
73
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
74
|
-
# parent_name_extractor: "organizations/{organization}"
|
75
|
-
# }
|
76
|
-
# name_descriptor: {
|
77
|
-
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
78
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
79
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
80
|
-
# }
|
54
|
+
# pattern: "projects/{project}/logs/{log}"
|
55
|
+
# pattern: "folders/{folder}/logs/{log}"
|
56
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
57
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
81
58
|
# };
|
82
59
|
# }
|
83
60
|
#
|
@@ -85,48 +62,10 @@ module Google
|
|
85
62
|
#
|
86
63
|
# resources:
|
87
64
|
# - type: 'logging.googleapis.com/LogEntry'
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
# - pattern: "folders/{folder}/logs/{log}"
|
93
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
94
|
-
# parent_name_extractor: "folders/{folder}"
|
95
|
-
# - pattern: "organizations/{organization}/logs/{log}"
|
96
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
97
|
-
# parent_name_extractor: "organizations/{organization}"
|
98
|
-
# - pattern: "billingAccounts/{billing_account}/logs/{log}"
|
99
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
100
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
101
|
-
#
|
102
|
-
# For flexible resources, the resource name doesn't contain parent names, but
|
103
|
-
# the resource itself has parents for policy evaluation.
|
104
|
-
#
|
105
|
-
# Example:
|
106
|
-
#
|
107
|
-
# message Shelf {
|
108
|
-
# option (google.api.resource) = {
|
109
|
-
# type: "library.googleapis.com/Shelf"
|
110
|
-
# name_descriptor: {
|
111
|
-
# pattern: "shelves/{shelf}"
|
112
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
113
|
-
# }
|
114
|
-
# name_descriptor: {
|
115
|
-
# pattern: "shelves/{shelf}"
|
116
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
117
|
-
# }
|
118
|
-
# };
|
119
|
-
# }
|
120
|
-
#
|
121
|
-
# The ResourceDescriptor Yaml config will look like:
|
122
|
-
#
|
123
|
-
# resources:
|
124
|
-
# - type: 'library.googleapis.com/Shelf'
|
125
|
-
# name_descriptor:
|
126
|
-
# - pattern: "shelves/{shelf}"
|
127
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
128
|
-
# - pattern: "shelves/{shelf}"
|
129
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
65
|
+
# pattern: "projects/{project}/logs/{log}"
|
66
|
+
# pattern: "folders/{folder}/logs/{log}"
|
67
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
68
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
130
69
|
# @!attribute [rw] type
|
131
70
|
# @return [::String]
|
132
71
|
# The resource type. It must be in the format of
|
@@ -0,0 +1,91 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Firestore
|
23
|
+
module Admin
|
24
|
+
module V1
|
25
|
+
# A Cloud Firestore Database.
|
26
|
+
# Currently only one database is allowed per cloud project; this database
|
27
|
+
# must have a `database_id` of '(default)'.
|
28
|
+
# @!attribute [rw] name
|
29
|
+
# @return [::String]
|
30
|
+
# The resource name of the Database.
|
31
|
+
# Format: `projects/{project}/databases/{database}`
|
32
|
+
# @!attribute [rw] location_id
|
33
|
+
# @return [::String]
|
34
|
+
# The location of the database. Available databases are listed at
|
35
|
+
# https://cloud.google.com/firestore/docs/locations.
|
36
|
+
# @!attribute [rw] type
|
37
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Database::DatabaseType]
|
38
|
+
# The type of the database.
|
39
|
+
# See https://cloud.google.com/datastore/docs/firestore-or-datastore for
|
40
|
+
# information about how to choose.
|
41
|
+
# @!attribute [rw] concurrency_mode
|
42
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Database::ConcurrencyMode]
|
43
|
+
# The concurrency control mode to use for this database.
|
44
|
+
# @!attribute [rw] etag
|
45
|
+
# @return [::String]
|
46
|
+
# This checksum is computed by the server based on the value of other
|
47
|
+
# fields, and may be sent on update and delete requests to ensure the
|
48
|
+
# client has an up-to-date value before proceeding.
|
49
|
+
class Database
|
50
|
+
include ::Google::Protobuf::MessageExts
|
51
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
52
|
+
|
53
|
+
# The type of the database.
|
54
|
+
# See https://cloud.google.com/datastore/docs/firestore-or-datastore for
|
55
|
+
# information about how to choose.
|
56
|
+
module DatabaseType
|
57
|
+
# The default value. This value is used if the database type is omitted.
|
58
|
+
DATABASE_TYPE_UNSPECIFIED = 0
|
59
|
+
|
60
|
+
# Firestore Native Mode
|
61
|
+
FIRESTORE_NATIVE = 1
|
62
|
+
|
63
|
+
# Firestore in Datastore Mode.
|
64
|
+
DATASTORE_MODE = 2
|
65
|
+
end
|
66
|
+
|
67
|
+
# The type of concurrency control mode for transactions.
|
68
|
+
module ConcurrencyMode
|
69
|
+
# Not used.
|
70
|
+
CONCURRENCY_MODE_UNSPECIFIED = 0
|
71
|
+
|
72
|
+
# Use optimistic concurrency control by default. This setting is available
|
73
|
+
# for Cloud Firestore customers.
|
74
|
+
OPTIMISTIC = 1
|
75
|
+
|
76
|
+
# Use pessimistic concurrency control by default. This setting is available
|
77
|
+
# for Cloud Firestore customers.
|
78
|
+
# This is the default setting for Cloud Firestore.
|
79
|
+
PESSIMISTIC = 2
|
80
|
+
|
81
|
+
# Use optimistic concurrency control with entity groups by default. This is
|
82
|
+
# the only available setting for Cloud Datastore customers.
|
83
|
+
# This is the default setting for Cloud Datastore.
|
84
|
+
OPTIMISTIC_WITH_ENTITY_GROUPS = 3
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
91
|
+
end
|
@@ -28,7 +28,7 @@ module Google
|
|
28
28
|
# collections in the database with the same id.
|
29
29
|
# @!attribute [rw] name
|
30
30
|
# @return [::String]
|
31
|
-
# A field name of the form
|
31
|
+
# Required. A field name of the form
|
32
32
|
# `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
|
33
33
|
#
|
34
34
|
# A field path may be a simple field name, e.g. `address` or a path to fields
|
@@ -22,6 +22,53 @@ module Google
|
|
22
22
|
module Firestore
|
23
23
|
module Admin
|
24
24
|
module V1
|
25
|
+
# A request to list the Firestore Databases in all locations for a project.
|
26
|
+
# @!attribute [rw] parent
|
27
|
+
# @return [::String]
|
28
|
+
# Required. A parent name of the form
|
29
|
+
# `projects/{project_id}`
|
30
|
+
class ListDatabasesRequest
|
31
|
+
include ::Google::Protobuf::MessageExts
|
32
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
33
|
+
end
|
34
|
+
|
35
|
+
# The list of databases for a project.
|
36
|
+
# @!attribute [rw] databases
|
37
|
+
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::Database>]
|
38
|
+
# The databases in the project.
|
39
|
+
class ListDatabasesResponse
|
40
|
+
include ::Google::Protobuf::MessageExts
|
41
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
42
|
+
end
|
43
|
+
|
44
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#get_database FirestoreAdmin.GetDatabase}.
|
45
|
+
# @!attribute [rw] name
|
46
|
+
# @return [::String]
|
47
|
+
# Required. A name of the form
|
48
|
+
# `projects/{project_id}/databases/{database_id}`
|
49
|
+
class GetDatabaseRequest
|
50
|
+
include ::Google::Protobuf::MessageExts
|
51
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
52
|
+
end
|
53
|
+
|
54
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_database FirestoreAdmin.UpdateDatabase}.
|
55
|
+
# @!attribute [rw] database
|
56
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Database]
|
57
|
+
# Required. The database to update.
|
58
|
+
# @!attribute [rw] update_mask
|
59
|
+
# @return [::Google::Protobuf::FieldMask]
|
60
|
+
# The list of fields to be updated.
|
61
|
+
class UpdateDatabaseRequest
|
62
|
+
include ::Google::Protobuf::MessageExts
|
63
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
64
|
+
end
|
65
|
+
|
66
|
+
# Metadata related to the update database operation.
|
67
|
+
class UpdateDatabaseMetadata
|
68
|
+
include ::Google::Protobuf::MessageExts
|
69
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
70
|
+
end
|
71
|
+
|
25
72
|
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_index FirestoreAdmin.CreateIndex}.
|
26
73
|
# @!attribute [rw] parent
|
27
74
|
# @return [::String]
|
@@ -122,8 +169,8 @@ module Google
|
|
122
169
|
# The filter to apply to list results. Currently,
|
123
170
|
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} only supports listing fields
|
124
171
|
# that have been explicitly overridden. To issue this query, call
|
125
|
-
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with
|
126
|
-
# `indexConfig.usesAncestorConfig:false
|
172
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with a filter that includes
|
173
|
+
# `indexConfig.usesAncestorConfig:false` .
|
127
174
|
# @!attribute [rw] page_size
|
128
175
|
# @return [::Integer]
|
129
176
|
# The number of results to return.
|
@@ -70,7 +70,7 @@ module Google
|
|
70
70
|
# @!attribute [rw] order
|
71
71
|
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order]
|
72
72
|
# Indicates that this field supports ordering by the specified order or
|
73
|
-
# comparing using =, <, <=, >, >=.
|
73
|
+
# comparing using =, !=, <, <=, >, >=.
|
74
74
|
# @!attribute [rw] array_config
|
75
75
|
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig]
|
76
76
|
# Indicates that this field supports operations on `array_value`s.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-firestore-admin-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.4.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:
|
11
|
+
date: 2022-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '0.
|
19
|
+
version: '0.7'
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: '0.
|
29
|
+
version: '0.7'
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -159,8 +159,7 @@ dependencies:
|
|
159
159
|
description: Cloud Firestore is a NoSQL document database built for automatic scaling,
|
160
160
|
high performance, and ease of application development. Note that google-cloud-firestore-admin-v1
|
161
161
|
is a version-specific client library. For most uses, we recommend installing the
|
162
|
-
main client library google-cloud-firestore
|
163
|
-
details.
|
162
|
+
main client library google-cloud-firestore instead. See the readme for more details.
|
164
163
|
email: googleapis-packages@google.com
|
165
164
|
executables: []
|
166
165
|
extensions: []
|
@@ -178,6 +177,7 @@ files:
|
|
178
177
|
- lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb
|
179
178
|
- lib/google/cloud/firestore/admin/v1/firestore_admin/paths.rb
|
180
179
|
- lib/google/cloud/firestore/admin/v1/version.rb
|
180
|
+
- lib/google/firestore/admin/v1/database_pb.rb
|
181
181
|
- lib/google/firestore/admin/v1/field_pb.rb
|
182
182
|
- lib/google/firestore/admin/v1/firestore_admin_pb.rb
|
183
183
|
- lib/google/firestore/admin/v1/firestore_admin_services_pb.rb
|
@@ -187,6 +187,7 @@ files:
|
|
187
187
|
- proto_docs/README.md
|
188
188
|
- proto_docs/google/api/field_behavior.rb
|
189
189
|
- proto_docs/google/api/resource.rb
|
190
|
+
- proto_docs/google/firestore/admin/v1/database.rb
|
190
191
|
- proto_docs/google/firestore/admin/v1/field.rb
|
191
192
|
- proto_docs/google/firestore/admin/v1/firestore_admin.rb
|
192
193
|
- proto_docs/google/firestore/admin/v1/index.rb
|
@@ -219,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
219
220
|
- !ruby/object:Gem::Version
|
220
221
|
version: '0'
|
221
222
|
requirements: []
|
222
|
-
rubygems_version: 3.
|
223
|
+
rubygems_version: 3.3.4
|
223
224
|
signing_key:
|
224
225
|
specification_version: 4
|
225
226
|
summary: API Client library for the Cloud Firestore Admin V1 API
|