opc

Documentation

Index

• func Int(v int) *int
• func LogOutput() (logOutput io.Writer, err error)
• func String(v string) *string
• type Config
  • func NewConfig() *Config
• type LogLevelType
  • func LogLevel() LogLevelType
• type Logger
  • func NewDefaultLogger() Logger
• type LoggerFunc
  • func (f LoggerFunc) Log(args ...interface{})
• type OracleError
  • func (e OracleError) Error() string

Functions

func Int

func Int(v int) *int

Int returns a pointer to an int

func LogOutput

func LogOutput() (logOutput io.Writer, err error)

LogOutput outputs the requested messages

func String

func String(v string) *string

String returns a pointer to a string

Types

type Config

type Config struct {
	Username       *string
	Password       *string
	IdentityDomain *string
	APIEndpoint    *url.URL
	MaxRetries     *int
	LogLevel       LogLevelType
	Logger         Logger
	HTTPClient     *http.Client
	UserAgent      *string
}

Config details the parameters needed to authenticate with Oracle Clouds API

func NewConfig

func NewConfig() *Config

NewConfig returns a blank config to populate with the neccessary fields to authenitcate with Oracle's API

type LogLevelType

type LogLevelType uint

LogLevelType details the constants that log level can be in

const (
	// LogOff turns logging off
	LogOff LogLevelType = 0
	// LogDebug turns logging to debug
	LogDebug LogLevelType = 1
)

func LogLevel

func LogLevel() LogLevelType

LogLevel gets current Log Level from the ORACLE_LOG env var

type Logger

type Logger interface {
	Log(...interface{})
}

Logger interface. Should be satisfied by Terraform's logger as well as the Default logger

func NewDefaultLogger

func NewDefaultLogger() Logger

NewDefaultLogger returns a default logger if one isn't specified during configuration

type LoggerFunc

type LoggerFunc func(...interface{})

LoggerFunc details the logger functions

func (LoggerFunc) Log

func (f LoggerFunc) Log(args ...interface{})

Log logs the specified messages

type OracleError

type OracleError struct {
	StatusCode int
	Message    string
}

OracleError details the parameters of an error returned from Oracle's API

func (OracleError) Error

func (e OracleError) Error() string