queryUserCurveTemplateData

package
v0.0.0-...-391253a Latest Latest
Warning

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

 Go to latest Published: Sep 4, 2023 License: GPL-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package queryUserCurveTemplateData - This file is auto-generated from the update_all.sh script. Do not modify anything here. Any changes to this EndPoint should be made in the data.go file. The only exception is the AppService.login package.

Index

Constants

View Source 
const Disabled = false
View Source 
const EndPointName = "WebAppService.queryUserCurveTemplateData"
View Source 
const Url = "/v1/devService/queryUserCurveTemplateData"

Variables

This section is empty.

Functions

This section is empty.

Types

type DeviceData 

type DeviceData struct {
	DeviceName valueTypes.String  `json:"device_name"`
	DeviceType valueTypes.Integer `json:"device_type"`
	DeviceUUID valueTypes.Integer `json:"device_uuid"`
	Points     Points             `json:"points" DataTable:"true" DataTableMerge:"true" DataTableSortOn:"PointId"` // PointIdReplace:"false" PointIdFromChild:"PsId.PsKey"
}

func (*DeviceData) UnmarshalJSON 

func (p *DeviceData) UnmarshalJSON(data []byte) error

type Devices 

type Devices map[string]DeviceData

type EndPoint 

type EndPoint struct {
	api.EndPointStruct
	Request  Request
	Response Response
}

EndPoint - Holds the request, response and web method structures.

func Assert 

func Assert(e api.EndPoint) EndPoint

Assert - Used to obtain locally scoped EndPoint methods, (not visible from api.EndPoint).

func Init 

func Init(apiRoot api.Web) EndPoint

Init - Used to initialize a new endpoint instance. Usually called from an area.

func (EndPoint) CacheFilename 

func (e EndPoint) CacheFilename() string

CacheFilename - Check if a cache file exists for this EndPoint.

func (EndPoint) Call 

func (e EndPoint) Call() api.EndPoint

Call - Once RequestData is populated, this will access the iSolarCloud API and populate ResultData.

func (EndPoint) GetArea 

func (e EndPoint) GetArea() api.AreaName

GetArea - Returns the API area that this EndPoint is located.

func (EndPoint) GetCacheTimeout 

func (e EndPoint) GetCacheTimeout() time.Duration

GetCacheTimeout - Return the cache timeout for this EndPoint.

func (*EndPoint) GetData 

func (e *EndPoint) GetData() api.DataMap

func (EndPoint) GetEndPointData 

func (e EndPoint) GetEndPointData() api.DataMap

func (EndPoint) GetEndPointDataTables 

func (e EndPoint) GetEndPointDataTables() output.Tables

func (EndPoint) GetEndPointResultTable 

func (e EndPoint) GetEndPointResultTable() output.Table

func (EndPoint) GetError 

func (e EndPoint) GetError() error

GetError - Get the error code for this EndPoint.

func (EndPoint) GetJsonData 

func (e EndPoint) GetJsonData(raw bool) output.Json

GetJsonData - Get the JSON representation of ResultData, either as condensed or "pretty".

func (EndPoint) GetName 

func (e EndPoint) GetName() api.EndPointName

GetName - Returns the API EndPoint name.

func (EndPoint) GetRequest 

func (e EndPoint) GetRequest() Request

GetRequest - Get the Request structure as scoped by this endpoint.

func (EndPoint) GetRequestArgNames 

func (e EndPoint) GetRequestArgNames() map[string]string

GetRequestArgNames -

func (EndPoint) GetRequestJson 

func (e EndPoint) GetRequestJson() output.Json

GetRequestJson - Return the Request structure as a JSON string.

func (EndPoint) GetResponse 

func (e EndPoint) GetResponse() Response

GetResponse - Get the Response structure as scoped by this endpoint.

func (EndPoint) GetResponseJson 

func (e EndPoint) GetResponseJson() output.Json

GetResponseJson - Return the Response structure as a JSON string.

func (EndPoint) GetUrl 

func (e EndPoint) GetUrl() api.EndPointUrl

GetUrl - Returns the API EndPoint url.

func (EndPoint) Help 

func (e EndPoint) Help() string

Help - Return help information on the JSON structure used to populate RequestData.

func (EndPoint) Init 

func (e EndPoint) Init(apiRoot api.Web) *EndPoint

Init - If the endpoint needs to be re-initialized.

func (EndPoint) IsDebug 

func (e EndPoint) IsDebug() bool

IsDebug - Are we in debug mode?

func (EndPoint) IsDisabled 

func (e EndPoint) IsDisabled() bool

IsDisabled - Is this endpoint disabled? See data.go Disabled constant.

func (EndPoint) IsError 

func (e EndPoint) IsError() bool

IsError - Is there an error?

func (EndPoint) IsRequestValid 

func (e EndPoint) IsRequestValid() error

IsRequestValid - Is api.RequestCommon and RequestData valid?

func (EndPoint) IsResponseValid 

func (e EndPoint) IsResponseValid() error

IsResponseValid - Is api.ResponseCommon and ResultData valid?

func (EndPoint) MarshalJSON 

func (e EndPoint) MarshalJSON() ([]byte, error)

MarshalJSON - Marshall the EndPoint.

func (EndPoint) ReadDataFile 

func (e EndPoint) ReadDataFile() error

ReadDataFile - Read a JSON file and populate the ResultData structure. (File names will default to AREA-ENDPOINT.json )

func (EndPoint) RequestFingerprint 

func (e EndPoint) RequestFingerprint() string

RequestFingerprint - Check if a cache file exists for this EndPoint.

func (EndPoint) RequestRef 

func (e EndPoint) RequestRef() interface{}

RequestRef - Return the locally scoped Request structure.

func (EndPoint) RequestString 

func (e EndPoint) RequestString() string

RequestString - Return the Request structure as a human-readable string.

func (EndPoint) ResponseRef 

func (e EndPoint) ResponseRef() interface{}

ResponseRef - Return the locally scoped Response structure.

func (EndPoint) ResponseString 

func (e EndPoint) ResponseString() string

ResponseString - Return the Response structure as a human-readable string.

func (EndPoint) ResultDataRef 

func (e EndPoint) ResultDataRef() ResultData

ResultDataRef - Return the locally scoped ResultData structure.

func (EndPoint) SetCacheTimeout 

func (e EndPoint) SetCacheTimeout(duration time.Duration) api.EndPoint

SetCacheTimeout - Set the cache timeout for this EndPoint. (Defaults to 1 hour.)

func (EndPoint) SetError 

func (e EndPoint) SetError(format string, a ...interface{}) api.EndPoint

SetError - Set the error code for this EndPoint.

func (EndPoint) SetFilenamePrefix 

func (e EndPoint) SetFilenamePrefix(format string, args ...interface{}) string

SetFilenamePrefix - Produce filename based on area and endpoint name.

func (EndPoint) SetRequest 

func (e EndPoint) SetRequest(ref interface{}) api.EndPoint

SetRequest - Save an interface reference as either api.RequestCommon or RequestData.

func (EndPoint) SetRequestByJson 

func (e EndPoint) SetRequestByJson(j output.Json) api.EndPoint

SetRequestByJson - Save RequestData from a JSON string.

func (EndPoint) SetResponse 

func (e EndPoint) SetResponse(ref []byte) api.EndPoint

SetResponse - Save a JSON string to the Response structure. (Used by the web call method.)

func (EndPoint) String 

func (e EndPoint) String() string

String - Stringer method for this EndPoint.

func (EndPoint) WriteDataFile 

func (e EndPoint) WriteDataFile() error

WriteDataFile - Write to a file, the contents of ResultData as JSON. (File names will default to AREA-ENDPOINT.json )

type Point 

type Point struct {
	PointId    valueTypes.PointId `json:"point_id"`
	PointName  valueTypes.String  `json:"point_name"`
	PsId       valueTypes.PsId    `json:"ps_id"`
	PsKey      valueTypes.PsKey   `json:"ps_key"`
	Color      valueTypes.String  `json:"color"`
	DetailId   valueTypes.String  `json:"detail_id"`
	PsName     valueTypes.String  `json:"ps_name"`
	Statistics valueTypes.String  `json:"statistics"`
	Style      valueTypes.String  `json:"style"`
	Unit       valueTypes.String  `json:"unit"`
	DataList   []struct {
		TimeStamp valueTypes.String `json:"time_stamp"`
		Value     valueTypes.String `json:"value"`
	} `json:"data_list" PointArrayFlatten:"false"`
}

func (*Point) UnmarshalJSON 

func (p *Point) UnmarshalJSON(data []byte) error

type Points 

type Points map[string]Point

func (*Points) UnmarshalJSON 

func (p *Points) UnmarshalJSON(data []byte) error

type PointsData 

type PointsData struct {
	Devices map[string]DeviceData `json:"devices" PointIdReplace:"true"` // PointIdFromChild:"DateId" PointIdReplace:"true"`
	Order   valueTypes.String     `json:"order" PointSplitOn:"," PointValueReplace:"&" PointValueReplaceWith:".p"`
}

func (*PointsData) UnmarshalJSON 

func (p *PointsData) UnmarshalJSON(data []byte) error

type Request 

type Request struct {
	api.RequestCommon
	RequestData
}

Request - Holds the api.RequestCommon and user RequestData structures. See data.go for request fields.

type RequestData 

type RequestData struct {
	TemplateId valueTypes.String `json:"template_id" required:"true"`
}

func (RequestData) Help 

func (rd RequestData) Help() string

func (RequestData) IsValid 

func (rd RequestData) IsValid() error

type Response 

type Response struct {
	api.ResponseCommon
	ResultData ResultData `json:"result_data" PointIdReplace:"true"`
}

Response - Holds the api.ResponseCommon and endpoint specific ResultData structures. See data.go for response fields.

type ResultData 

type ResultData struct {
	CreateTime   valueTypes.DateTime `json:"create_time" PointNameDateFormat:"DateTimeLayout"`
	OpenTime     valueTypes.DateTime `json:"open_time" PointNameDateFormat:"DateTimeLayout"`
	UpdateTime   valueTypes.DateTime `json:"update_time" PointNameDateFormat:"DateTimeLayout"`
	StartTime    valueTypes.DateTime `json:"start_time" PointNameDateFormat:"DateTimeLayout"`
	EndTime      valueTypes.DateTime `json:"end_time" PointNameDateFormat:"DateTimeLayout"`
	DateType     valueTypes.Integer  `json:"date_type"`
	Cycle        valueTypes.Integer  `json:"cycle"`
	TemplateId   valueTypes.Integer  `json:"template_id"`
	TemplateName valueTypes.String   `json:"template_name"`
	PointsData   PointsData          `json:"points_data" PointIdReplace:"true"`
}

ResultData (struct) -> PointsData(struct) -> Devices(map[string]DeviceData) -> Points(map[string]Point)

func AssertResultData 

func AssertResultData(e api.EndPoint) ResultData

AssertResultData - Used to obtain locally scoped ResultData methods, (not visible from api.EndPoint).

func (*ResultData) IsValid 

func (e *ResultData) IsValid() error

Source Files

View all Source files

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.