Enum value maps for OperationState.
var (
OperationState_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "INITIALIZING",
2: "PROCESSING",
3: "CANCELLING",
4: "FINALIZING",
5: "SUCCESSFUL",
6: "FAILED",
7: "CANCELLED",
}
OperationState_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"INITIALIZING": 1,
"PROCESSING": 2,
"CANCELLING": 3,
"FINALIZING": 4,
"SUCCESSFUL": 5,
"FAILED": 6,
"CANCELLED": 7,
}
)
Enum value maps for IndexOperationMetadata_OperationType.
var (
IndexOperationMetadata_OperationType_name = map[int32]string{
0: "OPERATION_TYPE_UNSPECIFIED",
1: "CREATING_INDEX",
}
IndexOperationMetadata_OperationType_value = map[string]int32{
"OPERATION_TYPE_UNSPECIFIED": 0,
"CREATING_INDEX": 1,
}
)
Enum value maps for IndexField_Mode.
var (
IndexField_Mode_name = map[int32]string{
0: "MODE_UNSPECIFIED",
2: "ASCENDING",
3: "DESCENDING",
4: "ARRAY_CONTAINS",
}
IndexField_Mode_value = map[string]int32{
"MODE_UNSPECIFIED": 0,
"ASCENDING": 2,
"DESCENDING": 3,
"ARRAY_CONTAINS": 4,
}
)
Enum value maps for Index_State.
var (
Index_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
3: "CREATING",
2: "READY",
5: "ERROR",
}
Index_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"CREATING": 3,
"READY": 2,
"ERROR": 5,
}
)
var File_google_firestore_admin_v1beta1_firestore_admin_proto protoreflect.FileDescriptor
var File_google_firestore_admin_v1beta1_index_proto protoreflect.FileDescriptor
var File_google_firestore_admin_v1beta1_location_proto protoreflect.FileDescriptor
func RegisterFirestoreAdminServer(s *grpc.Server, srv FirestoreAdminServer)
The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex].
type CreateIndexRequest struct {
// The name of the database this index will apply to. For example:
// `projects/{project_id}/databases/{database_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The index to create. The name and state fields are output only and will be
// ignored. Certain single field indexes cannot be created or deleted.
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.v1beta1.FirestoreAdmin.DeleteIndex].
type DeleteIndexRequest struct {
// The index name. For example:
// `projects/{project_id}/databases/{database_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 ExportDocuments operations.
type ExportDocumentsMetadata struct {
// The time that work began on the operation.
StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// The time the operation ended, either successfully or otherwise. Unset if
// the operation is still active.
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.v1beta1.OperationState" json:"operation_state,omitempty"`
// An estimate of the number of documents processed.
ProgressDocuments *Progress `protobuf:"bytes,4,opt,name=progress_documents,json=progressDocuments,proto3" json:"progress_documents,omitempty"`
// An estimate of the number of bytes processed.
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.v1beta1.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,3,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,4,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
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 the specified index.
// A newly created index's initial state is `CREATING`. On completion of the
// returned [google.longrunning.Operation][google.longrunning.Operation], the state will be `READY`.
// If the index already exists, the call will return an `ALREADY_EXISTS`
// status.
//
// During creation, the process could result in an error, in which case the
// index will move to the `ERROR` state. The process can be recovered by
// fixing the data that caused the error, removing the index with
// [delete][google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex], then re-creating the index with
// [create][google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex].
//
// Indexes with a single field cannot be created.
CreateIndex(ctx context.Context, in *CreateIndexRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Lists the indexes that match the specified filters.
ListIndexes(ctx context.Context, in *ListIndexesRequest, opts ...grpc.CallOption) (*ListIndexesResponse, error)
// Gets an index.
GetIndex(ctx context.Context, in *GetIndexRequest, opts ...grpc.CallOption) (*Index, error)
// Deletes an index.
DeleteIndex(ctx context.Context, in *DeleteIndexRequest, opts ...grpc.CallOption) (*emptypb.Empty, 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 the specified index.
// A newly created index's initial state is `CREATING`. On completion of the
// returned [google.longrunning.Operation][google.longrunning.Operation], the state will be `READY`.
// If the index already exists, the call will return an `ALREADY_EXISTS`
// status.
//
// During creation, the process could result in an error, in which case the
// index will move to the `ERROR` state. The process can be recovered by
// fixing the data that caused the error, removing the index with
// [delete][google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex], then re-creating the index with
// [create][google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex].
//
// Indexes with a single field cannot be created.
CreateIndex(context.Context, *CreateIndexRequest) (*longrunning.Operation, error)
// Lists the indexes that match the specified filters.
ListIndexes(context.Context, *ListIndexesRequest) (*ListIndexesResponse, error)
// Gets an index.
GetIndex(context.Context, *GetIndexRequest) (*Index, error)
// Deletes an index.
DeleteIndex(context.Context, *DeleteIndexRequest) (*emptypb.Empty, 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.GetIndex][google.firestore.admin.v1beta1.FirestoreAdmin.GetIndex].
type GetIndexRequest struct {
// The name of the index. For example:
// `projects/{project_id}/databases/{database_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 ImportDocuments operations.
type ImportDocumentsMetadata struct {
// The time that work began on the operation.
StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// The time the operation ended, either successfully or otherwise. Unset if
// the operation is still active.
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.v1beta1.OperationState" json:"operation_state,omitempty"`
// An estimate of the number of documents processed.
ProgressDocuments *Progress `protobuf:"bytes,4,opt,name=progress_documents,json=progressDocuments,proto3" json:"progress_documents,omitempty"`
// An estimate of the number of bytes processed.
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.v1beta1.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,3,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.v1beta1.ExportDocumentsResponse.output_uri_prefix][google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix].
InputUriPrefix string `protobuf:"bytes,4,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
An index definition.
type Index struct {
// The resource name of the index.
// Output only.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The collection ID to which this index applies. Required.
CollectionId string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
// The fields to index.
Fields []*IndexField `protobuf:"bytes,3,rep,name=fields,proto3" json:"fields,omitempty"`
// The state of the index.
// Output only.
State Index_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.firestore.admin.v1beta1.Index_State" json:"state,omitempty"`
// contains filtered or unexported fields
}
func (*Index) Descriptor() ([]byte, []int)
Deprecated: Use Index.ProtoReflect.Descriptor instead.
func (x *Index) GetCollectionId() string
func (x *Index) GetFields() []*IndexField
func (x *Index) GetName() string
func (x *Index) GetState() Index_State
func (*Index) ProtoMessage()
func (x *Index) ProtoReflect() protoreflect.Message
func (x *Index) Reset()
func (x *Index) String() string
A field of an index.
type IndexField struct {
// The path of the field. Must match the field path specification described
// by [google.firestore.v1beta1.Document.fields][fields].
// Special field path `__name__` may be used by itself or at the end of a
// path. `__type__` may be used only at the end of path.
FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
// The field's mode.
Mode IndexField_Mode `protobuf:"varint,2,opt,name=mode,proto3,enum=google.firestore.admin.v1beta1.IndexField_Mode" json:"mode,omitempty"`
// contains filtered or unexported fields
}
func (*IndexField) Descriptor() ([]byte, []int)
Deprecated: Use IndexField.ProtoReflect.Descriptor instead.
func (x *IndexField) GetFieldPath() string
func (x *IndexField) GetMode() IndexField_Mode
func (*IndexField) ProtoMessage()
func (x *IndexField) ProtoReflect() protoreflect.Message
func (x *IndexField) Reset()
func (x *IndexField) String() string
The mode determines how a field is indexed.
type IndexField_Mode int32
const (
// The mode is unspecified.
IndexField_MODE_UNSPECIFIED IndexField_Mode = 0
// The field's values are indexed so as to support sequencing in
// ascending order and also query by <, >, <=, >=, and =.
IndexField_ASCENDING IndexField_Mode = 2
// The field's values are indexed so as to support sequencing in
// descending order and also query by <, >, <=, >=, and =.
IndexField_DESCENDING IndexField_Mode = 3
// The field's array values are indexed so as to support membership using
// ARRAY_CONTAINS queries.
IndexField_ARRAY_CONTAINS IndexField_Mode = 4
)
func (IndexField_Mode) Descriptor() protoreflect.EnumDescriptor
func (x IndexField_Mode) Enum() *IndexField_Mode
func (IndexField_Mode) EnumDescriptor() ([]byte, []int)
Deprecated: Use IndexField_Mode.Descriptor instead.
func (x IndexField_Mode) Number() protoreflect.EnumNumber
func (x IndexField_Mode) String() string
func (IndexField_Mode) Type() protoreflect.EnumType
Metadata for index operations. This metadata populates the metadata field of [google.longrunning.Operation][google.longrunning.Operation].
type IndexOperationMetadata struct {
// The time that work began on the operation.
StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// The time the operation ended, either successfully or otherwise. Unset if
// the operation is still active.
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}/indexes/{index_id}`
Index string `protobuf:"bytes,3,opt,name=index,proto3" json:"index,omitempty"`
// The type of index operation.
OperationType IndexOperationMetadata_OperationType `protobuf:"varint,4,opt,name=operation_type,json=operationType,proto3,enum=google.firestore.admin.v1beta1.IndexOperationMetadata_OperationType" json:"operation_type,omitempty"`
// True if the [google.longrunning.Operation] was cancelled. If the
// cancellation is in progress, cancelled will be true but
// [google.longrunning.Operation.done][google.longrunning.Operation.done] will be false.
Cancelled bool `protobuf:"varint,5,opt,name=cancelled,proto3" json:"cancelled,omitempty"`
// Progress of the existing operation, measured in number of documents.
DocumentProgress *Progress `protobuf:"bytes,6,opt,name=document_progress,json=documentProgress,proto3" json:"document_progress,omitempty"`
// contains filtered or unexported fields
}
func (*IndexOperationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use IndexOperationMetadata.ProtoReflect.Descriptor instead.
func (x *IndexOperationMetadata) GetCancelled() bool
func (x *IndexOperationMetadata) GetDocumentProgress() *Progress
func (x *IndexOperationMetadata) GetEndTime() *timestamppb.Timestamp
func (x *IndexOperationMetadata) GetIndex() string
func (x *IndexOperationMetadata) GetOperationType() IndexOperationMetadata_OperationType
func (x *IndexOperationMetadata) GetStartTime() *timestamppb.Timestamp
func (*IndexOperationMetadata) ProtoMessage()
func (x *IndexOperationMetadata) ProtoReflect() protoreflect.Message
func (x *IndexOperationMetadata) Reset()
func (x *IndexOperationMetadata) String() string
The type of index operation.
type IndexOperationMetadata_OperationType int32
const (
// Unspecified. Never set by server.
IndexOperationMetadata_OPERATION_TYPE_UNSPECIFIED IndexOperationMetadata_OperationType = 0
// The operation is creating the index. Initiated by a `CreateIndex` call.
IndexOperationMetadata_CREATING_INDEX IndexOperationMetadata_OperationType = 1
)
func (IndexOperationMetadata_OperationType) Descriptor() protoreflect.EnumDescriptor
func (x IndexOperationMetadata_OperationType) Enum() *IndexOperationMetadata_OperationType
func (IndexOperationMetadata_OperationType) EnumDescriptor() ([]byte, []int)
Deprecated: Use IndexOperationMetadata_OperationType.Descriptor instead.
func (x IndexOperationMetadata_OperationType) Number() protoreflect.EnumNumber
func (x IndexOperationMetadata_OperationType) String() string
func (IndexOperationMetadata_OperationType) 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 is not able to be created, it will transition to the `ERROR` 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 = 3
// 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.
Index_ERROR Index_State = 5
)
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.ListIndexes][google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes].
type ListIndexesRequest struct {
// The database name. For example:
// `projects/{project_id}/databases/{database_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// The standard List page size.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The standard List page token.
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.v1beta1.FirestoreAdmin.ListIndexes].
type ListIndexesResponse struct {
// The indexes.
Indexes []*Index `protobuf:"bytes,1,rep,name=indexes,proto3" json:"indexes,omitempty"`
// The standard List next-page token.
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
The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata].
type LocationMetadata struct {
// contains filtered or unexported fields
}
func (*LocationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use LocationMetadata.ProtoReflect.Descriptor instead.
func (*LocationMetadata) ProtoMessage()
func (x *LocationMetadata) ProtoReflect() protoreflect.Message
func (x *LocationMetadata) Reset()
func (x *LocationMetadata) String() string
The various possible states for an ongoing Operation.
type OperationState int32
const (
// Unspecified.
OperationState_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
Measures the progress of a particular metric.
type Progress struct {
// An estimate of how much work has been completed. Note that this may be
// greater than `work_estimated`.
WorkCompleted int64 `protobuf:"varint,1,opt,name=work_completed,json=workCompleted,proto3" json:"work_completed,omitempty"`
// An estimate of how much work needs to be performed. Zero if the
// work estimate is unavailable. May change as work progresses.
WorkEstimated int64 `protobuf:"varint,2,opt,name=work_estimated,json=workEstimated,proto3" json:"work_estimated,omitempty"`
// contains filtered or unexported fields
}
func (*Progress) Descriptor() ([]byte, []int)
Deprecated: Use Progress.ProtoReflect.Descriptor instead.
func (x *Progress) GetWorkCompleted() int64
func (x *Progress) GetWorkEstimated() 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) GetIndex(context.Context, *GetIndexRequest) (*Index, error)
func (*UnimplementedFirestoreAdminServer) ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunning.Operation, error)
func (*UnimplementedFirestoreAdminServer) ListIndexes(context.Context, *ListIndexesRequest) (*ListIndexesResponse, error)