Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.21.0

Nov 26, 2024

v1.20.0

Oct 30, 2023

v1.19.0

May 16, 2023

v1.18.0

Jan 17, 2023

v1.17.0

Oct 27, 2022

v1.16.0

Oct 14, 2021

v1.15.0

Sep 24, 2021

v1.14.0

Aug 19, 2021

v1.13.0

Jun 18, 2021

Changes in this version

type DatasetAPI

+ BatchSize int

+ MaxWorkers int

type DatasetClient

+ GetInstancesInBatches func(ctx context.Context, userAuthToken, serviceAuthToken, collectionID string, ...) (instances dataset.Instances, err error)

v1.12.0

Apr 8, 2021

v1.11.0

Mar 15, 2021

v1.10.0

Dec 11, 2020

v1.9.0

Oct 29, 2020

v1.8.0

Aug 13, 2020

v1.7.0

Apr 17, 2020

v1.6.0

Apr 17, 2020

Changes in this version

+ func RegisterCheckers(ctx context.Context, hc *healthcheck.HealthCheck, ...) (err error)

+ func StartHealthCheck(ctx context.Context, hc *healthcheck.HealthCheck, bindAddr string, ...)

+ func StopHealthCheck(ctx context.Context, hc *healthcheck.HealthCheck) (err error)

+ type DatasetAPI struct

+ Client DatasetClient

+ ServiceAuthToken string

+ func (api *DatasetAPI) GetInstance(ctx context.Context, instanceID string) (instance dataset.Instance, isFatal bool, err error)

+ func (api *DatasetAPI) GetInstances(ctx context.Context, vars url.Values) (instances dataset.Instances, isFatal bool, err error)

+ func (api *DatasetAPI) SetImportObservationTaskComplete(ctx context.Context, instanceID string) (isFatal bool, err error)

+ func (api *DatasetAPI) UpdateInstanceState(ctx context.Context, instanceID string, newState dataset.State) (isFatal bool, err error)

+ func (api *DatasetAPI) UpdateInstanceWithHierarchyBuilt(ctx context.Context, instanceID, dimensionID string) (isFatal bool, err error)

+ func (api *DatasetAPI) UpdateInstanceWithNewInserts(ctx context.Context, instanceID string, observationsInserted int32) (isFatal bool, err error)

+ func (api *DatasetAPI) UpdateInstanceWithSearchIndexBuilt(ctx context.Context, instanceID, dimensionID string) (isFatal bool, err error)

+ type DatasetClient interface

+ Checker func(ctx context.Context, check *healthcheck.CheckState) error

+ GetInstance func(ctx context.Context, ...) (m dataset.Instance, err error)

+ GetInstances func(ctx context.Context, userAuthToken, serviceAuthToken, collectionID string, ...) (m dataset.Instances, err error)

+ PutInstanceImportTasks func(ctx context.Context, serviceAuthToken, instanceID string, ...) error

+ PutInstanceState func(ctx context.Context, serviceAuthToken, instanceID string, state dataset.State) error

+ UpdateInstanceWithNewInserts func(ctx context.Context, serviceAuthToken, instanceID string, ...) error

+ type ImportAPI struct

+ Client ImportAPIClient

+ ServiceAuthToken string

+ func (i *ImportAPI) GetImportJob(ctx context.Context, importJobID string) (importJob importapi.ImportJob, isFatal bool, err error)

+ func (i *ImportAPI) UpdateImportJobState(ctx context.Context, jobID, newState string) error

+ type ImportAPIClient interface

+ Checker func(ctx context.Context, check *healthcheck.CheckState) error

+ GetImportJob func(ctx context.Context, importJobID, serviceToken string) (importJob importapi.ImportJob, err error)

+ UpdateImportJobState func(ctx context.Context, jobID, serviceToken string, newState string) error