gfs

Documentation

Overview

Package gfs helps with Google FireStore

Index

• func GetDoc(ctx context.Context, firestoreClient *firestore.Client, documentPath string, ...) (*firestore.DocumentSnapshot, bool)
• func ListKeyNames(ctx context.Context, firestoreClient *firestore.Client, serviceName string) (serviceAccountKeyNames []string, err error)
• func RecordDump(ctx context.Context, dumpNameFull string, firestoreClient *firestore.Client, ...) (err error)
• func RecordKeyName(core *deploy.Core, serviceAccountKeyName string, retriesNumber time.Duration) (err error)

Functions

func GetDoc

func GetDoc(ctx context.Context,
	firestoreClient *firestore.Client,
	documentPath string,
	retriesNumber time.Duration) (*firestore.DocumentSnapshot, bool)

GetDoc check if a document exist with retries

func ListKeyNames

func ListKeyNames(ctx context.Context, firestoreClient *firestore.Client, serviceName string) (serviceAccountKeyNames []string, err error)

ListKeyNames retrieve the list of recorded keyname for a given microservice

func RecordDump

func RecordDump(ctx context.Context,
	dumpNameFull string,
	firestoreClient *firestore.Client,
	stepStack logging.Steps,
	microserviceName string,
	instanceName string,
	environment string,
	pubSubID string,
	retriesNumber time.Duration) (err error)

RecordDump record a dump stepStack in firestore

func RecordKeyName

func RecordKeyName(core *deploy.Core, serviceAccountKeyName string, retriesNumber time.Duration) (err error)

RecordKeyName records the service account key name used by a deployed microservice instance