Enum value maps for Index_QueryScope.
var (
Index_QueryScope_name = map[int32]string{
0: "QUERY_SCOPE_UNSPECIFIED",
1: "COLLECTION",
2: "COLLECTION_GROUP",
}
Index_QueryScope_value = map[string]int32{
"QUERY_SCOPE_UNSPECIFIED": 0,
"COLLECTION": 1,
"COLLECTION_GROUP": 2,
}
)
Enum value maps for Index_State.
var (
Index_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "CREATING",
2: "READY",
3: "NEEDS_REPAIR",
}
Index_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"CREATING": 1,
"READY": 2,
"NEEDS_REPAIR": 3,
}
)
Enum value maps for Index_IndexField_Order.
var (
Index_IndexField_Order_name = map[int32]string{
0: "ORDER_UNSPECIFIED",
1: "ASCENDING",
2: "DESCENDING",
}
Index_IndexField_Order_value = map[string]int32{
"ORDER_UNSPECIFIED": 0,
"ASCENDING": 1,
"DESCENDING": 2,
}
)
Enum value maps for Index_IndexField_ArrayConfig.
var (
Index_IndexField_ArrayConfig_name = map[int32]string{
0: "ARRAY_CONFIG_UNSPECIFIED",
1: "CONTAINS",
}
Index_IndexField_ArrayConfig_value = map[string]int32{
"ARRAY_CONFIG_UNSPECIFIED": 0,
"CONTAINS": 1,
}
)
Enum value maps for OperationState.
var (
OperationState_name = map[int32]string{
0: "OPERATION_STATE_UNSPECIFIED",
1: "INITIALIZING",
2: "PROCESSING",
3: "CANCELLING",
4: "FINALIZING",
5: "SUCCESSFUL",
6: "FAILED",
7: "CANCELLED",
}
OperationState_value = map[string]int32{
"OPERATION_STATE_UNSPECIFIED": 0,
"INITIALIZING": 1,
"PROCESSING": 2,
"CANCELLING": 3,
"FINALIZING": 4,
"SUCCESSFUL": 5,
"FAILED": 6,
"CANCELLED": 7,
}
)
Enum value maps for FieldOperationMetadata_IndexConfigDelta_ChangeType.
var (
FieldOperationMetadata_IndexConfigDelta_ChangeType_name = map[int32]string{
0: "CHANGE_TYPE_UNSPECIFIED",
1: "ADD",
2: "REMOVE",
}
FieldOperationMetadata_IndexConfigDelta_ChangeType_value = map[string]int32{
"CHANGE_TYPE_UNSPECIFIED": 0,
"ADD": 1,
"REMOVE": 2,
}
)
var File_google_firestore_admin_v1beta2_field_proto protoreflect.FileDescriptor
var File_google_firestore_admin_v1beta2_firestore_admin_proto protoreflect.FileDescriptor
var File_google_firestore_admin_v1beta2_index_proto protoreflect.FileDescriptor
var File_google_firestore_admin_v1beta2_operation_proto protoreflect.FileDescriptor
func RegisterFirestoreAdminServer(s *grpc.Server, srv FirestoreAdminServer)
The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex].
type CreateIndexRequest struct {
// 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 composite index to create.
Index *Index `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
// contains filtered or unexported fields
}
func (*CreateIndexRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateIndexRequest.ProtoReflect.Descriptor instead.
func (x *CreateIndexRequest) GetIndex() *Index
func (x *CreateIndexRequest) GetParent() string
func (*CreateIndexRequest) ProtoMessage()
func (x *CreateIndexRequest) ProtoReflect() protoreflect.Message
func (x *CreateIndexRequest) Reset()
func (x *CreateIndexRequest) String() string
The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex].
type DeleteIndexRequest struct {
// 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"`
// contains filtered or unexported fields
}
func (*DeleteIndexRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteIndexRequest.ProtoReflect.Descriptor instead.
func (x *DeleteIndexRequest) GetName() string
func (*DeleteIndexRequest) ProtoMessage()
func (x *DeleteIndexRequest) ProtoReflect() protoreflect.Message
func (x *DeleteIndexRequest) Reset()
func (x *DeleteIndexRequest) String() string
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments].
type ExportDocumentsMetadata struct {
// The time this operation started.
StartTime *timestamppb.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 *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// The state of the export operation.
OperationState OperationState `protobuf:"varint,3,opt,name=operation_state,json=operationState,proto3,enum=google.firestore.admin.v1beta2.OperationState" json:"operation_state,omitempty"`
// 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"`
// contains filtered or unexported fields
}
func (*ExportDocumentsMetadata) Descriptor() ([]byte, []int)
Deprecated: Use ExportDocumentsMetadata.ProtoReflect.Descriptor instead.
func (x *ExportDocumentsMetadata) GetCollectionIds() []string
func (x *ExportDocumentsMetadata) GetEndTime() *timestamppb.Timestamp
func (x *ExportDocumentsMetadata) GetOperationState() OperationState
func (x *ExportDocumentsMetadata) GetOutputUriPrefix() string
func (x *ExportDocumentsMetadata) GetProgressBytes() *Progress
func (x *ExportDocumentsMetadata) GetProgressDocuments() *Progress
func (x *ExportDocumentsMetadata) GetStartTime() *timestamppb.Timestamp
func (*ExportDocumentsMetadata) ProtoMessage()
func (x *ExportDocumentsMetadata) ProtoReflect() protoreflect.Message
func (x *ExportDocumentsMetadata) Reset()
func (x *ExportDocumentsMetadata) String() string
The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments].
type ExportDocumentsRequest struct {
// 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"`
// contains filtered or unexported fields
}
func (*ExportDocumentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ExportDocumentsRequest.ProtoReflect.Descriptor instead.
func (x *ExportDocumentsRequest) GetCollectionIds() []string
func (x *ExportDocumentsRequest) GetName() string
func (x *ExportDocumentsRequest) GetOutputUriPrefix() string
func (*ExportDocumentsRequest) ProtoMessage()
func (x *ExportDocumentsRequest) ProtoReflect() protoreflect.Message
func (x *ExportDocumentsRequest) Reset()
func (x *ExportDocumentsRequest) String() string
Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field.
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"`
// contains filtered or unexported fields
}
func (*ExportDocumentsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ExportDocumentsResponse.ProtoReflect.Descriptor instead.
func (x *ExportDocumentsResponse) GetOutputUriPrefix() string
func (*ExportDocumentsResponse) ProtoMessage()
func (x *ExportDocumentsResponse) ProtoReflect() protoreflect.Message
func (x *ExportDocumentsResponse) Reset()
func (x *ExportDocumentsResponse) String() string
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.
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"`
// contains filtered or unexported fields
}
func (*Field) Descriptor() ([]byte, []int)
Deprecated: Use Field.ProtoReflect.Descriptor instead.
func (x *Field) GetIndexConfig() *Field_IndexConfig
func (x *Field) GetName() string
func (*Field) ProtoMessage()
func (x *Field) ProtoReflect() protoreflect.Message
func (x *Field) Reset()
func (x *Field) String() string
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField].
type FieldOperationMetadata struct {
// The time this operation started.
StartTime *timestamppb.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 *timestamppb.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.v1beta2.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.v1beta2.OperationState" json:"state,omitempty"`
// The progress, in documents, of this operation.
DocumentProgress *Progress `protobuf:"bytes,6,opt,name=document_progress,json=documentProgress,proto3" json:"document_progress,omitempty"`
// The progress, in bytes, of this operation.
BytesProgress *Progress `protobuf:"bytes,7,opt,name=bytes_progress,json=bytesProgress,proto3" json:"bytes_progress,omitempty"`
// contains filtered or unexported fields
}
func (*FieldOperationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use FieldOperationMetadata.ProtoReflect.Descriptor instead.
func (x *FieldOperationMetadata) GetBytesProgress() *Progress
func (x *FieldOperationMetadata) GetDocumentProgress() *Progress
func (x *FieldOperationMetadata) GetEndTime() *timestamppb.Timestamp
func (x *FieldOperationMetadata) GetField() string
func (x *FieldOperationMetadata) GetIndexConfigDeltas() []*FieldOperationMetadata_IndexConfigDelta
func (x *FieldOperationMetadata) GetStartTime() *timestamppb.Timestamp
func (x *FieldOperationMetadata) GetState() OperationState
func (*FieldOperationMetadata) ProtoMessage()
func (x *FieldOperationMetadata) ProtoReflect() protoreflect.Message
func (x *FieldOperationMetadata) Reset()
func (x *FieldOperationMetadata) String() string
Information about an index configuration change.
type FieldOperationMetadata_IndexConfigDelta struct {
// Specifies how the index is changing.
ChangeType FieldOperationMetadata_IndexConfigDelta_ChangeType `protobuf:"varint,1,opt,name=change_type,json=changeType,proto3,enum=google.firestore.admin.v1beta2.FieldOperationMetadata_IndexConfigDelta_ChangeType" json:"change_type,omitempty"`
// The index being changed.
Index *Index `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
// contains filtered or unexported fields
}
func (*FieldOperationMetadata_IndexConfigDelta) Descriptor() ([]byte, []int)
Deprecated: Use FieldOperationMetadata_IndexConfigDelta.ProtoReflect.Descriptor instead.
func (x *FieldOperationMetadata_IndexConfigDelta) GetChangeType() FieldOperationMetadata_IndexConfigDelta_ChangeType
func (x *FieldOperationMetadata_IndexConfigDelta) GetIndex() *Index
func (*FieldOperationMetadata_IndexConfigDelta) ProtoMessage()
func (x *FieldOperationMetadata_IndexConfigDelta) ProtoReflect() protoreflect.Message
func (x *FieldOperationMetadata_IndexConfigDelta) Reset()
func (x *FieldOperationMetadata_IndexConfigDelta) String() string
Specifies how the index is changing.
type FieldOperationMetadata_IndexConfigDelta_ChangeType int32
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) Descriptor() protoreflect.EnumDescriptor
func (x FieldOperationMetadata_IndexConfigDelta_ChangeType) Enum() *FieldOperationMetadata_IndexConfigDelta_ChangeType
func (FieldOperationMetadata_IndexConfigDelta_ChangeType) EnumDescriptor() ([]byte, []int)
Deprecated: Use FieldOperationMetadata_IndexConfigDelta_ChangeType.Descriptor instead.
func (x FieldOperationMetadata_IndexConfigDelta_ChangeType) Number() protoreflect.EnumNumber
func (x FieldOperationMetadata_IndexConfigDelta_ChangeType) String() string
func (FieldOperationMetadata_IndexConfigDelta_ChangeType) Type() protoreflect.EnumType
The index configuration for this field.
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"`
// contains filtered or unexported fields
}
func (*Field_IndexConfig) Descriptor() ([]byte, []int)
Deprecated: Use Field_IndexConfig.ProtoReflect.Descriptor instead.
func (x *Field_IndexConfig) GetAncestorField() string
func (x *Field_IndexConfig) GetIndexes() []*Index
func (x *Field_IndexConfig) GetReverting() bool
func (x *Field_IndexConfig) GetUsesAncestorConfig() bool
func (*Field_IndexConfig) ProtoMessage()
func (x *Field_IndexConfig) ProtoReflect() protoreflect.Message
func (x *Field_IndexConfig) Reset()
func (x *Field_IndexConfig) String() string
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.
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.v1beta2.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) (*emptypb.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.v1beta2.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.v1beta2.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.v1beta2.FirestoreAdmin.ListFields] only supports listing fields
// that have been explicitly overridden. To issue this query, call
// [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.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)
}
func NewFirestoreAdminClient(cc grpc.ClientConnInterface) FirestoreAdminClient
FirestoreAdminServer is the server API for FirestoreAdmin service.
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.v1beta2.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) (*emptypb.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.v1beta2.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.v1beta2.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.v1beta2.FirestoreAdmin.ListFields] only supports listing fields
// that have been explicitly overridden. To issue this query, call
// [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.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)
}
The request for [FirestoreAdmin.GetField][google.firestore.admin.v1beta2.FirestoreAdmin.GetField].
type GetFieldRequest struct {
// 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"`
// contains filtered or unexported fields
}
func (*GetFieldRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetFieldRequest.ProtoReflect.Descriptor instead.
func (x *GetFieldRequest) GetName() string
func (*GetFieldRequest) ProtoMessage()
func (x *GetFieldRequest) ProtoReflect() protoreflect.Message
func (x *GetFieldRequest) Reset()
func (x *GetFieldRequest) String() string
The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex].
type GetIndexRequest struct {
// 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"`
// contains filtered or unexported fields
}
func (*GetIndexRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetIndexRequest.ProtoReflect.Descriptor instead.
func (x *GetIndexRequest) GetName() string
func (*GetIndexRequest) ProtoMessage()
func (x *GetIndexRequest) ProtoReflect() protoreflect.Message
func (x *GetIndexRequest) Reset()
func (x *GetIndexRequest) String() string
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments].
type ImportDocumentsMetadata struct {
// The time this operation started.
StartTime *timestamppb.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 *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// The state of the import operation.
OperationState OperationState `protobuf:"varint,3,opt,name=operation_state,json=operationState,proto3,enum=google.firestore.admin.v1beta2.OperationState" json:"operation_state,omitempty"`
// 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"`
// contains filtered or unexported fields
}
func (*ImportDocumentsMetadata) Descriptor() ([]byte, []int)
Deprecated: Use ImportDocumentsMetadata.ProtoReflect.Descriptor instead.
func (x *ImportDocumentsMetadata) GetCollectionIds() []string
func (x *ImportDocumentsMetadata) GetEndTime() *timestamppb.Timestamp
func (x *ImportDocumentsMetadata) GetInputUriPrefix() string
func (x *ImportDocumentsMetadata) GetOperationState() OperationState
func (x *ImportDocumentsMetadata) GetProgressBytes() *Progress
func (x *ImportDocumentsMetadata) GetProgressDocuments() *Progress
func (x *ImportDocumentsMetadata) GetStartTime() *timestamppb.Timestamp
func (*ImportDocumentsMetadata) ProtoMessage()
func (x *ImportDocumentsMetadata) ProtoReflect() protoreflect.Message
func (x *ImportDocumentsMetadata) Reset()
func (x *ImportDocumentsMetadata) String() string
The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments].
type ImportDocumentsRequest struct {
// 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.v1beta2.ExportDocumentsResponse.output_uri_prefix][google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix].
InputUriPrefix string `protobuf:"bytes,3,opt,name=input_uri_prefix,json=inputUriPrefix,proto3" json:"input_uri_prefix,omitempty"`
// contains filtered or unexported fields
}
func (*ImportDocumentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ImportDocumentsRequest.ProtoReflect.Descriptor instead.
func (x *ImportDocumentsRequest) GetCollectionIds() []string
func (x *ImportDocumentsRequest) GetInputUriPrefix() string
func (x *ImportDocumentsRequest) GetName() string
func (*ImportDocumentsRequest) ProtoMessage()
func (x *ImportDocumentsRequest) ProtoReflect() protoreflect.Message
func (x *ImportDocumentsRequest) Reset()
func (x *ImportDocumentsRequest) String() string
Cloud Firestore indexes enable simple and complex queries against documents in a database.
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 `protobuf:"varint,2,opt,name=query_scope,json=queryScope,proto3,enum=google.firestore.admin.v1beta2.Index_QueryScope" json:"query_scope,omitempty"`
// 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.v1beta2.Index_State" json:"state,omitempty"`
// contains filtered or unexported fields
}
func (*Index) Descriptor() ([]byte, []int)
Deprecated: Use Index.ProtoReflect.Descriptor instead.
func (x *Index) GetFields() []*Index_IndexField
func (x *Index) GetName() string
func (x *Index) GetQueryScope() Index_QueryScope
func (x *Index) GetState() Index_State
func (*Index) ProtoMessage()
func (x *Index) ProtoReflect() protoreflect.Message
func (x *Index) Reset()
func (x *Index) String() string
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex].
type IndexOperationMetadata struct {
// The time this operation started.
StartTime *timestamppb.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 *timestamppb.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.v1beta2.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"`
// contains filtered or unexported fields
}
func (*IndexOperationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use IndexOperationMetadata.ProtoReflect.Descriptor instead.
func (x *IndexOperationMetadata) GetEndTime() *timestamppb.Timestamp
func (x *IndexOperationMetadata) GetIndex() string
func (x *IndexOperationMetadata) GetProgressBytes() *Progress
func (x *IndexOperationMetadata) GetProgressDocuments() *Progress
func (x *IndexOperationMetadata) GetStartTime() *timestamppb.Timestamp
func (x *IndexOperationMetadata) GetState() OperationState
func (*IndexOperationMetadata) ProtoMessage()
func (x *IndexOperationMetadata) ProtoReflect() protoreflect.Message
func (x *IndexOperationMetadata) Reset()
func (x *IndexOperationMetadata) String() string
A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
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 assignable to ValueMode:
// *Index_IndexField_Order_
// *Index_IndexField_ArrayConfig_
ValueMode isIndex_IndexField_ValueMode `protobuf_oneof:"value_mode"`
// contains filtered or unexported fields
}
func (*Index_IndexField) Descriptor() ([]byte, []int)
Deprecated: Use Index_IndexField.ProtoReflect.Descriptor instead.
func (x *Index_IndexField) GetArrayConfig() Index_IndexField_ArrayConfig
func (x *Index_IndexField) GetFieldPath() string
func (x *Index_IndexField) GetOrder() Index_IndexField_Order
func (m *Index_IndexField) GetValueMode() isIndex_IndexField_ValueMode
func (*Index_IndexField) ProtoMessage()
func (x *Index_IndexField) ProtoReflect() protoreflect.Message
func (x *Index_IndexField) Reset()
func (x *Index_IndexField) String() string
The supported array value configurations.
type Index_IndexField_ArrayConfig int32
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) Descriptor() protoreflect.EnumDescriptor
func (x Index_IndexField_ArrayConfig) Enum() *Index_IndexField_ArrayConfig
func (Index_IndexField_ArrayConfig) EnumDescriptor() ([]byte, []int)
Deprecated: Use Index_IndexField_ArrayConfig.Descriptor instead.
func (x Index_IndexField_ArrayConfig) Number() protoreflect.EnumNumber
func (x Index_IndexField_ArrayConfig) String() string
func (Index_IndexField_ArrayConfig) Type() protoreflect.EnumType
type Index_IndexField_ArrayConfig_ struct {
// Indicates that this field supports operations on `array_value`s.
ArrayConfig Index_IndexField_ArrayConfig `protobuf:"varint,3,opt,name=array_config,json=arrayConfig,proto3,enum=google.firestore.admin.v1beta2.Index_IndexField_ArrayConfig,oneof"`
}
The supported orderings.
type Index_IndexField_Order int32
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) Descriptor() protoreflect.EnumDescriptor
func (x Index_IndexField_Order) Enum() *Index_IndexField_Order
func (Index_IndexField_Order) EnumDescriptor() ([]byte, []int)
Deprecated: Use Index_IndexField_Order.Descriptor instead.
func (x Index_IndexField_Order) Number() protoreflect.EnumNumber
func (x Index_IndexField_Order) String() string
func (Index_IndexField_Order) Type() protoreflect.EnumType
type Index_IndexField_Order_ struct {
// Indicates that this field supports ordering by the specified order or
// comparing using =, <, <=, >, >=.
Order Index_IndexField_Order `protobuf:"varint,2,opt,name=order,proto3,enum=google.firestore.admin.v1beta2.Index_IndexField_Order,oneof"`
}
Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery's `from` field.
type Index_QueryScope int32
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) Descriptor() protoreflect.EnumDescriptor
func (x Index_QueryScope) Enum() *Index_QueryScope
func (Index_QueryScope) EnumDescriptor() ([]byte, []int)
Deprecated: Use Index_QueryScope.Descriptor instead.
func (x Index_QueryScope) Number() protoreflect.EnumNumber
func (x Index_QueryScope) String() string
func (Index_QueryScope) Type() protoreflect.EnumType
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.
type Index_State int32
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) Descriptor() protoreflect.EnumDescriptor
func (x Index_State) Enum() *Index_State
func (Index_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Index_State.Descriptor instead.
func (x Index_State) Number() protoreflect.EnumNumber
func (x Index_State) String() string
func (Index_State) Type() protoreflect.EnumType
The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields].
type ListFieldsRequest struct {
// 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.v1beta2.FirestoreAdmin.ListFields] only supports listing fields
// that have been explicitly overridden. To issue this query, call
// [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.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.v1beta2.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"`
// contains filtered or unexported fields
}
func (*ListFieldsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListFieldsRequest.ProtoReflect.Descriptor instead.
func (x *ListFieldsRequest) GetFilter() string
func (x *ListFieldsRequest) GetPageSize() int32
func (x *ListFieldsRequest) GetPageToken() string
func (x *ListFieldsRequest) GetParent() string
func (*ListFieldsRequest) ProtoMessage()
func (x *ListFieldsRequest) ProtoReflect() protoreflect.Message
func (x *ListFieldsRequest) Reset()
func (x *ListFieldsRequest) String() string
The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields].
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"`
// contains filtered or unexported fields
}
func (*ListFieldsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListFieldsResponse.ProtoReflect.Descriptor instead.
func (x *ListFieldsResponse) GetFields() []*Field
func (x *ListFieldsResponse) GetNextPageToken() string
func (*ListFieldsResponse) ProtoMessage()
func (x *ListFieldsResponse) ProtoReflect() protoreflect.Message
func (x *ListFieldsResponse) Reset()
func (x *ListFieldsResponse) String() string
The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes].
type ListIndexesRequest struct {
// 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.v1beta2.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"`
// contains filtered or unexported fields
}
func (*ListIndexesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListIndexesRequest.ProtoReflect.Descriptor instead.
func (x *ListIndexesRequest) GetFilter() string
func (x *ListIndexesRequest) GetPageSize() int32
func (x *ListIndexesRequest) GetPageToken() string
func (x *ListIndexesRequest) GetParent() string
func (*ListIndexesRequest) ProtoMessage()
func (x *ListIndexesRequest) ProtoReflect() protoreflect.Message
func (x *ListIndexesRequest) Reset()
func (x *ListIndexesRequest) String() string
The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes].
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"`
// contains filtered or unexported fields
}
func (*ListIndexesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListIndexesResponse.ProtoReflect.Descriptor instead.
func (x *ListIndexesResponse) GetIndexes() []*Index
func (x *ListIndexesResponse) GetNextPageToken() string
func (*ListIndexesResponse) ProtoMessage()
func (x *ListIndexesResponse) ProtoReflect() protoreflect.Message
func (x *ListIndexesResponse) Reset()
func (x *ListIndexesResponse) String() string
Describes the state of the operation.
type OperationState int32
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) Descriptor() protoreflect.EnumDescriptor
func (x OperationState) Enum() *OperationState
func (OperationState) EnumDescriptor() ([]byte, []int)
Deprecated: Use OperationState.Descriptor instead.
func (x OperationState) Number() protoreflect.EnumNumber
func (x OperationState) String() string
func (OperationState) Type() protoreflect.EnumType
Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress[google.firestore.admin.v1beta2.Progress] is used.
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"`
// contains filtered or unexported fields
}
func (*Progress) Descriptor() ([]byte, []int)
Deprecated: Use Progress.ProtoReflect.Descriptor instead.
func (x *Progress) GetCompletedWork() int64
func (x *Progress) GetEstimatedWork() int64
func (*Progress) ProtoMessage()
func (x *Progress) ProtoReflect() protoreflect.Message
func (x *Progress) Reset()
func (x *Progress) String() string
UnimplementedFirestoreAdminServer can be embedded to have forward compatible implementations.
type UnimplementedFirestoreAdminServer struct {
}
func (*UnimplementedFirestoreAdminServer) CreateIndex(context.Context, *CreateIndexRequest) (*longrunning.Operation, error)
func (*UnimplementedFirestoreAdminServer) DeleteIndex(context.Context, *DeleteIndexRequest) (*emptypb.Empty, error)
func (*UnimplementedFirestoreAdminServer) ExportDocuments(context.Context, *ExportDocumentsRequest) (*longrunning.Operation, error)
func (*UnimplementedFirestoreAdminServer) GetField(context.Context, *GetFieldRequest) (*Field, error)
func (*UnimplementedFirestoreAdminServer) GetIndex(context.Context, *GetIndexRequest) (*Index, error)
func (*UnimplementedFirestoreAdminServer) ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunning.Operation, error)
func (*UnimplementedFirestoreAdminServer) ListFields(context.Context, *ListFieldsRequest) (*ListFieldsResponse, error)
func (*UnimplementedFirestoreAdminServer) ListIndexes(context.Context, *ListIndexesRequest) (*ListIndexesResponse, error)
func (*UnimplementedFirestoreAdminServer) UpdateField(context.Context, *UpdateFieldRequest) (*longrunning.Operation, error)
The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField].
type UpdateFieldRequest struct {
// 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 *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateFieldRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateFieldRequest.ProtoReflect.Descriptor instead.
func (x *UpdateFieldRequest) GetField() *Field
func (x *UpdateFieldRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateFieldRequest) ProtoMessage()
func (x *UpdateFieldRequest) ProtoReflect() protoreflect.Message
func (x *UpdateFieldRequest) Reset()
func (x *UpdateFieldRequest) String() string