Documentation ¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type BasicAuth
- type Configuration
- type Echo2Opts
- type Echo3Opts
- type Echo4Opts
- type Echo5Opts
- type EchoDeleteOpts
- type EchoServiceApiService
- func (a *EchoServiceApiService) Echo(ctx context.Context, id string) (ExamplepbSimpleMessage, *http.Response, error)
- func (a *EchoServiceApiService) Echo2(ctx context.Context, id string, num string, localVarOptionals *Echo2Opts) (ExamplepbSimpleMessage, *http.Response, error)
- func (a *EchoServiceApiService) Echo3(ctx context.Context, id string, num string, lang string, ...) (ExamplepbSimpleMessage, *http.Response, error)
- func (a *EchoServiceApiService) Echo4(ctx context.Context, id string, lineNum string, statusNote string, ...) (ExamplepbSimpleMessage, *http.Response, error)
- func (a *EchoServiceApiService) Echo5(ctx context.Context, noNote string, localVarOptionals *Echo5Opts) (ExamplepbSimpleMessage, *http.Response, error)
- func (a *EchoServiceApiService) EchoBody(ctx context.Context, body ExamplepbSimpleMessage) (ExamplepbSimpleMessage, *http.Response, error)
- func (a *EchoServiceApiService) EchoDelete(ctx context.Context, localVarOptionals *EchoDeleteOpts) (ExamplepbSimpleMessage, *http.Response, error)
- type ExamplepbEmbedded
- type ExamplepbSimpleMessage
- type GenericSwaggerError
Constants ¶
This section is empty.
Variables ¶
var ( // ContextOAuth2 takes a oauth2.TokenSource as authentication for the request. ContextOAuth2 = contextKey("token") // ContextBasicAuth takes BasicAuth as authentication for the request. ContextBasicAuth = contextKey("basic") // ContextAccessToken takes a string oauth2 access token as authentication for the request. ContextAccessToken = contextKey("accesstoken") // ContextAPIKey takes an APIKey as authentication for the request ContextAPIKey = contextKey("apikey") )
Functions ¶
Types ¶
type APIClient ¶ added in v1.3.0
type APIClient struct { EchoServiceApi *EchoServiceApiService // contains filtered or unexported fields }
APIClient manages communication with the Echo Service API vversion not set In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶ added in v1.12.3
func NewAPIClient(cfg *Configuration) *APIClient
NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.
func (*APIClient) ChangeBasePath ¶ added in v1.12.3
Change base path to allow switching to mocks
type APIKey ¶ added in v1.12.3
APIKey provides API key based authentication to a request passed via context using ContextAPIKey
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 BasicAuth ¶ added in v1.12.3
type BasicAuth struct { UserName string `json:"userName,omitempty"` Password string `json:"password,omitempty"` }
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
type Configuration ¶ added in v1.3.0
type Configuration struct { BasePath string `json:"basePath,omitempty"` Host string `json:"host,omitempty"` Scheme string `json:"scheme,omitempty"` DefaultHeader map[string]string `json:"defaultHeader,omitempty"` UserAgent string `json:"userAgent,omitempty"` HTTPClient *http.Client }
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)
type EchoDeleteOpts ¶ added in v1.12.3
type EchoServiceApiService ¶ added in v1.12.3
type EchoServiceApiService service
func (*EchoServiceApiService) Echo ¶ added in v1.12.3
func (a *EchoServiceApiService) Echo(ctx context.Context, id string) (ExamplepbSimpleMessage, *http.Response, error)
EchoServiceApiService Echo method receives a simple message and returns it. The message posted as the id parameter will also be returned.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param id Id represents the message identifier.
@return ExamplepbSimpleMessage
func (*EchoServiceApiService) Echo2 ¶ added in v1.12.3
func (a *EchoServiceApiService) Echo2(ctx context.Context, id string, num string, localVarOptionals *Echo2Opts) (ExamplepbSimpleMessage, *http.Response, error)
func (*EchoServiceApiService) Echo5 ¶ added in v1.12.3
func (a *EchoServiceApiService) Echo5(ctx context.Context, noNote string, localVarOptionals *Echo5Opts) (ExamplepbSimpleMessage, *http.Response, error)
func (*EchoServiceApiService) EchoBody ¶ added in v1.12.3
func (a *EchoServiceApiService) EchoBody(ctx context.Context, body ExamplepbSimpleMessage) (ExamplepbSimpleMessage, *http.Response, error)
EchoServiceApiService EchoBody method receives a simple message and returns it.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return ExamplepbSimpleMessage
func (*EchoServiceApiService) EchoDelete ¶ added in v1.12.3
func (a *EchoServiceApiService) EchoDelete(ctx context.Context, localVarOptionals *EchoDeleteOpts) (ExamplepbSimpleMessage, *http.Response, error)
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.
type GenericSwaggerError ¶ added in v1.12.3
type GenericSwaggerError struct {
// contains filtered or unexported fields
}
GenericSwaggerError Provides access to the body, error and model on returned errors.
func (GenericSwaggerError) Body ¶ added in v1.12.3
func (e GenericSwaggerError) Body() []byte
Body returns the raw bytes of the response
func (GenericSwaggerError) Error ¶ added in v1.12.3
func (e GenericSwaggerError) Error() string
Error returns non-empty string if there was an error.
func (GenericSwaggerError) Model ¶ added in v1.12.3
func (e GenericSwaggerError) Model() interface{}
Model returns the unpacked model of the error