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

package admin

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

Index

Package Files

firestore_admin.pb.go index.pb.go location.pb.go

Variables

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

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

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

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

Enum value maps for Index_State.

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 Uses

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

type CreateIndexRequest Uses

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
}

The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta1.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 {

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

The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1beta1.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 that work began on the operation.
    StartTime *timestamp.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 *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.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
}

Metadata for ExportDocuments operations.

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

The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta1.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 FirestoreAdminClient Uses

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

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

FirestoreAdminServer is the server API for FirestoreAdmin service.

type GetIndexRequest Uses

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
}

The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1beta1.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 that work began on the operation.
    StartTime *timestamp.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 *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.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
}

Metadata for ImportDocuments operations.

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

The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta1.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 {

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

An index definition.

func (*Index) Descriptor Uses

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

Deprecated: Use Index.ProtoReflect.Descriptor instead.

func (*Index) GetCollectionId Uses

func (x *Index) GetCollectionId() string

func (*Index) GetFields Uses

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

func (*Index) GetName Uses

func (x *Index) GetName() string

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 IndexField Uses

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
}

A field of an index.

func (*IndexField) Descriptor Uses

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

Deprecated: Use IndexField.ProtoReflect.Descriptor instead.

func (*IndexField) GetFieldPath Uses

func (x *IndexField) GetFieldPath() string

func (*IndexField) GetMode Uses

func (x *IndexField) GetMode() IndexField_Mode

func (*IndexField) ProtoMessage Uses

func (*IndexField) ProtoMessage()

func (*IndexField) ProtoReflect Uses

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

func (*IndexField) Reset Uses

func (x *IndexField) Reset()

func (*IndexField) String Uses

func (x *IndexField) String() string

type IndexField_Mode Uses

type IndexField_Mode int32

The mode determines how a field is indexed.

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 Uses

func (IndexField_Mode) Descriptor() protoreflect.EnumDescriptor

func (IndexField_Mode) Enum Uses

func (x IndexField_Mode) Enum() *IndexField_Mode

func (IndexField_Mode) EnumDescriptor Uses

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

Deprecated: Use IndexField_Mode.Descriptor instead.

func (IndexField_Mode) Number Uses

func (x IndexField_Mode) Number() protoreflect.EnumNumber

func (IndexField_Mode) String Uses

func (x IndexField_Mode) String() string

func (IndexField_Mode) Type Uses

func (IndexField_Mode) Type() protoreflect.EnumType

type IndexOperationMetadata Uses

type IndexOperationMetadata struct {

    // The time that work began on the operation.
    StartTime *timestamp.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 *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}/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
}

Metadata for index operations. This metadata populates the metadata field of [google.longrunning.Operation][google.longrunning.Operation].

func (*IndexOperationMetadata) Descriptor Uses

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

Deprecated: Use IndexOperationMetadata.ProtoReflect.Descriptor instead.

func (*IndexOperationMetadata) GetCancelled Uses

func (x *IndexOperationMetadata) GetCancelled() bool

func (*IndexOperationMetadata) GetDocumentProgress Uses

func (x *IndexOperationMetadata) GetDocumentProgress() *Progress

func (*IndexOperationMetadata) GetEndTime Uses

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

func (*IndexOperationMetadata) GetIndex Uses

func (x *IndexOperationMetadata) GetIndex() string

func (*IndexOperationMetadata) GetOperationType Uses

func (x *IndexOperationMetadata) GetOperationType() IndexOperationMetadata_OperationType

func (*IndexOperationMetadata) GetStartTime Uses

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

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 IndexOperationMetadata_OperationType Uses

type IndexOperationMetadata_OperationType int32

The type of index operation.

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 Uses

func (IndexOperationMetadata_OperationType) Descriptor() protoreflect.EnumDescriptor

func (IndexOperationMetadata_OperationType) Enum Uses

func (x IndexOperationMetadata_OperationType) Enum() *IndexOperationMetadata_OperationType

func (IndexOperationMetadata_OperationType) EnumDescriptor Uses

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

Deprecated: Use IndexOperationMetadata_OperationType.Descriptor instead.

func (IndexOperationMetadata_OperationType) Number Uses

func (x IndexOperationMetadata_OperationType) Number() protoreflect.EnumNumber

func (IndexOperationMetadata_OperationType) String Uses

func (x IndexOperationMetadata_OperationType) String() string

func (IndexOperationMetadata_OperationType) Type Uses

func (IndexOperationMetadata_OperationType) 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 is not able to be created, it will transition to the `ERROR` 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 = 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 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 ListIndexesRequest Uses

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
}

The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta1.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 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
}

The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta1.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 LocationMetadata Uses

type LocationMetadata struct {
    // contains filtered or unexported fields
}

The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata].

func (*LocationMetadata) Descriptor Uses

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

Deprecated: Use LocationMetadata.ProtoReflect.Descriptor instead.

func (*LocationMetadata) ProtoMessage Uses

func (*LocationMetadata) ProtoMessage()

func (*LocationMetadata) ProtoReflect Uses

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

func (*LocationMetadata) Reset Uses

func (x *LocationMetadata) Reset()

func (*LocationMetadata) String Uses

func (x *LocationMetadata) String() string

type OperationState Uses

type OperationState int32

The various possible states for an ongoing Operation.

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 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 {

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

Measures the progress of a particular metric.

func (*Progress) Descriptor Uses

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

Deprecated: Use Progress.ProtoReflect.Descriptor instead.

func (*Progress) GetWorkCompleted Uses

func (x *Progress) GetWorkCompleted() int64

func (*Progress) GetWorkEstimated Uses

func (x *Progress) GetWorkEstimated() 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) 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) ListIndexes Uses

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

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