ibmpisession

Documentation

Index

• Constants
• func SDKFailWithAPIError(err error, origErr error) error
• type IBMPILogger
  • func (IBMPILogger) Debugf(format string, args ...interface{})
  • func (IBMPILogger) Printf(format string, args ...interface{})
• type IBMPIOptions
• type IBMPISession
  • func NewIBMPISession(o *IBMPIOptions) (*IBMPISession, error)
  • func (s *IBMPISession) AuthInfo(cloudInstanceID string) runtime.ClientAuthInfoWriter
  • func (s *IBMPISession) IsOnPrem() bool

Constants

const (
	SCHEME_HTTPS = "https"
	SCHEME_HTTP  = "http"
)

Functions

func SDKFailWithAPIError

func SDKFailWithAPIError(err error, origErr error) error

SDKFailWithAPIError returns a custom error message if a HTTP error response 500 or greater is found

Types

type IBMPILogger

type IBMPILogger struct{}

func (IBMPILogger) Debugf

func (IBMPILogger) Debugf(format string, args ...interface{})

func (IBMPILogger) Printf

func (IBMPILogger) Printf(format string, args ...interface{})

type IBMPIOptions

type IBMPIOptions struct {
	// The authenticator implementation to be used by the
	// service instance to authenticate outbound requests
	// Required
	Authenticator core.Authenticator

	// Enable/Disable http transport debugging log
	Debug bool

	// Region of the Power Cloud Service Instance
	// For generating the default endpoint
	// Deprecated: Region is deprecated, the URL is auto generated based on Zone when not provided.
	Region string

	// Power Virtual Server host or URL endpoint
	// This will be used instead of generating the default host
	// eg: dal.power-iaas.cloud.ibm.com
	URL string

	// Account id of the Power Cloud Service Instance
	// It will be part of the CRN string
	// Required
	UserAccount string

	// Zone of the Power Cloud Service Instance
	// It will be part of the CRN string
	// Required
	Zone string
}

PIOptions

type IBMPISession

type IBMPISession struct {
	CRNFormat string
	Power     *client.PowerIaasAPI
	Options   *IBMPIOptions
}

IBMPISession ...

func NewIBMPISession

func NewIBMPISession(o *IBMPIOptions) (*IBMPISession, error)

Create a IBMPISession

func (*IBMPISession) AuthInfo

func (s *IBMPISession) AuthInfo(cloudInstanceID string) runtime.ClientAuthInfoWriter

authInfo ...

func (*IBMPISession) IsOnPrem

func (s *IBMPISession) IsOnPrem() bool

IsOnPrem returns true if the operation is being done on premise (at a satellite region)