unannotatedecho

package
v2.27.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 2, 2025 License: BSD-3-Clause Imports: 21 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
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

func CacheExpires 

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

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

Types

type APIClient 

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

APIClient manages communication with the Unannotated Echo API v1.0 In most cases there should be only one, shared, APIClient.

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 

type APIKey struct {
	Key    string
	Prefix string
}

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 

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 ExamplepbNumericEnum 

type ExamplepbNumericEnum string

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

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

List of examplepbNumericEnum

type ExamplepbUnannotatedEmbedded 

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

Embedded represents a message embedded in SimpleMessage.

type ExamplepbUnannotatedNestedMessage added in v2.19.1 

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

type ExamplepbUnannotatedSimpleMessage 

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"`
}

A simple message with many types

type GenericSwaggerError 

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

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

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.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body A simple message with many types

@return ExamplepbUnannotatedSimpleMessage

func (*UnannotatedEchoServiceApiService) UnannotatedEchoServiceEchoDelete 

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

func (*UnannotatedEchoServiceApiService) UnannotatedEchoServiceEchoNested added in v2.27.1 

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

UnannotatedEchoServiceApiService EchoNested 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 A simple message with many types

@return ExamplepbUnannotatedNestedMessage

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 added in v2.7.0 

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
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.