genproto: google.golang.org/genproto/googleapis/firestore/admin/v1beta2 Index | Files

package admin

import "google.golang.org/genproto/googleapis/firestore/admin/v1beta2"

Index

Package Files

field.pb.go firestore_admin.pb.go index.pb.go operation.pb.go

Variables

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_QueryScope.

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_State.

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_Order.

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 Index_IndexField_ArrayConfig.

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 OperationState.

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,
    }
)

Enum value maps for FieldOperationMetadata_IndexConfigDelta_ChangeType.

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 Uses

func RegisterFirestoreAdminServer(s *grpc.Server, srv FirestoreAdminServer)

type CreateIndexRequest Uses

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
}

The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex].

func (*CreateIndexRequest) Descriptor Uses

func (*CreateIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateIndexRequest.ProtoReflect.Descriptor instead.

func (*CreateIndexRequest) GetIndex Uses

func (x *CreateIndexRequest) GetIndex() *Index

func (*CreateIndexRequest) GetParent Uses

func (x *CreateIndexRequest) GetParent() string

func (*CreateIndexRequest) ProtoMessage Uses

func (*CreateIndexRequest) ProtoMessage()

func (*CreateIndexRequest) ProtoReflect Uses

func (x *CreateIndexRequest) ProtoReflect() protoreflect.Message

func (*CreateIndexRequest) Reset Uses

func (x *CreateIndexRequest) Reset()

func (*CreateIndexRequest) String Uses

func (x *CreateIndexRequest) String() string

type DeleteIndexRequest Uses

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
}

The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex].

func (*DeleteIndexRequest) Descriptor Uses

func (*DeleteIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteIndexRequest.ProtoReflect.Descriptor instead.

func (*DeleteIndexRequest) GetName Uses

func (x *DeleteIndexRequest) GetName() string

func (*DeleteIndexRequest) ProtoMessage Uses

func (*DeleteIndexRequest) ProtoMessage()

func (*DeleteIndexRequest) ProtoReflect Uses

func (x *DeleteIndexRequest) ProtoReflect() protoreflect.Message

func (*DeleteIndexRequest) Reset Uses

func (x *DeleteIndexRequest) Reset()

func (*DeleteIndexRequest) String Uses

func (x *DeleteIndexRequest) String() string

type ExportDocumentsMetadata Uses

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 `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
}

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments].

func (*ExportDocumentsMetadata) Descriptor Uses

func (*ExportDocumentsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ExportDocumentsMetadata.ProtoReflect.Descriptor instead.

func (*ExportDocumentsMetadata) GetCollectionIds Uses

func (x *ExportDocumentsMetadata) GetCollectionIds() []string

func (*ExportDocumentsMetadata) GetEndTime Uses

func (x *ExportDocumentsMetadata) GetEndTime() *timestamp.Timestamp

func (*ExportDocumentsMetadata) GetOperationState Uses

func (x *ExportDocumentsMetadata) GetOperationState() OperationState

func (*ExportDocumentsMetadata) GetOutputUriPrefix Uses

func (x *ExportDocumentsMetadata) GetOutputUriPrefix() string

func (*ExportDocumentsMetadata) GetProgressBytes Uses

func (x *ExportDocumentsMetadata) GetProgressBytes() *Progress

func (*ExportDocumentsMetadata) GetProgressDocuments Uses

func (x *ExportDocumentsMetadata) GetProgressDocuments() *Progress

func (*ExportDocumentsMetadata) GetStartTime Uses

func (x *ExportDocumentsMetadata) GetStartTime() *timestamp.Timestamp

func (*ExportDocumentsMetadata) ProtoMessage Uses

func (*ExportDocumentsMetadata) ProtoMessage()

func (*ExportDocumentsMetadata) ProtoReflect Uses

func (x *ExportDocumentsMetadata) ProtoReflect() protoreflect.Message

func (*ExportDocumentsMetadata) Reset Uses

func (x *ExportDocumentsMetadata) Reset()

func (*ExportDocumentsMetadata) String Uses

func (x *ExportDocumentsMetadata) String() string

type ExportDocumentsRequest Uses

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
}

The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments].

func (*ExportDocumentsRequest) Descriptor Uses

func (*ExportDocumentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExportDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ExportDocumentsRequest) GetCollectionIds Uses

func (x *ExportDocumentsRequest) GetCollectionIds() []string

func (*ExportDocumentsRequest) GetName Uses

func (x *ExportDocumentsRequest) GetName() string

func (*ExportDocumentsRequest) GetOutputUriPrefix Uses

func (x *ExportDocumentsRequest) GetOutputUriPrefix() string

func (*ExportDocumentsRequest) ProtoMessage Uses

func (*ExportDocumentsRequest) ProtoMessage()

func (*ExportDocumentsRequest) ProtoReflect Uses

func (x *ExportDocumentsRequest) ProtoReflect() protoreflect.Message

func (*ExportDocumentsRequest) Reset Uses

func (x *ExportDocumentsRequest) Reset()

func (*ExportDocumentsRequest) String Uses

func (x *ExportDocumentsRequest) String() string

type ExportDocumentsResponse Uses

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
}

Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field.

func (*ExportDocumentsResponse) Descriptor Uses

func (*ExportDocumentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportDocumentsResponse.ProtoReflect.Descriptor instead.

func (*ExportDocumentsResponse) GetOutputUriPrefix Uses

func (x *ExportDocumentsResponse) GetOutputUriPrefix() string

func (*ExportDocumentsResponse) ProtoMessage Uses

func (*ExportDocumentsResponse) ProtoMessage()

func (*ExportDocumentsResponse) ProtoReflect Uses

func (x *ExportDocumentsResponse) ProtoReflect() protoreflect.Message

func (*ExportDocumentsResponse) Reset Uses

func (x *ExportDocumentsResponse) Reset()

func (*ExportDocumentsResponse) String Uses

func (x *ExportDocumentsResponse) String() string

type Field Uses

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
}

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 Uses

func (*Field) Descriptor() ([]byte, []int)

Deprecated: Use Field.ProtoReflect.Descriptor instead.

func (*Field) GetIndexConfig Uses

func (x *Field) GetIndexConfig() *Field_IndexConfig

func (*Field) GetName Uses

func (x *Field) GetName() string

func (*Field) ProtoMessage Uses

func (*Field) ProtoMessage()

func (*Field) ProtoReflect Uses

func (x *Field) ProtoReflect() protoreflect.Message

func (*Field) Reset Uses

func (x *Field) Reset()

func (*Field) String Uses

func (x *Field) String() string

type FieldOperationMetadata Uses

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.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
}

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField].

func (*FieldOperationMetadata) Descriptor Uses

func (*FieldOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use FieldOperationMetadata.ProtoReflect.Descriptor instead.

func (*FieldOperationMetadata) GetBytesProgress Uses

func (x *FieldOperationMetadata) GetBytesProgress() *Progress

func (*FieldOperationMetadata) GetDocumentProgress Uses

func (x *FieldOperationMetadata) GetDocumentProgress() *Progress

func (*FieldOperationMetadata) GetEndTime Uses

func (x *FieldOperationMetadata) GetEndTime() *timestamp.Timestamp

func (*FieldOperationMetadata) GetField Uses

func (x *FieldOperationMetadata) GetField() string

func (*FieldOperationMetadata) GetIndexConfigDeltas Uses

func (x *FieldOperationMetadata) GetIndexConfigDeltas() []*FieldOperationMetadata_IndexConfigDelta

func (*FieldOperationMetadata) GetStartTime Uses

func (x *FieldOperationMetadata) GetStartTime() *timestamp.Timestamp

func (*FieldOperationMetadata) GetState Uses

func (x *FieldOperationMetadata) GetState() OperationState

func (*FieldOperationMetadata) ProtoMessage Uses

func (*FieldOperationMetadata) ProtoMessage()

func (*FieldOperationMetadata) ProtoReflect Uses

func (x *FieldOperationMetadata) ProtoReflect() protoreflect.Message

func (*FieldOperationMetadata) Reset Uses

func (x *FieldOperationMetadata) Reset()

func (*FieldOperationMetadata) String Uses

func (x *FieldOperationMetadata) String() string

type FieldOperationMetadata_IndexConfigDelta Uses

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
}

Information about an index configuration change.

func (*FieldOperationMetadata_IndexConfigDelta) Descriptor Uses

func (*FieldOperationMetadata_IndexConfigDelta) Descriptor() ([]byte, []int)

Deprecated: Use FieldOperationMetadata_IndexConfigDelta.ProtoReflect.Descriptor instead.

func (*FieldOperationMetadata_IndexConfigDelta) GetChangeType Uses

func (x *FieldOperationMetadata_IndexConfigDelta) GetChangeType() FieldOperationMetadata_IndexConfigDelta_ChangeType

func (*FieldOperationMetadata_IndexConfigDelta) GetIndex Uses

func (x *FieldOperationMetadata_IndexConfigDelta) GetIndex() *Index

func (*FieldOperationMetadata_IndexConfigDelta) ProtoMessage Uses

func (*FieldOperationMetadata_IndexConfigDelta) ProtoMessage()

func (*FieldOperationMetadata_IndexConfigDelta) ProtoReflect Uses

func (x *FieldOperationMetadata_IndexConfigDelta) ProtoReflect() protoreflect.Message

func (*FieldOperationMetadata_IndexConfigDelta) Reset Uses

func (x *FieldOperationMetadata_IndexConfigDelta) Reset()

func (*FieldOperationMetadata_IndexConfigDelta) String Uses

func (x *FieldOperationMetadata_IndexConfigDelta) String() string

type FieldOperationMetadata_IndexConfigDelta_ChangeType Uses

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) Descriptor Uses

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) Descriptor() protoreflect.EnumDescriptor

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) Enum Uses

func (x FieldOperationMetadata_IndexConfigDelta_ChangeType) Enum() *FieldOperationMetadata_IndexConfigDelta_ChangeType

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) EnumDescriptor Uses

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldOperationMetadata_IndexConfigDelta_ChangeType.Descriptor instead.

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) Number Uses

func (x FieldOperationMetadata_IndexConfigDelta_ChangeType) Number() protoreflect.EnumNumber

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) String Uses

func (x FieldOperationMetadata_IndexConfigDelta_ChangeType) String() string

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) Type Uses

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) Type() protoreflect.EnumType

type Field_IndexConfig Uses

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
}

The index configuration for this field.

func (*Field_IndexConfig) Descriptor Uses

func (*Field_IndexConfig) Descriptor() ([]byte, []int)

Deprecated: Use Field_IndexConfig.ProtoReflect.Descriptor instead.

func (*Field_IndexConfig) GetAncestorField Uses

func (x *Field_IndexConfig) GetAncestorField() string

func (*Field_IndexConfig) GetIndexes Uses

func (x *Field_IndexConfig) GetIndexes() []*Index

func (*Field_IndexConfig) GetReverting Uses

func (x *Field_IndexConfig) GetReverting() bool

func (*Field_IndexConfig) GetUsesAncestorConfig Uses

func (x *Field_IndexConfig) GetUsesAncestorConfig() bool

func (*Field_IndexConfig) ProtoMessage Uses

func (*Field_IndexConfig) ProtoMessage()

func (*Field_IndexConfig) ProtoReflect Uses

func (x *Field_IndexConfig) ProtoReflect() protoreflect.Message

func (*Field_IndexConfig) Reset Uses

func (x *Field_IndexConfig) Reset()

func (*Field_IndexConfig) String Uses

func (x *Field_IndexConfig) String() string

type FirestoreAdminClient Uses

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) (*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.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)
}

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 Uses

func NewFirestoreAdminClient(cc grpc.ClientConnInterface) FirestoreAdminClient

type FirestoreAdminServer Uses

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) (*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.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)
}

FirestoreAdminServer is the server API for FirestoreAdmin service.

type GetFieldRequest Uses

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
}

The request for [FirestoreAdmin.GetField][google.firestore.admin.v1beta2.FirestoreAdmin.GetField].

func (*GetFieldRequest) Descriptor Uses

func (*GetFieldRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetFieldRequest.ProtoReflect.Descriptor instead.

func (*GetFieldRequest) GetName Uses

func (x *GetFieldRequest) GetName() string

func (*GetFieldRequest) ProtoMessage Uses

func (*GetFieldRequest) ProtoMessage()

func (*GetFieldRequest) ProtoReflect Uses

func (x *GetFieldRequest) ProtoReflect() protoreflect.Message

func (*GetFieldRequest) Reset Uses

func (x *GetFieldRequest) Reset()

func (*GetFieldRequest) String Uses

func (x *GetFieldRequest) String() string

type GetIndexRequest Uses

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
}

The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex].

func (*GetIndexRequest) Descriptor Uses

func (*GetIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetIndexRequest.ProtoReflect.Descriptor instead.

func (*GetIndexRequest) GetName Uses

func (x *GetIndexRequest) GetName() string

func (*GetIndexRequest) ProtoMessage Uses

func (*GetIndexRequest) ProtoMessage()

func (*GetIndexRequest) ProtoReflect Uses

func (x *GetIndexRequest) ProtoReflect() protoreflect.Message

func (*GetIndexRequest) Reset Uses

func (x *GetIndexRequest) Reset()

func (*GetIndexRequest) String Uses

func (x *GetIndexRequest) String() string

type ImportDocumentsMetadata Uses

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 `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
}

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments].

func (*ImportDocumentsMetadata) Descriptor Uses

func (*ImportDocumentsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportDocumentsMetadata.ProtoReflect.Descriptor instead.

func (*ImportDocumentsMetadata) GetCollectionIds Uses

func (x *ImportDocumentsMetadata) GetCollectionIds() []string

func (*ImportDocumentsMetadata) GetEndTime Uses

func (x *ImportDocumentsMetadata) GetEndTime() *timestamp.Timestamp

func (*ImportDocumentsMetadata) GetInputUriPrefix Uses

func (x *ImportDocumentsMetadata) GetInputUriPrefix() string

func (*ImportDocumentsMetadata) GetOperationState Uses

func (x *ImportDocumentsMetadata) GetOperationState() OperationState

func (*ImportDocumentsMetadata) GetProgressBytes Uses

func (x *ImportDocumentsMetadata) GetProgressBytes() *Progress

func (*ImportDocumentsMetadata) GetProgressDocuments Uses

func (x *ImportDocumentsMetadata) GetProgressDocuments() *Progress

func (*ImportDocumentsMetadata) GetStartTime Uses

func (x *ImportDocumentsMetadata) GetStartTime() *timestamp.Timestamp

func (*ImportDocumentsMetadata) ProtoMessage Uses

func (*ImportDocumentsMetadata) ProtoMessage()

func (*ImportDocumentsMetadata) ProtoReflect Uses

func (x *ImportDocumentsMetadata) ProtoReflect() protoreflect.Message

func (*ImportDocumentsMetadata) Reset Uses

func (x *ImportDocumentsMetadata) Reset()

func (*ImportDocumentsMetadata) String Uses

func (x *ImportDocumentsMetadata) String() string

type ImportDocumentsRequest Uses

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
}

The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments].

func (*ImportDocumentsRequest) Descriptor Uses

func (*ImportDocumentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ImportDocumentsRequest) GetCollectionIds Uses

func (x *ImportDocumentsRequest) GetCollectionIds() []string

func (*ImportDocumentsRequest) GetInputUriPrefix Uses

func (x *ImportDocumentsRequest) GetInputUriPrefix() string

func (*ImportDocumentsRequest) GetName Uses

func (x *ImportDocumentsRequest) GetName() string

func (*ImportDocumentsRequest) ProtoMessage Uses

func (*ImportDocumentsRequest) ProtoMessage()

func (*ImportDocumentsRequest) ProtoReflect Uses

func (x *ImportDocumentsRequest) ProtoReflect() protoreflect.Message

func (*ImportDocumentsRequest) Reset Uses

func (x *ImportDocumentsRequest) Reset()

func (*ImportDocumentsRequest) String Uses

func (x *ImportDocumentsRequest) String() string

type Index Uses

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
}

Cloud Firestore indexes enable simple and complex queries against documents in a database.

func (*Index) Descriptor Uses

func (*Index) Descriptor() ([]byte, []int)

Deprecated: Use Index.ProtoReflect.Descriptor instead.

func (*Index) GetFields Uses

func (x *Index) GetFields() []*Index_IndexField

func (*Index) GetName Uses

func (x *Index) GetName() string

func (*Index) GetQueryScope Uses

func (x *Index) GetQueryScope() Index_QueryScope

func (*Index) GetState Uses

func (x *Index) GetState() Index_State

func (*Index) ProtoMessage Uses

func (*Index) ProtoMessage()

func (*Index) ProtoReflect Uses

func (x *Index) ProtoReflect() protoreflect.Message

func (*Index) Reset Uses

func (x *Index) Reset()

func (*Index) String Uses

func (x *Index) String() string

type IndexOperationMetadata Uses

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.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
}

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex].

func (*IndexOperationMetadata) Descriptor Uses

func (*IndexOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use IndexOperationMetadata.ProtoReflect.Descriptor instead.

func (*IndexOperationMetadata) GetEndTime Uses

func (x *IndexOperationMetadata) GetEndTime() *timestamp.Timestamp

func (*IndexOperationMetadata) GetIndex Uses

func (x *IndexOperationMetadata) GetIndex() string

func (*IndexOperationMetadata) GetProgressBytes Uses

func (x *IndexOperationMetadata) GetProgressBytes() *Progress

func (*IndexOperationMetadata) GetProgressDocuments Uses

func (x *IndexOperationMetadata) GetProgressDocuments() *Progress

func (*IndexOperationMetadata) GetStartTime Uses

func (x *IndexOperationMetadata) GetStartTime() *timestamp.Timestamp

func (*IndexOperationMetadata) GetState Uses

func (x *IndexOperationMetadata) GetState() OperationState

func (*IndexOperationMetadata) ProtoMessage Uses

func (*IndexOperationMetadata) ProtoMessage()

func (*IndexOperationMetadata) ProtoReflect Uses

func (x *IndexOperationMetadata) ProtoReflect() protoreflect.Message

func (*IndexOperationMetadata) Reset Uses

func (x *IndexOperationMetadata) Reset()

func (*IndexOperationMetadata) String Uses

func (x *IndexOperationMetadata) String() string

type Index_IndexField Uses

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
}

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 Uses

func (*Index_IndexField) Descriptor() ([]byte, []int)

Deprecated: Use Index_IndexField.ProtoReflect.Descriptor instead.

func (*Index_IndexField) GetArrayConfig Uses

func (x *Index_IndexField) GetArrayConfig() Index_IndexField_ArrayConfig

func (*Index_IndexField) GetFieldPath Uses

func (x *Index_IndexField) GetFieldPath() string

func (*Index_IndexField) GetOrder Uses

func (x *Index_IndexField) GetOrder() Index_IndexField_Order

func (*Index_IndexField) GetValueMode Uses

func (m *Index_IndexField) GetValueMode() isIndex_IndexField_ValueMode

func (*Index_IndexField) ProtoMessage Uses

func (*Index_IndexField) ProtoMessage()

func (*Index_IndexField) ProtoReflect Uses

func (x *Index_IndexField) ProtoReflect() protoreflect.Message

func (*Index_IndexField) Reset Uses

func (x *Index_IndexField) Reset()

func (*Index_IndexField) String Uses

func (x *Index_IndexField) String() string

type Index_IndexField_ArrayConfig Uses

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) Descriptor Uses

func (Index_IndexField_ArrayConfig) Descriptor() protoreflect.EnumDescriptor

func (Index_IndexField_ArrayConfig) Enum Uses

func (x Index_IndexField_ArrayConfig) Enum() *Index_IndexField_ArrayConfig

func (Index_IndexField_ArrayConfig) EnumDescriptor Uses

func (Index_IndexField_ArrayConfig) EnumDescriptor() ([]byte, []int)

Deprecated: Use Index_IndexField_ArrayConfig.Descriptor instead.

func (Index_IndexField_ArrayConfig) Number Uses

func (x Index_IndexField_ArrayConfig) Number() protoreflect.EnumNumber

func (Index_IndexField_ArrayConfig) String Uses

func (x Index_IndexField_ArrayConfig) String() string

func (Index_IndexField_ArrayConfig) Type Uses

func (Index_IndexField_ArrayConfig) Type() protoreflect.EnumType

type Index_IndexField_ArrayConfig_ Uses

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"`
}

type Index_IndexField_Order Uses

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) Descriptor Uses

func (Index_IndexField_Order) Descriptor() protoreflect.EnumDescriptor

func (Index_IndexField_Order) Enum Uses

func (x Index_IndexField_Order) Enum() *Index_IndexField_Order

func (Index_IndexField_Order) EnumDescriptor Uses

func (Index_IndexField_Order) EnumDescriptor() ([]byte, []int)

Deprecated: Use Index_IndexField_Order.Descriptor instead.

func (Index_IndexField_Order) Number Uses

func (x Index_IndexField_Order) Number() protoreflect.EnumNumber

func (Index_IndexField_Order) String Uses

func (x Index_IndexField_Order) String() string

func (Index_IndexField_Order) Type Uses

func (Index_IndexField_Order) Type() protoreflect.EnumType

type Index_IndexField_Order_ Uses

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"`
}

type Index_QueryScope Uses

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) Descriptor Uses

func (Index_QueryScope) Descriptor() protoreflect.EnumDescriptor

func (Index_QueryScope) Enum Uses

func (x Index_QueryScope) Enum() *Index_QueryScope

func (Index_QueryScope) EnumDescriptor Uses

func (Index_QueryScope) EnumDescriptor() ([]byte, []int)

Deprecated: Use Index_QueryScope.Descriptor instead.

func (Index_QueryScope) Number Uses

func (x Index_QueryScope) Number() protoreflect.EnumNumber

func (Index_QueryScope) String Uses

func (x Index_QueryScope) String() string

func (Index_QueryScope) Type Uses

func (Index_QueryScope) Type() protoreflect.EnumType

type Index_State Uses

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) Descriptor Uses

func (Index_State) Descriptor() protoreflect.EnumDescriptor

func (Index_State) Enum Uses

func (x Index_State) Enum() *Index_State

func (Index_State) EnumDescriptor Uses

func (Index_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Index_State.Descriptor instead.

func (Index_State) Number Uses

func (x Index_State) Number() protoreflect.EnumNumber

func (Index_State) String Uses

func (x Index_State) String() string

func (Index_State) Type Uses

func (Index_State) Type() protoreflect.EnumType

type ListFieldsRequest Uses

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
}

The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields].

func (*ListFieldsRequest) Descriptor Uses

func (*ListFieldsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListFieldsRequest.ProtoReflect.Descriptor instead.

func (*ListFieldsRequest) GetFilter Uses

func (x *ListFieldsRequest) GetFilter() string

func (*ListFieldsRequest) GetPageSize Uses

func (x *ListFieldsRequest) GetPageSize() int32

func (*ListFieldsRequest) GetPageToken Uses

func (x *ListFieldsRequest) GetPageToken() string

func (*ListFieldsRequest) GetParent Uses

func (x *ListFieldsRequest) GetParent() string

func (*ListFieldsRequest) ProtoMessage Uses

func (*ListFieldsRequest) ProtoMessage()

func (*ListFieldsRequest) ProtoReflect Uses

func (x *ListFieldsRequest) ProtoReflect() protoreflect.Message

func (*ListFieldsRequest) Reset Uses

func (x *ListFieldsRequest) Reset()

func (*ListFieldsRequest) String Uses

func (x *ListFieldsRequest) String() string

type ListFieldsResponse Uses

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
}

The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields].

func (*ListFieldsResponse) Descriptor Uses

func (*ListFieldsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListFieldsResponse.ProtoReflect.Descriptor instead.

func (*ListFieldsResponse) GetFields Uses

func (x *ListFieldsResponse) GetFields() []*Field

func (*ListFieldsResponse) GetNextPageToken Uses

func (x *ListFieldsResponse) GetNextPageToken() string

func (*ListFieldsResponse) ProtoMessage Uses

func (*ListFieldsResponse) ProtoMessage()

func (*ListFieldsResponse) ProtoReflect Uses

func (x *ListFieldsResponse) ProtoReflect() protoreflect.Message

func (*ListFieldsResponse) Reset Uses

func (x *ListFieldsResponse) Reset()

func (*ListFieldsResponse) String Uses

func (x *ListFieldsResponse) String() string

type ListIndexesRequest Uses

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
}

The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes].

func (*ListIndexesRequest) Descriptor Uses

func (*ListIndexesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListIndexesRequest.ProtoReflect.Descriptor instead.

func (*ListIndexesRequest) GetFilter Uses

func (x *ListIndexesRequest) GetFilter() string

func (*ListIndexesRequest) GetPageSize Uses

func (x *ListIndexesRequest) GetPageSize() int32

func (*ListIndexesRequest) GetPageToken Uses

func (x *ListIndexesRequest) GetPageToken() string

func (*ListIndexesRequest) GetParent Uses

func (x *ListIndexesRequest) GetParent() string

func (*ListIndexesRequest) ProtoMessage Uses

func (*ListIndexesRequest) ProtoMessage()

func (*ListIndexesRequest) ProtoReflect Uses

func (x *ListIndexesRequest) ProtoReflect() protoreflect.Message

func (*ListIndexesRequest) Reset Uses

func (x *ListIndexesRequest) Reset()

func (*ListIndexesRequest) String Uses

func (x *ListIndexesRequest) String() string

type ListIndexesResponse Uses

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
}

The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes].

func (*ListIndexesResponse) Descriptor Uses

func (*ListIndexesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListIndexesResponse.ProtoReflect.Descriptor instead.

func (*ListIndexesResponse) GetIndexes Uses

func (x *ListIndexesResponse) GetIndexes() []*Index

func (*ListIndexesResponse) GetNextPageToken Uses

func (x *ListIndexesResponse) GetNextPageToken() string

func (*ListIndexesResponse) ProtoMessage Uses

func (*ListIndexesResponse) ProtoMessage()

func (*ListIndexesResponse) ProtoReflect Uses

func (x *ListIndexesResponse) ProtoReflect() protoreflect.Message

func (*ListIndexesResponse) Reset Uses

func (x *ListIndexesResponse) Reset()

func (*ListIndexesResponse) String Uses

func (x *ListIndexesResponse) String() string

type OperationState Uses

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) Descriptor Uses

func (OperationState) Descriptor() protoreflect.EnumDescriptor

func (OperationState) Enum Uses

func (x OperationState) Enum() *OperationState

func (OperationState) EnumDescriptor Uses

func (OperationState) EnumDescriptor() ([]byte, []int)

Deprecated: Use OperationState.Descriptor instead.

func (OperationState) Number Uses

func (x OperationState) Number() protoreflect.EnumNumber

func (OperationState) String Uses

func (x OperationState) String() string

func (OperationState) Type Uses

func (OperationState) Type() protoreflect.EnumType

type Progress Uses

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
}

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.

func (*Progress) Descriptor Uses

func (*Progress) Descriptor() ([]byte, []int)

Deprecated: Use Progress.ProtoReflect.Descriptor instead.

func (*Progress) GetCompletedWork Uses

func (x *Progress) GetCompletedWork() int64

func (*Progress) GetEstimatedWork Uses

func (x *Progress) GetEstimatedWork() int64

func (*Progress) ProtoMessage Uses

func (*Progress) ProtoMessage()

func (*Progress) ProtoReflect Uses

func (x *Progress) ProtoReflect() protoreflect.Message

func (*Progress) Reset Uses

func (x *Progress) Reset()

func (*Progress) String Uses

func (x *Progress) String() string

type UnimplementedFirestoreAdminServer Uses

type UnimplementedFirestoreAdminServer struct {
}

UnimplementedFirestoreAdminServer can be embedded to have forward compatible implementations.

func (*UnimplementedFirestoreAdminServer) CreateIndex Uses

func (*UnimplementedFirestoreAdminServer) CreateIndex(context.Context, *CreateIndexRequest) (*longrunning.Operation, error)

func (*UnimplementedFirestoreAdminServer) DeleteIndex Uses

func (*UnimplementedFirestoreAdminServer) DeleteIndex(context.Context, *DeleteIndexRequest) (*empty.Empty, error)

func (*UnimplementedFirestoreAdminServer) ExportDocuments Uses

func (*UnimplementedFirestoreAdminServer) ExportDocuments(context.Context, *ExportDocumentsRequest) (*longrunning.Operation, error)

func (*UnimplementedFirestoreAdminServer) GetField Uses

func (*UnimplementedFirestoreAdminServer) GetField(context.Context, *GetFieldRequest) (*Field, error)

func (*UnimplementedFirestoreAdminServer) GetIndex Uses

func (*UnimplementedFirestoreAdminServer) GetIndex(context.Context, *GetIndexRequest) (*Index, error)

func (*UnimplementedFirestoreAdminServer) ImportDocuments Uses

func (*UnimplementedFirestoreAdminServer) ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunning.Operation, error)

func (*UnimplementedFirestoreAdminServer) ListFields Uses

func (*UnimplementedFirestoreAdminServer) ListFields(context.Context, *ListFieldsRequest) (*ListFieldsResponse, error)

func (*UnimplementedFirestoreAdminServer) ListIndexes Uses

func (*UnimplementedFirestoreAdminServer) ListIndexes(context.Context, *ListIndexesRequest) (*ListIndexesResponse, error)

func (*UnimplementedFirestoreAdminServer) UpdateField Uses

func (*UnimplementedFirestoreAdminServer) UpdateField(context.Context, *UpdateFieldRequest) (*longrunning.Operation, error)

type UpdateFieldRequest Uses

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 *field_mask.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
    // contains filtered or unexported fields
}

The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField].

func (*UpdateFieldRequest) Descriptor Uses

func (*UpdateFieldRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateFieldRequest.ProtoReflect.Descriptor instead.

func (*UpdateFieldRequest) GetField Uses

func (x *UpdateFieldRequest) GetField() *Field

func (*UpdateFieldRequest) GetUpdateMask Uses

func (x *UpdateFieldRequest) GetUpdateMask() *field_mask.FieldMask

func (*UpdateFieldRequest) ProtoMessage Uses

func (*UpdateFieldRequest) ProtoMessage()

func (*UpdateFieldRequest) ProtoReflect Uses

func (x *UpdateFieldRequest) ProtoReflect() protoreflect.Message

func (*UpdateFieldRequest) Reset Uses

func (x *UpdateFieldRequest) Reset()

func (*UpdateFieldRequest) String Uses

func (x *UpdateFieldRequest) String() string

Package admin imports 14 packages (graph). Updated 2020-08-13. Refresh now. Tools for package owners.