Documentation
¶
Index ¶
- Variables
- func RegisterFirestoreAdminServer(s *grpc.Server, srv FirestoreAdminServer)
- type CreateIndexRequest
- func (*CreateIndexRequest) Descriptor() ([]byte, []int)
- func (m *CreateIndexRequest) GetIndex() *Index
- func (m *CreateIndexRequest) GetParent() string
- func (*CreateIndexRequest) ProtoMessage()
- func (m *CreateIndexRequest) Reset()
- func (m *CreateIndexRequest) String() string
- func (m *CreateIndexRequest) XXX_DiscardUnknown()
- func (m *CreateIndexRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *CreateIndexRequest) XXX_Merge(src proto.Message)
- func (m *CreateIndexRequest) XXX_Size() int
- func (m *CreateIndexRequest) XXX_Unmarshal(b []byte) error
- type DeleteIndexRequest
- func (*DeleteIndexRequest) Descriptor() ([]byte, []int)
- func (m *DeleteIndexRequest) GetName() string
- func (*DeleteIndexRequest) ProtoMessage()
- func (m *DeleteIndexRequest) Reset()
- func (m *DeleteIndexRequest) String() string
- func (m *DeleteIndexRequest) XXX_DiscardUnknown()
- func (m *DeleteIndexRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DeleteIndexRequest) XXX_Merge(src proto.Message)
- func (m *DeleteIndexRequest) XXX_Size() int
- func (m *DeleteIndexRequest) XXX_Unmarshal(b []byte) error
- type ExportDocumentsMetadata
- func (*ExportDocumentsMetadata) Descriptor() ([]byte, []int)
- func (m *ExportDocumentsMetadata) GetCollectionIds() []string
- func (m *ExportDocumentsMetadata) GetEndTime() *timestamp.Timestamp
- func (m *ExportDocumentsMetadata) GetOperationState() OperationState
- func (m *ExportDocumentsMetadata) GetOutputUriPrefix() string
- func (m *ExportDocumentsMetadata) GetProgressBytes() *Progress
- func (m *ExportDocumentsMetadata) GetProgressDocuments() *Progress
- func (m *ExportDocumentsMetadata) GetStartTime() *timestamp.Timestamp
- func (*ExportDocumentsMetadata) ProtoMessage()
- func (m *ExportDocumentsMetadata) Reset()
- func (m *ExportDocumentsMetadata) String() string
- func (m *ExportDocumentsMetadata) XXX_DiscardUnknown()
- func (m *ExportDocumentsMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ExportDocumentsMetadata) XXX_Merge(src proto.Message)
- func (m *ExportDocumentsMetadata) XXX_Size() int
- func (m *ExportDocumentsMetadata) XXX_Unmarshal(b []byte) error
- type ExportDocumentsRequest
- func (*ExportDocumentsRequest) Descriptor() ([]byte, []int)
- func (m *ExportDocumentsRequest) GetCollectionIds() []string
- func (m *ExportDocumentsRequest) GetName() string
- func (m *ExportDocumentsRequest) GetOutputUriPrefix() string
- func (*ExportDocumentsRequest) ProtoMessage()
- func (m *ExportDocumentsRequest) Reset()
- func (m *ExportDocumentsRequest) String() string
- func (m *ExportDocumentsRequest) XXX_DiscardUnknown()
- func (m *ExportDocumentsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ExportDocumentsRequest) XXX_Merge(src proto.Message)
- func (m *ExportDocumentsRequest) XXX_Size() int
- func (m *ExportDocumentsRequest) XXX_Unmarshal(b []byte) error
- type ExportDocumentsResponse
- func (*ExportDocumentsResponse) Descriptor() ([]byte, []int)
- func (m *ExportDocumentsResponse) GetOutputUriPrefix() string
- func (*ExportDocumentsResponse) ProtoMessage()
- func (m *ExportDocumentsResponse) Reset()
- func (m *ExportDocumentsResponse) String() string
- func (m *ExportDocumentsResponse) XXX_DiscardUnknown()
- func (m *ExportDocumentsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ExportDocumentsResponse) XXX_Merge(src proto.Message)
- func (m *ExportDocumentsResponse) XXX_Size() int
- func (m *ExportDocumentsResponse) XXX_Unmarshal(b []byte) error
- type Field
- func (*Field) Descriptor() ([]byte, []int)
- func (m *Field) GetIndexConfig() *Field_IndexConfig
- func (m *Field) GetName() string
- func (*Field) ProtoMessage()
- func (m *Field) Reset()
- func (m *Field) String() string
- func (m *Field) XXX_DiscardUnknown()
- func (m *Field) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Field) XXX_Merge(src proto.Message)
- func (m *Field) XXX_Size() int
- func (m *Field) XXX_Unmarshal(b []byte) error
- type FieldOperationMetadata
- func (*FieldOperationMetadata) Descriptor() ([]byte, []int)
- func (m *FieldOperationMetadata) GetEndTime() *timestamp.Timestamp
- func (m *FieldOperationMetadata) GetField() string
- func (m *FieldOperationMetadata) GetIndexConfigDeltas() []*FieldOperationMetadata_IndexConfigDelta
- func (m *FieldOperationMetadata) GetProgressBytes() *Progress
- func (m *FieldOperationMetadata) GetProgressDocuments() *Progress
- func (m *FieldOperationMetadata) GetStartTime() *timestamp.Timestamp
- func (m *FieldOperationMetadata) GetState() OperationState
- func (*FieldOperationMetadata) ProtoMessage()
- func (m *FieldOperationMetadata) Reset()
- func (m *FieldOperationMetadata) String() string
- func (m *FieldOperationMetadata) XXX_DiscardUnknown()
- func (m *FieldOperationMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *FieldOperationMetadata) XXX_Merge(src proto.Message)
- func (m *FieldOperationMetadata) XXX_Size() int
- func (m *FieldOperationMetadata) XXX_Unmarshal(b []byte) error
- type FieldOperationMetadata_IndexConfigDelta
- func (*FieldOperationMetadata_IndexConfigDelta) Descriptor() ([]byte, []int)
- func (m *FieldOperationMetadata_IndexConfigDelta) GetChangeType() FieldOperationMetadata_IndexConfigDelta_ChangeType
- func (m *FieldOperationMetadata_IndexConfigDelta) GetIndex() *Index
- func (*FieldOperationMetadata_IndexConfigDelta) ProtoMessage()
- func (m *FieldOperationMetadata_IndexConfigDelta) Reset()
- func (m *FieldOperationMetadata_IndexConfigDelta) String() string
- func (m *FieldOperationMetadata_IndexConfigDelta) XXX_DiscardUnknown()
- func (m *FieldOperationMetadata_IndexConfigDelta) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *FieldOperationMetadata_IndexConfigDelta) XXX_Merge(src proto.Message)
- func (m *FieldOperationMetadata_IndexConfigDelta) XXX_Size() int
- func (m *FieldOperationMetadata_IndexConfigDelta) XXX_Unmarshal(b []byte) error
- type FieldOperationMetadata_IndexConfigDelta_ChangeType
- type Field_IndexConfig
- func (*Field_IndexConfig) Descriptor() ([]byte, []int)
- func (m *Field_IndexConfig) GetAncestorField() string
- func (m *Field_IndexConfig) GetIndexes() []*Index
- func (m *Field_IndexConfig) GetReverting() bool
- func (m *Field_IndexConfig) GetUsesAncestorConfig() bool
- func (*Field_IndexConfig) ProtoMessage()
- func (m *Field_IndexConfig) Reset()
- func (m *Field_IndexConfig) String() string
- func (m *Field_IndexConfig) XXX_DiscardUnknown()
- func (m *Field_IndexConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Field_IndexConfig) XXX_Merge(src proto.Message)
- func (m *Field_IndexConfig) XXX_Size() int
- func (m *Field_IndexConfig) XXX_Unmarshal(b []byte) error
- type FirestoreAdminClient
- type FirestoreAdminServer
- type GetFieldRequest
- func (*GetFieldRequest) Descriptor() ([]byte, []int)
- func (m *GetFieldRequest) GetName() string
- func (*GetFieldRequest) ProtoMessage()
- func (m *GetFieldRequest) Reset()
- func (m *GetFieldRequest) String() string
- func (m *GetFieldRequest) XXX_DiscardUnknown()
- func (m *GetFieldRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *GetFieldRequest) XXX_Merge(src proto.Message)
- func (m *GetFieldRequest) XXX_Size() int
- func (m *GetFieldRequest) XXX_Unmarshal(b []byte) error
- type GetIndexRequest
- func (*GetIndexRequest) Descriptor() ([]byte, []int)
- func (m *GetIndexRequest) GetName() string
- func (*GetIndexRequest) ProtoMessage()
- func (m *GetIndexRequest) Reset()
- func (m *GetIndexRequest) String() string
- func (m *GetIndexRequest) XXX_DiscardUnknown()
- func (m *GetIndexRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *GetIndexRequest) XXX_Merge(src proto.Message)
- func (m *GetIndexRequest) XXX_Size() int
- func (m *GetIndexRequest) XXX_Unmarshal(b []byte) error
- type ImportDocumentsMetadata
- func (*ImportDocumentsMetadata) Descriptor() ([]byte, []int)
- func (m *ImportDocumentsMetadata) GetCollectionIds() []string
- func (m *ImportDocumentsMetadata) GetEndTime() *timestamp.Timestamp
- func (m *ImportDocumentsMetadata) GetInputUriPrefix() string
- func (m *ImportDocumentsMetadata) GetOperationState() OperationState
- func (m *ImportDocumentsMetadata) GetProgressBytes() *Progress
- func (m *ImportDocumentsMetadata) GetProgressDocuments() *Progress
- func (m *ImportDocumentsMetadata) GetStartTime() *timestamp.Timestamp
- func (*ImportDocumentsMetadata) ProtoMessage()
- func (m *ImportDocumentsMetadata) Reset()
- func (m *ImportDocumentsMetadata) String() string
- func (m *ImportDocumentsMetadata) XXX_DiscardUnknown()
- func (m *ImportDocumentsMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ImportDocumentsMetadata) XXX_Merge(src proto.Message)
- func (m *ImportDocumentsMetadata) XXX_Size() int
- func (m *ImportDocumentsMetadata) XXX_Unmarshal(b []byte) error
- type ImportDocumentsRequest
- func (*ImportDocumentsRequest) Descriptor() ([]byte, []int)
- func (m *ImportDocumentsRequest) GetCollectionIds() []string
- func (m *ImportDocumentsRequest) GetInputUriPrefix() string
- func (m *ImportDocumentsRequest) GetName() string
- func (*ImportDocumentsRequest) ProtoMessage()
- func (m *ImportDocumentsRequest) Reset()
- func (m *ImportDocumentsRequest) String() string
- func (m *ImportDocumentsRequest) XXX_DiscardUnknown()
- func (m *ImportDocumentsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ImportDocumentsRequest) XXX_Merge(src proto.Message)
- func (m *ImportDocumentsRequest) XXX_Size() int
- func (m *ImportDocumentsRequest) XXX_Unmarshal(b []byte) error
- type Index
- func (*Index) Descriptor() ([]byte, []int)
- func (m *Index) GetFields() []*Index_IndexField
- func (m *Index) GetName() string
- func (m *Index) GetQueryScope() Index_QueryScope
- func (m *Index) GetState() Index_State
- func (*Index) ProtoMessage()
- func (m *Index) Reset()
- func (m *Index) String() string
- func (m *Index) XXX_DiscardUnknown()
- func (m *Index) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Index) XXX_Merge(src proto.Message)
- func (m *Index) XXX_Size() int
- func (m *Index) XXX_Unmarshal(b []byte) error
- type IndexOperationMetadata
- func (*IndexOperationMetadata) Descriptor() ([]byte, []int)
- func (m *IndexOperationMetadata) GetEndTime() *timestamp.Timestamp
- func (m *IndexOperationMetadata) GetIndex() string
- func (m *IndexOperationMetadata) GetProgressBytes() *Progress
- func (m *IndexOperationMetadata) GetProgressDocuments() *Progress
- func (m *IndexOperationMetadata) GetStartTime() *timestamp.Timestamp
- func (m *IndexOperationMetadata) GetState() OperationState
- func (*IndexOperationMetadata) ProtoMessage()
- func (m *IndexOperationMetadata) Reset()
- func (m *IndexOperationMetadata) String() string
- func (m *IndexOperationMetadata) XXX_DiscardUnknown()
- func (m *IndexOperationMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *IndexOperationMetadata) XXX_Merge(src proto.Message)
- func (m *IndexOperationMetadata) XXX_Size() int
- func (m *IndexOperationMetadata) XXX_Unmarshal(b []byte) error
- type Index_IndexField
- func (*Index_IndexField) Descriptor() ([]byte, []int)
- func (m *Index_IndexField) GetArrayConfig() Index_IndexField_ArrayConfig
- func (m *Index_IndexField) GetFieldPath() string
- func (m *Index_IndexField) GetOrder() Index_IndexField_Order
- func (m *Index_IndexField) GetValueMode() isIndex_IndexField_ValueMode
- func (*Index_IndexField) ProtoMessage()
- func (m *Index_IndexField) Reset()
- func (m *Index_IndexField) String() string
- func (m *Index_IndexField) XXX_DiscardUnknown()
- func (m *Index_IndexField) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Index_IndexField) XXX_Merge(src proto.Message)
- func (*Index_IndexField) XXX_OneofWrappers() []interface{}
- func (m *Index_IndexField) XXX_Size() int
- func (m *Index_IndexField) XXX_Unmarshal(b []byte) error
- type Index_IndexField_ArrayConfig
- type Index_IndexField_ArrayConfig_
- type Index_IndexField_Order
- type Index_IndexField_Order_
- type Index_QueryScope
- type Index_State
- type ListFieldsRequest
- func (*ListFieldsRequest) Descriptor() ([]byte, []int)
- func (m *ListFieldsRequest) GetFilter() string
- func (m *ListFieldsRequest) GetPageSize() int32
- func (m *ListFieldsRequest) GetPageToken() string
- func (m *ListFieldsRequest) GetParent() string
- func (*ListFieldsRequest) ProtoMessage()
- func (m *ListFieldsRequest) Reset()
- func (m *ListFieldsRequest) String() string
- func (m *ListFieldsRequest) XXX_DiscardUnknown()
- func (m *ListFieldsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ListFieldsRequest) XXX_Merge(src proto.Message)
- func (m *ListFieldsRequest) XXX_Size() int
- func (m *ListFieldsRequest) XXX_Unmarshal(b []byte) error
- type ListFieldsResponse
- func (*ListFieldsResponse) Descriptor() ([]byte, []int)
- func (m *ListFieldsResponse) GetFields() []*Field
- func (m *ListFieldsResponse) GetNextPageToken() string
- func (*ListFieldsResponse) ProtoMessage()
- func (m *ListFieldsResponse) Reset()
- func (m *ListFieldsResponse) String() string
- func (m *ListFieldsResponse) XXX_DiscardUnknown()
- func (m *ListFieldsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ListFieldsResponse) XXX_Merge(src proto.Message)
- func (m *ListFieldsResponse) XXX_Size() int
- func (m *ListFieldsResponse) XXX_Unmarshal(b []byte) error
- type ListIndexesRequest
- func (*ListIndexesRequest) Descriptor() ([]byte, []int)
- func (m *ListIndexesRequest) GetFilter() string
- func (m *ListIndexesRequest) GetPageSize() int32
- func (m *ListIndexesRequest) GetPageToken() string
- func (m *ListIndexesRequest) GetParent() string
- func (*ListIndexesRequest) ProtoMessage()
- func (m *ListIndexesRequest) Reset()
- func (m *ListIndexesRequest) String() string
- func (m *ListIndexesRequest) XXX_DiscardUnknown()
- func (m *ListIndexesRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ListIndexesRequest) XXX_Merge(src proto.Message)
- func (m *ListIndexesRequest) XXX_Size() int
- func (m *ListIndexesRequest) XXX_Unmarshal(b []byte) error
- type ListIndexesResponse
- func (*ListIndexesResponse) Descriptor() ([]byte, []int)
- func (m *ListIndexesResponse) GetIndexes() []*Index
- func (m *ListIndexesResponse) GetNextPageToken() string
- func (*ListIndexesResponse) ProtoMessage()
- func (m *ListIndexesResponse) Reset()
- func (m *ListIndexesResponse) String() string
- func (m *ListIndexesResponse) XXX_DiscardUnknown()
- func (m *ListIndexesResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ListIndexesResponse) XXX_Merge(src proto.Message)
- func (m *ListIndexesResponse) XXX_Size() int
- func (m *ListIndexesResponse) XXX_Unmarshal(b []byte) error
- type LocationMetadata
- func (*LocationMetadata) Descriptor() ([]byte, []int)
- func (*LocationMetadata) ProtoMessage()
- func (m *LocationMetadata) Reset()
- func (m *LocationMetadata) String() string
- func (m *LocationMetadata) XXX_DiscardUnknown()
- func (m *LocationMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *LocationMetadata) XXX_Merge(src proto.Message)
- func (m *LocationMetadata) XXX_Size() int
- func (m *LocationMetadata) XXX_Unmarshal(b []byte) error
- type OperationState
- type Progress
- func (*Progress) Descriptor() ([]byte, []int)
- func (m *Progress) GetCompletedWork() int64
- func (m *Progress) GetEstimatedWork() int64
- func (*Progress) ProtoMessage()
- func (m *Progress) Reset()
- func (m *Progress) String() string
- func (m *Progress) XXX_DiscardUnknown()
- func (m *Progress) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Progress) XXX_Merge(src proto.Message)
- func (m *Progress) XXX_Size() int
- func (m *Progress) XXX_Unmarshal(b []byte) error
- type UnimplementedFirestoreAdminServer
- func (*UnimplementedFirestoreAdminServer) CreateIndex(ctx context.Context, req *CreateIndexRequest) (*longrunning.Operation, error)
- func (*UnimplementedFirestoreAdminServer) DeleteIndex(ctx context.Context, req *DeleteIndexRequest) (*empty.Empty, error)
- func (*UnimplementedFirestoreAdminServer) ExportDocuments(ctx context.Context, req *ExportDocumentsRequest) (*longrunning.Operation, error)
- func (*UnimplementedFirestoreAdminServer) GetField(ctx context.Context, req *GetFieldRequest) (*Field, error)
- func (*UnimplementedFirestoreAdminServer) GetIndex(ctx context.Context, req *GetIndexRequest) (*Index, error)
- func (*UnimplementedFirestoreAdminServer) ImportDocuments(ctx context.Context, req *ImportDocumentsRequest) (*longrunning.Operation, error)
- func (*UnimplementedFirestoreAdminServer) ListFields(ctx context.Context, req *ListFieldsRequest) (*ListFieldsResponse, error)
- func (*UnimplementedFirestoreAdminServer) ListIndexes(ctx context.Context, req *ListIndexesRequest) (*ListIndexesResponse, error)
- func (*UnimplementedFirestoreAdminServer) UpdateField(ctx context.Context, req *UpdateFieldRequest) (*longrunning.Operation, error)
- type UpdateFieldRequest
- func (*UpdateFieldRequest) Descriptor() ([]byte, []int)
- func (m *UpdateFieldRequest) GetField() *Field
- func (m *UpdateFieldRequest) GetUpdateMask() *field_mask.FieldMask
- func (*UpdateFieldRequest) ProtoMessage()
- func (m *UpdateFieldRequest) Reset()
- func (m *UpdateFieldRequest) String() string
- func (m *UpdateFieldRequest) XXX_DiscardUnknown()
- func (m *UpdateFieldRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *UpdateFieldRequest) XXX_Merge(src proto.Message)
- func (m *UpdateFieldRequest) XXX_Size() int
- func (m *UpdateFieldRequest) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
var FieldOperationMetadata_IndexConfigDelta_ChangeType_name = map[int32]string{
0: "CHANGE_TYPE_UNSPECIFIED",
1: "ADD",
2: "REMOVE",
}
var FieldOperationMetadata_IndexConfigDelta_ChangeType_value = map[string]int32{
"CHANGE_TYPE_UNSPECIFIED": 0,
"ADD": 1,
"REMOVE": 2,
}
var Index_IndexField_ArrayConfig_name = map[int32]string{
0: "ARRAY_CONFIG_UNSPECIFIED",
1: "CONTAINS",
}
var Index_IndexField_ArrayConfig_value = map[string]int32{
"ARRAY_CONFIG_UNSPECIFIED": 0,
"CONTAINS": 1,
}
var Index_IndexField_Order_name = map[int32]string{
0: "ORDER_UNSPECIFIED",
1: "ASCENDING",
2: "DESCENDING",
}
var Index_IndexField_Order_value = map[string]int32{
"ORDER_UNSPECIFIED": 0,
"ASCENDING": 1,
"DESCENDING": 2,
}
var Index_QueryScope_name = map[int32]string{
0: "QUERY_SCOPE_UNSPECIFIED",
1: "COLLECTION",
2: "COLLECTION_GROUP",
}
var Index_QueryScope_value = map[string]int32{
"QUERY_SCOPE_UNSPECIFIED": 0,
"COLLECTION": 1,
"COLLECTION_GROUP": 2,
}
var Index_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "CREATING",
2: "READY",
3: "NEEDS_REPAIR",
}
var Index_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"CREATING": 1,
"READY": 2,
"NEEDS_REPAIR": 3,
}
var OperationState_name = map[int32]string{
0: "OPERATION_STATE_UNSPECIFIED",
1: "INITIALIZING",
2: "PROCESSING",
3: "CANCELLING",
4: "FINALIZING",
5: "SUCCESSFUL",
6: "FAILED",
7: "CANCELLED",
}
var OperationState_value = map[string]int32{
"OPERATION_STATE_UNSPECIFIED": 0,
"INITIALIZING": 1,
"PROCESSING": 2,
"CANCELLING": 3,
"FINALIZING": 4,
"SUCCESSFUL": 5,
"FAILED": 6,
"CANCELLED": 7,
}
Functions ¶
func RegisterFirestoreAdminServer ¶
func RegisterFirestoreAdminServer(s *grpc.Server, srv FirestoreAdminServer)
Types ¶
type CreateIndexRequest ¶
type CreateIndexRequest struct { // Required. A parent name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"` // Required. The composite index to create. Index *Index `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
func (*CreateIndexRequest) Descriptor ¶
func (*CreateIndexRequest) Descriptor() ([]byte, []int)
func (*CreateIndexRequest) GetIndex ¶
func (m *CreateIndexRequest) GetIndex() *Index
func (*CreateIndexRequest) GetParent ¶
func (m *CreateIndexRequest) GetParent() string
func (*CreateIndexRequest) ProtoMessage ¶
func (*CreateIndexRequest) ProtoMessage()
func (*CreateIndexRequest) Reset ¶
func (m *CreateIndexRequest) Reset()
func (*CreateIndexRequest) String ¶
func (m *CreateIndexRequest) String() string
func (*CreateIndexRequest) XXX_DiscardUnknown ¶
func (m *CreateIndexRequest) XXX_DiscardUnknown()
func (*CreateIndexRequest) XXX_Marshal ¶
func (m *CreateIndexRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*CreateIndexRequest) XXX_Merge ¶
func (m *CreateIndexRequest) XXX_Merge(src proto.Message)
func (*CreateIndexRequest) XXX_Size ¶
func (m *CreateIndexRequest) XXX_Size() int
func (*CreateIndexRequest) XXX_Unmarshal ¶
func (m *CreateIndexRequest) XXX_Unmarshal(b []byte) error
type DeleteIndexRequest ¶
type DeleteIndexRequest struct { // Required. A name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex].
func (*DeleteIndexRequest) Descriptor ¶
func (*DeleteIndexRequest) Descriptor() ([]byte, []int)
func (*DeleteIndexRequest) GetName ¶
func (m *DeleteIndexRequest) GetName() string
func (*DeleteIndexRequest) ProtoMessage ¶
func (*DeleteIndexRequest) ProtoMessage()
func (*DeleteIndexRequest) Reset ¶
func (m *DeleteIndexRequest) Reset()
func (*DeleteIndexRequest) String ¶
func (m *DeleteIndexRequest) String() string
func (*DeleteIndexRequest) XXX_DiscardUnknown ¶
func (m *DeleteIndexRequest) XXX_DiscardUnknown()
func (*DeleteIndexRequest) XXX_Marshal ¶
func (m *DeleteIndexRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DeleteIndexRequest) XXX_Merge ¶
func (m *DeleteIndexRequest) XXX_Merge(src proto.Message)
func (*DeleteIndexRequest) XXX_Size ¶
func (m *DeleteIndexRequest) XXX_Size() int
func (*DeleteIndexRequest) XXX_Unmarshal ¶
func (m *DeleteIndexRequest) XXX_Unmarshal(b []byte) error
type ExportDocumentsMetadata ¶
type ExportDocumentsMetadata struct { // The time this operation started. StartTime *timestamp.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` // The time this operation completed. Will be unset if operation still in // progress. EndTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"` // The state of the export operation. OperationState OperationState `` /* 150-byte string literal not displayed */ // The progress, in documents, of this operation. ProgressDocuments *Progress `protobuf:"bytes,4,opt,name=progress_documents,json=progressDocuments,proto3" json:"progress_documents,omitempty"` // The progress, in bytes, of this operation. ProgressBytes *Progress `protobuf:"bytes,5,opt,name=progress_bytes,json=progressBytes,proto3" json:"progress_bytes,omitempty"` // Which collection ids are being exported. CollectionIds []string `protobuf:"bytes,6,rep,name=collection_ids,json=collectionIds,proto3" json:"collection_ids,omitempty"` // Where the entities are being exported to. OutputUriPrefix string `protobuf:"bytes,7,opt,name=output_uri_prefix,json=outputUriPrefix,proto3" json:"output_uri_prefix,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
func (*ExportDocumentsMetadata) Descriptor ¶
func (*ExportDocumentsMetadata) Descriptor() ([]byte, []int)
func (*ExportDocumentsMetadata) GetCollectionIds ¶
func (m *ExportDocumentsMetadata) GetCollectionIds() []string
func (*ExportDocumentsMetadata) GetEndTime ¶
func (m *ExportDocumentsMetadata) GetEndTime() *timestamp.Timestamp
func (*ExportDocumentsMetadata) GetOperationState ¶
func (m *ExportDocumentsMetadata) GetOperationState() OperationState
func (*ExportDocumentsMetadata) GetOutputUriPrefix ¶
func (m *ExportDocumentsMetadata) GetOutputUriPrefix() string
func (*ExportDocumentsMetadata) GetProgressBytes ¶
func (m *ExportDocumentsMetadata) GetProgressBytes() *Progress
func (*ExportDocumentsMetadata) GetProgressDocuments ¶
func (m *ExportDocumentsMetadata) GetProgressDocuments() *Progress
func (*ExportDocumentsMetadata) GetStartTime ¶
func (m *ExportDocumentsMetadata) GetStartTime() *timestamp.Timestamp
func (*ExportDocumentsMetadata) ProtoMessage ¶
func (*ExportDocumentsMetadata) ProtoMessage()
func (*ExportDocumentsMetadata) Reset ¶
func (m *ExportDocumentsMetadata) Reset()
func (*ExportDocumentsMetadata) String ¶
func (m *ExportDocumentsMetadata) String() string
func (*ExportDocumentsMetadata) XXX_DiscardUnknown ¶
func (m *ExportDocumentsMetadata) XXX_DiscardUnknown()
func (*ExportDocumentsMetadata) XXX_Marshal ¶
func (m *ExportDocumentsMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ExportDocumentsMetadata) XXX_Merge ¶
func (m *ExportDocumentsMetadata) XXX_Merge(src proto.Message)
func (*ExportDocumentsMetadata) XXX_Size ¶
func (m *ExportDocumentsMetadata) XXX_Size() int
func (*ExportDocumentsMetadata) XXX_Unmarshal ¶
func (m *ExportDocumentsMetadata) XXX_Unmarshal(b []byte) error
type ExportDocumentsRequest ¶
type ExportDocumentsRequest struct { // Required. Database to export. Should be of the form: // `projects/{project_id}/databases/{database_id}`. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Which collection ids to export. Unspecified means all collections. CollectionIds []string `protobuf:"bytes,2,rep,name=collection_ids,json=collectionIds,proto3" json:"collection_ids,omitempty"` // The output URI. Currently only supports Google Cloud Storage URIs of the // form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name // of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional // Google Cloud Storage namespace path. When // choosing a name, be sure to consider Google Cloud Storage naming // guidelines: https://cloud.google.com/storage/docs/naming. // If the URI is a bucket (without a namespace path), a prefix will be // generated based on the start time. OutputUriPrefix string `protobuf:"bytes,3,opt,name=output_uri_prefix,json=outputUriPrefix,proto3" json:"output_uri_prefix,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
func (*ExportDocumentsRequest) Descriptor ¶
func (*ExportDocumentsRequest) Descriptor() ([]byte, []int)
func (*ExportDocumentsRequest) GetCollectionIds ¶
func (m *ExportDocumentsRequest) GetCollectionIds() []string
func (*ExportDocumentsRequest) GetName ¶
func (m *ExportDocumentsRequest) GetName() string
func (*ExportDocumentsRequest) GetOutputUriPrefix ¶
func (m *ExportDocumentsRequest) GetOutputUriPrefix() string
func (*ExportDocumentsRequest) ProtoMessage ¶
func (*ExportDocumentsRequest) ProtoMessage()
func (*ExportDocumentsRequest) Reset ¶
func (m *ExportDocumentsRequest) Reset()
func (*ExportDocumentsRequest) String ¶
func (m *ExportDocumentsRequest) String() string
func (*ExportDocumentsRequest) XXX_DiscardUnknown ¶
func (m *ExportDocumentsRequest) XXX_DiscardUnknown()
func (*ExportDocumentsRequest) XXX_Marshal ¶
func (m *ExportDocumentsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ExportDocumentsRequest) XXX_Merge ¶
func (m *ExportDocumentsRequest) XXX_Merge(src proto.Message)
func (*ExportDocumentsRequest) XXX_Size ¶
func (m *ExportDocumentsRequest) XXX_Size() int
func (*ExportDocumentsRequest) XXX_Unmarshal ¶
func (m *ExportDocumentsRequest) XXX_Unmarshal(b []byte) error
type ExportDocumentsResponse ¶
type ExportDocumentsResponse struct { // Location of the output files. This can be used to begin an import // into Cloud Firestore (this project or another project) after the operation // completes successfully. OutputUriPrefix string `protobuf:"bytes,1,opt,name=output_uri_prefix,json=outputUriPrefix,proto3" json:"output_uri_prefix,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field.
func (*ExportDocumentsResponse) Descriptor ¶
func (*ExportDocumentsResponse) Descriptor() ([]byte, []int)
func (*ExportDocumentsResponse) GetOutputUriPrefix ¶
func (m *ExportDocumentsResponse) GetOutputUriPrefix() string
func (*ExportDocumentsResponse) ProtoMessage ¶
func (*ExportDocumentsResponse) ProtoMessage()
func (*ExportDocumentsResponse) Reset ¶
func (m *ExportDocumentsResponse) Reset()
func (*ExportDocumentsResponse) String ¶
func (m *ExportDocumentsResponse) String() string
func (*ExportDocumentsResponse) XXX_DiscardUnknown ¶
func (m *ExportDocumentsResponse) XXX_DiscardUnknown()
func (*ExportDocumentsResponse) XXX_Marshal ¶
func (m *ExportDocumentsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ExportDocumentsResponse) XXX_Merge ¶
func (m *ExportDocumentsResponse) XXX_Merge(src proto.Message)
func (*ExportDocumentsResponse) XXX_Size ¶
func (m *ExportDocumentsResponse) XXX_Size() int
func (*ExportDocumentsResponse) XXX_Unmarshal ¶
func (m *ExportDocumentsResponse) XXX_Unmarshal(b []byte) error
type Field ¶
type Field struct { // A field name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` // // A field path may be a simple field name, e.g. `address` or a path to fields // within map_value , e.g. `address.city`, // or a special field path. The only valid special field is `*`, which // represents any field. // // Field paths may be quoted using ` (backtick). The only character that needs // to be escaped within a quoted field path is the backtick character itself, // escaped using a backslash. Special characters in field paths that // must be quoted include: `*`, `.`, // “` (backtick), `[`, `]`, as well as any ascii symbolic characters. // // Examples: // (Note: Comments here are written in markdown syntax, so there is an // additional layer of backticks to represent a code block) // `\`address.city\“ represents a field named `address.city`, not the map key // `city` in the field `address`. // `\`*\“ represents a field named `*`, not any field. // // A special `Field` contains the default indexing settings for all fields. // This field's resource name is: // `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` // Indexes defined on this `Field` will be applied to all fields which do not // have their own `Field` index configuration. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The index configuration for this field. If unset, field indexing will // revert to the configuration defined by the `ancestor_field`. To // explicitly remove all indexes for this field, specify an index config // with an empty list of indexes. IndexConfig *Field_IndexConfig `protobuf:"bytes,2,opt,name=index_config,json=indexConfig,proto3" json:"index_config,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Represents a single field in the database.
Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.
func (*Field) Descriptor ¶
func (*Field) GetIndexConfig ¶
func (m *Field) GetIndexConfig() *Field_IndexConfig
func (*Field) ProtoMessage ¶
func (*Field) ProtoMessage()
func (*Field) XXX_DiscardUnknown ¶
func (m *Field) XXX_DiscardUnknown()
func (*Field) XXX_Marshal ¶
func (*Field) XXX_Unmarshal ¶
type FieldOperationMetadata ¶
type FieldOperationMetadata struct { // The time this operation started. StartTime *timestamp.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` // The time this operation completed. Will be unset if operation still in // progress. EndTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"` // The field resource that this operation is acting on. For example: // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` Field string `protobuf:"bytes,3,opt,name=field,proto3" json:"field,omitempty"` // A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this // operation. IndexConfigDeltas []*FieldOperationMetadata_IndexConfigDelta `protobuf:"bytes,4,rep,name=index_config_deltas,json=indexConfigDeltas,proto3" json:"index_config_deltas,omitempty"` // The state of the operation. State OperationState `protobuf:"varint,5,opt,name=state,proto3,enum=google.firestore.admin.v1.OperationState" json:"state,omitempty"` // The progress, in documents, of this operation. ProgressDocuments *Progress `protobuf:"bytes,6,opt,name=progress_documents,json=progressDocuments,proto3" json:"progress_documents,omitempty"` // The progress, in bytes, of this operation. ProgressBytes *Progress `protobuf:"bytes,7,opt,name=progress_bytes,json=progressBytes,proto3" json:"progress_bytes,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
func (*FieldOperationMetadata) Descriptor ¶
func (*FieldOperationMetadata) Descriptor() ([]byte, []int)
func (*FieldOperationMetadata) GetEndTime ¶
func (m *FieldOperationMetadata) GetEndTime() *timestamp.Timestamp
func (*FieldOperationMetadata) GetField ¶
func (m *FieldOperationMetadata) GetField() string
func (*FieldOperationMetadata) GetIndexConfigDeltas ¶
func (m *FieldOperationMetadata) GetIndexConfigDeltas() []*FieldOperationMetadata_IndexConfigDelta
func (*FieldOperationMetadata) GetProgressBytes ¶
func (m *FieldOperationMetadata) GetProgressBytes() *Progress
func (*FieldOperationMetadata) GetProgressDocuments ¶
func (m *FieldOperationMetadata) GetProgressDocuments() *Progress
func (*FieldOperationMetadata) GetStartTime ¶
func (m *FieldOperationMetadata) GetStartTime() *timestamp.Timestamp
func (*FieldOperationMetadata) GetState ¶
func (m *FieldOperationMetadata) GetState() OperationState
func (*FieldOperationMetadata) ProtoMessage ¶
func (*FieldOperationMetadata) ProtoMessage()
func (*FieldOperationMetadata) Reset ¶
func (m *FieldOperationMetadata) Reset()
func (*FieldOperationMetadata) String ¶
func (m *FieldOperationMetadata) String() string
func (*FieldOperationMetadata) XXX_DiscardUnknown ¶
func (m *FieldOperationMetadata) XXX_DiscardUnknown()
func (*FieldOperationMetadata) XXX_Marshal ¶
func (m *FieldOperationMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*FieldOperationMetadata) XXX_Merge ¶
func (m *FieldOperationMetadata) XXX_Merge(src proto.Message)
func (*FieldOperationMetadata) XXX_Size ¶
func (m *FieldOperationMetadata) XXX_Size() int
func (*FieldOperationMetadata) XXX_Unmarshal ¶
func (m *FieldOperationMetadata) XXX_Unmarshal(b []byte) error
type FieldOperationMetadata_IndexConfigDelta ¶
type FieldOperationMetadata_IndexConfigDelta struct { // Specifies how the index is changing. ChangeType FieldOperationMetadata_IndexConfigDelta_ChangeType `` /* 174-byte string literal not displayed */ // The index being changed. Index *Index `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Information about an index configuration change.
func (*FieldOperationMetadata_IndexConfigDelta) Descriptor ¶
func (*FieldOperationMetadata_IndexConfigDelta) Descriptor() ([]byte, []int)
func (*FieldOperationMetadata_IndexConfigDelta) GetChangeType ¶
func (m *FieldOperationMetadata_IndexConfigDelta) GetChangeType() FieldOperationMetadata_IndexConfigDelta_ChangeType
func (*FieldOperationMetadata_IndexConfigDelta) GetIndex ¶
func (m *FieldOperationMetadata_IndexConfigDelta) GetIndex() *Index
func (*FieldOperationMetadata_IndexConfigDelta) ProtoMessage ¶
func (*FieldOperationMetadata_IndexConfigDelta) ProtoMessage()
func (*FieldOperationMetadata_IndexConfigDelta) Reset ¶
func (m *FieldOperationMetadata_IndexConfigDelta) Reset()
func (*FieldOperationMetadata_IndexConfigDelta) String ¶
func (m *FieldOperationMetadata_IndexConfigDelta) String() string
func (*FieldOperationMetadata_IndexConfigDelta) XXX_DiscardUnknown ¶
func (m *FieldOperationMetadata_IndexConfigDelta) XXX_DiscardUnknown()
func (*FieldOperationMetadata_IndexConfigDelta) XXX_Marshal ¶
func (m *FieldOperationMetadata_IndexConfigDelta) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*FieldOperationMetadata_IndexConfigDelta) XXX_Merge ¶
func (m *FieldOperationMetadata_IndexConfigDelta) XXX_Merge(src proto.Message)
func (*FieldOperationMetadata_IndexConfigDelta) XXX_Size ¶
func (m *FieldOperationMetadata_IndexConfigDelta) XXX_Size() int
func (*FieldOperationMetadata_IndexConfigDelta) XXX_Unmarshal ¶
func (m *FieldOperationMetadata_IndexConfigDelta) XXX_Unmarshal(b []byte) error
type FieldOperationMetadata_IndexConfigDelta_ChangeType ¶
type FieldOperationMetadata_IndexConfigDelta_ChangeType int32
Specifies how the index is changing.
const ( // The type of change is not specified or known. FieldOperationMetadata_IndexConfigDelta_CHANGE_TYPE_UNSPECIFIED FieldOperationMetadata_IndexConfigDelta_ChangeType = 0 // The single field index is being added. FieldOperationMetadata_IndexConfigDelta_ADD FieldOperationMetadata_IndexConfigDelta_ChangeType = 1 // The single field index is being removed. FieldOperationMetadata_IndexConfigDelta_REMOVE FieldOperationMetadata_IndexConfigDelta_ChangeType = 2 )
func (FieldOperationMetadata_IndexConfigDelta_ChangeType) EnumDescriptor ¶
func (FieldOperationMetadata_IndexConfigDelta_ChangeType) EnumDescriptor() ([]byte, []int)
func (FieldOperationMetadata_IndexConfigDelta_ChangeType) String ¶
func (x FieldOperationMetadata_IndexConfigDelta_ChangeType) String() string
type Field_IndexConfig ¶
type Field_IndexConfig struct { // The indexes supported for this field. Indexes []*Index `protobuf:"bytes,1,rep,name=indexes,proto3" json:"indexes,omitempty"` // Output only. When true, the `Field`'s index configuration is set from the // configuration specified by the `ancestor_field`. // When false, the `Field`'s index configuration is defined explicitly. UsesAncestorConfig bool `protobuf:"varint,2,opt,name=uses_ancestor_config,json=usesAncestorConfig,proto3" json:"uses_ancestor_config,omitempty"` // Output only. Specifies the resource name of the `Field` from which this field's // index configuration is set (when `uses_ancestor_config` is true), // or from which it *would* be set if this field had no index configuration // (when `uses_ancestor_config` is false). AncestorField string `protobuf:"bytes,3,opt,name=ancestor_field,json=ancestorField,proto3" json:"ancestor_field,omitempty"` // Output only // When true, the `Field`'s index configuration is in the process of being // reverted. Once complete, the index config will transition to the same // state as the field specified by `ancestor_field`, at which point // `uses_ancestor_config` will be `true` and `reverting` will be `false`. Reverting bool `protobuf:"varint,4,opt,name=reverting,proto3" json:"reverting,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The index configuration for this field.
func (*Field_IndexConfig) Descriptor ¶
func (*Field_IndexConfig) Descriptor() ([]byte, []int)
func (*Field_IndexConfig) GetAncestorField ¶
func (m *Field_IndexConfig) GetAncestorField() string
func (*Field_IndexConfig) GetIndexes ¶
func (m *Field_IndexConfig) GetIndexes() []*Index
func (*Field_IndexConfig) GetReverting ¶
func (m *Field_IndexConfig) GetReverting() bool
func (*Field_IndexConfig) GetUsesAncestorConfig ¶
func (m *Field_IndexConfig) GetUsesAncestorConfig() bool
func (*Field_IndexConfig) ProtoMessage ¶
func (*Field_IndexConfig) ProtoMessage()
func (*Field_IndexConfig) Reset ¶
func (m *Field_IndexConfig) Reset()
func (*Field_IndexConfig) String ¶
func (m *Field_IndexConfig) String() string
func (*Field_IndexConfig) XXX_DiscardUnknown ¶
func (m *Field_IndexConfig) XXX_DiscardUnknown()
func (*Field_IndexConfig) XXX_Marshal ¶
func (m *Field_IndexConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*Field_IndexConfig) XXX_Merge ¶
func (m *Field_IndexConfig) XXX_Merge(src proto.Message)
func (*Field_IndexConfig) XXX_Size ¶
func (m *Field_IndexConfig) XXX_Size() int
func (*Field_IndexConfig) XXX_Unmarshal ¶
func (m *Field_IndexConfig) XXX_Unmarshal(b []byte) error
type FirestoreAdminClient ¶
type FirestoreAdminClient interface { // Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] // which may be used to track the status of the creation. The metadata for // the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata]. CreateIndex(ctx context.Context, in *CreateIndexRequest, opts ...grpc.CallOption) (*longrunning.Operation, error) // Lists composite indexes. ListIndexes(ctx context.Context, in *ListIndexesRequest, opts ...grpc.CallOption) (*ListIndexesResponse, error) // Gets a composite index. GetIndex(ctx context.Context, in *GetIndexRequest, opts ...grpc.CallOption) (*Index, error) // Deletes a composite index. DeleteIndex(ctx context.Context, in *DeleteIndexRequest, opts ...grpc.CallOption) (*empty.Empty, error) // Gets the metadata and configuration for a Field. GetField(ctx context.Context, in *GetFieldRequest, opts ...grpc.CallOption) (*Field, error) // Updates a field configuration. Currently, field updates apply only to // single field index configuration. However, calls to // [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid // changing any configuration that the caller isn't aware of. The field mask // should be specified as: `{ paths: "index_config" }`. // // This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to // track the status of the field update. The metadata for // the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata]. // // To configure the default field settings for the database, use // the special `Field` with resource name: // `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`. UpdateField(ctx context.Context, in *UpdateFieldRequest, opts ...grpc.CallOption) (*longrunning.Operation, error) // Lists the field configuration and metadata for this database. // // Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields // that have been explicitly overridden. To issue this query, call // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to // `indexConfig.usesAncestorConfig:false`. ListFields(ctx context.Context, in *ListFieldsRequest, opts ...grpc.CallOption) (*ListFieldsResponse, error) // Exports a copy of all or a subset of documents from Google Cloud Firestore // to another storage system, such as Google Cloud Storage. Recent updates to // documents may not be reflected in the export. The export occurs in the // background and its progress can be monitored and managed via the // Operation resource that is created. The output of an export may only be // used once the associated operation is done. If an export operation is // cancelled before completion it may leave partial data behind in Google // Cloud Storage. ExportDocuments(ctx context.Context, in *ExportDocumentsRequest, opts ...grpc.CallOption) (*longrunning.Operation, error) // Imports documents into Google Cloud Firestore. Existing documents with the // same name are overwritten. The import occurs in the background and its // progress can be monitored and managed via the Operation resource that is // created. If an ImportDocuments operation is cancelled, it is possible // that a subset of the data has already been imported to Cloud Firestore. ImportDocuments(ctx context.Context, in *ImportDocumentsRequest, opts ...grpc.CallOption) (*longrunning.Operation, error) }
FirestoreAdminClient is the client API for FirestoreAdmin service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewFirestoreAdminClient ¶
func NewFirestoreAdminClient(cc grpc.ClientConnInterface) FirestoreAdminClient
type FirestoreAdminServer ¶
type FirestoreAdminServer interface { // Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] // which may be used to track the status of the creation. The metadata for // the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata]. CreateIndex(context.Context, *CreateIndexRequest) (*longrunning.Operation, error) // Lists composite indexes. ListIndexes(context.Context, *ListIndexesRequest) (*ListIndexesResponse, error) // Gets a composite index. GetIndex(context.Context, *GetIndexRequest) (*Index, error) // Deletes a composite index. DeleteIndex(context.Context, *DeleteIndexRequest) (*empty.Empty, error) // Gets the metadata and configuration for a Field. GetField(context.Context, *GetFieldRequest) (*Field, error) // Updates a field configuration. Currently, field updates apply only to // single field index configuration. However, calls to // [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid // changing any configuration that the caller isn't aware of. The field mask // should be specified as: `{ paths: "index_config" }`. // // This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to // track the status of the field update. The metadata for // the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata]. // // To configure the default field settings for the database, use // the special `Field` with resource name: // `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`. UpdateField(context.Context, *UpdateFieldRequest) (*longrunning.Operation, error) // Lists the field configuration and metadata for this database. // // Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields // that have been explicitly overridden. To issue this query, call // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to // `indexConfig.usesAncestorConfig:false`. ListFields(context.Context, *ListFieldsRequest) (*ListFieldsResponse, error) // Exports a copy of all or a subset of documents from Google Cloud Firestore // to another storage system, such as Google Cloud Storage. Recent updates to // documents may not be reflected in the export. The export occurs in the // background and its progress can be monitored and managed via the // Operation resource that is created. The output of an export may only be // used once the associated operation is done. If an export operation is // cancelled before completion it may leave partial data behind in Google // Cloud Storage. ExportDocuments(context.Context, *ExportDocumentsRequest) (*longrunning.Operation, error) // Imports documents into Google Cloud Firestore. Existing documents with the // same name are overwritten. The import occurs in the background and its // progress can be monitored and managed via the Operation resource that is // created. If an ImportDocuments operation is cancelled, it is possible // that a subset of the data has already been imported to Cloud Firestore. ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunning.Operation, error) }
FirestoreAdminServer is the server API for FirestoreAdmin service.
type GetFieldRequest ¶
type GetFieldRequest struct { // Required. A name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The request for [FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField].
func (*GetFieldRequest) Descriptor ¶
func (*GetFieldRequest) Descriptor() ([]byte, []int)
func (*GetFieldRequest) GetName ¶
func (m *GetFieldRequest) GetName() string
func (*GetFieldRequest) ProtoMessage ¶
func (*GetFieldRequest) ProtoMessage()
func (*GetFieldRequest) Reset ¶
func (m *GetFieldRequest) Reset()
func (*GetFieldRequest) String ¶
func (m *GetFieldRequest) String() string
func (*GetFieldRequest) XXX_DiscardUnknown ¶
func (m *GetFieldRequest) XXX_DiscardUnknown()
func (*GetFieldRequest) XXX_Marshal ¶
func (m *GetFieldRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*GetFieldRequest) XXX_Merge ¶
func (m *GetFieldRequest) XXX_Merge(src proto.Message)
func (*GetFieldRequest) XXX_Size ¶
func (m *GetFieldRequest) XXX_Size() int
func (*GetFieldRequest) XXX_Unmarshal ¶
func (m *GetFieldRequest) XXX_Unmarshal(b []byte) error
type GetIndexRequest ¶
type GetIndexRequest struct { // Required. A name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex].
func (*GetIndexRequest) Descriptor ¶
func (*GetIndexRequest) Descriptor() ([]byte, []int)
func (*GetIndexRequest) GetName ¶
func (m *GetIndexRequest) GetName() string
func (*GetIndexRequest) ProtoMessage ¶
func (*GetIndexRequest) ProtoMessage()
func (*GetIndexRequest) Reset ¶
func (m *GetIndexRequest) Reset()
func (*GetIndexRequest) String ¶
func (m *GetIndexRequest) String() string
func (*GetIndexRequest) XXX_DiscardUnknown ¶
func (m *GetIndexRequest) XXX_DiscardUnknown()
func (*GetIndexRequest) XXX_Marshal ¶
func (m *GetIndexRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*GetIndexRequest) XXX_Merge ¶
func (m *GetIndexRequest) XXX_Merge(src proto.Message)
func (*GetIndexRequest) XXX_Size ¶
func (m *GetIndexRequest) XXX_Size() int
func (*GetIndexRequest) XXX_Unmarshal ¶
func (m *GetIndexRequest) XXX_Unmarshal(b []byte) error
type ImportDocumentsMetadata ¶
type ImportDocumentsMetadata struct { // The time this operation started. StartTime *timestamp.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` // The time this operation completed. Will be unset if operation still in // progress. EndTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"` // The state of the import operation. OperationState OperationState `` /* 150-byte string literal not displayed */ // The progress, in documents, of this operation. ProgressDocuments *Progress `protobuf:"bytes,4,opt,name=progress_documents,json=progressDocuments,proto3" json:"progress_documents,omitempty"` // The progress, in bytes, of this operation. ProgressBytes *Progress `protobuf:"bytes,5,opt,name=progress_bytes,json=progressBytes,proto3" json:"progress_bytes,omitempty"` // Which collection ids are being imported. CollectionIds []string `protobuf:"bytes,6,rep,name=collection_ids,json=collectionIds,proto3" json:"collection_ids,omitempty"` // The location of the documents being imported. InputUriPrefix string `protobuf:"bytes,7,opt,name=input_uri_prefix,json=inputUriPrefix,proto3" json:"input_uri_prefix,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
func (*ImportDocumentsMetadata) Descriptor ¶
func (*ImportDocumentsMetadata) Descriptor() ([]byte, []int)
func (*ImportDocumentsMetadata) GetCollectionIds ¶
func (m *ImportDocumentsMetadata) GetCollectionIds() []string
func (*ImportDocumentsMetadata) GetEndTime ¶
func (m *ImportDocumentsMetadata) GetEndTime() *timestamp.Timestamp
func (*ImportDocumentsMetadata) GetInputUriPrefix ¶
func (m *ImportDocumentsMetadata) GetInputUriPrefix() string
func (*ImportDocumentsMetadata) GetOperationState ¶
func (m *ImportDocumentsMetadata) GetOperationState() OperationState
func (*ImportDocumentsMetadata) GetProgressBytes ¶
func (m *ImportDocumentsMetadata) GetProgressBytes() *Progress
func (*ImportDocumentsMetadata) GetProgressDocuments ¶
func (m *ImportDocumentsMetadata) GetProgressDocuments() *Progress
func (*ImportDocumentsMetadata) GetStartTime ¶
func (m *ImportDocumentsMetadata) GetStartTime() *timestamp.Timestamp
func (*ImportDocumentsMetadata) ProtoMessage ¶
func (*ImportDocumentsMetadata) ProtoMessage()
func (*ImportDocumentsMetadata) Reset ¶
func (m *ImportDocumentsMetadata) Reset()
func (*ImportDocumentsMetadata) String ¶
func (m *ImportDocumentsMetadata) String() string
func (*ImportDocumentsMetadata) XXX_DiscardUnknown ¶
func (m *ImportDocumentsMetadata) XXX_DiscardUnknown()
func (*ImportDocumentsMetadata) XXX_Marshal ¶
func (m *ImportDocumentsMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ImportDocumentsMetadata) XXX_Merge ¶
func (m *ImportDocumentsMetadata) XXX_Merge(src proto.Message)
func (*ImportDocumentsMetadata) XXX_Size ¶
func (m *ImportDocumentsMetadata) XXX_Size() int
func (*ImportDocumentsMetadata) XXX_Unmarshal ¶
func (m *ImportDocumentsMetadata) XXX_Unmarshal(b []byte) error
type ImportDocumentsRequest ¶
type ImportDocumentsRequest struct { // Required. Database to import into. Should be of the form: // `projects/{project_id}/databases/{database_id}`. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Which collection ids to import. Unspecified means all collections included // in the import. CollectionIds []string `protobuf:"bytes,2,rep,name=collection_ids,json=collectionIds,proto3" json:"collection_ids,omitempty"` // Location of the exported files. // This must match the output_uri_prefix of an ExportDocumentsResponse from // an export that has completed successfully. // See: // [google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix][google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix]. InputUriPrefix string `protobuf:"bytes,3,opt,name=input_uri_prefix,json=inputUriPrefix,proto3" json:"input_uri_prefix,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
func (*ImportDocumentsRequest) Descriptor ¶
func (*ImportDocumentsRequest) Descriptor() ([]byte, []int)
func (*ImportDocumentsRequest) GetCollectionIds ¶
func (m *ImportDocumentsRequest) GetCollectionIds() []string
func (*ImportDocumentsRequest) GetInputUriPrefix ¶
func (m *ImportDocumentsRequest) GetInputUriPrefix() string
func (*ImportDocumentsRequest) GetName ¶
func (m *ImportDocumentsRequest) GetName() string
func (*ImportDocumentsRequest) ProtoMessage ¶
func (*ImportDocumentsRequest) ProtoMessage()
func (*ImportDocumentsRequest) Reset ¶
func (m *ImportDocumentsRequest) Reset()
func (*ImportDocumentsRequest) String ¶
func (m *ImportDocumentsRequest) String() string
func (*ImportDocumentsRequest) XXX_DiscardUnknown ¶
func (m *ImportDocumentsRequest) XXX_DiscardUnknown()
func (*ImportDocumentsRequest) XXX_Marshal ¶
func (m *ImportDocumentsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ImportDocumentsRequest) XXX_Merge ¶
func (m *ImportDocumentsRequest) XXX_Merge(src proto.Message)
func (*ImportDocumentsRequest) XXX_Size ¶
func (m *ImportDocumentsRequest) XXX_Size() int
func (*ImportDocumentsRequest) XXX_Unmarshal ¶
func (m *ImportDocumentsRequest) XXX_Unmarshal(b []byte) error
type Index ¶
type Index struct { // 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. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // 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 Index_QueryScope `` /* 140-byte string literal not displayed */ // 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. Fields []*Index_IndexField `protobuf:"bytes,3,rep,name=fields,proto3" json:"fields,omitempty"` // Output only. The serving state of the index. State Index_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.firestore.admin.v1.Index_State" json:"state,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Cloud Firestore indexes enable simple and complex queries against documents in a database.
func (*Index) Descriptor ¶
func (*Index) GetFields ¶
func (m *Index) GetFields() []*Index_IndexField
func (*Index) GetQueryScope ¶
func (m *Index) GetQueryScope() Index_QueryScope
func (*Index) GetState ¶
func (m *Index) GetState() Index_State
func (*Index) ProtoMessage ¶
func (*Index) ProtoMessage()
func (*Index) XXX_DiscardUnknown ¶
func (m *Index) XXX_DiscardUnknown()
func (*Index) XXX_Marshal ¶
func (*Index) XXX_Unmarshal ¶
type IndexOperationMetadata ¶
type IndexOperationMetadata struct { // The time this operation started. StartTime *timestamp.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` // The time this operation completed. Will be unset if operation still in // progress. EndTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"` // The index resource that this operation is acting on. For example: // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` Index string `protobuf:"bytes,3,opt,name=index,proto3" json:"index,omitempty"` // The state of the operation. State OperationState `protobuf:"varint,4,opt,name=state,proto3,enum=google.firestore.admin.v1.OperationState" json:"state,omitempty"` // The progress, in documents, of this operation. ProgressDocuments *Progress `protobuf:"bytes,5,opt,name=progress_documents,json=progressDocuments,proto3" json:"progress_documents,omitempty"` // The progress, in bytes, of this operation. ProgressBytes *Progress `protobuf:"bytes,6,opt,name=progress_bytes,json=progressBytes,proto3" json:"progress_bytes,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
func (*IndexOperationMetadata) Descriptor ¶
func (*IndexOperationMetadata) Descriptor() ([]byte, []int)
func (*IndexOperationMetadata) GetEndTime ¶
func (m *IndexOperationMetadata) GetEndTime() *timestamp.Timestamp
func (*IndexOperationMetadata) GetIndex ¶
func (m *IndexOperationMetadata) GetIndex() string
func (*IndexOperationMetadata) GetProgressBytes ¶
func (m *IndexOperationMetadata) GetProgressBytes() *Progress
func (*IndexOperationMetadata) GetProgressDocuments ¶
func (m *IndexOperationMetadata) GetProgressDocuments() *Progress
func (*IndexOperationMetadata) GetStartTime ¶
func (m *IndexOperationMetadata) GetStartTime() *timestamp.Timestamp
func (*IndexOperationMetadata) GetState ¶
func (m *IndexOperationMetadata) GetState() OperationState
func (*IndexOperationMetadata) ProtoMessage ¶
func (*IndexOperationMetadata) ProtoMessage()
func (*IndexOperationMetadata) Reset ¶
func (m *IndexOperationMetadata) Reset()
func (*IndexOperationMetadata) String ¶
func (m *IndexOperationMetadata) String() string
func (*IndexOperationMetadata) XXX_DiscardUnknown ¶
func (m *IndexOperationMetadata) XXX_DiscardUnknown()
func (*IndexOperationMetadata) XXX_Marshal ¶
func (m *IndexOperationMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*IndexOperationMetadata) XXX_Merge ¶
func (m *IndexOperationMetadata) XXX_Merge(src proto.Message)
func (*IndexOperationMetadata) XXX_Size ¶
func (m *IndexOperationMetadata) XXX_Size() int
func (*IndexOperationMetadata) XXX_Unmarshal ¶
func (m *IndexOperationMetadata) XXX_Unmarshal(b []byte) error
type Index_IndexField ¶
type Index_IndexField struct { // Can be __name__. // For single field indexes, this must match the name of the field or may // be omitted. FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"` // How the field value is indexed. // // Types that are valid to be assigned to ValueMode: // *Index_IndexField_Order_ // *Index_IndexField_ArrayConfig_ ValueMode isIndex_IndexField_ValueMode `protobuf_oneof:"value_mode"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
func (*Index_IndexField) Descriptor ¶
func (*Index_IndexField) Descriptor() ([]byte, []int)
func (*Index_IndexField) GetArrayConfig ¶
func (m *Index_IndexField) GetArrayConfig() Index_IndexField_ArrayConfig
func (*Index_IndexField) GetFieldPath ¶
func (m *Index_IndexField) GetFieldPath() string
func (*Index_IndexField) GetOrder ¶
func (m *Index_IndexField) GetOrder() Index_IndexField_Order
func (*Index_IndexField) GetValueMode ¶
func (m *Index_IndexField) GetValueMode() isIndex_IndexField_ValueMode
func (*Index_IndexField) ProtoMessage ¶
func (*Index_IndexField) ProtoMessage()
func (*Index_IndexField) Reset ¶
func (m *Index_IndexField) Reset()
func (*Index_IndexField) String ¶
func (m *Index_IndexField) String() string
func (*Index_IndexField) XXX_DiscardUnknown ¶
func (m *Index_IndexField) XXX_DiscardUnknown()
func (*Index_IndexField) XXX_Marshal ¶
func (m *Index_IndexField) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*Index_IndexField) XXX_Merge ¶
func (m *Index_IndexField) XXX_Merge(src proto.Message)
func (*Index_IndexField) XXX_OneofWrappers ¶
func (*Index_IndexField) XXX_OneofWrappers() []interface{}
XXX_OneofWrappers is for the internal use of the proto package.
func (*Index_IndexField) XXX_Size ¶
func (m *Index_IndexField) XXX_Size() int
func (*Index_IndexField) XXX_Unmarshal ¶
func (m *Index_IndexField) XXX_Unmarshal(b []byte) error
type Index_IndexField_ArrayConfig ¶
type Index_IndexField_ArrayConfig int32
The supported array value configurations.
const ( // The index does not support additional array queries. Index_IndexField_ARRAY_CONFIG_UNSPECIFIED Index_IndexField_ArrayConfig = 0 // The index supports array containment queries. Index_IndexField_CONTAINS Index_IndexField_ArrayConfig = 1 )
func (Index_IndexField_ArrayConfig) EnumDescriptor ¶
func (Index_IndexField_ArrayConfig) EnumDescriptor() ([]byte, []int)
func (Index_IndexField_ArrayConfig) String ¶
func (x Index_IndexField_ArrayConfig) String() string
type Index_IndexField_ArrayConfig_ ¶
type Index_IndexField_ArrayConfig_ struct {
ArrayConfig Index_IndexField_ArrayConfig `` /* 131-byte string literal not displayed */
}
type Index_IndexField_Order ¶
type Index_IndexField_Order int32
The supported orderings.
const ( // The ordering is unspecified. Not a valid option. Index_IndexField_ORDER_UNSPECIFIED Index_IndexField_Order = 0 // The field is ordered by ascending field value. Index_IndexField_ASCENDING Index_IndexField_Order = 1 // The field is ordered by descending field value. Index_IndexField_DESCENDING Index_IndexField_Order = 2 )
func (Index_IndexField_Order) EnumDescriptor ¶
func (Index_IndexField_Order) EnumDescriptor() ([]byte, []int)
func (Index_IndexField_Order) String ¶
func (x Index_IndexField_Order) String() string
type Index_IndexField_Order_ ¶
type Index_IndexField_Order_ struct {
Order Index_IndexField_Order `protobuf:"varint,2,opt,name=order,proto3,enum=google.firestore.admin.v1.Index_IndexField_Order,oneof"`
}
type Index_QueryScope ¶
type Index_QueryScope int32
Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery's `from` field.
const ( // The query scope is unspecified. Not a valid option. Index_QUERY_SCOPE_UNSPECIFIED Index_QueryScope = 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. Index_COLLECTION Index_QueryScope = 1 // Indexes with a collection group query scope specified allow queries // against all collections that has the collection id specified by the // index. Index_COLLECTION_GROUP Index_QueryScope = 2 )
func (Index_QueryScope) EnumDescriptor ¶
func (Index_QueryScope) EnumDescriptor() ([]byte, []int)
func (Index_QueryScope) String ¶
func (x Index_QueryScope) String() string
type Index_State ¶
type Index_State int32
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.
const ( // The state is unspecified. Index_STATE_UNSPECIFIED Index_State = 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. Index_CREATING Index_State = 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. Index_READY Index_State = 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. Index_NEEDS_REPAIR Index_State = 3 )
func (Index_State) EnumDescriptor ¶
func (Index_State) EnumDescriptor() ([]byte, []int)
func (Index_State) String ¶
func (x Index_State) String() string
type ListFieldsRequest ¶
type ListFieldsRequest struct { // Required. A parent name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"` // The filter to apply to list results. Currently, // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields // that have been explicitly overridden. To issue this query, call // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to // `indexConfig.usesAncestorConfig:false`. Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"` // The number of results to return. PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` // A page token, returned from a previous call to // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next // page of results. PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
func (*ListFieldsRequest) Descriptor ¶
func (*ListFieldsRequest) Descriptor() ([]byte, []int)
func (*ListFieldsRequest) GetFilter ¶
func (m *ListFieldsRequest) GetFilter() string
func (*ListFieldsRequest) GetPageSize ¶
func (m *ListFieldsRequest) GetPageSize() int32
func (*ListFieldsRequest) GetPageToken ¶
func (m *ListFieldsRequest) GetPageToken() string
func (*ListFieldsRequest) GetParent ¶
func (m *ListFieldsRequest) GetParent() string
func (*ListFieldsRequest) ProtoMessage ¶
func (*ListFieldsRequest) ProtoMessage()
func (*ListFieldsRequest) Reset ¶
func (m *ListFieldsRequest) Reset()
func (*ListFieldsRequest) String ¶
func (m *ListFieldsRequest) String() string
func (*ListFieldsRequest) XXX_DiscardUnknown ¶
func (m *ListFieldsRequest) XXX_DiscardUnknown()
func (*ListFieldsRequest) XXX_Marshal ¶
func (m *ListFieldsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ListFieldsRequest) XXX_Merge ¶
func (m *ListFieldsRequest) XXX_Merge(src proto.Message)
func (*ListFieldsRequest) XXX_Size ¶
func (m *ListFieldsRequest) XXX_Size() int
func (*ListFieldsRequest) XXX_Unmarshal ¶
func (m *ListFieldsRequest) XXX_Unmarshal(b []byte) error
type ListFieldsResponse ¶
type ListFieldsResponse struct { // The requested fields. Fields []*Field `protobuf:"bytes,1,rep,name=fields,proto3" json:"fields,omitempty"` // A page token that may be used to request another page of results. If blank, // this is the last page. NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
func (*ListFieldsResponse) Descriptor ¶
func (*ListFieldsResponse) Descriptor() ([]byte, []int)
func (*ListFieldsResponse) GetFields ¶
func (m *ListFieldsResponse) GetFields() []*Field
func (*ListFieldsResponse) GetNextPageToken ¶
func (m *ListFieldsResponse) GetNextPageToken() string
func (*ListFieldsResponse) ProtoMessage ¶
func (*ListFieldsResponse) ProtoMessage()
func (*ListFieldsResponse) Reset ¶
func (m *ListFieldsResponse) Reset()
func (*ListFieldsResponse) String ¶
func (m *ListFieldsResponse) String() string
func (*ListFieldsResponse) XXX_DiscardUnknown ¶
func (m *ListFieldsResponse) XXX_DiscardUnknown()
func (*ListFieldsResponse) XXX_Marshal ¶
func (m *ListFieldsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ListFieldsResponse) XXX_Merge ¶
func (m *ListFieldsResponse) XXX_Merge(src proto.Message)
func (*ListFieldsResponse) XXX_Size ¶
func (m *ListFieldsResponse) XXX_Size() int
func (*ListFieldsResponse) XXX_Unmarshal ¶
func (m *ListFieldsResponse) XXX_Unmarshal(b []byte) error
type ListIndexesRequest ¶
type ListIndexesRequest struct { // Required. A parent name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"` // The filter to apply to list results. Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"` // The number of results to return. PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` // A page token, returned from a previous call to // [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes], that may be used to get the next // page of results. PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
func (*ListIndexesRequest) Descriptor ¶
func (*ListIndexesRequest) Descriptor() ([]byte, []int)
func (*ListIndexesRequest) GetFilter ¶
func (m *ListIndexesRequest) GetFilter() string
func (*ListIndexesRequest) GetPageSize ¶
func (m *ListIndexesRequest) GetPageSize() int32
func (*ListIndexesRequest) GetPageToken ¶
func (m *ListIndexesRequest) GetPageToken() string
func (*ListIndexesRequest) GetParent ¶
func (m *ListIndexesRequest) GetParent() string
func (*ListIndexesRequest) ProtoMessage ¶
func (*ListIndexesRequest) ProtoMessage()
func (*ListIndexesRequest) Reset ¶
func (m *ListIndexesRequest) Reset()
func (*ListIndexesRequest) String ¶
func (m *ListIndexesRequest) String() string
func (*ListIndexesRequest) XXX_DiscardUnknown ¶
func (m *ListIndexesRequest) XXX_DiscardUnknown()
func (*ListIndexesRequest) XXX_Marshal ¶
func (m *ListIndexesRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ListIndexesRequest) XXX_Merge ¶
func (m *ListIndexesRequest) XXX_Merge(src proto.Message)
func (*ListIndexesRequest) XXX_Size ¶
func (m *ListIndexesRequest) XXX_Size() int
func (*ListIndexesRequest) XXX_Unmarshal ¶
func (m *ListIndexesRequest) XXX_Unmarshal(b []byte) error
type ListIndexesResponse ¶
type ListIndexesResponse struct { // The requested indexes. Indexes []*Index `protobuf:"bytes,1,rep,name=indexes,proto3" json:"indexes,omitempty"` // A page token that may be used to request another page of results. If blank, // this is the last page. NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
func (*ListIndexesResponse) Descriptor ¶
func (*ListIndexesResponse) Descriptor() ([]byte, []int)
func (*ListIndexesResponse) GetIndexes ¶
func (m *ListIndexesResponse) GetIndexes() []*Index
func (*ListIndexesResponse) GetNextPageToken ¶
func (m *ListIndexesResponse) GetNextPageToken() string
func (*ListIndexesResponse) ProtoMessage ¶
func (*ListIndexesResponse) ProtoMessage()
func (*ListIndexesResponse) Reset ¶
func (m *ListIndexesResponse) Reset()
func (*ListIndexesResponse) String ¶
func (m *ListIndexesResponse) String() string
func (*ListIndexesResponse) XXX_DiscardUnknown ¶
func (m *ListIndexesResponse) XXX_DiscardUnknown()
func (*ListIndexesResponse) XXX_Marshal ¶
func (m *ListIndexesResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ListIndexesResponse) XXX_Merge ¶
func (m *ListIndexesResponse) XXX_Merge(src proto.Message)
func (*ListIndexesResponse) XXX_Size ¶
func (m *ListIndexesResponse) XXX_Size() int
func (*ListIndexesResponse) XXX_Unmarshal ¶
func (m *ListIndexesResponse) XXX_Unmarshal(b []byte) error
type LocationMetadata ¶
type LocationMetadata struct { XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata].
func (*LocationMetadata) Descriptor ¶
func (*LocationMetadata) Descriptor() ([]byte, []int)
func (*LocationMetadata) ProtoMessage ¶
func (*LocationMetadata) ProtoMessage()
func (*LocationMetadata) Reset ¶
func (m *LocationMetadata) Reset()
func (*LocationMetadata) String ¶
func (m *LocationMetadata) String() string
func (*LocationMetadata) XXX_DiscardUnknown ¶
func (m *LocationMetadata) XXX_DiscardUnknown()
func (*LocationMetadata) XXX_Marshal ¶
func (m *LocationMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*LocationMetadata) XXX_Merge ¶
func (m *LocationMetadata) XXX_Merge(src proto.Message)
func (*LocationMetadata) XXX_Size ¶
func (m *LocationMetadata) XXX_Size() int
func (*LocationMetadata) XXX_Unmarshal ¶
func (m *LocationMetadata) XXX_Unmarshal(b []byte) error
type OperationState ¶
type OperationState int32
Describes the state of the operation.
const ( // Unspecified. OperationState_OPERATION_STATE_UNSPECIFIED OperationState = 0 // Request is being prepared for processing. OperationState_INITIALIZING OperationState = 1 // Request is actively being processed. OperationState_PROCESSING OperationState = 2 // Request is in the process of being cancelled after user called // google.longrunning.Operations.CancelOperation on the operation. OperationState_CANCELLING OperationState = 3 // Request has been processed and is in its finalization stage. OperationState_FINALIZING OperationState = 4 // Request has completed successfully. OperationState_SUCCESSFUL OperationState = 5 // Request has finished being processed, but encountered an error. OperationState_FAILED OperationState = 6 // Request has finished being cancelled after user called // google.longrunning.Operations.CancelOperation. OperationState_CANCELLED OperationState = 7 )
func (OperationState) EnumDescriptor ¶
func (OperationState) EnumDescriptor() ([]byte, []int)
func (OperationState) String ¶
func (x OperationState) String() string
type Progress ¶
type Progress struct { // The amount of work estimated. EstimatedWork int64 `protobuf:"varint,1,opt,name=estimated_work,json=estimatedWork,proto3" json:"estimated_work,omitempty"` // The amount of work completed. CompletedWork int64 `protobuf:"varint,2,opt,name=completed_work,json=completedWork,proto3" json:"completed_work,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress[google.firestore.admin.v1.Progress] is used.
func (*Progress) Descriptor ¶
func (*Progress) GetCompletedWork ¶
func (*Progress) GetEstimatedWork ¶
func (*Progress) ProtoMessage ¶
func (*Progress) ProtoMessage()
func (*Progress) XXX_DiscardUnknown ¶
func (m *Progress) XXX_DiscardUnknown()
func (*Progress) XXX_Marshal ¶
func (*Progress) XXX_Unmarshal ¶
type UnimplementedFirestoreAdminServer ¶
type UnimplementedFirestoreAdminServer struct { }
UnimplementedFirestoreAdminServer can be embedded to have forward compatible implementations.
func (*UnimplementedFirestoreAdminServer) CreateIndex ¶
func (*UnimplementedFirestoreAdminServer) CreateIndex(ctx context.Context, req *CreateIndexRequest) (*longrunning.Operation, error)
func (*UnimplementedFirestoreAdminServer) DeleteIndex ¶
func (*UnimplementedFirestoreAdminServer) DeleteIndex(ctx context.Context, req *DeleteIndexRequest) (*empty.Empty, error)
func (*UnimplementedFirestoreAdminServer) ExportDocuments ¶
func (*UnimplementedFirestoreAdminServer) ExportDocuments(ctx context.Context, req *ExportDocumentsRequest) (*longrunning.Operation, error)
func (*UnimplementedFirestoreAdminServer) GetField ¶
func (*UnimplementedFirestoreAdminServer) GetField(ctx context.Context, req *GetFieldRequest) (*Field, error)
func (*UnimplementedFirestoreAdminServer) GetIndex ¶
func (*UnimplementedFirestoreAdminServer) GetIndex(ctx context.Context, req *GetIndexRequest) (*Index, error)
func (*UnimplementedFirestoreAdminServer) ImportDocuments ¶
func (*UnimplementedFirestoreAdminServer) ImportDocuments(ctx context.Context, req *ImportDocumentsRequest) (*longrunning.Operation, error)
func (*UnimplementedFirestoreAdminServer) ListFields ¶
func (*UnimplementedFirestoreAdminServer) ListFields(ctx context.Context, req *ListFieldsRequest) (*ListFieldsResponse, error)
func (*UnimplementedFirestoreAdminServer) ListIndexes ¶
func (*UnimplementedFirestoreAdminServer) ListIndexes(ctx context.Context, req *ListIndexesRequest) (*ListIndexesResponse, error)
func (*UnimplementedFirestoreAdminServer) UpdateField ¶
func (*UnimplementedFirestoreAdminServer) UpdateField(ctx context.Context, req *UpdateFieldRequest) (*longrunning.Operation, error)
type UpdateFieldRequest ¶
type UpdateFieldRequest struct { // Required. The field to be updated. Field *Field `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"` // A mask, relative to the field. If specified, only configuration specified // by this field_mask will be updated in the field. UpdateMask *field_mask.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
func (*UpdateFieldRequest) Descriptor ¶
func (*UpdateFieldRequest) Descriptor() ([]byte, []int)
func (*UpdateFieldRequest) GetField ¶
func (m *UpdateFieldRequest) GetField() *Field
func (*UpdateFieldRequest) GetUpdateMask ¶
func (m *UpdateFieldRequest) GetUpdateMask() *field_mask.FieldMask
func (*UpdateFieldRequest) ProtoMessage ¶
func (*UpdateFieldRequest) ProtoMessage()
func (*UpdateFieldRequest) Reset ¶
func (m *UpdateFieldRequest) Reset()
func (*UpdateFieldRequest) String ¶
func (m *UpdateFieldRequest) String() string
func (*UpdateFieldRequest) XXX_DiscardUnknown ¶
func (m *UpdateFieldRequest) XXX_DiscardUnknown()
func (*UpdateFieldRequest) XXX_Marshal ¶
func (m *UpdateFieldRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*UpdateFieldRequest) XXX_Merge ¶
func (m *UpdateFieldRequest) XXX_Merge(src proto.Message)
func (*UpdateFieldRequest) XXX_Size ¶
func (m *UpdateFieldRequest) XXX_Size() int
func (*UpdateFieldRequest) XXX_Unmarshal ¶
func (m *UpdateFieldRequest) XXX_Unmarshal(b []byte) error