common

Documentation

Index

• Constants
• func GetComponentInfo() *core.ProblemComponent
• func GetSdkHeaders(serviceName string, serviceVersion string, operationId string) map[string]string
• func GetSystemInfo() string
• func GetUserAgentInfo() string
• func ToJSON(obj interface{}) string

Constants

const Version = "0.72.0"

Version of the SDK

Functions

func GetComponentInfo

func GetComponentInfo() *core.ProblemComponent

func GetSdkHeaders

func GetSdkHeaders(serviceName string, serviceVersion string, operationId string) map[string]string

GetSdkHeaders - returns the set of SDK-specific headers to be included in an outgoing request.

This function is invoked by generated service methods (i.e. methods which implement the REST API operations defined within the API definition). The purpose of this function is to give the SDK implementor the opportunity to provide SDK-specific HTTP headers that will be sent with an outgoing REST API request. This function is invoked for each invocation of a generated service method, so the set of HTTP headers could be request-specific. As an optimization, if your SDK will be returning the same set of HTTP headers for each invocation of this function, it is recommended that you initialize the returned map just once (perhaps by using lazy initialization) and simply return it each time the function is invoked, instead of building it each time as in the example below.

Parameters:

serviceName - the name of the service as defined in the API definition (e.g. "MyService1")
serviceVersion - the version of the service as defined in the API definition (e.g. "V1")
operationId - the operationId as defined in the API definition (e.g. getContext)

Returns:

a Map which contains the set of headers to be included in the REST API request

func GetSystemInfo

func GetSystemInfo() string

func GetUserAgentInfo

func GetUserAgentInfo() string

func ToJSON

func ToJSON(obj interface{}) string

ToJSON marshals the specified object and returns the resulting JSON string