You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
151 lines
5.6 KiB
151 lines
5.6 KiB
// Copyright 2019 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 |
|
// |
|
// http://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. |
|
// |
|
|
|
syntax = "proto3"; |
|
|
|
package google.firestore.admin.v1; |
|
|
|
import "google/api/annotations.proto"; |
|
|
|
option csharp_namespace = "Google.Cloud.Firestore.Admin.V1"; |
|
option go_package = "google.golang.org/genproto/googleapis/firestore/admin/v1;admin"; |
|
option java_multiple_files = true; |
|
option java_outer_classname = "IndexProto"; |
|
option java_package = "com.google.firestore.admin.v1"; |
|
option objc_class_prefix = "GCFS"; |
|
option php_namespace = "Google\\Cloud\\Firestore\\Admin\\V1"; |
|
|
|
// Cloud Firestore indexes enable simple and complex queries against |
|
// documents in a database. |
|
message Index { |
|
// A field in an index. |
|
// The field_path describes which field is indexed, the value_mode describes |
|
// how the field value is indexed. |
|
message IndexField { |
|
// The supported orderings. |
|
enum Order { |
|
// The ordering is unspecified. Not a valid option. |
|
ORDER_UNSPECIFIED = 0; |
|
|
|
// The field is ordered by ascending field value. |
|
ASCENDING = 1; |
|
|
|
// The field is ordered by descending field value. |
|
DESCENDING = 2; |
|
} |
|
|
|
// The supported array value configurations. |
|
enum ArrayConfig { |
|
// The index does not support additional array queries. |
|
ARRAY_CONFIG_UNSPECIFIED = 0; |
|
|
|
// The index supports array containment queries. |
|
CONTAINS = 1; |
|
} |
|
|
|
// Can be __name__. |
|
// For single field indexes, this must match the name of the field or may |
|
// be omitted. |
|
string field_path = 1; |
|
|
|
// How the field value is indexed. |
|
oneof value_mode { |
|
// Indicates that this field supports ordering by the specified order or |
|
// comparing using =, <, <=, >, >=. |
|
Order order = 2; |
|
|
|
// Indicates that this field supports operations on `array_value`s. |
|
ArrayConfig array_config = 3; |
|
} |
|
} |
|
|
|
// Query Scope defines the scope at which a query is run. This is specified on |
|
// a StructuredQuery's `from` field. |
|
enum QueryScope { |
|
// The query scope is unspecified. Not a valid option. |
|
QUERY_SCOPE_UNSPECIFIED = 0; |
|
|
|
// Indexes with a collection query scope specified allow queries |
|
// against a collection that is the child of a specific document, specified |
|
// at query time, and that has the collection id specified by the index. |
|
COLLECTION = 1; |
|
|
|
// Indexes with a collection group query scope specified allow queries |
|
// against all collections that has the collection id specified by the |
|
// index. |
|
COLLECTION_GROUP = 2; |
|
} |
|
|
|
// The state of an index. During index creation, an index will be in the |
|
// `CREATING` state. If the index is created successfully, it will transition |
|
// to the `READY` state. If the index creation encounters a problem, the index |
|
// will transition to the `NEEDS_REPAIR` state. |
|
enum State { |
|
// The state is unspecified. |
|
STATE_UNSPECIFIED = 0; |
|
|
|
// The index is being created. |
|
// There is an active long-running operation for the index. |
|
// The index is updated when writing a document. |
|
// Some index data may exist. |
|
CREATING = 1; |
|
|
|
// The index is ready to be used. |
|
// The index is updated when writing a document. |
|
// The index is fully populated from all stored documents it applies to. |
|
READY = 2; |
|
|
|
// The index was being created, but something went wrong. |
|
// There is no active long-running operation for the index, |
|
// and the most recently finished long-running operation failed. |
|
// The index is not updated when writing a document. |
|
// Some index data may exist. |
|
// Use the google.longrunning.Operations API to determine why the operation |
|
// that last attempted to create this index failed, then re-create the |
|
// index. |
|
NEEDS_REPAIR = 3; |
|
} |
|
|
|
// Output only. A server defined name for this index. |
|
// The form of this name for composite indexes will be: |
|
// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` |
|
// For single field indexes, this field will be empty. |
|
string name = 1; |
|
|
|
// Indexes with a collection query scope specified allow queries |
|
// against a collection that is the child of a specific document, specified at |
|
// query time, and that has the same collection id. |
|
// |
|
// Indexes with a collection group query scope specified allow queries against |
|
// all collections descended from a specific document, specified at query |
|
// time, and that have the same collection id as this index. |
|
QueryScope query_scope = 2; |
|
|
|
// The fields supported by this index. |
|
// |
|
// For composite indexes, this is always 2 or more fields. |
|
// The last field entry is always for the field path `__name__`. If, on |
|
// creation, `__name__` was not specified as the last field, it will be added |
|
// automatically with the same direction as that of the last field defined. If |
|
// the final field in a composite index is not directional, the `__name__` |
|
// will be ordered ASCENDING (unless explicitly specified). |
|
// |
|
// For single field indexes, this will always be exactly one entry with a |
|
// field path equal to the field path of the associated field. |
|
repeated IndexField fields = 3; |
|
|
|
// Output only. The serving state of the index. |
|
State state = 4; |
|
}
|
|
|