api

Documentation

Index

• Constants
• func CanonicalLinkRelation(rel string) string
• func IsUnauthorized(err error) bool
• func UnmarshalJSON(b []byte, v interface{}) error
• func UnmarshalMetadata(resp *http.Response, md *Metadata)
• type Client
  • func NewClient(address string, transport http.RoundTripper) (Client, error)
• type Duration
  • func (d Duration) MarshalJSON() ([]byte, error)
  • func (d Duration) String() string
  • func (d *Duration) UnmarshalJSON(bytes []byte) error
• type Error
  • func NewError(t ErrorType, resp *http.Response, body []byte) *Error
  • func NewUnexpectedError(resp *http.Response, body []byte) *Error
  • func (e *Error) Error() string
• type ErrorType
• type IndexQuery
  • func (q *IndexQuery) AppendToURL(u string) (string, error)
  • func (q *IndexQuery) SetLabelSelector(kv map[string]string)
  • func (q *IndexQuery) SetLimit(limit int)
  • func (q *IndexQuery) SetOffset(offset int)
• type Metadata
  • func (m Metadata) LastModified() time.Time
  • func (m Metadata) Link(rel string) string
  • func (m Metadata) Location() string
  • func (m Metadata) Title() string
• type NumberOrString
  • func FromFloat64(val float64) NumberOrString
  • func FromInt64(val int64) NumberOrString
  • func FromNumber(val json.Number) NumberOrString
  • func FromString(val string) NumberOrString
  • func FromValue(val string) NumberOrString
  • func (s *NumberOrString) Float64Value() float64
  • func (s *NumberOrString) Int64Value() int64
  • func (s NumberOrString) MarshalJSON() ([]byte, error)
  • func (s *NumberOrString) Quantity() *big.Float
  • func (s *NumberOrString) String() string
  • func (s *NumberOrString) UnmarshalJSON(b []byte) error

Constants

const (
	ParamOffset        = "offset"
	ParamLimit         = "limit"
	ParamLabelSelector = "labelSelector"
)

const (
	RelationSelf      = "self"
	RelationNext      = "next"
	RelationPrev      = "prev"
	RelationAlternate = "alternate"
	RelationUp        = "up"

	RelationExperiments     = "https://stormforge.io/rel/experiments"
	RelationLabels          = "https://stormforge.io/rel/labels"
	RelationNextTrial       = "https://stormforge.io/rel/next-trial"
	RelationRecommendations = "https://stormforge.io/rel/recommendations"
	RelationScenarios       = "https://stormforge.io/rel/scenarios"
	RelationTemplate        = "https://stormforge.io/rel/template"
	RelationTrials          = "https://stormforge.io/rel/trials"
)

Functions

func CanonicalLinkRelation

func CanonicalLinkRelation(rel string) string

CanonicalLinkRelation returns the supplied link relation name normalized for previously accepted values. The returned value can be compared case-insensitively to the supplied `Relation*` constants.

func IsUnauthorized

func IsUnauthorized(err error) bool

IsUnauthorized checks to see if the error is an "unauthorized" error.

func UnmarshalJSON

func UnmarshalJSON(b []byte, v interface{}) error

UnmarshalJSON extracts the supplied JSON, preserving the "_metadata" field if necessary. This should only be necessary on items in index (list) representations as top-level "_metadata" fields should normally be populated from HTTP headers.

func UnmarshalMetadata

func UnmarshalMetadata(resp *http.Response, md *Metadata)

Types

type Client

type Client interface {
	// URL returns the location of the specified endpoint.
	URL(endpoint string) *url.URL
	// Do sends an HTTP request and returns the buffered body contents.
	Do(context.Context, *http.Request) (*http.Response, []byte, error)
}

Client is used to handle interactions with the API Server.

func NewClient

func NewClient(address string, transport http.RoundTripper) (Client, error)

NewClient returns a new client for accessing API server.

type Duration

type Duration time.Duration

Duration is an alternate duration type that marshals as a JSON string.

func (Duration) MarshalJSON

func (d Duration) MarshalJSON() ([]byte, error)

MarshalJSON produces a string formatted duration.

func (Duration) String

func (d Duration) String() string

String returns the string representation of the duration.

func (*Duration) UnmarshalJSON

func (d *Duration) UnmarshalJSON(bytes []byte) error

UnmarshalJSON handles the string formatted duration.

type Error

type Error struct {
	Type       ErrorType     `json:"-"`
	Message    string        `json:"error"`
	RetryAfter time.Duration `json:"-"`
	Location   string        `json:"-"`
}

Error represents the API specific error messages and may be used in response to HTTP status codes

func NewError

func NewError(t ErrorType, resp *http.Response, body []byte) *Error

NewError returns a new error with an API specific error condition, it also captures the details of the response

func NewUnexpectedError

func NewUnexpectedError(resp *http.Response, body []byte) *Error

NewUnexpectedError returns an error in situations where the API returned an undocumented status for the requested resource.

func (*Error) Error

func (e *Error) Error() string

Error returns the message associated with this API error.

type ErrorType

type ErrorType string

ErrorType is an identifying token for errors.

const (
	ErrUnauthorized ErrorType = "unauthorized"
	ErrUnexpected   ErrorType = "unexpected"
)

type IndexQuery

type IndexQuery map[string][]string

IndexQuery represents the query parameter of an index resource.

func (*IndexQuery) AppendToURL

func (q *IndexQuery) AppendToURL(u string) (string, error)

AppendToURL adds this index query to an existing URL.

func (*IndexQuery) SetLabelSelector

func (q *IndexQuery) SetLabelSelector(kv map[string]string)

SetLabelSelector is a helper to set label selectors used to filter the index.

func (*IndexQuery) SetLimit

func (q *IndexQuery) SetLimit(limit int)

SetLimit sets the maximum number of items to include with the index.

func (*IndexQuery) SetOffset

func (q *IndexQuery) SetOffset(offset int)

SetOffset sets the number of items to skip from the beginning of the index.

type Metadata

type Metadata map[string][]string

Metadata is used to hold single or multi-value metadata from list responses.

func (Metadata) LastModified

func (m Metadata) LastModified() time.Time

func (Metadata) Link

func (m Metadata) Link(rel string) string

func (Metadata) Location

func (m Metadata) Location() string

func (Metadata) Title

func (m Metadata) Title() string

type NumberOrString

type NumberOrString struct {
	IsString bool
	NumVal   json.Number
	StrVal   string
}

NumberOrString is value that can be a JSON number or string.

func FromFloat64

func FromFloat64(val float64) NumberOrString

FromFloat64 returns the supplied value as a NumberOrString

func FromInt64

func FromInt64(val int64) NumberOrString

FromInt64 returns the supplied value as a NumberOrString

func FromNumber

func FromNumber(val json.Number) NumberOrString

FromNumber returns the supplied value as a NumberOrString

func FromString

func FromString(val string) NumberOrString

FromString returns the supplied value as a NumberOrString

func FromValue

func FromValue(val string) NumberOrString

FromValue returns the supplied value as a NumberOrString based on an attempt to parse the supplied value as an int or float.

func (*NumberOrString) Float64Value

func (s *NumberOrString) Float64Value() float64

Float64Value coerces the value to a float64.

func (*NumberOrString) Int64Value

func (s *NumberOrString) Int64Value() int64

Int64Value coerces the value to an int64.

func (NumberOrString) MarshalJSON

func (s NumberOrString) MarshalJSON() ([]byte, error)

MarshalJSON writes the value with the appropriate type.

func (*NumberOrString) Quantity

func (s *NumberOrString) Quantity() *big.Float

Quantity attempts to return a big float using the same logic as a Kubernetes quantity. If parsing fails, this will return nil.

func (*NumberOrString) String

func (s *NumberOrString) String() string

String coerces the value to a string.

func (*NumberOrString) UnmarshalJSON

func (s *NumberOrString) UnmarshalJSON(b []byte) error

UnmarshalJSON reads the value from either a string or number.