apiv1

Sep 11, 2024

Changes in this version

type FieldIterator

+ func (it *FieldIterator) All() iter.Seq2[*adminpb.Field, error]

type IndexIterator

+ func (it *IndexIterator) All() iter.Seq2[*adminpb.Index, error]

type OperationIterator

+ func (it *OperationIterator) All() iter.Seq2[*longrunningpb.Operation, error]

Jul 24, 2024

Changes in this version

+ type BulkDeleteDocumentsOperation struct

+ func (op *BulkDeleteDocumentsOperation) Done() bool

+ func (op *BulkDeleteDocumentsOperation) Metadata() (*adminpb.BulkDeleteDocumentsMetadata, error)

+ func (op *BulkDeleteDocumentsOperation) Name() string

+ func (op *BulkDeleteDocumentsOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*adminpb.BulkDeleteDocumentsResponse, error)

+ func (op *BulkDeleteDocumentsOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*adminpb.BulkDeleteDocumentsResponse, error)

type FirestoreAdminCallOptions

+ BulkDeleteDocuments []gax.CallOption

+ CreateBackupSchedule []gax.CallOption

+ DeleteBackup []gax.CallOption

+ DeleteBackupSchedule []gax.CallOption

+ GetBackup []gax.CallOption

+ GetBackupSchedule []gax.CallOption

+ ListBackupSchedules []gax.CallOption

+ ListBackups []gax.CallOption

+ RestoreDatabase []gax.CallOption

+ UpdateBackupSchedule []gax.CallOption

type FirestoreAdminClient

+ func (c *FirestoreAdminClient) BulkDeleteDocuments(ctx context.Context, req *adminpb.BulkDeleteDocumentsRequest, ...) (*BulkDeleteDocumentsOperation, error)

+ func (c *FirestoreAdminClient) BulkDeleteDocumentsOperation(name string) *BulkDeleteDocumentsOperation

+ func (c *FirestoreAdminClient) CreateBackupSchedule(ctx context.Context, req *adminpb.CreateBackupScheduleRequest, ...) (*adminpb.BackupSchedule, error)

+ func (c *FirestoreAdminClient) DeleteBackup(ctx context.Context, req *adminpb.DeleteBackupRequest, opts ...gax.CallOption) error

+ func (c *FirestoreAdminClient) DeleteBackupSchedule(ctx context.Context, req *adminpb.DeleteBackupScheduleRequest, ...) error

+ func (c *FirestoreAdminClient) GetBackup(ctx context.Context, req *adminpb.GetBackupRequest, opts ...gax.CallOption) (*adminpb.Backup, error)

+ func (c *FirestoreAdminClient) GetBackupSchedule(ctx context.Context, req *adminpb.GetBackupScheduleRequest, ...) (*adminpb.BackupSchedule, error)

+ func (c *FirestoreAdminClient) ListBackupSchedules(ctx context.Context, req *adminpb.ListBackupSchedulesRequest, ...) (*adminpb.ListBackupSchedulesResponse, error)

+ func (c *FirestoreAdminClient) ListBackups(ctx context.Context, req *adminpb.ListBackupsRequest, opts ...gax.CallOption) (*adminpb.ListBackupsResponse, error)

+ func (c *FirestoreAdminClient) RestoreDatabase(ctx context.Context, req *adminpb.RestoreDatabaseRequest, ...) (*RestoreDatabaseOperation, error)

+ func (c *FirestoreAdminClient) RestoreDatabaseOperation(name string) *RestoreDatabaseOperation

+ func (c *FirestoreAdminClient) UpdateBackupSchedule(ctx context.Context, req *adminpb.UpdateBackupScheduleRequest, ...) (*adminpb.BackupSchedule, error)

+ type RestoreDatabaseOperation struct

+ func (op *RestoreDatabaseOperation) Done() bool

+ func (op *RestoreDatabaseOperation) Metadata() (*adminpb.RestoreDatabaseMetadata, error)

+ func (op *RestoreDatabaseOperation) Name() string

+ func (op *RestoreDatabaseOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*adminpb.Database, error)

+ func (op *RestoreDatabaseOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*adminpb.Database, error)

Mar 5, 2024

Changes in this version

+ type CreateDatabaseOperation struct

+ func (op *CreateDatabaseOperation) Done() bool

+ func (op *CreateDatabaseOperation) Metadata() (*adminpb.CreateDatabaseMetadata, error)

+ func (op *CreateDatabaseOperation) Name() string

+ func (op *CreateDatabaseOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*adminpb.Database, error)

+ func (op *CreateDatabaseOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*adminpb.Database, error)

+ type DeleteDatabaseOperation struct

+ func (op *DeleteDatabaseOperation) Done() bool

+ func (op *DeleteDatabaseOperation) Metadata() (*adminpb.DeleteDatabaseMetadata, error)

+ func (op *DeleteDatabaseOperation) Name() string

+ func (op *DeleteDatabaseOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*adminpb.Database, error)

+ func (op *DeleteDatabaseOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*adminpb.Database, error)

type FirestoreAdminCallOptions

+ CreateDatabase []gax.CallOption

+ DeleteDatabase []gax.CallOption

type FirestoreAdminClient

+ func (c *FirestoreAdminClient) CreateDatabase(ctx context.Context, req *adminpb.CreateDatabaseRequest, ...) (*CreateDatabaseOperation, error)

+ func (c *FirestoreAdminClient) CreateDatabaseOperation(name string) *CreateDatabaseOperation

+ func (c *FirestoreAdminClient) DeleteDatabase(ctx context.Context, req *adminpb.DeleteDatabaseRequest, ...) (*DeleteDatabaseOperation, error)

+ func (c *FirestoreAdminClient) DeleteDatabaseOperation(name string) *DeleteDatabaseOperation

May 22, 2023

Changes in this version

type FirestoreAdminClient

+ func NewFirestoreAdminRESTClient(ctx context.Context, opts ...option.ClientOption) (*FirestoreAdminClient, error)

Oct 6, 2022

Changes in this version

type FirestoreAdminCallOptions

+ CancelOperation []gax.CallOption

+ DeleteOperation []gax.CallOption

+ GetDatabase []gax.CallOption

+ GetOperation []gax.CallOption

+ ListDatabases []gax.CallOption

+ ListOperations []gax.CallOption

+ UpdateDatabase []gax.CallOption

type FirestoreAdminClient

+ func (c *FirestoreAdminClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error

+ func (c *FirestoreAdminClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error

+ func (c *FirestoreAdminClient) GetDatabase(ctx context.Context, req *adminpb.GetDatabaseRequest, opts ...gax.CallOption) (*adminpb.Database, error)

+ func (c *FirestoreAdminClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)

+ func (c *FirestoreAdminClient) ListDatabases(ctx context.Context, req *adminpb.ListDatabasesRequest, opts ...gax.CallOption) (*adminpb.ListDatabasesResponse, error)

+ func (c *FirestoreAdminClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator

+ func (c *FirestoreAdminClient) UpdateDatabase(ctx context.Context, req *adminpb.UpdateDatabaseRequest, ...) (*UpdateDatabaseOperation, error)

+ func (c *FirestoreAdminClient) UpdateDatabaseOperation(name string) *UpdateDatabaseOperation

+ type OperationIterator struct

+ InternalFetch func(pageSize int, pageToken string) (results []*longrunningpb.Operation, nextPageToken string, err error)

+ Response interface{}

+ func (it *OperationIterator) Next() (*longrunningpb.Operation, error)

+ func (it *OperationIterator) PageInfo() *iterator.PageInfo

+ type UpdateDatabaseOperation struct

+ func (op *UpdateDatabaseOperation) Done() bool

+ func (op *UpdateDatabaseOperation) Metadata() (*adminpb.UpdateDatabaseMetadata, error)

+ func (op *UpdateDatabaseOperation) Name() string

+ func (op *UpdateDatabaseOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*adminpb.Database, error)

+ func (op *UpdateDatabaseOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*adminpb.Database, error)

Mar 27, 2020

Changes in this version

+ type CreateIndexOperation struct

+ func (op *CreateIndexOperation) Done() bool

+ func (op *CreateIndexOperation) Metadata() (*adminpb.IndexOperationMetadata, error)

+ func (op *CreateIndexOperation) Name() string

+ func (op *CreateIndexOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*adminpb.Index, error)

+ func (op *CreateIndexOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*adminpb.Index, error)

+ type ExportDocumentsOperation struct

+ func (op *ExportDocumentsOperation) Done() bool

+ func (op *ExportDocumentsOperation) Metadata() (*adminpb.ExportDocumentsMetadata, error)

+ func (op *ExportDocumentsOperation) Name() string

+ func (op *ExportDocumentsOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*adminpb.ExportDocumentsResponse, error)

+ func (op *ExportDocumentsOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*adminpb.ExportDocumentsResponse, error)

type FieldIterator

+ Response interface{}

type FirestoreAdminClient

+ LROClient *lroauto.OperationsClient

+ func (c *FirestoreAdminClient) CreateIndexOperation(name string) *CreateIndexOperation

+ func (c *FirestoreAdminClient) ExportDocumentsOperation(name string) *ExportDocumentsOperation

+ func (c *FirestoreAdminClient) ImportDocumentsOperation(name string) *ImportDocumentsOperation

+ func (c *FirestoreAdminClient) UpdateFieldOperation(name string) *UpdateFieldOperation

+ type ImportDocumentsOperation struct

+ func (op *ImportDocumentsOperation) Done() bool

+ func (op *ImportDocumentsOperation) Metadata() (*adminpb.ImportDocumentsMetadata, error)

+ func (op *ImportDocumentsOperation) Name() string

+ func (op *ImportDocumentsOperation) Poll(ctx context.Context, opts ...gax.CallOption) error

+ func (op *ImportDocumentsOperation) Wait(ctx context.Context, opts ...gax.CallOption) error

type IndexIterator

+ Response interface{}

+ type UpdateFieldOperation struct

+ func (op *UpdateFieldOperation) Done() bool

+ func (op *UpdateFieldOperation) Metadata() (*adminpb.FieldOperationMetadata, error)

+ func (op *UpdateFieldOperation) Name() string

+ func (op *UpdateFieldOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*adminpb.Field, error)

+ func (op *UpdateFieldOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*adminpb.Field, error)

Sep 13, 2019

Changes in this version

+ func DefaultAuthScopes() []string

+ type FieldIterator struct

+ InternalFetch func(pageSize int, pageToken string) (results []*adminpb.Field, nextPageToken string, err error)

+ func (it *FieldIterator) Next() (*adminpb.Field, error)

+ func (it *FieldIterator) PageInfo() *iterator.PageInfo

+ type FirestoreAdminCallOptions struct

+ CreateIndex []gax.CallOption

+ DeleteIndex []gax.CallOption

+ ExportDocuments []gax.CallOption

+ GetField []gax.CallOption

+ GetIndex []gax.CallOption

+ ImportDocuments []gax.CallOption

+ ListFields []gax.CallOption

+ ListIndexes []gax.CallOption

+ UpdateField []gax.CallOption

+ type FirestoreAdminClient struct

+ CallOptions *FirestoreAdminCallOptions

+ func NewFirestoreAdminClient(ctx context.Context, opts ...option.ClientOption) (*FirestoreAdminClient, error)

+ func (c *FirestoreAdminClient) Close() error

+ func (c *FirestoreAdminClient) Connection() *grpc.ClientConn

+ func (c *FirestoreAdminClient) CreateIndex(ctx context.Context, req *adminpb.CreateIndexRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)

+ func (c *FirestoreAdminClient) DeleteIndex(ctx context.Context, req *adminpb.DeleteIndexRequest, opts ...gax.CallOption) error

+ func (c *FirestoreAdminClient) ExportDocuments(ctx context.Context, req *adminpb.ExportDocumentsRequest, ...) (*longrunningpb.Operation, error)

+ func (c *FirestoreAdminClient) GetField(ctx context.Context, req *adminpb.GetFieldRequest, opts ...gax.CallOption) (*adminpb.Field, error)

+ func (c *FirestoreAdminClient) GetIndex(ctx context.Context, req *adminpb.GetIndexRequest, opts ...gax.CallOption) (*adminpb.Index, error)

+ func (c *FirestoreAdminClient) ImportDocuments(ctx context.Context, req *adminpb.ImportDocumentsRequest, ...) (*longrunningpb.Operation, error)

+ func (c *FirestoreAdminClient) ListFields(ctx context.Context, req *adminpb.ListFieldsRequest, opts ...gax.CallOption) *FieldIterator

+ func (c *FirestoreAdminClient) ListIndexes(ctx context.Context, req *adminpb.ListIndexesRequest, opts ...gax.CallOption) *IndexIterator

+ func (c *FirestoreAdminClient) SetGoogleClientInfo(keyval ...string)

+ func (c *FirestoreAdminClient) UpdateField(ctx context.Context, req *adminpb.UpdateFieldRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)

+ type IndexIterator struct

+ InternalFetch func(pageSize int, pageToken string) (results []*adminpb.Index, nextPageToken string, err error)

+ func (it *IndexIterator) Next() (*adminpb.Index, error)

+ func (it *IndexIterator) PageInfo() *iterator.PageInfo