async

Documentation

Overview

Package async : has no documentation (yet)

Index

• Constants
• type LaunchEmptyResult
• type LaunchResultBase
  • func (u *LaunchResultBase) UnmarshalJSON(body []byte) error
• type PollArg
  • func NewPollArg(AsyncJobId string) *PollArg
• type PollEmptyResult
• type PollError
• type PollResultBase

Constants

const (
	PollErrorInvalidAsyncJobId = "invalid_async_job_id"
	PollErrorInternalError     = "internal_error"
	PollErrorOther             = "other"
)

Valid tag values for PollError

const (
	LaunchEmptyResultComplete = "complete"
)

Valid tag values for LaunchEmptyResult

const (
	LaunchResultBaseAsyncJobId = "async_job_id"
)

Valid tag values for LaunchResultBase

const (
	PollEmptyResultComplete = "complete"
)

Valid tag values for PollEmptyResult

const (
	PollResultBaseInProgress = "in_progress"
)

Valid tag values for PollResultBase

Types

type LaunchEmptyResult

type LaunchEmptyResult struct {
	dropbox.Tagged
}

LaunchEmptyResult : Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.

type LaunchResultBase

type LaunchResultBase struct {
	dropbox.Tagged
	// AsyncJobId : This response indicates that the processing is asynchronous.
	// The string is an id that can be used to obtain the status of the
	// asynchronous job.
	AsyncJobId string `json:"async_job_id,omitempty"`
}

LaunchResultBase : Result returned by methods that launch an asynchronous job. A method who may either launch an asynchronous job, or complete the request synchronously, can use this union by extending it, and adding a 'complete' field with the type of the synchronous response. See `LaunchEmptyResult` for an example.

func (*LaunchResultBase) UnmarshalJSON

func (u *LaunchResultBase) UnmarshalJSON(body []byte) error

UnmarshalJSON deserializes into a LaunchResultBase instance

type PollArg

type PollArg struct {
	// AsyncJobId : Id of the asynchronous job. This is the value of a response
	// returned from the method that launched the job.
	AsyncJobId string `json:"async_job_id"`
}

PollArg : Arguments for methods that poll the status of an asynchronous job.

func NewPollArg

func NewPollArg(AsyncJobId string) *PollArg

NewPollArg returns a new PollArg instance

type PollEmptyResult

type PollEmptyResult struct {
	dropbox.Tagged
}

PollEmptyResult : Result returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned.

type PollError

type PollError struct {
	dropbox.Tagged
}

PollError : Error returned by methods for polling the status of asynchronous job.

type PollResultBase

type PollResultBase struct {
	dropbox.Tagged
}

PollResultBase : Result returned by methods that poll for the status of an asynchronous job. Unions that extend this union should add a 'complete' field with a type of the information returned upon job completion. See `PollEmptyResult` for an example.