restapi

Documentation

Index

• func GetEnvOrDefault(k string, defaultvalue string) string
• func GetKeys(hash map[string]interface{}) []string
• func GetObjectAtKey(data map[string]interface{}, path string, debug bool) (interface{}, error)
• func GetStringAtKey(data map[string]interface{}, path string, debug bool) (string, error)
• func Provider() *schema.Provider
• type APIClient
  • func NewAPIClient(opt *apiClientOpt) (*APIClient, error)
• type APIObject
  • func NewAPIObject(iClient *APIClient, opts *apiObjectOpts) (*APIObject, error)

Functions

func GetEnvOrDefault

func GetEnvOrDefault(k string, defaultvalue string) string

GetEnvOrDefault is a helper function that returns the value of the given environment variable, if one exists, or the default value

func GetKeys

func GetKeys(hash map[string]interface{}) []string

GetKeys is a handy helper to just dump the keys of a map into a slice

func GetObjectAtKey

func GetObjectAtKey(data map[string]interface{}, path string, debug bool) (interface{}, error)

GetObjectAtKey is a handy helper that will dig through a map and find something

 at the defined key. The returned data is not type checked
 Example:
 Given:
 {
   "attrs": {
     "id": 1234
   },
   "config": {
     "foo": "abc",
     "bar": "xyz"
   }
}

Result: attrs/id => 1234 config/foo => "abc"

func GetStringAtKey

func GetStringAtKey(data map[string]interface{}, path string, debug bool) (string, error)

GetStringAtKey uses GetObjectAtKey to verify the resulting

object is either a JSON string or Number and returns it as a string

func Provider

func Provider() *schema.Provider

Provider implements the REST API provider

Types

type APIClient

type APIClient struct {
	// contains filtered or unexported fields
}

APIClient is a HTTP client with additional controlling fields

func NewAPIClient

func NewAPIClient(opt *apiClientOpt) (*APIClient, error)

NewAPIClient makes a new api client for RESTful calls

type APIObject

type APIObject struct {
	// contains filtered or unexported fields
}

APIObject is the state holding struct for a restapi_object resource

func NewAPIObject

func NewAPIObject(iClient *APIClient, opts *apiObjectOpts) (*APIObject, error)

NewAPIObject makes an APIobject to manage a RESTful object in an API