loc

Documentation

Index

• func Applicable(resp *azcore.Response) bool
• type Poller
  • func New(resp *azcore.Response, pollerID string) (*Poller, error)
  • func (p *Poller) Done() bool
  • func (p *Poller) FinalGetURL() string
  • func (p *Poller) Status() string
  • func (p *Poller) URL() string
  • func (p *Poller) Update(resp *azcore.Response) error

Functions

func Applicable

func Applicable(resp *azcore.Response) bool

Applicable returns true if the LRO is using Location.

Types

type Poller

type Poller 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"`
}

Poller is an LRO poller that uses the Location pattern.

func New

func New(resp *azcore.Response, pollerID string) (*Poller, error)

New creates a new Poller from the provided initial response.

func (*Poller) Done

func (p *Poller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*Poller) FinalGetURL

func (p *Poller) FinalGetURL() string

FinalGetURL returns the empty string as no final GET is required for this poller type.

func (*Poller) Status

func (p *Poller) Status() string

Status returns the status of the LRO.

func (*Poller) URL

func (p *Poller) URL() string

URL returns the polling URL.

func (*Poller) Update

func (p *Poller) Update(resp *azcore.Response) error

Update updates the Poller from the polling response.