...

Package unannotatedecho

import "github.com/grpc-ecosystem/grpc-gateway/v2/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 ExamplepbNumericEnum
type ExamplepbUnannotatedEmbedded
type ExamplepbUnannotatedNestedMessage
type ExamplepbUnannotatedSimpleMessage
type GenericSwaggerError
    func (e GenericSwaggerError) Body() []byte
    func (e GenericSwaggerError) Error() string
    func (e GenericSwaggerError) Model() interface{}
type ProtobufAny
type RpcStatus
type UnannotatedEchoServiceApiService
    func (a *UnannotatedEchoServiceApiService) UnannotatedEchoServiceEcho(ctx context.Context, id string, num string, localVarOptionals *UnannotatedEchoServiceEchoOpts) (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, num string, localVarOptionals *UnannotatedEchoServiceEchoDeleteOpts) (ExamplepbUnannotatedSimpleMessage, *http.Response, error)
type UnannotatedEchoServiceEcho2Opts
type UnannotatedEchoServiceEchoDeleteOpts
type UnannotatedEchoServiceEchoOpts

Package files

api_unannotated_echo_service.go client.go configuration.go model_examplepb_numeric_enum.go model_examplepb_unannotated_embedded.go model_examplepb_unannotated_nested_message.go model_examplepb_unannotated_simple_message.go model_protobuf_any.go model_rpc_status.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 Unannotated Echo API v1.0 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 ExamplepbNumericEnum

ExamplepbNumericEnum : NumericEnum is one or zero. - ZERO: ZERO means 0 - ONE: ONE means 1

type ExamplepbNumericEnum string

List of examplepbNumericEnum

const (
    ZERO_ExamplepbNumericEnum ExamplepbNumericEnum = "ZERO"
    ONE_ExamplepbNumericEnum  ExamplepbNumericEnum = "ONE"
)

type ExamplepbUnannotatedEmbedded

Embedded represents a message embedded in SimpleMessage.

type ExamplepbUnannotatedEmbedded struct {
    Progress string `json:"progress,omitempty"`
    Note     string `json:"note,omitempty"`
}

type ExamplepbUnannotatedNestedMessage

type ExamplepbUnannotatedNestedMessage struct {
    NId string `json:"nId,omitempty"`
    Val string `json:"val,omitempty"`
}

type ExamplepbUnannotatedSimpleMessage

A simple message with many types

type ExamplepbUnannotatedSimpleMessage struct {
    // Id represents the message identifier.
    Id string `json:"id"`
    // Int value field
    Num        string                             `json:"num"`
    Duration   string                             `json:"duration,omitempty"`
    LineNum    string                             `json:"lineNum,omitempty"`
    Lang       string                             `json:"lang,omitempty"`
    Status     *ExamplepbUnannotatedEmbedded      `json:"status,omitempty"`
    En         string                             `json:"en,omitempty"`
    No         *ExamplepbUnannotatedEmbedded      `json:"no,omitempty"`
    ResourceId string                             `json:"resourceId,omitempty"`
    NId        *ExamplepbUnannotatedNestedMessage `json:"nId,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

type ProtobufAny struct {
    Type_ string `json:"@type,omitempty"`
}

type RpcStatus

type RpcStatus struct {
    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, num string, localVarOptionals *UnannotatedEchoServiceEchoOpts) (ExamplepbUnannotatedSimpleMessage, *http.Response, error)

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, num string, localVarOptionals *UnannotatedEchoServiceEchoDeleteOpts) (ExamplepbUnannotatedSimpleMessage, *http.Response, error)

type UnannotatedEchoServiceEcho2Opts

type UnannotatedEchoServiceEcho2Opts struct {
    Duration       optional.String
    LineNum        optional.String
    Lang           optional.String
    StatusProgress optional.String
    StatusNote     optional.String
    En             optional.String
    NoProgress     optional.String
    NoNote         optional.String
    ResourceId     optional.String
    NIdNId         optional.String
    NIdVal         optional.String
}

type UnannotatedEchoServiceEchoDeleteOpts

type UnannotatedEchoServiceEchoDeleteOpts struct {
    Id             optional.String
    Duration       optional.String
    LineNum        optional.String
    Lang           optional.String
    StatusProgress optional.String
    StatusNote     optional.String
    En             optional.String
    NoProgress     optional.String
    NoNote         optional.String
    ResourceId     optional.String
    NIdNId         optional.String
    NIdVal         optional.String
}

type UnannotatedEchoServiceEchoOpts

type UnannotatedEchoServiceEchoOpts struct {
    Duration       optional.String
    LineNum        optional.String
    Lang           optional.String
    StatusProgress optional.String
    StatusNote     optional.String
    En             optional.String
    NoProgress     optional.String
    NoNote         optional.String
    ResourceId     optional.String
    NIdNId         optional.String
    NIdVal         optional.String
}