Documentation
¶
Index ¶
- type APIClient
- func (c *APIClient) CallAPI(path string, method string, postBody interface{}, ...) (*resty.Response, error)
- func (c *APIClient) ParameterToString(obj interface{}, collectionFormat string) string
- func (c *APIClient) SelectHeaderAccept(accepts []string) string
- func (c *APIClient) SelectHeaderContentType(contentTypes []string) string
- type APIResponse
- type Configuration
- type EchoServiceApi
- func (a EchoServiceApi) Echo(id string) (*ExamplepbSimpleMessage, *APIResponse, error)
- func (a EchoServiceApi) Echo2(id string, num string, lineNum string, lang string, statusProgress string, ...) (*ExamplepbSimpleMessage, *APIResponse, error)
- func (a EchoServiceApi) Echo3(id string, num string, lang string, lineNum string, statusProgress string, ...) (*ExamplepbSimpleMessage, *APIResponse, error)
- func (a EchoServiceApi) Echo4(id string, lineNum string, statusNote string, num string, lang string, ...) (*ExamplepbSimpleMessage, *APIResponse, error)
- func (a EchoServiceApi) Echo5(noNote string, id string, num string, lineNum string, lang string, ...) (*ExamplepbSimpleMessage, *APIResponse, error)
- func (a EchoServiceApi) EchoBody(body ExamplepbSimpleMessage) (*ExamplepbSimpleMessage, *APIResponse, error)
- func (a EchoServiceApi) EchoDelete(id string, num string, lineNum string, lang string, statusProgress string, ...) (*ExamplepbSimpleMessage, *APIResponse, error)
- type ExamplepbEmbedded
- type ExamplepbSimpleMessage
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIClient ¶ added in v1.3.0
type APIClient struct {
// contains filtered or unexported fields
}
func (*APIClient) ParameterToString ¶ added in v1.3.0
func (*APIClient) SelectHeaderAccept ¶ added in v1.3.0
func (*APIClient) SelectHeaderContentType ¶ added in v1.3.0
type APIResponse ¶ added in v1.3.0
type APIResponse struct {
*http.Response `json:"-"`
Message string `json:"message,omitempty"`
// Operation is the name of the swagger operation.
Operation string `json:"operation,omitempty"`
// RequestURL is the request URL. This value is always available, even if the
// embedded *http.Response is nil.
RequestURL string `json:"url,omitempty"`
// Method is the HTTP method used for the request. This value is always
// available, even if the embedded *http.Response is nil.
Method string `json:"method,omitempty"`
// Payload holds the contents of the response body (which may be nil or empty).
// This is provided here as the raw response.Body() reader will have already
// been drained.
Payload []byte `json:"-"`
}
func NewAPIResponse ¶ added in v1.3.0
func NewAPIResponse(r *http.Response) *APIResponse
func NewAPIResponseWithError ¶ added in v1.3.0
func NewAPIResponseWithError(errorMessage string) *APIResponse
type Configuration ¶ added in v1.3.0
type Configuration struct {
Username string `json:"userName,omitempty"`
Password string `json:"password,omitempty"`
APIKeyPrefix map[string]string `json:"APIKeyPrefix,omitempty"`
APIKey map[string]string `json:"APIKey,omitempty"`
Debug bool `json:"debug,omitempty"`
DebugFile string `json:"debugFile,omitempty"`
OAuthToken string `json:"oAuthToken,omitempty"`
BasePath string `json:"basePath,omitempty"`
Host string `json:"host,omitempty"`
Scheme string `json:"scheme,omitempty"`
AccessToken string `json:"accessToken,omitempty"`
DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
UserAgent string `json:"userAgent,omitempty"`
APIClient *APIClient
Transport *http.Transport
Timeout *time.Duration `json:"timeout,omitempty"`
}
func NewConfiguration ¶ added in v1.3.0
func NewConfiguration() *Configuration
func (*Configuration) AddDefaultHeader ¶ added in v1.3.0
func (c *Configuration) AddDefaultHeader(key string, value string)
func (*Configuration) GetAPIKeyWithPrefix ¶ added in v1.3.0
func (c *Configuration) GetAPIKeyWithPrefix(APIKeyIdentifier string) string
func (*Configuration) GetBasicAuthEncodedString ¶ added in v1.3.0
func (c *Configuration) GetBasicAuthEncodedString() string
type EchoServiceApi ¶
type EchoServiceApi struct {
Configuration *Configuration
}
func NewEchoServiceApi ¶
func NewEchoServiceApi() *EchoServiceApi
func NewEchoServiceApiWithBasePath ¶
func NewEchoServiceApiWithBasePath(basePath string) *EchoServiceApi
func (EchoServiceApi) Echo ¶
func (a EchoServiceApi) Echo(id string) (*ExamplepbSimpleMessage, *APIResponse, error)
*
- Echo method receives a simple message and returns it.
- The message posted as the id parameter will also be returned. *
- @param id Id represents the message identifier.
- @return *ExamplepbSimpleMessage
func (EchoServiceApi) Echo2 ¶ added in v1.3.0
func (a EchoServiceApi) Echo2(id string, num string, lineNum string, lang string, statusProgress string, statusNote string, en string, noProgress string, noNote string) (*ExamplepbSimpleMessage, *APIResponse, error)
*
- Echo method receives a simple message and returns it.
- The message posted as the id parameter will also be returned. *
- @param id Id represents the message identifier.
- @param num
- @param lineNum
- @param lang
- @param statusProgress
- @param statusNote
- @param en
- @param noProgress
- @param noNote
- @return *ExamplepbSimpleMessage
func (EchoServiceApi) Echo3 ¶ added in v1.4.0
func (a EchoServiceApi) Echo3(id string, num string, lang string, lineNum string, statusProgress string, statusNote string, en string, noProgress string, noNote string) (*ExamplepbSimpleMessage, *APIResponse, error)
*
- Echo method receives a simple message and returns it.
- The message posted as the id parameter will also be returned. *
- @param id Id represents the message identifier.
- @param num
- @param lang
- @param lineNum
- @param statusProgress
- @param statusNote
- @param en
- @param noProgress
- @param noNote
- @return *ExamplepbSimpleMessage
func (EchoServiceApi) Echo4 ¶ added in v1.4.0
func (a EchoServiceApi) Echo4(id string, lineNum string, statusNote string, num string, lang string, statusProgress string, en string, noProgress string) (*ExamplepbSimpleMessage, *APIResponse, error)
*
- Echo method receives a simple message and returns it.
- The message posted as the id parameter will also be returned. *
- @param id Id represents the message identifier.
- @param lineNum
- @param statusNote
- @param num
- @param lang
- @param statusProgress
- @param en
- @param noProgress
- @return *ExamplepbSimpleMessage
func (EchoServiceApi) Echo5 ¶ added in v1.4.0
func (a EchoServiceApi) Echo5(noNote string, id string, num string, lineNum string, lang string, statusProgress string, en string, noProgress string) (*ExamplepbSimpleMessage, *APIResponse, error)
*
- Echo method receives a simple message and returns it.
- The message posted as the id parameter will also be returned. *
- @param noNote
- @param id Id represents the message identifier.
- @param num
- @param lineNum
- @param lang
- @param statusProgress
- @param en
- @param noProgress
- @return *ExamplepbSimpleMessage
func (EchoServiceApi) EchoBody ¶
func (a EchoServiceApi) EchoBody(body ExamplepbSimpleMessage) (*ExamplepbSimpleMessage, *APIResponse, error)
*
- EchoBody method receives a simple message and returns it. *
- @param body
- @return *ExamplepbSimpleMessage
func (EchoServiceApi) EchoDelete ¶ added in v1.4.0
func (a EchoServiceApi) EchoDelete(id string, num string, lineNum string, lang string, statusProgress string, statusNote string, en string, noProgress string, noNote string) (*ExamplepbSimpleMessage, *APIResponse, error)
*
- EchoDelete method receives a simple message and returns it. *
- @param id Id represents the message identifier.
- @param num
- @param lineNum
- @param lang
- @param statusProgress
- @param statusNote
- @param en
- @param noProgress
- @param noNote
- @return *ExamplepbSimpleMessage
type ExamplepbEmbedded ¶ added in v1.4.0
type ExamplepbEmbedded struct {
Progress string `json:"progress,omitempty"`
Note string `json:"note,omitempty"`
}
Embedded represents a message embedded in SimpleMessage.
type ExamplepbSimpleMessage ¶
type ExamplepbSimpleMessage struct {
// Id represents the message identifier.
Id string `json:"id,omitempty"`
Num string `json:"num,omitempty"`
LineNum string `json:"line_num,omitempty"`
Lang string `json:"lang,omitempty"`
Status ExamplepbEmbedded `json:"status,omitempty"`
En string `json:"en,omitempty"`
No ExamplepbEmbedded `json:"no,omitempty"`
}
SimpleMessage represents a simple message sent to the Echo service.
Click to show internal directories.
Click to hide internal directories.