async

Documentation

Index

• Constants
• type Creator
• type Deleter
• type FutureScope
• type Getter
• type Reconciler
• type Service
  • func New[C, D any](scope FutureScope, createClient Creator[C], deleteClient Deleter[D]) *Service[C, D]
  • func (s *Service[C, D]) CreateOrUpdateResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (result interface{}, err error)
  • func (s *Service[C, D]) DeleteResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (err error)
• type TagsGetter

Constants

const (
	// DefaultPollerFrequency is how often a poller should check for completion, in seconds.
	DefaultPollerFrequency = 1 * time.Second
)

Types

type Creator

type Creator[T any] interface {
	Getter
	CreateOrUpdateAsync(ctx context.Context, spec azure.ResourceSpecGetter, resumeToken string, parameters interface{}) (result interface{}, poller *runtime.Poller[T], err error)
}

Creator creates or updates a resource asynchronously.

type Deleter

type Deleter[T any] interface {
	DeleteAsync(ctx context.Context, spec azure.ResourceSpecGetter, resumeToken string) (poller *runtime.Poller[T], err error)
}

Deleter deletes a resource asynchronously.

type FutureScope

type FutureScope interface {
	azure.AsyncStatusUpdater
}

FutureScope stores and retrieves Futures and Conditions.

type Getter

type Getter interface {
	Get(ctx context.Context, spec azure.ResourceSpecGetter) (result interface{}, err error)
}

Getter gets a resource.

type Reconciler

type Reconciler interface {
	CreateOrUpdateResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (result interface{}, err error)
	DeleteResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (err error)
}

Reconciler reconciles a resource.

type Service

type Service[C, D any] struct {
	Scope FutureScope
	Creator[C]
	Deleter[D]
}

Service handles asynchronous creation and deletion of resources. It implements the Reconciler interface.

func New

func New[C, D any](scope FutureScope, createClient Creator[C], deleteClient Deleter[D]) *Service[C, D]

New creates an async Service.

func (*Service[C, D]) CreateOrUpdateResource

func (s *Service[C, D]) CreateOrUpdateResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (result interface{}, err error)

CreateOrUpdateResource creates a new resource or updates an existing one asynchronously.

func (*Service[C, D]) DeleteResource

func (s *Service[C, D]) DeleteResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (err error)

DeleteResource deletes a resource asynchronously.

type TagsGetter

type TagsGetter interface {
	GetAtScope(ctx context.Context, scope string) (result armresources.TagsResource, err error)
}

TagsGetter is an interface that can get a tags resource.