api

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 22, 2017 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrNotLogined means user was not logined
	ErrNotLogined = errors.New("not logined")
)

Functions

func DeleteFile 

func DeleteFile(appID string, objectID string) error

DeleteFile will delete the specific file

func DeployAppFromFile 

func DeployAppFromFile(appID string, projectPath string, groupName string, fileURL string, message string, noDepsCache bool) (string, error)

DeployAppFromFile will deploy applications with specific file returns the event token for polling deploy log

func DeployAppFromGit 

func DeployAppFromGit(appID string, projectPath string, groupName string, revision string, noDepsCache bool) (string, error)

DeployAppFromGit will deploy applications with user's git repo returns the event token for polling deploy log

func DeployImage 

func DeployImage(appID string, groupName string, imageTag string) (string, error)

DeployImage will deploy the engine group with specify image tag

func GetAppRegion 

func GetAppRegion(appID string) (regions.Region, error)

GetAppRegion will query the app router, and return the app's region. The result is cached in process memory.

func GetLoginedRegion added in v0.6.0 

func GetLoginedRegion() (result []regions.Region, err error)

GetLoginedRegion returns all regions which is logined

func LoginUSRegion 

func LoginUSRegion() error

LoginUSRegion will use OAuth2 to login US Region

func NewErrorFromBody 

func NewErrorFromBody(body string) error

NewErrorFromBody build an error value from JSON string

func NewErrorFromResponse added in v0.3.0 

func NewErrorFromResponse(resp *grequests.Response) error

NewErrorFromResponse build an error value from *grequest.Response

func PollEvents 

func PollEvents(appID string, tok string, writer io.Writer) (bool, error)

PollEvents will poll the server's event logs and print the result to the given io.Writer

func PrintLogs added in v0.3.0 

func PrintLogs(printer LogPrinter, appID string, masterKey string, follow bool, isProd bool, limit int) error

PrintLogs will poll the leanengine's log and print it to the giver io.Writer

func PutEnvironments added in v0.5.0 

func PutEnvironments(appID string, envs map[string]string) error

func UploadFile 

func UploadFile(appID string, filePath string) (*upload.File, error)

UploadFile upload specific file to LeanCloud

Types

type Client 

type Client struct {
	CookieJar *cookiejar.Jar
	Region    regions.Region
}

Client info

func NewClient 

func NewClient(region regions.Region) *Client

NewClient initilized a new Client

type Error 

type Error struct {
	Code         int    `json:"code"`
	Content      string `json:"error"`
	ErrorEventID string `json:"errorEventID"`
}

Error is the LeanCloud API Server API common error format

func (Error) Error 

func (err Error) Error() string

type ExecuteCQLResult added in v0.4.0 

type ExecuteCQLResult struct {
	ClassName string                   `json:"className"`
	Results   []map[string]interface{} `json:"results"`
	Count     int                      `json:"count"`
}

ExecuteCQLResult is ExecuteCQL's result type

func ExecuteCQL added in v0.4.0 

func ExecuteCQL(appID string, masterKey string, region regions.Region, cql string) (*ExecuteCQLResult, error)

ExecuteCQL will execute the cql, and returns' the result

type ExecuteCacheCommandResult added in v0.3.0 

type ExecuteCacheCommandResult struct {
	Result interface{} `json:"result"`
}

ExecuteCacheCommandResult is ExecuteCacheCommand's result type

func ExecuteCacheCommand added in v0.3.0 

func ExecuteCacheCommand(appID string, instance string, db int, command string) (*ExecuteCacheCommandResult, error)

ExecuteCacheCommand will send command to LeanCache and excute it

type GetAppInfoResult 

type GetAppInfoResult struct {
	AppDomain      string `json:"app_domain"`
	AppID          string `json:"app_id"`
	AppKey         string `json:"app_key"`
	AppName        string `json:"app_name"`
	HookKey        string `json:"hook_key"`
	LeanEngineMode string `json:"leanengine_mode"`
	MasterKey      string `json:"master_key"`
}

GetAppInfoResult is GetAppInfo function's result type

func GetAppInfo 

func GetAppInfo(appID string) (*GetAppInfoResult, error)

GetAppInfo returns the application's detail info

type GetAppListResult 

type GetAppListResult struct {
	AppID     string `json:"app_id"`
	AppKey    string `json:"app_key"`
	AppName   string `json:"app_name"`
	MasterKey string `json:"master_key"`
	AppDomain string `json:"app_domain"`
}

GetAppListResult is GetAppList function's result type

func GetAppList 

func GetAppList(region regions.Region) ([]*GetAppListResult, error)

GetAppList returns the current user's all LeanCloud application this will also update the app router cache

type GetCacheListResult added in v0.3.0 

type GetCacheListResult struct {
	Instance   string `json:"instance"`
	MaxMemory  int    `json:"max_memory"`
	InstanceID string `json:"instance_id"`
	Info       struct {
		UsedMemoryHuman string `json:"used_memory_human"`
	} `json:"info"`
}

GetCacheListResult is GetCacheList's return structure type

func GetCacheList added in v0.3.0 

func GetCacheList(appID string) ([]*GetCacheListResult, error)

GetCacheList returns current app's LeanCache instance list

type GetEngineInfoResult added in v0.5.0 

type GetEngineInfoResult struct {
	AppID         string            `json:"appId"`
	Mode          string            `json:"mode"`
	InstanceLimit int               `json:"instanceLimit"`
	Version       string            `json:"version"`
	Environments  map[string]string `json:"environments"`
}

func GetEngineInfo added in v0.5.0 

func GetEngineInfo(appID string) (*GetEngineInfoResult, error)

type GetGroupsResult 

type GetGroupsResult struct {
	GroupName string `json:"groupName"`
	Prod      int    `json:"prod"`
	Instances []struct {
		Name  string `json:"name"`
		Quota int    `json:"quota"`
	} `json:"instances"`
	CurrentImage struct {
		Runtime  string `json:"runtime"`
		ImageTag string `json:"imageTag"`
	} `json:"currentImage"`
}

GetGroupsResult is GetGroups's result struct

func GetGroups 

func GetGroups(appID string) ([]*GetGroupsResult, error)

GetGroups returns the application's engine groups

type GetUserInfoResult 

type GetUserInfoResult struct {
	Email    string `json:"email"`
	UserName string `json:"username"`
}

GetUserInfoResult is the return type of GetUserInfo

func GetUserInfo 

func GetUserInfo(region regions.Region) (*GetUserInfoResult, error)

GetUserInfo returns the current logined user info

func Login 

func Login(email string, password string) (*GetUserInfoResult, error)

Login LeanCloud account

func LoginTABRegion added in v0.4.0 

func LoginTABRegion(token string) (*GetUserInfoResult, error)

LoginTABRegion will use qrcode to login TAB Region

type Log added in v0.3.0 

type Log struct {
	InstanceName string `json:"instanceName"`
	Content      string `json:"content"`
	Type         string `json:"type"`
	Time         string `json:"time"`
	GroupName    string `json:"groupName"`
	Production   int    `json:"production"`
	OID          string `json:"oid"`
	Level        string `json:"level"`
	Instance     string `json:"instance"`
}

Log is EngineLogs's type structure

type LogPrinter added in v0.5.5 

type LogPrinter func(*Log) error

LogPrinter is print func interface to PrintLogs

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.