dataset

Documentation

Index

• type API
  • func (api *API) CreateInstance(ctx context.Context, job *models.Job, recipeInst *models.RecipeInstance) (instance *models.Instance, err error)
  • func (api *API) UpdateInstanceState(ctx context.Context, instanceID string, newState string) error

Types

type API

type API struct {
	Client           dphttp.Clienter
	URL              string
	ServiceAuthToken string
}

API aggregates a client and URL and other common data for accessing the API

func (*API) CreateInstance

func (api *API) CreateInstance(ctx context.Context, job *models.Job, recipeInst *models.RecipeInstance) (instance *models.Instance, err error)

CreateInstance tells the Dataset API to create a Dataset instance

func (*API) UpdateInstanceState

func (api *API) UpdateInstanceState(ctx context.Context, instanceID string, newState string) error

UpdateInstanceState tells the Dataset API that the state of a Dataset instance has changed