gcs

Documentation

Overview

Package gcs loads configuration from GCP Cloud Storage.

It requires following roles on the target GCS object:

• roles/storage.objectViewer

Change notification

By default, it periodically polls the configuration only. It also listens to change events by register it to PubSub notifier with Pub/Sub notifications for Cloud Storage.

Only OBJECT_FINALIZE events trigger polling the configuration and other type of events are ignored.

Index

• type GCS
  • func New(uri string, opts ...Option) *GCS
  • func (g *GCS) Load() (map[string]any, error)
  • func (g *GCS) OnEvent(attributes map[string]string) error
  • func (g *GCS) Status(onStatus func(bool, error))
  • func (g *GCS) String() string
  • func (g *GCS) Watch(ctx context.Context, onChange func(map[string]any)) error
• type Option
  • func WithPollInterval(interval time.Duration) Option
  • func WithUnmarshal(unmarshal func([]byte, any) error) Option

Types

type GCS

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

GCS is a Provider that loads configuration from GCP Cloud Storage.

To create a new GCS, call New.

func New

func New(uri string, opts ...Option) *GCS

New creates a GCS with the given endpoint and Option(s).

func (*GCS) Load

func (g *GCS) Load() (map[string]any, error)

func (*GCS) OnEvent

func (g *GCS) OnEvent(attributes map[string]string) error

func (*GCS) Status

func (g *GCS) Status(onStatus func(bool, error))

func (*GCS) String

func (g *GCS) String() string

func (*GCS) Watch

func (g *GCS) Watch(ctx context.Context, onChange func(map[string]any)) error

type Option

type Option = option.ClientOption

func WithPollInterval

func WithPollInterval(interval time.Duration) Option

WithPollInterval provides the interval for polling the configuration.

The default interval is 1 minute.

func WithUnmarshal

func WithUnmarshal(unmarshal func([]byte, any) error) Option

WithUnmarshal provides the function used to parses the configuration. The unmarshal function must be able to unmarshal the configuration into a map[string]any.

The default function is json.Unmarshal.