Documentation ¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type BasicAuth
- type Configuration
- type ExamplepbRepeatedResponseBodyOut
- type ExamplepbRepeatedResponseBodyOutResponse
- type ExamplepbRepeatedResponseStrings
- type ExamplepbResponseBodyOut
- type ExamplepbResponseBodyOutResponse
- type GenericSwaggerError
- type ResponseBodyServiceApiService
- func (a *ResponseBodyServiceApiService) GetResponseBody(ctx context.Context, data string) (ExamplepbResponseBodyOutResponse, *http.Response, error)
- func (a *ResponseBodyServiceApiService) ListResponseBodies(ctx context.Context, data string) ([]ExamplepbRepeatedResponseBodyOutResponse, *http.Response, error)
- func (a *ResponseBodyServiceApiService) ListResponseStrings(ctx context.Context, data string) ([]string, *http.Response, error)
- type ResponseResponseType
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 ¶
type APIClient struct { ResponseBodyServiceApi *ResponseBodyServiceApiService // contains filtered or unexported fields }
APIClient manages communication with the examples/proto/examplepb/response_body_service.proto 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 ¶
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 ¶
func NewAPIResponse(r *http.Response) *APIResponse
func NewAPIResponseWithError ¶
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 ¶
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 ¶
func NewConfiguration() *Configuration
func (*Configuration) AddDefaultHeader ¶
func (c *Configuration) AddDefaultHeader(key string, value string)
type ExamplepbRepeatedResponseBodyOut ¶ added in v1.7.0
type ExamplepbRepeatedResponseBodyOut struct {
Response []ExamplepbRepeatedResponseBodyOutResponse `json:"response,omitempty"`
}
type ExamplepbRepeatedResponseBodyOutResponse ¶ added in v1.7.0
type ExamplepbRepeatedResponseBodyOutResponse struct { Data string `json:"data,omitempty"` Type_ *ResponseResponseType `json:"type,omitempty"` }
type ExamplepbRepeatedResponseStrings ¶ added in v1.7.0
type ExamplepbRepeatedResponseStrings struct {
Values []string `json:"values,omitempty"`
}
type ExamplepbResponseBodyOut ¶
type ExamplepbResponseBodyOut struct {
Response *ExamplepbResponseBodyOutResponse `json:"response,omitempty"`
}
type ExamplepbResponseBodyOutResponse ¶
type ExamplepbResponseBodyOutResponse struct {
Data string `json:"data,omitempty"`
}
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
type ResponseBodyServiceApiService ¶ added in v1.12.3
type ResponseBodyServiceApiService service
func (*ResponseBodyServiceApiService) GetResponseBody ¶ added in v1.12.3
func (a *ResponseBodyServiceApiService) GetResponseBody(ctx context.Context, data string) (ExamplepbResponseBodyOutResponse, *http.Response, error)
ResponseBodyServiceApiService
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param data
@return ExamplepbResponseBodyOutResponse
func (*ResponseBodyServiceApiService) ListResponseBodies ¶ added in v1.12.3
func (a *ResponseBodyServiceApiService) ListResponseBodies(ctx context.Context, data string) ([]ExamplepbRepeatedResponseBodyOutResponse, *http.Response, error)
ResponseBodyServiceApiService
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param data
@return []ExamplepbRepeatedResponseBodyOutResponse
func (*ResponseBodyServiceApiService) ListResponseStrings ¶ added in v1.12.3
func (a *ResponseBodyServiceApiService) ListResponseStrings(ctx context.Context, data string) ([]string, *http.Response, error)
ResponseBodyServiceApiService
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param data
@return []string
type ResponseResponseType ¶ added in v1.7.0
type ResponseResponseType string
const ( UNKNOWN_ResponseResponseType ResponseResponseType = "UNKNOWN" A_ResponseResponseType ResponseResponseType = "A" B_ResponseResponseType ResponseResponseType = "B" )
List of ResponseResponseType
Source Files ¶
- api_response_body_service.go
- client.go
- configuration.go
- model_examplepb_repeated_response_body_out.go
- model_examplepb_repeated_response_body_out_response.go
- model_examplepb_repeated_response_strings.go
- model_examplepb_response_body_out.go
- model_examplepb_response_body_out_response.go
- model_response_response_type.go
- response.go