1// Code generated by protoc-gen-go. DO NOT EDIT.
2// source: google/firestore/admin/v1beta1/index.proto
3
4package admin
5
6import (
7	fmt "fmt"
8	math "math"
9
10	proto "github.com/golang/protobuf/proto"
11	_ "google.golang.org/genproto/googleapis/api/annotations"
12)
13
14// Reference imports to suppress errors if they are not otherwise used.
15var _ = proto.Marshal
16var _ = fmt.Errorf
17var _ = math.Inf
18
19// This is a compile-time assertion to ensure that this generated file
20// is compatible with the proto package it is being compiled against.
21// A compilation error at this line likely means your copy of the
22// proto package needs to be updated.
23const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package
24
25// The mode determines how a field is indexed.
26type IndexField_Mode int32
27
28const (
29	// The mode is unspecified.
30	IndexField_MODE_UNSPECIFIED IndexField_Mode = 0
31	// The field's values are indexed so as to support sequencing in
32	// ascending order and also query by <, >, <=, >=, and =.
33	IndexField_ASCENDING IndexField_Mode = 2
34	// The field's values are indexed so as to support sequencing in
35	// descending order and also query by <, >, <=, >=, and =.
36	IndexField_DESCENDING IndexField_Mode = 3
37	// The field's array values are indexed so as to support membership using
38	// ARRAY_CONTAINS queries.
39	IndexField_ARRAY_CONTAINS IndexField_Mode = 4
40)
41
42var IndexField_Mode_name = map[int32]string{
43	0: "MODE_UNSPECIFIED",
44	2: "ASCENDING",
45	3: "DESCENDING",
46	4: "ARRAY_CONTAINS",
47}
48
49var IndexField_Mode_value = map[string]int32{
50	"MODE_UNSPECIFIED": 0,
51	"ASCENDING":        2,
52	"DESCENDING":       3,
53	"ARRAY_CONTAINS":   4,
54}
55
56func (x IndexField_Mode) String() string {
57	return proto.EnumName(IndexField_Mode_name, int32(x))
58}
59
60func (IndexField_Mode) EnumDescriptor() ([]byte, []int) {
61	return fileDescriptor_18dcb37b2ab27460, []int{0, 0}
62}
63
64// The state of an index. During index creation, an index will be in the
65// `CREATING` state. If the index is created successfully, it will transition
66// to the `READY` state. If the index is not able to be created, it will
67// transition to the `ERROR` state.
68type Index_State int32
69
70const (
71	// The state is unspecified.
72	Index_STATE_UNSPECIFIED Index_State = 0
73	// The index is being created.
74	// There is an active long-running operation for the index.
75	// The index is updated when writing a document.
76	// Some index data may exist.
77	Index_CREATING Index_State = 3
78	// The index is ready to be used.
79	// The index is updated when writing a document.
80	// The index is fully populated from all stored documents it applies to.
81	Index_READY Index_State = 2
82	// The index was being created, but something went wrong.
83	// There is no active long-running operation for the index,
84	// and the most recently finished long-running operation failed.
85	// The index is not updated when writing a document.
86	// Some index data may exist.
87	Index_ERROR Index_State = 5
88)
89
90var Index_State_name = map[int32]string{
91	0: "STATE_UNSPECIFIED",
92	3: "CREATING",
93	2: "READY",
94	5: "ERROR",
95}
96
97var Index_State_value = map[string]int32{
98	"STATE_UNSPECIFIED": 0,
99	"CREATING":          3,
100	"READY":             2,
101	"ERROR":             5,
102}
103
104func (x Index_State) String() string {
105	return proto.EnumName(Index_State_name, int32(x))
106}
107
108func (Index_State) EnumDescriptor() ([]byte, []int) {
109	return fileDescriptor_18dcb37b2ab27460, []int{1, 0}
110}
111
112// A field of an index.
113type IndexField struct {
114	// The path of the field. Must match the field path specification described
115	// by [google.firestore.v1beta1.Document.fields][fields].
116	// Special field path `__name__` may be used by itself or at the end of a
117	// path. `__type__` may be used only at the end of path.
118	FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
119	// The field's mode.
120	Mode                 IndexField_Mode `protobuf:"varint,2,opt,name=mode,proto3,enum=google.firestore.admin.v1beta1.IndexField_Mode" json:"mode,omitempty"`
121	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
122	XXX_unrecognized     []byte          `json:"-"`
123	XXX_sizecache        int32           `json:"-"`
124}
125
126func (m *IndexField) Reset()         { *m = IndexField{} }
127func (m *IndexField) String() string { return proto.CompactTextString(m) }
128func (*IndexField) ProtoMessage()    {}
129func (*IndexField) Descriptor() ([]byte, []int) {
130	return fileDescriptor_18dcb37b2ab27460, []int{0}
131}
132
133func (m *IndexField) XXX_Unmarshal(b []byte) error {
134	return xxx_messageInfo_IndexField.Unmarshal(m, b)
135}
136func (m *IndexField) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) {
137	return xxx_messageInfo_IndexField.Marshal(b, m, deterministic)
138}
139func (m *IndexField) XXX_Merge(src proto.Message) {
140	xxx_messageInfo_IndexField.Merge(m, src)
141}
142func (m *IndexField) XXX_Size() int {
143	return xxx_messageInfo_IndexField.Size(m)
144}
145func (m *IndexField) XXX_DiscardUnknown() {
146	xxx_messageInfo_IndexField.DiscardUnknown(m)
147}
148
149var xxx_messageInfo_IndexField proto.InternalMessageInfo
150
151func (m *IndexField) GetFieldPath() string {
152	if m != nil {
153		return m.FieldPath
154	}
155	return ""
156}
157
158func (m *IndexField) GetMode() IndexField_Mode {
159	if m != nil {
160		return m.Mode
161	}
162	return IndexField_MODE_UNSPECIFIED
163}
164
165// An index definition.
166type Index struct {
167	// The resource name of the index.
168	// Output only.
169	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
170	// The collection ID to which this index applies. Required.
171	CollectionId string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
172	// The fields to index.
173	Fields []*IndexField `protobuf:"bytes,3,rep,name=fields,proto3" json:"fields,omitempty"`
174	// The state of the index.
175	// Output only.
176	State                Index_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.firestore.admin.v1beta1.Index_State" json:"state,omitempty"`
177	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
178	XXX_unrecognized     []byte      `json:"-"`
179	XXX_sizecache        int32       `json:"-"`
180}
181
182func (m *Index) Reset()         { *m = Index{} }
183func (m *Index) String() string { return proto.CompactTextString(m) }
184func (*Index) ProtoMessage()    {}
185func (*Index) Descriptor() ([]byte, []int) {
186	return fileDescriptor_18dcb37b2ab27460, []int{1}
187}
188
189func (m *Index) XXX_Unmarshal(b []byte) error {
190	return xxx_messageInfo_Index.Unmarshal(m, b)
191}
192func (m *Index) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) {
193	return xxx_messageInfo_Index.Marshal(b, m, deterministic)
194}
195func (m *Index) XXX_Merge(src proto.Message) {
196	xxx_messageInfo_Index.Merge(m, src)
197}
198func (m *Index) XXX_Size() int {
199	return xxx_messageInfo_Index.Size(m)
200}
201func (m *Index) XXX_DiscardUnknown() {
202	xxx_messageInfo_Index.DiscardUnknown(m)
203}
204
205var xxx_messageInfo_Index proto.InternalMessageInfo
206
207func (m *Index) GetName() string {
208	if m != nil {
209		return m.Name
210	}
211	return ""
212}
213
214func (m *Index) GetCollectionId() string {
215	if m != nil {
216		return m.CollectionId
217	}
218	return ""
219}
220
221func (m *Index) GetFields() []*IndexField {
222	if m != nil {
223		return m.Fields
224	}
225	return nil
226}
227
228func (m *Index) GetState() Index_State {
229	if m != nil {
230		return m.State
231	}
232	return Index_STATE_UNSPECIFIED
233}
234
235func init() {
236	proto.RegisterEnum("google.firestore.admin.v1beta1.IndexField_Mode", IndexField_Mode_name, IndexField_Mode_value)
237	proto.RegisterEnum("google.firestore.admin.v1beta1.Index_State", Index_State_name, Index_State_value)
238	proto.RegisterType((*IndexField)(nil), "google.firestore.admin.v1beta1.IndexField")
239	proto.RegisterType((*Index)(nil), "google.firestore.admin.v1beta1.Index")
240}
241
242func init() {
243	proto.RegisterFile("google/firestore/admin/v1beta1/index.proto", fileDescriptor_18dcb37b2ab27460)
244}
245
246var fileDescriptor_18dcb37b2ab27460 = []byte{
247	// 438 bytes of a gzipped FileDescriptorProto
248	0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x8c, 0x52, 0x5d, 0x8b, 0xd3, 0x40,
249	0x14, 0x35, 0x69, 0x52, 0xcc, 0x75, 0xb7, 0xc4, 0x41, 0xa1, 0x88, 0x4a, 0x89, 0x3e, 0x94, 0x15,
250	0x26, 0x74, 0x7d, 0xf4, 0x69, 0xf2, 0xd1, 0x92, 0x87, 0x4d, 0xcb, 0xa4, 0x0a, 0xeb, 0x4b, 0x99,
251	0x6d, 0x66, 0xb3, 0x81, 0x74, 0xa6, 0x34, 0xa3, 0xf8, 0x1f, 0xfc, 0x17, 0x82, 0x2f, 0xfe, 0x0b,
252	0xff, 0x99, 0xcc, 0x24, 0x74, 0x41, 0xd0, 0xed, 0xdb, 0x3d, 0x93, 0x73, 0xce, 0x3d, 0xf7, 0xe6,
253	0xc2, 0x45, 0x25, 0x65, 0xd5, 0xf0, 0xf0, 0xb6, 0x3e, 0xf0, 0x56, 0xc9, 0x03, 0x0f, 0x59, 0xb9,
254	0xab, 0x45, 0xf8, 0x75, 0x76, 0xc3, 0x15, 0x9b, 0x85, 0xb5, 0x28, 0xf9, 0x37, 0xbc, 0x3f, 0x48,
255	0x25, 0xd1, 0xeb, 0x8e, 0x8b, 0x8f, 0x5c, 0x6c, 0xb8, 0xb8, 0xe7, 0xbe, 0x78, 0xd9, 0x7b, 0xb1,
256	0x7d, 0x1d, 0x32, 0x21, 0xa4, 0x62, 0xaa, 0x96, 0xa2, 0xed, 0xd4, 0xc1, 0x6f, 0x0b, 0x20, 0xd3,
257	0x6e, 0xf3, 0x9a, 0x37, 0x25, 0x7a, 0x05, 0x70, 0xab, 0x8b, 0xcd, 0x9e, 0xa9, 0xbb, 0xb1, 0x35,
258	0xb1, 0xa6, 0x1e, 0xf5, 0xcc, 0xcb, 0x8a, 0xa9, 0x3b, 0x14, 0x83, 0xb3, 0x93, 0x25, 0x1f, 0xdb,
259	0x13, 0x6b, 0x3a, 0xba, 0x0c, 0xf1, 0xff, 0x5b, 0xe3, 0x7b, 0x63, 0x7c, 0x25, 0x4b, 0x4e, 0x8d,
260	0x38, 0x58, 0x82, 0xa3, 0x11, 0x7a, 0x06, 0xfe, 0xd5, 0x32, 0x49, 0x37, 0x1f, 0xf3, 0x62, 0x95,
261	0xc6, 0xd9, 0x3c, 0x4b, 0x13, 0xff, 0x11, 0x3a, 0x07, 0x8f, 0x14, 0x71, 0x9a, 0x27, 0x59, 0xbe,
262	0xf0, 0x6d, 0x34, 0x02, 0x48, 0xd2, 0x23, 0x1e, 0x20, 0x04, 0x23, 0x42, 0x29, 0xb9, 0xde, 0xc4,
263	0xcb, 0x7c, 0x4d, 0xb2, 0xbc, 0xf0, 0x9d, 0xe0, 0xbb, 0x0d, 0xae, 0x69, 0x85, 0x10, 0x38, 0x82,
264	0xed, 0x78, 0x1f, 0xdc, 0xd4, 0xe8, 0x0d, 0x9c, 0x6f, 0x65, 0xd3, 0xf0, 0xad, 0x1e, 0x7b, 0x53,
265	0x97, 0x26, 0xbc, 0x47, 0xcf, 0xee, 0x1f, 0xb3, 0x12, 0x45, 0x30, 0x34, 0x53, 0xb6, 0xe3, 0xc1,
266	0x64, 0x30, 0x7d, 0x72, 0x79, 0x71, 0xfa, 0x68, 0xb4, 0x57, 0x22, 0x02, 0x6e, 0xab, 0x98, 0xe2,
267	0xe3, 0xa1, 0xd9, 0xce, 0xbb, 0x93, 0x2c, 0x70, 0xa1, 0x25, 0xb4, 0x53, 0x06, 0x11, 0xb8, 0x06,
268	0xa3, 0xe7, 0xf0, 0xb4, 0x58, 0x93, 0xf5, 0xdf, 0xcb, 0x39, 0x83, 0xc7, 0x31, 0x4d, 0xc9, 0xba,
269	0xdb, 0x85, 0x07, 0x2e, 0x4d, 0x49, 0x72, 0xed, 0xdb, 0xba, 0x4c, 0x29, 0x5d, 0x52, 0xdf, 0x8d,
270	0x7e, 0x5a, 0x10, 0x6c, 0xe5, 0xee, 0x81, 0xee, 0x51, 0xf7, 0xd7, 0x57, 0xfa, 0x08, 0x56, 0xd6,
271	0xe7, 0xb8, 0x67, 0x57, 0xb2, 0x61, 0xa2, 0xc2, 0xf2, 0x50, 0x85, 0x15, 0x17, 0xe6, 0x44, 0xc2,
272	0xee, 0x13, 0xdb, 0xd7, 0xed, 0xbf, 0xee, 0xf1, 0x83, 0x41, 0x3f, 0x6c, 0x67, 0x11, 0xcf, 0x8b,
273	0x5f, 0xf6, 0xdb, 0x45, 0x67, 0x16, 0x37, 0xf2, 0x4b, 0x89, 0xe7, 0xc7, 0x00, 0xc4, 0x04, 0xf8,
274	0x34, 0x8b, 0xb4, 0xe6, 0x66, 0x68, 0xdc, 0xdf, 0xff, 0x09, 0x00, 0x00, 0xff, 0xff, 0x0c, 0xbf,
275	0x61, 0xbe, 0xec, 0x02, 0x00, 0x00,
276}
277