package pollers

import "github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers"

Index ¶

• Constants
• Variables
• func ExtractToken(token string) ([]byte, error)
• func Failed(s string) bool
• func GetJSON(resp *http.Response) (map[string]interface{}, error)
• func GetProvisioningState(resp *http.Response) (string, error)
• func GetResourceLocation(resp *http.Response) (string, error)
• func GetStatus(resp *http.Response) (string, error)
• func IsTerminalState(s string) bool
• func IsTokenValid[T any](token string) error
• func IsValidURL(s string) bool
• func NewResumeToken[TResult, TSource any](from TSource) (string, error)
• func PollHelper(ctx context.Context, endpoint string, pl exported.Pipeline, update func(resp *http.Response) (string, error)) error
• func ResultHelper[T any](resp *http.Response, failed bool, out *T) error
• func StatusCodeValid(resp *http.Response) bool
• func Succeeded(s string) bool
• type FinalStateVia
• type NopPoller
• func NewNopPoller[T any](resp *http.Response) (*NopPoller[T], error)
• func (*NopPoller[T]) Done() bool
• func (p *NopPoller[T]) Poll(context.Context) (*http.Response, error)
• func (p *NopPoller[T]) Result(ctx context.Context, out *T) error

Constants ¶

const (
	StatusSucceeded  = "Succeeded"
	StatusCanceled   = "Canceled"
	StatusFailed     = "Failed"
	StatusInProgress = "InProgress"
)

the well-known set of LRO status/provisioning state values.

Variables ¶

var ErrNoBody = errors.New("the response did not contain a body")

ErrNoBody is returned if the response didn't contain a body.

Functions ¶

func ExtractToken ¶

func ExtractToken(token string) ([]byte, error)

ExtractToken returns the poller-specific token information from the provided token value.

func Failed ¶

func Failed(s string) bool

Failed returns true if the LRO's state is terminal failure.

func GetJSON ¶

func GetJSON(resp *http.Response) (map[string]interface{}, error)

GetJSON reads the response body into a raw JSON object. It returns ErrNoBody if there was no content.

func GetProvisioningState ¶

func GetProvisioningState(resp *http.Response) (string, error)

GetProvisioningState returns the LRO's state from the response body. If there is no state in the response body the empty string is returned.

func GetResourceLocation ¶

func GetResourceLocation(resp *http.Response) (string, error)

GetResourceLocation returns the LRO's resourceLocation value from the response body. Typically used for Operation-Location flows. If there is no resourceLocation in the response body the empty string is returned.

func GetStatus ¶

func GetStatus(resp *http.Response) (string, error)

GetStatus returns the LRO's status from the response body. Typically used for Azure-AsyncOperation flows. If there is no status in the response body the empty string is returned.

func IsTerminalState ¶

func IsTerminalState(s string) bool

IsTerminalState returns true if the LRO's state is terminal.

func IsTokenValid ¶

func IsTokenValid[T any](token string) error

IsTokenValid returns an error if the specified token isn't applicable for generic type T.

func IsValidURL ¶

func IsValidURL(s string) bool

IsValidURL verifies that the URL is valid and absolute.

func NewResumeToken ¶

func NewResumeToken[TResult, TSource any](from TSource) (string, error)

NewResumeToken creates a resume token from the specified type. An error is returned if the generic type has no name (e.g. struct{}).

func PollHelper ¶

func PollHelper(ctx context.Context, endpoint string, pl exported.Pipeline, update func(resp *http.Response) (string, error)) error

PollHelper creates and executes the request, calling update() with the response. If the request fails, the update func is not called. The update func returns the state of the operation for logging purposes or an error if it fails to extract the required state from the response.

func ResultHelper ¶

func ResultHelper[T any](resp *http.Response, failed bool, out *T) error

ResultHelper processes the response as success or failure. In the success case, it unmarshals the payload into either a new instance of T or out. In the failure case, it creates an *azcore.Response error from the response.

func StatusCodeValid ¶

func StatusCodeValid(resp *http.Response) bool

returns true if the LRO response contains a valid HTTP status code

func Succeeded ¶

func Succeeded(s string) bool

Succeeded returns true if the LRO's state is terminal success.

Types ¶

type FinalStateVia ¶

type FinalStateVia string

FinalStateVia is the enumerated type for the possible final-state-via values.

const (
	// FinalStateViaAzureAsyncOp indicates the final payload comes from the Azure-AsyncOperation URL.
	FinalStateViaAzureAsyncOp FinalStateVia = "azure-async-operation"

	// FinalStateViaLocation indicates the final payload comes from the Location URL.
	FinalStateViaLocation FinalStateVia = "location"

	// FinalStateViaOriginalURI indicates the final payload comes from the original URL.
	FinalStateViaOriginalURI FinalStateVia = "original-uri"

	// FinalStateViaOpLocation indicates the final payload comes from the Operation-Location URL.
	FinalStateViaOpLocation FinalStateVia = "operation-location"
)

type NopPoller ¶

type NopPoller[T any] struct {
	// contains filtered or unexported fields
}

used if the operation synchronously completed

func NewNopPoller ¶

func NewNopPoller[T any](resp *http.Response) (*NopPoller[T], error)

NewNopPoller creates a NopPoller from the provided response. It unmarshals the response body into an instance of T.

func (*NopPoller[T]) Done ¶

func (*NopPoller[T]) Done() bool

func (*NopPoller[T]) Poll ¶

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

func (*NopPoller[T]) Result ¶

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

Source Files ¶

poller.go util.go

Directories ¶