Documentation
¶
Overview ¶
Package tests is a generated protocol buffer package.
It is generated from these files:
test.proto
It has these top-level messages:
TestSuite Test GetTest CreateTest SetTest UpdateTest UpdatePathsTest DeleteTest SetOption QueryTest Clause Select Where OrderBy Cursor DocSnapshot FieldPath
Index ¶
- type Clause
- func (*Clause) Descriptor() ([]byte, []int)
- func (m *Clause) GetClause() isClause_Clause
- func (m *Clause) GetEndAt() *Cursor
- func (m *Clause) GetEndBefore() *Cursor
- func (m *Clause) GetLimit() int32
- func (m *Clause) GetOffset() int32
- func (m *Clause) GetOrderBy() *OrderBy
- func (m *Clause) GetSelect() *Select
- func (m *Clause) GetStartAfter() *Cursor
- func (m *Clause) GetStartAt() *Cursor
- func (m *Clause) GetWhere() *Where
- func (*Clause) ProtoMessage()
- func (m *Clause) Reset()
- func (m *Clause) String() string
- func (*Clause) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type Clause_EndAt
- type Clause_EndBefore
- type Clause_Limit
- type Clause_Offset
- type Clause_OrderBy
- type Clause_Select
- type Clause_StartAfter
- type Clause_StartAt
- type Clause_Where
- type CreateTest
- func (*CreateTest) Descriptor() ([]byte, []int)
- func (m *CreateTest) GetDocRefPath() string
- func (m *CreateTest) GetIsError() bool
- func (m *CreateTest) GetJsonData() string
- func (m *CreateTest) GetRequest() *google_firestore_v1beta14.CommitRequest
- func (*CreateTest) ProtoMessage()
- func (m *CreateTest) Reset()
- func (m *CreateTest) String() string
- type Cursor
- type DeleteTest
- func (*DeleteTest) Descriptor() ([]byte, []int)
- func (m *DeleteTest) GetDocRefPath() string
- func (m *DeleteTest) GetIsError() bool
- func (m *DeleteTest) GetPrecondition() *google_firestore_v1beta1.Precondition
- func (m *DeleteTest) GetRequest() *google_firestore_v1beta14.CommitRequest
- func (*DeleteTest) ProtoMessage()
- func (m *DeleteTest) Reset()
- func (m *DeleteTest) String() string
- type DocSnapshot
- type FieldPath
- type GetTest
- type OrderBy
- type QueryTest
- func (*QueryTest) Descriptor() ([]byte, []int)
- func (m *QueryTest) GetClauses() []*Clause
- func (m *QueryTest) GetCollPath() string
- func (m *QueryTest) GetIsError() bool
- func (m *QueryTest) GetQuery() *google_firestore_v1beta12.StructuredQuery
- func (*QueryTest) ProtoMessage()
- func (m *QueryTest) Reset()
- func (m *QueryTest) String() string
- type Select
- type SetOption
- type SetTest
- func (*SetTest) Descriptor() ([]byte, []int)
- func (m *SetTest) GetDocRefPath() string
- func (m *SetTest) GetIsError() bool
- func (m *SetTest) GetJsonData() string
- func (m *SetTest) GetOption() *SetOption
- func (m *SetTest) GetRequest() *google_firestore_v1beta14.CommitRequest
- func (*SetTest) ProtoMessage()
- func (m *SetTest) Reset()
- func (m *SetTest) String() string
- type Test
- func (*Test) Descriptor() ([]byte, []int)
- func (m *Test) GetCreate() *CreateTest
- func (m *Test) GetDelete() *DeleteTest
- func (m *Test) GetDescription() string
- func (m *Test) GetGet() *GetTest
- func (m *Test) GetQuery() *QueryTest
- func (m *Test) GetSet() *SetTest
- func (m *Test) GetTest() isTest_Test
- func (m *Test) GetUpdate() *UpdateTest
- func (m *Test) GetUpdatePaths() *UpdatePathsTest
- func (*Test) ProtoMessage()
- func (m *Test) Reset()
- func (m *Test) String() string
- func (*Test) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type TestSuite
- type Test_Create
- type Test_Delete
- type Test_Get
- type Test_Query
- type Test_Set
- type Test_Update
- type Test_UpdatePaths
- type UpdatePathsTest
- func (*UpdatePathsTest) Descriptor() ([]byte, []int)
- func (m *UpdatePathsTest) GetDocRefPath() string
- func (m *UpdatePathsTest) GetFieldPaths() []*FieldPath
- func (m *UpdatePathsTest) GetIsError() bool
- func (m *UpdatePathsTest) GetJsonValues() []string
- func (m *UpdatePathsTest) GetPrecondition() *google_firestore_v1beta1.Precondition
- func (m *UpdatePathsTest) GetRequest() *google_firestore_v1beta14.CommitRequest
- func (*UpdatePathsTest) ProtoMessage()
- func (m *UpdatePathsTest) Reset()
- func (m *UpdatePathsTest) String() string
- type UpdateTest
- func (*UpdateTest) Descriptor() ([]byte, []int)
- func (m *UpdateTest) GetDocRefPath() string
- func (m *UpdateTest) GetIsError() bool
- func (m *UpdateTest) GetJsonData() string
- func (m *UpdateTest) GetPrecondition() *google_firestore_v1beta1.Precondition
- func (m *UpdateTest) GetRequest() *google_firestore_v1beta14.CommitRequest
- func (*UpdateTest) ProtoMessage()
- func (m *UpdateTest) Reset()
- func (m *UpdateTest) String() string
- type Where
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Clause ¶ added in v0.19.0
type Clause struct {
// Types that are valid to be assigned to Clause:
// *Clause_Select
// *Clause_Where
// *Clause_OrderBy
// *Clause_Offset
// *Clause_Limit
// *Clause_StartAt
// *Clause_StartAfter
// *Clause_EndAt
// *Clause_EndBefore
Clause isClause_Clause `protobuf_oneof:"clause"`
}
func (*Clause) XXX_OneofFuncs ¶ added in v0.19.0
func (*Clause) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type Clause_EndAt ¶ added in v0.19.0
type Clause_EndAt struct {
EndAt *Cursor `protobuf:"bytes,8,opt,name=end_at,json=endAt,oneof"`
}
type Clause_EndBefore ¶ added in v0.19.0
type Clause_EndBefore struct {
EndBefore *Cursor `protobuf:"bytes,9,opt,name=end_before,json=endBefore,oneof"`
}
type Clause_Limit ¶ added in v0.19.0
type Clause_Limit struct {
Limit int32 `protobuf:"varint,5,opt,name=limit,oneof"`
}
type Clause_Offset ¶ added in v0.19.0
type Clause_Offset struct {
Offset int32 `protobuf:"varint,4,opt,name=offset,oneof"`
}
type Clause_OrderBy ¶ added in v0.19.0
type Clause_OrderBy struct {
OrderBy *OrderBy `protobuf:"bytes,3,opt,name=order_by,json=orderBy,oneof"`
}
type Clause_Select ¶ added in v0.19.0
type Clause_Select struct {
Select *Select `protobuf:"bytes,1,opt,name=select,oneof"`
}
type Clause_StartAfter ¶ added in v0.19.0
type Clause_StartAfter struct {
StartAfter *Cursor `protobuf:"bytes,7,opt,name=start_after,json=startAfter,oneof"`
}
type Clause_StartAt ¶ added in v0.19.0
type Clause_StartAt struct {
StartAt *Cursor `protobuf:"bytes,6,opt,name=start_at,json=startAt,oneof"`
}
type Clause_Where ¶ added in v0.19.0
type Clause_Where struct {
Where *Where `protobuf:"bytes,2,opt,name=where,oneof"`
}
type CreateTest ¶
type CreateTest struct {
// The path of the doc, e.g. "projects/projectID/databases/(default)/documents/C/d"
DocRefPath string `protobuf:"bytes,1,opt,name=doc_ref_path,json=docRefPath" json:"doc_ref_path,omitempty"`
// The data passed to Create, as JSON. The strings "Delete" and "ServerTimestamp"
// denote the two special sentinel values. Values that could be interpreted as integers
// (i.e. digit strings) should be treated as integers.
JsonData string `protobuf:"bytes,2,opt,name=json_data,json=jsonData" json:"json_data,omitempty"`
// The request that the call should generate.
Request *google_firestore_v1beta14.CommitRequest `protobuf:"bytes,3,opt,name=request" json:"request,omitempty"`
// If true, the call should result in an error without generating a request.
// If this is true, request should not be set.
IsError bool `protobuf:"varint,4,opt,name=is_error,json=isError" json:"is_error,omitempty"`
}
Call to DocumentRef.Create.
func (*CreateTest) Descriptor ¶
func (*CreateTest) Descriptor() ([]byte, []int)
func (*CreateTest) GetDocRefPath ¶
func (m *CreateTest) GetDocRefPath() string
func (*CreateTest) GetIsError ¶
func (m *CreateTest) GetIsError() bool
func (*CreateTest) GetJsonData ¶
func (m *CreateTest) GetJsonData() string
func (*CreateTest) GetRequest ¶
func (m *CreateTest) GetRequest() *google_firestore_v1beta14.CommitRequest
func (*CreateTest) ProtoMessage ¶
func (*CreateTest) ProtoMessage()
func (*CreateTest) Reset ¶
func (m *CreateTest) Reset()
func (*CreateTest) String ¶
func (m *CreateTest) String() string
type Cursor ¶ added in v0.19.0
type Cursor struct {
// one of:
DocSnapshot *DocSnapshot `protobuf:"bytes,1,opt,name=doc_snapshot,json=docSnapshot" json:"doc_snapshot,omitempty"`
JsonValues []string `protobuf:"bytes,2,rep,name=json_values,json=jsonValues" json:"json_values,omitempty"`
}
func (*Cursor) GetDocSnapshot ¶ added in v0.19.0
func (m *Cursor) GetDocSnapshot() *DocSnapshot
type DeleteTest ¶
type DeleteTest struct {
DocRefPath string `protobuf:"bytes,1,opt,name=doc_ref_path,json=docRefPath" json:"doc_ref_path,omitempty"`
Precondition *google_firestore_v1beta1.Precondition `protobuf:"bytes,2,opt,name=precondition" json:"precondition,omitempty"`
Request *google_firestore_v1beta14.CommitRequest `protobuf:"bytes,3,opt,name=request" json:"request,omitempty"`
IsError bool `protobuf:"varint,4,opt,name=is_error,json=isError" json:"is_error,omitempty"`
}
A call to DocmentRef.Delete
func (*DeleteTest) Descriptor ¶
func (*DeleteTest) Descriptor() ([]byte, []int)
func (*DeleteTest) GetDocRefPath ¶
func (m *DeleteTest) GetDocRefPath() string
func (*DeleteTest) GetIsError ¶
func (m *DeleteTest) GetIsError() bool
func (*DeleteTest) GetPrecondition ¶
func (m *DeleteTest) GetPrecondition() *google_firestore_v1beta1.Precondition
func (*DeleteTest) GetRequest ¶
func (m *DeleteTest) GetRequest() *google_firestore_v1beta14.CommitRequest
func (*DeleteTest) ProtoMessage ¶
func (*DeleteTest) ProtoMessage()
func (*DeleteTest) Reset ¶
func (m *DeleteTest) Reset()
func (*DeleteTest) String ¶
func (m *DeleteTest) String() string
type DocSnapshot ¶ added in v0.19.0
type DocSnapshot struct {
Path string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
JsonData string `protobuf:"bytes,2,opt,name=json_data,json=jsonData" json:"json_data,omitempty"`
}
func (*DocSnapshot) Descriptor ¶ added in v0.19.0
func (*DocSnapshot) Descriptor() ([]byte, []int)
func (*DocSnapshot) GetJsonData ¶ added in v0.19.0
func (m *DocSnapshot) GetJsonData() string
func (*DocSnapshot) GetPath ¶ added in v0.19.0
func (m *DocSnapshot) GetPath() string
func (*DocSnapshot) ProtoMessage ¶ added in v0.19.0
func (*DocSnapshot) ProtoMessage()
func (*DocSnapshot) Reset ¶ added in v0.19.0
func (m *DocSnapshot) Reset()
func (*DocSnapshot) String ¶ added in v0.19.0
func (m *DocSnapshot) String() string
type FieldPath ¶
type FieldPath struct {
Field []string `protobuf:"bytes,1,rep,name=field" json:"field,omitempty"`
}
type GetTest ¶
type GetTest struct {
// The path of the doc, e.g. "projects/projectID/databases/(default)/documents/C/d"
DocRefPath string `protobuf:"bytes,1,opt,name=doc_ref_path,json=docRefPath" json:"doc_ref_path,omitempty"`
// The request that the call should send to the Firestore service.
Request *google_firestore_v1beta14.GetDocumentRequest `protobuf:"bytes,2,opt,name=request" json:"request,omitempty"`
}
Call to the DocumentRef.Get method.
func (*GetTest) GetRequest ¶
func (m *GetTest) GetRequest() *google_firestore_v1beta14.GetDocumentRequest
type OrderBy ¶ added in v0.19.0
type QueryTest ¶ added in v0.19.0
type QueryTest struct {
CollPath string `protobuf:"bytes,1,opt,name=coll_path,json=collPath" json:"coll_path,omitempty"`
Clauses []*Clause `protobuf:"bytes,2,rep,name=clauses" json:"clauses,omitempty"`
Query *google_firestore_v1beta12.StructuredQuery `protobuf:"bytes,3,opt,name=query" json:"query,omitempty"`
IsError bool `protobuf:"varint,4,opt,name=is_error,json=isError" json:"is_error,omitempty"`
}
func (*QueryTest) GetQuery ¶ added in v0.19.0
func (m *QueryTest) GetQuery() *google_firestore_v1beta12.StructuredQuery
type Select ¶ added in v0.19.0
type Select struct {
Fields []*FieldPath `protobuf:"bytes,1,rep,name=fields" json:"fields,omitempty"`
}
type SetOption ¶
type SetOption struct {
All bool `protobuf:"varint,1,opt,name=all" json:"all,omitempty"`
Fields []*FieldPath `protobuf:"bytes,2,rep,name=fields" json:"fields,omitempty"`
}
An option to the DocumentRef.Set call.
type SetTest ¶
type SetTest struct {
DocRefPath string `protobuf:"bytes,1,opt,name=doc_ref_path,json=docRefPath" json:"doc_ref_path,omitempty"`
Option *SetOption `protobuf:"bytes,2,opt,name=option" json:"option,omitempty"`
JsonData string `protobuf:"bytes,3,opt,name=json_data,json=jsonData" json:"json_data,omitempty"`
Request *google_firestore_v1beta14.CommitRequest `protobuf:"bytes,4,opt,name=request" json:"request,omitempty"`
IsError bool `protobuf:"varint,5,opt,name=is_error,json=isError" json:"is_error,omitempty"`
}
A call to DocumentRef.Set.
func (*SetTest) GetRequest ¶
func (m *SetTest) GetRequest() *google_firestore_v1beta14.CommitRequest
type Test ¶
type Test struct {
Description string `protobuf:"bytes,1,opt,name=description" json:"description,omitempty"`
// Types that are valid to be assigned to Test:
// *Test_Get
// *Test_Create
// *Test_Set
// *Test_Update
// *Test_UpdatePaths
// *Test_Delete
// *Test_Query
Test isTest_Test `protobuf_oneof:"test"`
}
A Test describes a single client method call and its expected result.
func (*Test) GetCreate ¶
func (m *Test) GetCreate() *CreateTest
func (*Test) GetDelete ¶
func (m *Test) GetDelete() *DeleteTest
func (*Test) GetUpdate ¶
func (m *Test) GetUpdate() *UpdateTest
func (*Test) GetUpdatePaths ¶
func (m *Test) GetUpdatePaths() *UpdatePathsTest
type TestSuite ¶ added in v0.19.0
type TestSuite struct {
Tests []*Test `protobuf:"bytes,1,rep,name=tests" json:"tests,omitempty"`
}
A collection of tests.
type Test_Create ¶
type Test_Create struct {
Create *CreateTest `protobuf:"bytes,3,opt,name=create,oneof"`
}
type Test_Delete ¶
type Test_Delete struct {
Delete *DeleteTest `protobuf:"bytes,7,opt,name=delete,oneof"`
}
type Test_Query ¶ added in v0.19.0
type Test_Query struct {
Query *QueryTest `protobuf:"bytes,8,opt,name=query,oneof"`
}
type Test_Update ¶
type Test_Update struct {
Update *UpdateTest `protobuf:"bytes,5,opt,name=update,oneof"`
}
type Test_UpdatePaths ¶
type Test_UpdatePaths struct {
UpdatePaths *UpdatePathsTest `protobuf:"bytes,6,opt,name=update_paths,json=updatePaths,oneof"`
}
type UpdatePathsTest ¶
type UpdatePathsTest struct {
DocRefPath string `protobuf:"bytes,1,opt,name=doc_ref_path,json=docRefPath" json:"doc_ref_path,omitempty"`
Precondition *google_firestore_v1beta1.Precondition `protobuf:"bytes,2,opt,name=precondition" json:"precondition,omitempty"`
// parallel sequences: field_paths[i] corresponds to json_values[i]
FieldPaths []*FieldPath `protobuf:"bytes,3,rep,name=field_paths,json=fieldPaths" json:"field_paths,omitempty"`
JsonValues []string `protobuf:"bytes,4,rep,name=json_values,json=jsonValues" json:"json_values,omitempty"`
Request *google_firestore_v1beta14.CommitRequest `protobuf:"bytes,5,opt,name=request" json:"request,omitempty"`
IsError bool `protobuf:"varint,6,opt,name=is_error,json=isError" json:"is_error,omitempty"`
}
A call to the form of DocumentRef.Update that represents the data as a list of field paths and their values.
func (*UpdatePathsTest) Descriptor ¶
func (*UpdatePathsTest) Descriptor() ([]byte, []int)
func (*UpdatePathsTest) GetDocRefPath ¶
func (m *UpdatePathsTest) GetDocRefPath() string
func (*UpdatePathsTest) GetFieldPaths ¶
func (m *UpdatePathsTest) GetFieldPaths() []*FieldPath
func (*UpdatePathsTest) GetIsError ¶
func (m *UpdatePathsTest) GetIsError() bool
func (*UpdatePathsTest) GetJsonValues ¶
func (m *UpdatePathsTest) GetJsonValues() []string
func (*UpdatePathsTest) GetPrecondition ¶
func (m *UpdatePathsTest) GetPrecondition() *google_firestore_v1beta1.Precondition
func (*UpdatePathsTest) GetRequest ¶
func (m *UpdatePathsTest) GetRequest() *google_firestore_v1beta14.CommitRequest
func (*UpdatePathsTest) ProtoMessage ¶
func (*UpdatePathsTest) ProtoMessage()
func (*UpdatePathsTest) Reset ¶
func (m *UpdatePathsTest) Reset()
func (*UpdatePathsTest) String ¶
func (m *UpdatePathsTest) String() string
type UpdateTest ¶
type UpdateTest struct {
DocRefPath string `protobuf:"bytes,1,opt,name=doc_ref_path,json=docRefPath" json:"doc_ref_path,omitempty"`
Precondition *google_firestore_v1beta1.Precondition `protobuf:"bytes,2,opt,name=precondition" json:"precondition,omitempty"`
JsonData string `protobuf:"bytes,3,opt,name=json_data,json=jsonData" json:"json_data,omitempty"`
Request *google_firestore_v1beta14.CommitRequest `protobuf:"bytes,4,opt,name=request" json:"request,omitempty"`
IsError bool `protobuf:"varint,5,opt,name=is_error,json=isError" json:"is_error,omitempty"`
}
A call to the form of DocumentRef.Update that represents the data as a map or dictionary.
func (*UpdateTest) Descriptor ¶
func (*UpdateTest) Descriptor() ([]byte, []int)
func (*UpdateTest) GetDocRefPath ¶
func (m *UpdateTest) GetDocRefPath() string
func (*UpdateTest) GetIsError ¶
func (m *UpdateTest) GetIsError() bool
func (*UpdateTest) GetJsonData ¶
func (m *UpdateTest) GetJsonData() string
func (*UpdateTest) GetPrecondition ¶
func (m *UpdateTest) GetPrecondition() *google_firestore_v1beta1.Precondition
func (*UpdateTest) GetRequest ¶
func (m *UpdateTest) GetRequest() *google_firestore_v1beta14.CommitRequest
func (*UpdateTest) ProtoMessage ¶
func (*UpdateTest) ProtoMessage()
func (*UpdateTest) Reset ¶
func (m *UpdateTest) Reset()
func (*UpdateTest) String ¶
func (m *UpdateTest) String() string
Source Files
¶
- test.pb.go