google-cloud-firestore-admin-v1 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +203 -0
- data/README.md +75 -0
- data/lib/google-cloud-firestore-admin-v1.rb +21 -0
- data/lib/google/cloud/firestore/admin/v1.rb +37 -0
- data/lib/google/cloud/firestore/admin/v1/firestore_admin.rb +53 -0
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb +1105 -0
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/credentials.rb +54 -0
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb +572 -0
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/paths.rb +113 -0
- data/lib/google/cloud/firestore/admin/v1/version.rb +30 -0
- data/lib/google/firestore/admin/v1/field_pb.rb +35 -0
- data/lib/google/firestore/admin/v1/firestore_admin_pb.rb +87 -0
- data/lib/google/firestore/admin/v1/firestore_admin_services_pb.rb +95 -0
- data/lib/google/firestore/admin/v1/index_pb.rb +61 -0
- data/lib/google/firestore/admin/v1/location_pb.rb +25 -0
- data/lib/google/firestore/admin/v1/operation_pb.rb +93 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +59 -0
- data/proto_docs/google/api/resource.rb +247 -0
- data/proto_docs/google/firestore/admin/v1/field.rb +98 -0
- data/proto_docs/google/firestore/admin/v1/firestore_admin.rb +200 -0
- data/proto_docs/google/firestore/admin/v1/index.rb +154 -0
- data/proto_docs/google/firestore/admin/v1/location.rb +34 -0
- data/proto_docs/google/firestore/admin/v1/operation.rb +222 -0
- data/proto_docs/google/longrunning/operations.rb +150 -0
- data/proto_docs/google/protobuf/any.rb +138 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +120 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- data/proto_docs/google/type/latlng.rb +38 -0
- metadata +216 -0
@@ -0,0 +1,200 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_index FirestoreAdmin.CreateIndex}.
|
26
|
+
# @!attribute [rw] parent
|
27
|
+
# @return [::String]
|
28
|
+
# Required. A parent name of the form
|
29
|
+
# `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
|
30
|
+
# @!attribute [rw] index
|
31
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index]
|
32
|
+
# Required. The composite index to create.
|
33
|
+
class CreateIndexRequest
|
34
|
+
include ::Google::Protobuf::MessageExts
|
35
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
36
|
+
end
|
37
|
+
|
38
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_indexes FirestoreAdmin.ListIndexes}.
|
39
|
+
# @!attribute [rw] parent
|
40
|
+
# @return [::String]
|
41
|
+
# Required. A parent name of the form
|
42
|
+
# `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
|
43
|
+
# @!attribute [rw] filter
|
44
|
+
# @return [::String]
|
45
|
+
# The filter to apply to list results.
|
46
|
+
# @!attribute [rw] page_size
|
47
|
+
# @return [::Integer]
|
48
|
+
# The number of results to return.
|
49
|
+
# @!attribute [rw] page_token
|
50
|
+
# @return [::String]
|
51
|
+
# A page token, returned from a previous call to
|
52
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_indexes FirestoreAdmin.ListIndexes}, that may be used to get the next
|
53
|
+
# page of results.
|
54
|
+
class ListIndexesRequest
|
55
|
+
include ::Google::Protobuf::MessageExts
|
56
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
57
|
+
end
|
58
|
+
|
59
|
+
# The response for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_indexes FirestoreAdmin.ListIndexes}.
|
60
|
+
# @!attribute [rw] indexes
|
61
|
+
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::Index>]
|
62
|
+
# The requested indexes.
|
63
|
+
# @!attribute [rw] next_page_token
|
64
|
+
# @return [::String]
|
65
|
+
# A page token that may be used to request another page of results. If blank,
|
66
|
+
# this is the last page.
|
67
|
+
class ListIndexesResponse
|
68
|
+
include ::Google::Protobuf::MessageExts
|
69
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
70
|
+
end
|
71
|
+
|
72
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#get_index FirestoreAdmin.GetIndex}.
|
73
|
+
# @!attribute [rw] name
|
74
|
+
# @return [::String]
|
75
|
+
# Required. A name of the form
|
76
|
+
# `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
|
77
|
+
class GetIndexRequest
|
78
|
+
include ::Google::Protobuf::MessageExts
|
79
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
80
|
+
end
|
81
|
+
|
82
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#delete_index FirestoreAdmin.DeleteIndex}.
|
83
|
+
# @!attribute [rw] name
|
84
|
+
# @return [::String]
|
85
|
+
# Required. A name of the form
|
86
|
+
# `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
|
87
|
+
class DeleteIndexRequest
|
88
|
+
include ::Google::Protobuf::MessageExts
|
89
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
90
|
+
end
|
91
|
+
|
92
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_field FirestoreAdmin.UpdateField}.
|
93
|
+
# @!attribute [rw] field
|
94
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Field]
|
95
|
+
# Required. The field to be updated.
|
96
|
+
# @!attribute [rw] update_mask
|
97
|
+
# @return [::Google::Protobuf::FieldMask]
|
98
|
+
# A mask, relative to the field. If specified, only configuration specified
|
99
|
+
# by this field_mask will be updated in the field.
|
100
|
+
class UpdateFieldRequest
|
101
|
+
include ::Google::Protobuf::MessageExts
|
102
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
103
|
+
end
|
104
|
+
|
105
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#get_field FirestoreAdmin.GetField}.
|
106
|
+
# @!attribute [rw] name
|
107
|
+
# @return [::String]
|
108
|
+
# Required. A name of the form
|
109
|
+
# `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`
|
110
|
+
class GetFieldRequest
|
111
|
+
include ::Google::Protobuf::MessageExts
|
112
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
113
|
+
end
|
114
|
+
|
115
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields}.
|
116
|
+
# @!attribute [rw] parent
|
117
|
+
# @return [::String]
|
118
|
+
# Required. A parent name of the form
|
119
|
+
# `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
|
120
|
+
# @!attribute [rw] filter
|
121
|
+
# @return [::String]
|
122
|
+
# The filter to apply to list results. Currently,
|
123
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} only supports listing fields
|
124
|
+
# that have been explicitly overridden. To issue this query, call
|
125
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with the filter set to
|
126
|
+
# `indexConfig.usesAncestorConfig:false`.
|
127
|
+
# @!attribute [rw] page_size
|
128
|
+
# @return [::Integer]
|
129
|
+
# The number of results to return.
|
130
|
+
# @!attribute [rw] page_token
|
131
|
+
# @return [::String]
|
132
|
+
# A page token, returned from a previous call to
|
133
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields}, that may be used to get the next
|
134
|
+
# page of results.
|
135
|
+
class ListFieldsRequest
|
136
|
+
include ::Google::Protobuf::MessageExts
|
137
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
138
|
+
end
|
139
|
+
|
140
|
+
# The response for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields}.
|
141
|
+
# @!attribute [rw] fields
|
142
|
+
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::Field>]
|
143
|
+
# The requested fields.
|
144
|
+
# @!attribute [rw] next_page_token
|
145
|
+
# @return [::String]
|
146
|
+
# A page token that may be used to request another page of results. If blank,
|
147
|
+
# this is the last page.
|
148
|
+
class ListFieldsResponse
|
149
|
+
include ::Google::Protobuf::MessageExts
|
150
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
151
|
+
end
|
152
|
+
|
153
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#export_documents FirestoreAdmin.ExportDocuments}.
|
154
|
+
# @!attribute [rw] name
|
155
|
+
# @return [::String]
|
156
|
+
# Required. Database to export. Should be of the form:
|
157
|
+
# `projects/{project_id}/databases/{database_id}`.
|
158
|
+
# @!attribute [rw] collection_ids
|
159
|
+
# @return [::Array<::String>]
|
160
|
+
# Which collection ids to export. Unspecified means all collections.
|
161
|
+
# @!attribute [rw] output_uri_prefix
|
162
|
+
# @return [::String]
|
163
|
+
# The output URI. Currently only supports Google Cloud Storage URIs of the
|
164
|
+
# form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name
|
165
|
+
# of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional
|
166
|
+
# Google Cloud Storage namespace path. When
|
167
|
+
# choosing a name, be sure to consider Google Cloud Storage naming
|
168
|
+
# guidelines: https://cloud.google.com/storage/docs/naming.
|
169
|
+
# If the URI is a bucket (without a namespace path), a prefix will be
|
170
|
+
# generated based on the start time.
|
171
|
+
class ExportDocumentsRequest
|
172
|
+
include ::Google::Protobuf::MessageExts
|
173
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
174
|
+
end
|
175
|
+
|
176
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#import_documents FirestoreAdmin.ImportDocuments}.
|
177
|
+
# @!attribute [rw] name
|
178
|
+
# @return [::String]
|
179
|
+
# Required. Database to import into. Should be of the form:
|
180
|
+
# `projects/{project_id}/databases/{database_id}`.
|
181
|
+
# @!attribute [rw] collection_ids
|
182
|
+
# @return [::Array<::String>]
|
183
|
+
# Which collection ids to import. Unspecified means all collections included
|
184
|
+
# in the import.
|
185
|
+
# @!attribute [rw] input_uri_prefix
|
186
|
+
# @return [::String]
|
187
|
+
# Location of the exported files.
|
188
|
+
# This must match the output_uri_prefix of an ExportDocumentsResponse from
|
189
|
+
# an export that has completed successfully.
|
190
|
+
# See:
|
191
|
+
# {::Google::Cloud::Firestore::Admin::V1::ExportDocumentsResponse#output_uri_prefix google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix}.
|
192
|
+
class ImportDocumentsRequest
|
193
|
+
include ::Google::Protobuf::MessageExts
|
194
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
195
|
+
end
|
196
|
+
end
|
197
|
+
end
|
198
|
+
end
|
199
|
+
end
|
200
|
+
end
|
@@ -0,0 +1,154 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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
|
+
# Cloud Firestore indexes enable simple and complex queries against
|
26
|
+
# documents in a database.
|
27
|
+
# @!attribute [rw] name
|
28
|
+
# @return [::String]
|
29
|
+
# Output only. A server defined name for this index.
|
30
|
+
# The form of this name for composite indexes will be:
|
31
|
+
# `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}`
|
32
|
+
# For single field indexes, this field will be empty.
|
33
|
+
# @!attribute [rw] query_scope
|
34
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index::QueryScope]
|
35
|
+
# Indexes with a collection query scope specified allow queries
|
36
|
+
# against a collection that is the child of a specific document, specified at
|
37
|
+
# query time, and that has the same collection id.
|
38
|
+
#
|
39
|
+
# Indexes with a collection group query scope specified allow queries against
|
40
|
+
# all collections descended from a specific document, specified at query
|
41
|
+
# time, and that have the same collection id as this index.
|
42
|
+
# @!attribute [rw] fields
|
43
|
+
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::Index::IndexField>]
|
44
|
+
# The fields supported by this index.
|
45
|
+
#
|
46
|
+
# For composite indexes, this is always 2 or more fields.
|
47
|
+
# The last field entry is always for the field path `__name__`. If, on
|
48
|
+
# creation, `__name__` was not specified as the last field, it will be added
|
49
|
+
# automatically with the same direction as that of the last field defined. If
|
50
|
+
# the final field in a composite index is not directional, the `__name__`
|
51
|
+
# will be ordered ASCENDING (unless explicitly specified).
|
52
|
+
#
|
53
|
+
# For single field indexes, this will always be exactly one entry with a
|
54
|
+
# field path equal to the field path of the associated field.
|
55
|
+
# @!attribute [rw] state
|
56
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index::State]
|
57
|
+
# Output only. The serving state of the index.
|
58
|
+
class Index
|
59
|
+
include ::Google::Protobuf::MessageExts
|
60
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
61
|
+
|
62
|
+
# A field in an index.
|
63
|
+
# The field_path describes which field is indexed, the value_mode describes
|
64
|
+
# how the field value is indexed.
|
65
|
+
# @!attribute [rw] field_path
|
66
|
+
# @return [::String]
|
67
|
+
# Can be __name__.
|
68
|
+
# For single field indexes, this must match the name of the field or may
|
69
|
+
# be omitted.
|
70
|
+
# @!attribute [rw] order
|
71
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order]
|
72
|
+
# Indicates that this field supports ordering by the specified order or
|
73
|
+
# comparing using =, <, <=, >, >=.
|
74
|
+
# @!attribute [rw] array_config
|
75
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig]
|
76
|
+
# Indicates that this field supports operations on `array_value`s.
|
77
|
+
class IndexField
|
78
|
+
include ::Google::Protobuf::MessageExts
|
79
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
80
|
+
|
81
|
+
# The supported orderings.
|
82
|
+
module Order
|
83
|
+
# The ordering is unspecified. Not a valid option.
|
84
|
+
ORDER_UNSPECIFIED = 0
|
85
|
+
|
86
|
+
# The field is ordered by ascending field value.
|
87
|
+
ASCENDING = 1
|
88
|
+
|
89
|
+
# The field is ordered by descending field value.
|
90
|
+
DESCENDING = 2
|
91
|
+
end
|
92
|
+
|
93
|
+
# The supported array value configurations.
|
94
|
+
module ArrayConfig
|
95
|
+
# The index does not support additional array queries.
|
96
|
+
ARRAY_CONFIG_UNSPECIFIED = 0
|
97
|
+
|
98
|
+
# The index supports array containment queries.
|
99
|
+
CONTAINS = 1
|
100
|
+
end
|
101
|
+
end
|
102
|
+
|
103
|
+
# Query Scope defines the scope at which a query is run. This is specified on
|
104
|
+
# a StructuredQuery's `from` field.
|
105
|
+
module QueryScope
|
106
|
+
# The query scope is unspecified. Not a valid option.
|
107
|
+
QUERY_SCOPE_UNSPECIFIED = 0
|
108
|
+
|
109
|
+
# Indexes with a collection query scope specified allow queries
|
110
|
+
# against a collection that is the child of a specific document, specified
|
111
|
+
# at query time, and that has the collection id specified by the index.
|
112
|
+
COLLECTION = 1
|
113
|
+
|
114
|
+
# Indexes with a collection group query scope specified allow queries
|
115
|
+
# against all collections that has the collection id specified by the
|
116
|
+
# index.
|
117
|
+
COLLECTION_GROUP = 2
|
118
|
+
end
|
119
|
+
|
120
|
+
# The state of an index. During index creation, an index will be in the
|
121
|
+
# `CREATING` state. If the index is created successfully, it will transition
|
122
|
+
# to the `READY` state. If the index creation encounters a problem, the index
|
123
|
+
# will transition to the `NEEDS_REPAIR` state.
|
124
|
+
module State
|
125
|
+
# The state is unspecified.
|
126
|
+
STATE_UNSPECIFIED = 0
|
127
|
+
|
128
|
+
# The index is being created.
|
129
|
+
# There is an active long-running operation for the index.
|
130
|
+
# The index is updated when writing a document.
|
131
|
+
# Some index data may exist.
|
132
|
+
CREATING = 1
|
133
|
+
|
134
|
+
# The index is ready to be used.
|
135
|
+
# The index is updated when writing a document.
|
136
|
+
# The index is fully populated from all stored documents it applies to.
|
137
|
+
READY = 2
|
138
|
+
|
139
|
+
# The index was being created, but something went wrong.
|
140
|
+
# There is no active long-running operation for the index,
|
141
|
+
# and the most recently finished long-running operation failed.
|
142
|
+
# The index is not updated when writing a document.
|
143
|
+
# Some index data may exist.
|
144
|
+
# Use the google.longrunning.Operations API to determine why the operation
|
145
|
+
# that last attempted to create this index failed, then re-create the
|
146
|
+
# index.
|
147
|
+
NEEDS_REPAIR = 3
|
148
|
+
end
|
149
|
+
end
|
150
|
+
end
|
151
|
+
end
|
152
|
+
end
|
153
|
+
end
|
154
|
+
end
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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
|
+
# The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata].
|
26
|
+
class LocationMetadata
|
27
|
+
include ::Google::Protobuf::MessageExts
|
28
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
@@ -0,0 +1,222 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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
|
+
# Metadata for {::Google::Longrunning::Operation google.longrunning.Operation} results from
|
26
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_index FirestoreAdmin.CreateIndex}.
|
27
|
+
# @!attribute [rw] start_time
|
28
|
+
# @return [::Google::Protobuf::Timestamp]
|
29
|
+
# The time this operation started.
|
30
|
+
# @!attribute [rw] end_time
|
31
|
+
# @return [::Google::Protobuf::Timestamp]
|
32
|
+
# The time this operation completed. Will be unset if operation still in
|
33
|
+
# progress.
|
34
|
+
# @!attribute [rw] index
|
35
|
+
# @return [::String]
|
36
|
+
# The index resource that this operation is acting on. For example:
|
37
|
+
# `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
|
38
|
+
# @!attribute [rw] state
|
39
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::OperationState]
|
40
|
+
# The state of the operation.
|
41
|
+
# @!attribute [rw] progress_documents
|
42
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Progress]
|
43
|
+
# The progress, in documents, of this operation.
|
44
|
+
# @!attribute [rw] progress_bytes
|
45
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Progress]
|
46
|
+
# The progress, in bytes, of this operation.
|
47
|
+
class IndexOperationMetadata
|
48
|
+
include ::Google::Protobuf::MessageExts
|
49
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
50
|
+
end
|
51
|
+
|
52
|
+
# Metadata for {::Google::Longrunning::Operation google.longrunning.Operation} results from
|
53
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_field FirestoreAdmin.UpdateField}.
|
54
|
+
# @!attribute [rw] start_time
|
55
|
+
# @return [::Google::Protobuf::Timestamp]
|
56
|
+
# The time this operation started.
|
57
|
+
# @!attribute [rw] end_time
|
58
|
+
# @return [::Google::Protobuf::Timestamp]
|
59
|
+
# The time this operation completed. Will be unset if operation still in
|
60
|
+
# progress.
|
61
|
+
# @!attribute [rw] field
|
62
|
+
# @return [::String]
|
63
|
+
# The field resource that this operation is acting on. For example:
|
64
|
+
# `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
|
65
|
+
# @!attribute [rw] index_config_deltas
|
66
|
+
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta>]
|
67
|
+
# A list of {::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta IndexConfigDelta}, which describe the intent of this
|
68
|
+
# operation.
|
69
|
+
# @!attribute [rw] state
|
70
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::OperationState]
|
71
|
+
# The state of the operation.
|
72
|
+
# @!attribute [rw] progress_documents
|
73
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Progress]
|
74
|
+
# The progress, in documents, of this operation.
|
75
|
+
# @!attribute [rw] progress_bytes
|
76
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Progress]
|
77
|
+
# The progress, in bytes, of this operation.
|
78
|
+
class FieldOperationMetadata
|
79
|
+
include ::Google::Protobuf::MessageExts
|
80
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
81
|
+
|
82
|
+
# Information about an index configuration change.
|
83
|
+
# @!attribute [rw] change_type
|
84
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta::ChangeType]
|
85
|
+
# Specifies how the index is changing.
|
86
|
+
# @!attribute [rw] index
|
87
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index]
|
88
|
+
# The index being changed.
|
89
|
+
class IndexConfigDelta
|
90
|
+
include ::Google::Protobuf::MessageExts
|
91
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
92
|
+
|
93
|
+
# Specifies how the index is changing.
|
94
|
+
module ChangeType
|
95
|
+
# The type of change is not specified or known.
|
96
|
+
CHANGE_TYPE_UNSPECIFIED = 0
|
97
|
+
|
98
|
+
# The single field index is being added.
|
99
|
+
ADD = 1
|
100
|
+
|
101
|
+
# The single field index is being removed.
|
102
|
+
REMOVE = 2
|
103
|
+
end
|
104
|
+
end
|
105
|
+
end
|
106
|
+
|
107
|
+
# Metadata for {::Google::Longrunning::Operation google.longrunning.Operation} results from
|
108
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#export_documents FirestoreAdmin.ExportDocuments}.
|
109
|
+
# @!attribute [rw] start_time
|
110
|
+
# @return [::Google::Protobuf::Timestamp]
|
111
|
+
# The time this operation started.
|
112
|
+
# @!attribute [rw] end_time
|
113
|
+
# @return [::Google::Protobuf::Timestamp]
|
114
|
+
# The time this operation completed. Will be unset if operation still in
|
115
|
+
# progress.
|
116
|
+
# @!attribute [rw] operation_state
|
117
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::OperationState]
|
118
|
+
# The state of the export operation.
|
119
|
+
# @!attribute [rw] progress_documents
|
120
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Progress]
|
121
|
+
# The progress, in documents, of this operation.
|
122
|
+
# @!attribute [rw] progress_bytes
|
123
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Progress]
|
124
|
+
# The progress, in bytes, of this operation.
|
125
|
+
# @!attribute [rw] collection_ids
|
126
|
+
# @return [::Array<::String>]
|
127
|
+
# Which collection ids are being exported.
|
128
|
+
# @!attribute [rw] output_uri_prefix
|
129
|
+
# @return [::String]
|
130
|
+
# Where the entities are being exported to.
|
131
|
+
class ExportDocumentsMetadata
|
132
|
+
include ::Google::Protobuf::MessageExts
|
133
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
134
|
+
end
|
135
|
+
|
136
|
+
# Metadata for {::Google::Longrunning::Operation google.longrunning.Operation} results from
|
137
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#import_documents FirestoreAdmin.ImportDocuments}.
|
138
|
+
# @!attribute [rw] start_time
|
139
|
+
# @return [::Google::Protobuf::Timestamp]
|
140
|
+
# The time this operation started.
|
141
|
+
# @!attribute [rw] end_time
|
142
|
+
# @return [::Google::Protobuf::Timestamp]
|
143
|
+
# The time this operation completed. Will be unset if operation still in
|
144
|
+
# progress.
|
145
|
+
# @!attribute [rw] operation_state
|
146
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::OperationState]
|
147
|
+
# The state of the import operation.
|
148
|
+
# @!attribute [rw] progress_documents
|
149
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Progress]
|
150
|
+
# The progress, in documents, of this operation.
|
151
|
+
# @!attribute [rw] progress_bytes
|
152
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Progress]
|
153
|
+
# The progress, in bytes, of this operation.
|
154
|
+
# @!attribute [rw] collection_ids
|
155
|
+
# @return [::Array<::String>]
|
156
|
+
# Which collection ids are being imported.
|
157
|
+
# @!attribute [rw] input_uri_prefix
|
158
|
+
# @return [::String]
|
159
|
+
# The location of the documents being imported.
|
160
|
+
class ImportDocumentsMetadata
|
161
|
+
include ::Google::Protobuf::MessageExts
|
162
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
163
|
+
end
|
164
|
+
|
165
|
+
# Returned in the {::Google::Longrunning::Operation google.longrunning.Operation} response field.
|
166
|
+
# @!attribute [rw] output_uri_prefix
|
167
|
+
# @return [::String]
|
168
|
+
# Location of the output files. This can be used to begin an import
|
169
|
+
# into Cloud Firestore (this project or another project) after the operation
|
170
|
+
# completes successfully.
|
171
|
+
class ExportDocumentsResponse
|
172
|
+
include ::Google::Protobuf::MessageExts
|
173
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
174
|
+
end
|
175
|
+
|
176
|
+
# Describes the progress of the operation.
|
177
|
+
# Unit of work is generic and must be interpreted based on where {::Google::Cloud::Firestore::Admin::V1::Progress Progress}
|
178
|
+
# is used.
|
179
|
+
# @!attribute [rw] estimated_work
|
180
|
+
# @return [::Integer]
|
181
|
+
# The amount of work estimated.
|
182
|
+
# @!attribute [rw] completed_work
|
183
|
+
# @return [::Integer]
|
184
|
+
# The amount of work completed.
|
185
|
+
class Progress
|
186
|
+
include ::Google::Protobuf::MessageExts
|
187
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
188
|
+
end
|
189
|
+
|
190
|
+
# Describes the state of the operation.
|
191
|
+
module OperationState
|
192
|
+
# Unspecified.
|
193
|
+
OPERATION_STATE_UNSPECIFIED = 0
|
194
|
+
|
195
|
+
# Request is being prepared for processing.
|
196
|
+
INITIALIZING = 1
|
197
|
+
|
198
|
+
# Request is actively being processed.
|
199
|
+
PROCESSING = 2
|
200
|
+
|
201
|
+
# Request is in the process of being cancelled after user called
|
202
|
+
# google.longrunning.Operations.CancelOperation on the operation.
|
203
|
+
CANCELLING = 3
|
204
|
+
|
205
|
+
# Request has been processed and is in its finalization stage.
|
206
|
+
FINALIZING = 4
|
207
|
+
|
208
|
+
# Request has completed successfully.
|
209
|
+
SUCCESSFUL = 5
|
210
|
+
|
211
|
+
# Request has finished being processed, but encountered an error.
|
212
|
+
FAILED = 6
|
213
|
+
|
214
|
+
# Request has finished being cancelled after user called
|
215
|
+
# google.longrunning.Operations.CancelOperation.
|
216
|
+
CANCELLED = 7
|
217
|
+
end
|
218
|
+
end
|
219
|
+
end
|
220
|
+
end
|
221
|
+
end
|
222
|
+
end
|