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.5.5

Jan 12, 2017

v1.5.4

Dec 27, 2016

v1.5.3

Dec 6, 2016

v1.5.2

Nov 22, 2016

v1.5.2-go1.8beta1

Nov 22, 2016

v1.5.1

Nov 18, 2016

v1.5.0

Nov 18, 2016

v1.4.4

Oct 24, 2016

v1.4.3

Oct 17, 2016

v1.4.2

Oct 10, 2016

v1.4.1

Aug 26, 2016

v1.4.0

Aug 19, 2016

Changes in this version

type ObjectResource

+ Authenticated bool

+ func (o *ObjectResource) NeedsAuth() bool

v1.3.1

Aug 2, 2016

v1.3.0

Jul 27, 2016

Changes in this version

+ const MediaType

+ var ErrNoOperationGiven = errors.New("lfs/api: no operation provided in schema")

+ func DoBatchRequest(req *http.Request) (*http.Response, *batchResponse, error)

+ func DoRequest(req *http.Request, useCreds bool) (*http.Response, error)

+ func NewBatchRequest(operation string) (*http.Request, error)

+ func NewRequest(method, oid string) (*http.Request, error)

+ func ObjectUrl(endpoint config.Endpoint, oid string) (*url.URL, error)

+ func VerifyUpload(obj *ObjectResource) error

+ type Client struct

+ Locks LockService

+ func NewClient(lifecycle Lifecycle) *Client

+ func (c *Client) Do(schema *RequestSchema) (Response, error)

+ type Committer struct

+ Email string

+ Name string

+ func CurrentCommitter() Committer

+ type EndpointSource interface

+ Endpoint func(operation string) config.Endpoint

+ type Filter struct

+ Property string

+ Value string

+ type HttpLifecycle struct

+ func NewHttpLifecycle(endpoints EndpointSource) *HttpLifecycle

+ func (l *HttpLifecycle) Build(schema *RequestSchema) (*http.Request, error)

+ func (l *HttpLifecycle) Cleanup(resp Response) error

+ func (l *HttpLifecycle) Execute(req *http.Request, into interface{}) (Response, error)

+ type HttpResponse struct

+ func WrapHttpResponse(r *http.Response) *HttpResponse

+ func (h *HttpResponse) Body() io.ReadCloser

+ func (h *HttpResponse) Header() http.Header

+ func (h *HttpResponse) Proto() string

+ func (h *HttpResponse) Status() string

+ func (h *HttpResponse) StatusCode() int

+ type Lifecycle interface

+ Build func(req *RequestSchema) (*http.Request, error)

+ Cleanup func(resp Response) error

+ Execute func(req *http.Request, into interface{}) (Response, error)

+ type LinkRelation struct

+ ExpiresAt time.Time

+ Header map[string]string

+ Href string

+ type Lock struct

+ CommitSHA string

+ Committer Committer

+ Id string

+ LockedAt time.Time

+ Path string

+ UnlockedAt time.Time

+ func (l *Lock) Active() bool

+ type LockList struct

+ Err string

+ Locks []Lock

+ NextCursor string

+ type LockRequest struct

+ Committer Committer

+ LatestRemoteCommit string

+ Path string

+ type LockResponse struct

+ CommitNeeded string

+ Err string

+ Lock *Lock

+ type LockSearchRequest struct

+ Cursor string

+ Filters []Filter

+ Limit int

+ type LockService struct

+ func (s *LockService) Lock(req *LockRequest) (*RequestSchema, *LockResponse)

+ func (s *LockService) Search(req *LockSearchRequest) (*RequestSchema, *LockList)

+ func (s *LockService) Unlock(id string, force bool) (*RequestSchema, *UnlockResponse)

+ type ObjectError struct

+ Code int

+ Message string

+ func (e *ObjectError) Error() string

+ type ObjectResource struct

+ Actions map[string]*LinkRelation

+ Error *ObjectError

+ Links map[string]*LinkRelation

+ Oid string

+ Size int64

+ func Batch(objects []*ObjectResource, operation string, transferAdapters []string) (objs []*ObjectResource, transferAdapter string, e error)

+ func BatchOrLegacy(objects []*ObjectResource, operation string, transferAdapters []string) (objs []*ObjectResource, transferAdapter string, e error)

+ func BatchOrLegacySingle(inobj *ObjectResource, operation string, transferAdapters []string) (obj *ObjectResource, transferAdapter string, e error)

+ func DoLegacyRequest(req *http.Request) (*http.Response, *ObjectResource, error)

+ func DownloadCheck(oid string) (*ObjectResource, error)

+ func Legacy(objects []*ObjectResource, operation string) ([]*ObjectResource, error)

+ func UploadCheck(oid string, size int64) (*ObjectResource, error)

+ func (o *ObjectResource) IsExpired(now time.Time) bool

+ func (o *ObjectResource) NewRequest(relation, method string) (*http.Request, error)

+ func (o *ObjectResource) Rel(name string) (*LinkRelation, bool)

+ type Operation string

+ const DownloadOperation

+ const UploadOperation

+ type RequestSchema struct

+ Body interface{}

+ Into interface{}

+ Method string

+ Operation Operation

+ Path string

+ Query map[string]string

+ type Response interface

+ Body func() io.ReadCloser

+ Proto func() string

+ Status func() string

+ StatusCode func() int

+ type UnlockRequest struct

+ Force bool

+ Id string

+ type UnlockResponse struct

+ Err string

+ Lock *Lock