pollers

type PollResult struct {
	// HttpResponse is a copy of the HttpResponse returned from the API in the last request.
	HttpResponse *client.Response

	// PollInterval specifies the interval until this poller should be called again.
	PollInterval time.Duration

	// Status specifies the polling status of this resource at the time of the last request.
	Status PollingStatus
}

type Poller struct {
	// contains filtered or unexported fields
}

type PollerType interface {
	// Poll performs a poll to determine whether the Operation has been Completed/Cancelled or Failed.
	// Behaviourally this method should:
	//   1. Perform a single poll, and assume that it will be called again after the PollInterval
	//      defined within the PollResult.
	//   2. When the operation is still in progress, a PollResult should be returned with the Status
	//      `InProgress` and the next PollInterval.
	//   3. When the operation is Completed, a PollResult should be returned with the Status
	//      `Succeeded`.
	//   4. When the operation is Cancelled a PollingCancelledError should be returned.
	//   5. When the operation Fails a PollingFailedError should be returned.
	Poll(ctx context.Context) (*PollResult, error)
}

type PollingCancelledError struct {
	// HttpResponse is a copy of the HttpResponse returned from the API in the last request.
	HttpResponse *client.Response

	// Message is a custom error message containing more details
	Message string
}

type PollingDroppedConnectionError struct {
	// Message is a custom error message containing more details
	Message string
}

type PollingFailedError struct {
	// HttpResponse is a copy of the HttpResponse returned from the API in the last request.
	HttpResponse *client.Response

	// Message is a custom error message containing more details
	Message string
}

type PollingStatus string