client

Documentation

Index

• Constants
• func Version() string
• func WasNotFoundError(e error) bool
• type Client
  • func NewClient(c *opc.Config) (*Client, error)
  • func (c *Client) BuildMultipartFormRequest(method, path string, files map[string]string, ...) (*http.Request, error)
  • func (c *Client) BuildNonJSONRequest(method, path string, body io.ReadSeeker) (*http.Request, error)
  • func (c *Client) BuildRequestBody(method, path string, body []byte) (*http.Request, error)
  • func (c *Client) DebugLogReq(req *http.Request)
  • func (c *Client) DebugLogString(str string)
  • func (c *Client) ExecuteRequest(req *http.Request) (*http.Response, error)
  • func (c *Client) MarshallRequestBody(body interface{}) ([]byte, error)
  • func (c *Client) WaitFor(description string, pollInterval, timeout time.Duration, ...) error

Constants

const DEFAULT_MAX_RETRIES = 1

const USER_AGENT_HEADER = "User-Agent"

Functions

func Version

func Version() string

Version returns the semantic version (see http://semver.org).

func WasNotFoundError

func WasNotFoundError(e error) bool

Used to determine if the checked resource was found or not.

Types

type Client

type Client struct {
	IdentityDomain *string
	UserName       *string
	Password       *string
	APIEndpoint    *url.URL

	MaxRetries *int
	UserAgent  *string
	// contains filtered or unexported fields
}

Client represents an authenticated compute client, with compute credentials and an api client.

func NewClient

func NewClient(c *opc.Config) (*Client, error)

func (*Client) BuildMultipartFormRequest

func (c *Client) BuildMultipartFormRequest(method, path string, files map[string]string, parameters map[string]interface{}) (*http.Request, error)

Builds a new HTTP Request for a multipart form request

func (*Client) BuildNonJSONRequest

func (c *Client) BuildNonJSONRequest(method, path string, body io.ReadSeeker) (*http.Request, error)

Build a new HTTP request that doesn't marshall the request body

func (*Client) BuildRequestBody

func (c *Client) BuildRequestBody(method, path string, body []byte) (*http.Request, error)

Builds an HTTP Request that accepts a pre-marshaled body parameter as a raw byte array Returns the raw HTTP Request and any error occured

func (*Client) DebugLogReq

func (c *Client) DebugLogReq(req *http.Request)

func (*Client) DebugLogString

func (c *Client) DebugLogString(str string)

Log a string if debug logs are on

func (*Client) ExecuteRequest

func (c *Client) ExecuteRequest(req *http.Request) (*http.Response, error)

This method executes the http.Request from the BuildRequest method. It is split up to add additional authentication that is Oracle API dependent.

func (*Client) MarshallRequestBody

func (c *Client) MarshallRequestBody(body interface{}) ([]byte, error)

Marshalls the request body and returns the resulting byte slice This is split out of the BuildRequestBody method so as to allow the developer to print a debug string of the request body if they should so choose.

func (*Client) WaitFor

func (c *Client) WaitFor(description string, pollInterval, timeout time.Duration, test func() (bool, error)) error

Retry function