client

package

v0.0.0-...-a7257a3 Latest Latest Go to latest Published: Mar 16, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/clesyde/cli-4.23.0

Documentation ¶

Index ¶

Constants
Variables
func GenericJSONGet(section, command string) (*resty.Response, error)
func GenericJSONGetTimeout(section, command string, timeout time.Duration) (*resty.Response, error)
func GenericJSONPost(section, command string, body map[string]interface{}) (*resty.Response, error)
func GenericJSONPostTimeout(section, command string, body map[string]interface{}, timeout time.Duration) (*resty.Response, error)
func GetJSONRequest() *resty.Request
func GetJSONRequestTimeout(timeout time.Duration) *resty.Request
func GetRequest() *resty.Request
func GetRequestTimeout(timeout time.Duration) *resty.Request
func ShowJSONResponse(resp *resty.Response) (success bool)
func StreamTextResponse(resp *resty.Response) (success bool)
func URLHelper(section, command string) (string, error)
type Response

Constants ¶

View Source

const BackupTimeout = 3 * time.Hour

View Source

const ContainerDownloadTimeout = 1 * time.Hour

View Source

const ContainerOperationTimeout = 10 * time.Minute

View Source

const DefaultTimeout = 30 * time.Second

View Source

const OsDownloadTimeout = 1 * time.Hour

Variables ¶

View Source

var RawJSON = false

RawJSON controls if the client does json handling or outputs it raw

Functions ¶

func GenericJSONGet ¶

func GenericJSONGet(section, command string) (*resty.Response, error)

GenericJSONGet is a helper for generic empty post request

func GenericJSONGetTimeout ¶

func GenericJSONGetTimeout(section, command string, timeout time.Duration) (*resty.Response, error)

func GenericJSONPost ¶

func GenericJSONPost(section, command string, body map[string]interface{}) (*resty.Response, error)

GenericJSONPost is a helper for generic empty post request

func GenericJSONPostTimeout ¶

func GenericJSONPostTimeout(section, command string, body map[string]interface{}, timeout time.Duration) (*resty.Response, error)

func GetJSONRequest ¶

func GetJSONRequest() *resty.Request

func GetJSONRequestTimeout ¶

func GetJSONRequestTimeout(timeout time.Duration) *resty.Request

GetJSONRequest returns a request prepared for default JSON resposes

func GetRequest ¶

func GetRequest() *resty.Request

func GetRequestTimeout ¶

func GetRequestTimeout(timeout time.Duration) *resty.Request

GetRequest returns a resty.Request object prepared for an API call

func ShowJSONResponse ¶

func ShowJSONResponse(resp *resty.Response) (success bool)

ShowJSONResponse formats a JSON response for human readers

func StreamTextResponse ¶

func StreamTextResponse(resp *resty.Response) (success bool)

Streams out a text response, like ones from /host/logs

func URLHelper ¶

func URLHelper(section, command string) (string, error)

URLHelper returns a URL built from the arguments

Types ¶

type Response ¶

type Response struct {
	Result  string                 `json:"result"`
	Message string                 `json:"message,omitempty"`
	Data    map[string]interface{} `json:"data,omitempty"`
}

Response is the default JSON response from the Home Assistant Supervisor

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL