echo

package
v2.0.0-...-253fdba Latest Latest
Warning

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

 Go to latest Published: Feb 3, 2024 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 {
	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 

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 EchoServiceApiService 

type EchoServiceApiService service

func (*EchoServiceApiService) EchoServiceEcho 

func (a *EchoServiceApiService) EchoServiceEcho(ctx context.Context, id string, localVarOptionals *EchoServiceEchoOpts) (ExamplepbSimpleMessage, *http.Response, error)

func (*EchoServiceApiService) EchoServiceEcho2 

func (a *EchoServiceApiService) EchoServiceEcho2(ctx context.Context, id string, num string, localVarOptionals *EchoServiceEcho2Opts) (ExamplepbSimpleMessage, *http.Response, error)

func (*EchoServiceApiService) EchoServiceEcho3 

func (a *EchoServiceApiService) EchoServiceEcho3(ctx context.Context, id string, num string, lang string, localVarOptionals *EchoServiceEcho3Opts) (ExamplepbSimpleMessage, *http.Response, error)

func (*EchoServiceApiService) EchoServiceEcho4 

func (a *EchoServiceApiService) EchoServiceEcho4(ctx context.Context, id string, lineNum string, statusNote string, localVarOptionals *EchoServiceEcho4Opts) (ExamplepbSimpleMessage, *http.Response, error)

func (*EchoServiceApiService) EchoServiceEcho5 

func (a *EchoServiceApiService) EchoServiceEcho5(ctx context.Context, noNote string, localVarOptionals *EchoServiceEcho5Opts) (ExamplepbSimpleMessage, *http.Response, error)

func (*EchoServiceApiService) EchoServiceEchoBody 

func (a *EchoServiceApiService) EchoServiceEchoBody(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 SimpleMessage represents a simple message sent to the Echo service.

@return ExamplepbSimpleMessage

func (*EchoServiceApiService) EchoServiceEchoBody2 

func (a *EchoServiceApiService) EchoServiceEchoBody2(ctx context.Context, id string, no ExamplepbEmbedded, localVarOptionals *EchoServiceEchoBody2Opts) (ExamplepbSimpleMessage, *http.Response, error)

func (*EchoServiceApiService) EchoServiceEchoDelete 

func (a *EchoServiceApiService) EchoServiceEchoDelete(ctx context.Context, localVarOptionals *EchoServiceEchoDeleteOpts) (ExamplepbSimpleMessage, *http.Response, error)

func (*EchoServiceApiService) EchoServiceEchoPatch 

func (a *EchoServiceApiService) EchoServiceEchoPatch(ctx context.Context, body ExamplepbDynamicMessage) (ExamplepbDynamicMessageUpdate, *http.Response, error)

EchoServiceApiService EchoPatch method receives a NonStandardUpdateRequest and returns it.

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

@return ExamplepbDynamicMessageUpdate

func (*EchoServiceApiService) EchoServiceEchoUnauthorized 

func (a *EchoServiceApiService) EchoServiceEchoUnauthorized(ctx context.Context, localVarOptionals *EchoServiceEchoUnauthorizedOpts) (ExamplepbSimpleMessage, *http.Response, error)

type EchoServiceEcho2Opts 

type EchoServiceEcho2Opts struct {
	LineNum        optional.String
	Lang           optional.String
	StatusProgress optional.String
	StatusNote     optional.String
	En             optional.String
	NoProgress     optional.String
	NoNote         optional.String
}

type EchoServiceEcho3Opts 

type EchoServiceEcho3Opts struct {
	LineNum        optional.String
	StatusProgress optional.String
	StatusNote     optional.String
	En             optional.String
	NoProgress     optional.String
	NoNote         optional.String
}

type EchoServiceEcho4Opts 

type EchoServiceEcho4Opts struct {
	Num            optional.String
	Lang           optional.String
	StatusProgress optional.String
	En             optional.String
	NoProgress     optional.String
}

type EchoServiceEcho5Opts 

type EchoServiceEcho5Opts struct {
	Id             optional.String
	Num            optional.String
	LineNum        optional.String
	Lang           optional.String
	StatusProgress optional.String
	En             optional.String
	NoProgress     optional.String
}

type EchoServiceEchoBody2Opts 

type EchoServiceEchoBody2Opts struct {
	Num            optional.String
	LineNum        optional.String
	Lang           optional.String
	StatusProgress optional.String
	StatusNote     optional.String
}

type EchoServiceEchoDeleteOpts 

type EchoServiceEchoDeleteOpts struct {
	Id             optional.String
	Num            optional.String
	LineNum        optional.String
	Lang           optional.String
	StatusProgress optional.String
	StatusNote     optional.String
	En             optional.String
	NoProgress     optional.String
	NoNote         optional.String
}

type EchoServiceEchoOpts 

type EchoServiceEchoOpts struct {
	Num            optional.String
	LineNum        optional.String
	Lang           optional.String
	StatusProgress optional.String
	StatusNote     optional.String
	En             optional.String
	NoProgress     optional.String
	NoNote         optional.String
}

type EchoServiceEchoUnauthorizedOpts 

type EchoServiceEchoUnauthorizedOpts struct {
	Id             optional.String
	Num            optional.String
	LineNum        optional.String
	Lang           optional.String
	StatusProgress optional.String
	StatusNote     optional.String
	En             optional.String
	NoProgress     optional.String
	NoNote         optional.String
}

type ExamplepbDynamicMessage 

type ExamplepbDynamicMessage struct {
	StructField *interface{} `json:"structField,omitempty"`
	ValueField  *interface{} `json:"valueField,omitempty"`
}

DynamicMessage represents a message which can have its structure built dynamically using Struct and Values.

type ExamplepbDynamicMessageUpdate 

type ExamplepbDynamicMessageUpdate struct {
	Body       *ExamplepbDynamicMessage `json:"body,omitempty"`
	UpdateMask string                   `json:"updateMask,omitempty"`
}

type ExamplepbEmbedded 

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:"lineNum,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 

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 {
	// 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.
	Type_ string `json:"@type,omitempty"`
}

`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 := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(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 ProtobufNullValue 

type ProtobufNullValue string

ProtobufNullValue : `NullValue` is a singleton enumeration to represent the null value for the `Value` type union. The JSON representation for `NullValue` is JSON `null`. - NULL_VALUE: Null value. 

const (
	NULL_VALUE_ProtobufNullValue ProtobufNullValue = "NULL_VALUE"
)

List of protobufNullValue

type RpcStatus 

type RpcStatus struct {
	// The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
	Code int32 `json:"code,omitempty"`
	// A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
	Message string `json:"message,omitempty"`
	// A list of messages that carry the error details.  There is a common set of message types for APIs to use.
	Details []ProtobufAny `json:"details,omitempty"`
}

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

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.