body

Documentation

Index

• func Applicable(resp *http.Response) bool
• func CanResume(token map[string]interface{}) bool
• type Poller
  • func New[T any](pl exported.Pipeline, resp *http.Response) (*Poller[T], error)
  • func (p *Poller[T]) Done() bool
  • func (p *Poller[T]) Poll(ctx context.Context) (*http.Response, error)
  • func (p *Poller[T]) Result(ctx context.Context, out *T) error

Functions

func Applicable

func Applicable(resp *http.Response) bool

Applicable returns true if the LRO is using no headers, just provisioning state. This is only applicable to PATCH and PUT methods and assumes no polling headers.

func CanResume

func CanResume(token map[string]interface{}) bool

CanResume returns true if the token can rehydrate this poller type.

Types

type Poller

type Poller[T any] struct {

	// The poller's type, used for resume token processing.
	Type string `json:"type"`

	// The URL for polling.
	PollURL string `json:"pollURL"`

	// The LRO's current state.
	CurState string `json:"state"`
	// contains filtered or unexported fields
}

Poller is an LRO poller that uses the Body pattern.

func New

func New[T any](pl exported.Pipeline, resp *http.Response) (*Poller[T], error)

New creates a new Poller from the provided initial response. Pass nil for response to create an empty Poller for rehydration.

func (*Poller[T]) Done

func (p *Poller[T]) Done() bool

func (*Poller[T]) Poll

func (p *Poller[T]) Poll(ctx context.Context) (*http.Response, error)

func (*Poller[T]) Result

func (p *Poller[T]) Result(ctx context.Context, out *T) error