api

Documentation

Index

• Constants
• func FormatToMediaType(format string) (string, error)
• func MediaTypeToFormat(s string, dflt string) (string, error)
• func RequestIDFromContext(ctx context.Context) string
• type AuthIdentityResponse
• type AuthMethod
• type AuthMethodAuth0Details
• type AuthMethodResponse
• type BranchMergeRequest
• type BranchPostRequest
• type CommitMessage
• type CommitResponse
• type CompactRequest
• type DeleteRequest
• type ErrUnsupportedMimeType
  • func (m *ErrUnsupportedMimeType) Error() string
• type Error
  • func (e Error) Error() string
• type EventBranch
• type EventBranchCommit
• type EventPool
• type PoolPostRequest
• type PoolPutRequest
• type QueryChannelEnd
• type QueryChannelSet
• type QueryError
• type QueryRequest
• type QueryStats
• type QueryWarning
• type VacuumResponse
• type VectorRequest
• type VersionResponse

Constants

const (
	MediaTypeAny         = "*/*"
	MediaTypeArrowStream = "application/vnd.apache.arrow.stream"
	MediaTypeCSV         = "text/csv"
	MediaTypeJSON        = "application/json"
	MediaTypeLine        = "application/x-line"
	MediaTypeNDJSON      = "application/x-ndjson"
	MediaTypeParquet     = "application/x-parquet"
	MediaTypeTSV         = "text/tab-separated-values"
	MediaTypeVNG         = "application/x-vng"
	MediaTypeZeek        = "application/x-zeek"
	MediaTypeZJSON       = "application/x-zjson"
	MediaTypeZNG         = "application/x-zng"
	MediaTypeZSON        = "application/x-zson"
)

const RequestIDHeader = "X-Request-ID"

Functions

func FormatToMediaType

func FormatToMediaType(format string) (string, error)

func MediaTypeToFormat

func MediaTypeToFormat(s string, dflt string) (string, error)

MediaTypeToFormat returns the anyio format of the media type value s. If s is MediaTypeAny or undefined the default format dflt will be returned.

func RequestIDFromContext

func RequestIDFromContext(ctx context.Context) string

Types

type AuthIdentityResponse

type AuthIdentityResponse struct {
	TenantID string `json:"tenant_id" zed:"tenant_id"`
	UserID   string `json:"user_id" zed:"user_id"`
}

type AuthMethod

type AuthMethod string

const (
	AuthMethodNone  AuthMethod = ""
	AuthMethodAuth0 AuthMethod = "auth0"
)

type AuthMethodAuth0Details

type AuthMethodAuth0Details struct {
	// Audience is the value to use for the "aud" standard claim when
	// requesting an access token for this service.
	Audience string `json:"audience"`
	// ClientID is the public client id to use when interacting with
	// the above Auth0 domain.
	ClientID string `json:"client_id"`
	// Domain is the Auth0 domain (in url form) to use as the endpoint
	// for any oauth flows.
	Domain string `json:"domain"`
}

type AuthMethodResponse

type AuthMethodResponse struct {
	Kind  AuthMethod              `json:"kind" zed:"kind"`
	Auth0 *AuthMethodAuth0Details `json:"auth0,omitempty" zed:"auth0,omitempty"`
}

type BranchMergeRequest

type BranchMergeRequest struct {
	At string `json:"at"`
}

type BranchPostRequest

type BranchPostRequest struct {
	Name   string `json:"name"`
	Commit string `json:"commit"`
}

type CommitMessage

type CommitMessage struct {
	Author string `zed:"author"`
	Body   string `zed:"body"`
	Meta   string `zed:"meta"`
}

type CommitResponse

type CommitResponse struct {
	Commit   ksuid.KSUID `zed:"commit"`
	Warnings []string    `zed:"warnings"`
}

type CompactRequest

type CompactRequest struct {
	ObjectIDs []ksuid.KSUID `zed:"object_ids"`
}

type DeleteRequest

type DeleteRequest struct {
	ObjectIDs []string `zed:"object_ids"`
	Where     string   `zed:"where"`
}

type ErrUnsupportedMimeType

type ErrUnsupportedMimeType struct {
	Type string
}

func (*ErrUnsupportedMimeType) Error

func (m *ErrUnsupportedMimeType) Error() string

type Error

type Error struct {
	Type    string      `json:"type"`
	Kind    string      `json:"kind"`
	Message string      `json:"error"`
	Info    interface{} `json:"info,omitempty"`
}

func (Error) Error

func (e Error) Error() string

type EventBranch

type EventBranch struct {
	PoolID ksuid.KSUID `zed:"pool_id"`
	Branch string      `zed:"branch"`
}

type EventBranchCommit

type EventBranchCommit struct {
	CommitID ksuid.KSUID `zed:"commit_id"`
	PoolID   ksuid.KSUID `zed:"pool_id"`
	Branch   string      `zed:"branch"`
	Parent   string      `zed:"parent"`
}

type EventPool

type EventPool struct {
	PoolID ksuid.KSUID `zed:"pool_id"`
}

type PoolPostRequest

type PoolPostRequest struct {
	Name       string        `json:"name"`
	SortKey    order.SortKey `json:"layout"`
	SeekStride int           `json:"seek_stride"`
	Thresh     int64         `json:"thresh"`
}

type PoolPutRequest

type PoolPutRequest struct {
	Name string `json:"name"`
}

type QueryChannelEnd

type QueryChannelEnd struct {
	ChannelID int `json:"channel_id" zed:"channel_id"`
}

type QueryChannelSet

type QueryChannelSet struct {
	ChannelID int `json:"channel_id" zed:"channel_id"`
}

type QueryError

type QueryError struct {
	Error string `json:"error" zed:"error"`
}

type QueryRequest

type QueryRequest struct {
	Query string              `json:"query"`
	Head  lakeparse.Commitish `json:"head"`
}

type QueryStats

type QueryStats struct {
	StartTime  nano.Ts `json:"start_time" zed:"start_time"`
	UpdateTime nano.Ts `json:"update_time" zed:"update_time"`
	zbuf.Progress
}

type QueryWarning

type QueryWarning struct {
	Warning string `json:"warning" zed:"warning"`
}

type VacuumResponse

type VacuumResponse struct {
	ObjectIDs []ksuid.KSUID `zed:"object_ids"`
}

type VectorRequest

type VectorRequest struct {
	ObjectIDs []ksuid.KSUID `zed:"object_ids"`
}

type VersionResponse

type VersionResponse struct {
	Version string `json:"version"`
}