gcf

Documentation

Overview

Package gcf helps with Google cloud functions

Index

• Constants
• func IntialRetryCheck(ctxEvent context.Context, retryTimeOutSeconds int64) (bool, *metadata.Metadata, error)
• type Event
• type FunctionDeployment
  • func NewFunctionDeployment() *FunctionDeployment
  • func (functionDeployment *FunctionDeployment) Deploy() (err error)
  • func (functionDeployment *FunctionDeployment) UploadZipUsingSignedURL() (response *http.Response, err error)
• type Parameters

Constants

const Retries = 5

Retries is the max number of tentative to get the operation status on the cloud function deployment, to deal with transient

Functions

func IntialRetryCheck

func IntialRetryCheck(ctxEvent context.Context, retryTimeOutSeconds int64) (bool, *metadata.Metadata, error)

IntialRetryCheck avoids to retry more than the configured retry timeout

Types

type Event

type Event struct {
	TriggerTopic string `yaml:"triggerTopic,omitempty"`
	BucketName   string `yaml:"bucketName,omitempty"`
}

Event structure

type FunctionDeployment

type FunctionDeployment struct {
	Artifacts struct {
		OperationsService                 *cloudfunctions.OperationsService                 `yaml:"-"`
		ProjectsLocationsFunctionsService *cloudfunctions.ProjectsLocationsFunctionsService `yaml:"-"`
		CloudFunction                     cloudfunctions.CloudFunction
		CloudFunctionZipFullPath          string
		InstanceDeploymentYAMLContent     string
		ZipFiles                          map[string]string
	}
	Core     *deploy.Core
	Settings struct {
		Service struct {
			GCF Parameters
		}
		Instance struct {
			GCF Event
		}
	}
}

FunctionDeployment settings and artifacts structure

func NewFunctionDeployment

func NewFunctionDeployment() *FunctionDeployment

NewFunctionDeployment create deployment structure

func (*FunctionDeployment) Deploy

func (functionDeployment *FunctionDeployment) Deploy() (err error)

Deploy create or update a cloud function

func (*FunctionDeployment) UploadZipUsingSignedURL

func (functionDeployment *FunctionDeployment) UploadZipUsingSignedURL() (response *http.Response, err error)

UploadZipUsingSignedURL upload the rile content using a signed URL

type Parameters

type Parameters struct {
	AvailableMemoryMb      int64 `yaml:"availableMemoryMb" valid:"isAvailableMemory"`
	Description            string
	FunctionType           string `yaml:"functionType"`
	RetryTimeOutSeconds    int64  `yaml:"retryTimeOutSeconds"`
	Timeout                string
	ServiceAccountBindings struct {
		GRM grm.Bindings
		IAM iamgt.Bindings
	} `yaml:"serviceAccountBindings"`
}

Parameters structure