fake

package

v1.11.1 Latest Latest Go to latest Published: Apr 2, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Azure/azure-sdk-for-go

Links

Open Source Insights

Documentation ¶

Index ¶

func Applicable(resp *http.Response) bool
func CanResume(token map[string]any) bool
func SanitizePollerPath(path string) string
type Poller
- func New[T any](pl exported.Pipeline, resp *http.Response) (*Poller[T], error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Applicable ¶

func Applicable(resp *http.Response) bool

Applicable returns true if the LRO is a fake.

func CanResume ¶

func CanResume(token map[string]any) bool

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

func SanitizePollerPath ¶

func SanitizePollerPath(path string) string

SanitizePollerPath removes any fake-appended suffix from a URL's path.

Types ¶

type Poller ¶

type Poller[T any] struct {

	// The API name from CtxAPINameKey
	APIName string `json:"apiName"`

	// The URL from Core-Fake-Poller header.
	FakeURL string `json:"fakeURL"`

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

Poller is an LRO poller that uses the Core-Fake-Poller 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

Done returns true if the LRO is in a terminal state.

func (*Poller[T]) Poll ¶

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

Poll retrieves the current state of the LRO.

func (*Poller[T]) Result ¶

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

Source Files ¶

View all Source files

fake.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL