api

Documentation

Overview

Package api contains representation types for Relay's REST endpoints which may be referenced from multiple packages.

Index

• type BigSegmentStatusRep
• type ConnectionErrorRep
• type ConnectionStatusRep
• type DataStoreStatusRep
• type EnvironmentStatusRep
• type StatusRep

Types

type BigSegmentStatusRep

type BigSegmentStatusRep struct {
	Available          bool                       `json:"available"`
	PotentiallyStale   bool                       `json:"potentiallyStale"`
	LastSynchronizedOn ldtime.UnixMillisecondTime `json:"lastSynchronizedOn"`
}

BigSegmentStatusRep is the big segment status representation returned by the status endpoint.

This is exported for use in integration test code.

type ConnectionErrorRep

type ConnectionErrorRep struct {
	Kind interfaces.DataSourceErrorKind `json:"kind"`
	Time ldtime.UnixMillisecondTime     `json:"time"`
}

ConnectionErrorRep is the optional error information in ConnectionStatusRep.

This is exported for use in integration test code.

type ConnectionStatusRep

type ConnectionStatusRep struct {
	State      interfaces.DataSourceState `json:"state"`
	StateSince ldtime.UnixMillisecondTime `json:"stateSince"`
	LastError  *ConnectionErrorRep        `json:"lastError,omitempty"`
}

ConnectionStatusRep is the data source status representation returned by the status endpoint.

This is exported for use in integration test code.

type DataStoreStatusRep

type DataStoreStatusRep struct {
	State      string                     `json:"state"`
	StateSince ldtime.UnixMillisecondTime `json:"stateSince"`
	Database   string                     `json:"database,omitempty"`
	DBServer   string                     `json:"dbServer,omitempty"`
	DBPrefix   string                     `json:"dbPrefix,omitempty"`
	DBTable    string                     `json:"dbTable,omitempty"`
}

DataStoreStatusRep is the data store status representation returned by the status endpoint.

This is exported for use in integration test code.

type EnvironmentStatusRep

type EnvironmentStatusRep struct {
	SDKKey           string               `json:"sdkKey"`
	EnvID            string               `json:"envId,omitempty"`
	EnvKey           string               `json:"envKey,omitempty"`
	EnvName          string               `json:"envName,omitempty"`
	ProjKey          string               `json:"projKey,omitempty"`
	ProjName         string               `json:"projName,omitempty"`
	MobileKey        string               `json:"mobileKey,omitempty"`
	ExpiringSDKKey   string               `json:"expiringSdkKey,omitempty"`
	Status           string               `json:"status"`
	ConnectionStatus ConnectionStatusRep  `json:"connectionStatus"`
	DataStoreStatus  DataStoreStatusRep   `json:"dataStoreStatus"`
	BigSegmentStatus *BigSegmentStatusRep `json:"bigSegmentStatus,omitempty"`
}

EnvironmentStatusRep is the per-environment JSON representation returned by the status endpoint.

This is exported for use in integration test code.

type StatusRep

type StatusRep struct {
	Environments  map[string]EnvironmentStatusRep `json:"environments"`
	Status        string                          `json:"status"`
	Version       string                          `json:"version"`
	ClientVersion string                          `json:"clientVersion"`
}

StatusRep is the JSON representation returned by the status endpoint.

This is exported for use in integration test code.