stateapi

Documentation

Index

• Constants
• type DeleteArgs
• type GetArgs
• type GetMultipleArgs
• type GetMultipleResp
• type GetResp
• type SetArgs
• type SetMultipleArgs

Constants

const DeleteMethod = "delete"

DeleteMethod deletes a record from the store

const GetMethod = "get"

GetMethod reads a record from the store

const GetMultipleMethod = "getMultiple"

GetMultipleMethod reads multiple records from the store

const ServiceName = "state"

ServiceName defines the default state service agent ID

const SetMethod = "set"

SetMethod writes a record to the store

const SetMultipleMethod = "setMultiple"

SetMultipleMethod writes multiple records to the store

const StorageCap = "store"

StorageCap identifies the capability to store state

Types

type DeleteArgs

type DeleteArgs struct {
	Key string `json:"key"`
}

type GetArgs

type GetArgs struct {
	Key string `json:"key"`
}

type GetMultipleArgs

type GetMultipleArgs struct {
	Keys []string `json:"keys"`
}

type GetMultipleResp

type GetMultipleResp struct {
	// Key-values that were found
	KV map[string][]byte `json:"kv"`
}

type GetResp

type GetResp struct {
	// The returned key or "" if record wasnt found
	Key string `json:"key"`
	// Flag, the record was found (true)
	Found bool `json:"found"`
	// Data, the raw data of the record
	Value []byte `json:"value"`
}

type SetArgs

type SetArgs struct {
	Key   string `json:"key"`
	Value []byte `json:"value"`
}

type SetMultipleArgs

type SetMultipleArgs struct {
	KV map[string][]byte `json:"kv"`
}