...

Package unannotatedecho

import "github.com/grpc-ecosystem/grpc-gateway/examples/internal/clients/unannotatedecho"
Overview
Index

Overview ▾

Index ▾

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
    func NewAPIClient(cfg *Configuration) *APIClient
    func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
    func NewAPIResponse(r *http.Response) *APIResponse
    func NewAPIResponseWithError(errorMessage string) *APIResponse
type BasicAuth
type Configuration
    func NewConfiguration() *Configuration
    func (c *Configuration) AddDefaultHeader(key string, value string)
type ExamplepbUnannotatedSimpleMessage
type GenericSwaggerError
    func (e GenericSwaggerError) Body() []byte
    func (e GenericSwaggerError) Error() string
    func (e GenericSwaggerError) Model() interface{}
type ProtobufAny
type RuntimeError
type UnannotatedEchoServiceApiService
    func (a *UnannotatedEchoServiceApiService) UnannotatedEchoServiceEcho(ctx context.Context, id string) (ExamplepbUnannotatedSimpleMessage, *http.Response, error)
    func (a *UnannotatedEchoServiceApiService) UnannotatedEchoServiceEcho2(ctx context.Context, id string, num string, localVarOptionals *UnannotatedEchoServiceEcho2Opts) (ExamplepbUnannotatedSimpleMessage, *http.Response, error)
    func (a *UnannotatedEchoServiceApiService) UnannotatedEchoServiceEchoBody(ctx context.Context, body ExamplepbUnannotatedSimpleMessage) (ExamplepbUnannotatedSimpleMessage, *http.Response, error)
    func (a *UnannotatedEchoServiceApiService) UnannotatedEchoServiceEchoDelete(ctx context.Context, localVarOptionals *UnannotatedEchoServiceEchoDeleteOpts) (ExamplepbUnannotatedSimpleMessage, *http.Response, error)
type UnannotatedEchoServiceEcho2Opts
type UnannotatedEchoServiceEchoDeleteOpts

Package files

api_unannotated_echo_service.go client.go configuration.go model_examplepb_unannotated_simple_message.go model_protobuf_any.go model_runtime_error.go response.go

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")
)

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

type APIClient

APIClient manages communication with the examples/internal/proto/examplepb/unannotated_echo_service.proto API vversion not set In most cases there should be only one, shared, APIClient.

type APIClient struct {
    UnannotatedEchoServiceApi *UnannotatedEchoServiceApiService
    // contains filtered or unexported fields
}

func NewAPIClient

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

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIKey struct {
    Key    string
    Prefix string
}

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

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BasicAuth struct {
    UserName string `json:"userName,omitempty"`
    Password string `json:"password,omitempty"`
}

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 ExamplepbUnannotatedSimpleMessage

UnannotatedSimpleMessage represents a simple message sent to the unannotated Echo service.

type ExamplepbUnannotatedSimpleMessage struct {
    // Id represents the message identifier.
    Id       string `json:"id,omitempty"`
    Num      string `json:"num,omitempty"`
    Duration string `json:"duration,omitempty"`
}

type GenericSwaggerError

GenericSwaggerError Provides access to the body, error and model on returned errors.

type GenericSwaggerError struct {
    // contains filtered or unexported fields
}

func (GenericSwaggerError) Body

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type ProtobufAny

`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example \"foo.bar.com/x/y.z\" will yield type name \"y.z\". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { \"@type\": \"type.googleapis.com/google.profile.Person\", \"firstName\": <string>, \"lastName\": <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { \"@type\": \"type.googleapis.com/google.protobuf.Duration\", \"value\": \"1.212s\" }

type ProtobufAny struct {
    // A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted).  In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:  * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][]   value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the   URL, or have them precompiled into a binary to avoid any   lookup. Therefore, binary compatibility needs to be preserved   on changes to types. (Use versioned type names to manage   breaking changes.)  Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.  Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
    TypeUrl string `json:"type_url,omitempty"`
    // Must be a valid serialized protocol buffer of the above specified type.
    Value string `json:"value,omitempty"`
}

type RuntimeError

type RuntimeError struct {
    Error_  string        `json:"error,omitempty"`
    Code    int32         `json:"code,omitempty"`
    Message string        `json:"message,omitempty"`
    Details []ProtobufAny `json:"details,omitempty"`
}

type UnannotatedEchoServiceApiService

type UnannotatedEchoServiceApiService service

func (*UnannotatedEchoServiceApiService) UnannotatedEchoServiceEcho

func (a *UnannotatedEchoServiceApiService) UnannotatedEchoServiceEcho(ctx context.Context, id string) (ExamplepbUnannotatedSimpleMessage, *http.Response, error)

UnannotatedEchoServiceApiService Echo method receives a simple message and returns it. The message posted as the id parameter will also be returned.

@return ExamplepbUnannotatedSimpleMessage

func (*UnannotatedEchoServiceApiService) UnannotatedEchoServiceEcho2

func (a *UnannotatedEchoServiceApiService) UnannotatedEchoServiceEcho2(ctx context.Context, id string, num string, localVarOptionals *UnannotatedEchoServiceEcho2Opts) (ExamplepbUnannotatedSimpleMessage, *http.Response, error)

func (*UnannotatedEchoServiceApiService) UnannotatedEchoServiceEchoBody

func (a *UnannotatedEchoServiceApiService) UnannotatedEchoServiceEchoBody(ctx context.Context, body ExamplepbUnannotatedSimpleMessage) (ExamplepbUnannotatedSimpleMessage, *http.Response, error)

UnannotatedEchoServiceApiService EchoBody method receives a simple message and returns it.

@return ExamplepbUnannotatedSimpleMessage

func (*UnannotatedEchoServiceApiService) UnannotatedEchoServiceEchoDelete

func (a *UnannotatedEchoServiceApiService) UnannotatedEchoServiceEchoDelete(ctx context.Context, localVarOptionals *UnannotatedEchoServiceEchoDeleteOpts) (ExamplepbUnannotatedSimpleMessage, *http.Response, error)

type UnannotatedEchoServiceEcho2Opts

type UnannotatedEchoServiceEcho2Opts struct {
    Duration optional.String
}

type UnannotatedEchoServiceEchoDeleteOpts

type UnannotatedEchoServiceEchoDeleteOpts struct {
    Id       optional.String
    Num      optional.String
    Duration optional.String
}