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 NewAPIClient(opt *apiClientOpt) (*api_client, error)
• func NewAPIObject(i_client *api_client, opts *apiObjectOpts) (*api_object, error)
• func Provider() terraform.ResourceProvider

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

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)

 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)

Using GetObjectAtKey, this function verifies the resulting

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

func NewAPIClient

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

Make a new api client for RESTful calls

func NewAPIObject

func NewAPIObject(i_client *api_client, opts *apiObjectOpts) (*api_object, error)

Make an api_object to manage a RESTful object in an API

func Provider

func Provider() terraform.ResourceProvider