abe

package
v1.16.5 Latest Latest
Warning

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

 Go to latest Published: Jul 5, 2021 License: BSD-3-Clause Imports: 24 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 ABitOfEverythingNested 

type ABitOfEverythingNested struct {
	// name is nested field.
	Name   string `json:"name,omitempty"`
	Amount int64  `json:"amount,omitempty"`
	// DeepEnum description.
	Ok *NestedDeepEnum `json:"ok,omitempty"`
}

Nested is nested type.

type ABitOfEverythingServiceApiService 

type ABitOfEverythingServiceApiService service

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceCheckExternalNestedPathEnum 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceCheckExternalNestedPathEnum(ctx context.Context, value string) (interface{}, *http.Response, error)

ABitOfEverythingServiceApiService

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

@return interface{}

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceCheckGetQueryParams 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceCheckGetQueryParams(ctx context.Context, singleNestedName string, floatValue float32, localVarOptionals *ABitOfEverythingServiceCheckGetQueryParamsOpts) (ExamplepbABitOfEverything, *http.Response, error)

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceCheckNestedEnumGetQueryParams 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceCheckNestedEnumGetQueryParams(ctx context.Context, singleNestedOk string, floatValue float32, localVarOptionals *ABitOfEverythingServiceCheckNestedEnumGetQueryParamsOpts) (ExamplepbABitOfEverything, *http.Response, error)

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceCheckPostQueryParams 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceCheckPostQueryParams(ctx context.Context, stringValue string, body ABitOfEverythingNested, floatValue float32, localVarOptionals *ABitOfEverythingServiceCheckPostQueryParamsOpts) (ExamplepbABitOfEverything, *http.Response, error)

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceCreate 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceCreate(ctx context.Context, floatValue float32, doubleValue float64, int64Value string, uint64Value string, int32Value int32, fixed64Value string, fixed32Value int64, boolValue bool, stringValue string, uint32Value int64, sfixed32Value int32, sfixed64Value string, sint32Value int32, sint64Value string, nonConventionalNameValue string, enumValue string, pathEnumValue string, nestedPathEnumValue string, enumValueAnnotation string) (ExamplepbABitOfEverything, *http.Response, error)

ABitOfEverythingServiceApiService Create a new ABitOfEverything This API creates a new ABitOfEverything

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param floatValue Float value field
  • @param doubleValue
  • @param int64Value
  • @param uint64Value
  • @param int32Value
  • @param fixed64Value
  • @param fixed32Value
  • @param boolValue
  • @param stringValue
  • @param uint32Value
  • @param sfixed32Value
  • @param sfixed64Value
  • @param sint32Value
  • @param sint64Value
  • @param nonConventionalNameValue
  • @param enumValue
  • @param pathEnumValue
  • @param nestedPathEnumValue
  • @param enumValueAnnotation Numeric enum description.

@return ExamplepbABitOfEverything

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceCreateBody 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceCreateBody(ctx context.Context, body ExamplepbABitOfEverything) (ExamplepbABitOfEverything, *http.Response, error)

ABitOfEverythingServiceApiService

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

@return ExamplepbABitOfEverything

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceCreateBook 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceCreateBook(ctx context.Context, parent string, body ExamplepbBook, localVarOptionals *ABitOfEverythingServiceCreateBookOpts) (ExamplepbBook, *http.Response, error)

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceDeepPathEcho 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceDeepPathEcho(ctx context.Context, singleNestedName string, body ExamplepbABitOfEverything) (ExamplepbABitOfEverything, *http.Response, error)

ABitOfEverythingServiceApiService

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

@return ExamplepbABitOfEverything

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceDelete 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceDelete(ctx context.Context, uuid string) (interface{}, *http.Response, error)

ABitOfEverythingServiceApiService

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

@return interface{}

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceErrorWithDetails 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceErrorWithDetails(ctx context.Context) (interface{}, *http.Response, error)

ABitOfEverythingServiceApiService

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

@return interface{}

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceGetMessageWithBody 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceGetMessageWithBody(ctx context.Context, id string, body ExamplepbBody) (interface{}, *http.Response, error)

ABitOfEverythingServiceApiService

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

@return interface{}

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceGetQuery 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceGetQuery(ctx context.Context, uuid string, floatValue float32, localVarOptionals *ABitOfEverythingServiceGetQueryOpts) (interface{}, *http.Response, error)

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceGetRepeatedQuery 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceGetRepeatedQuery(ctx context.Context, pathRepeatedFloatValue []float32, pathRepeatedDoubleValue []float64, pathRepeatedInt64Value []string, pathRepeatedUint64Value []string, pathRepeatedInt32Value []int32, pathRepeatedFixed64Value []string, pathRepeatedFixed32Value []int64, pathRepeatedBoolValue []bool, pathRepeatedStringValue []string, pathRepeatedBytesValue []string, pathRepeatedUint32Value []int64, pathRepeatedEnumValue []string, pathRepeatedSfixed32Value []int32, pathRepeatedSfixed64Value []string, pathRepeatedSint32Value []int32, pathRepeatedSint64Value []string) (ExamplepbABitOfEverythingRepeated, *http.Response, error)

ABitOfEverythingServiceApiService

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param pathRepeatedFloatValue repeated values. they are comma-separated in path
  • @param pathRepeatedDoubleValue
  • @param pathRepeatedInt64Value
  • @param pathRepeatedUint64Value
  • @param pathRepeatedInt32Value
  • @param pathRepeatedFixed64Value
  • @param pathRepeatedFixed32Value
  • @param pathRepeatedBoolValue
  • @param pathRepeatedStringValue
  • @param pathRepeatedBytesValue
  • @param pathRepeatedUint32Value
  • @param pathRepeatedEnumValue
  • @param pathRepeatedSfixed32Value
  • @param pathRepeatedSfixed64Value
  • @param pathRepeatedSint32Value
  • @param pathRepeatedSint64Value

@return ExamplepbABitOfEverythingRepeated

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceLookup 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceLookup(ctx context.Context, uuid string) (ExamplepbABitOfEverything, *http.Response, error)

ABitOfEverythingServiceApiService

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

@return ExamplepbABitOfEverything

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceOverwriteResponseContentType 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceOverwriteResponseContentType(ctx context.Context) (string, *http.Response, error)

ABitOfEverythingServiceApiService

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

@return string

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServicePostWithEmptyBody 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServicePostWithEmptyBody(ctx context.Context, name string, body ExamplepbBody) (interface{}, *http.Response, error)

ABitOfEverythingServiceApiService

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

@return interface{}

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceTimeout 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceTimeout(ctx context.Context) (interface{}, *http.Response, error)

ABitOfEverythingServiceApiService

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

@return interface{}

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceUpdate 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceUpdate(ctx context.Context, uuid string, body ExamplepbABitOfEverything) (interface{}, *http.Response, error)

ABitOfEverythingServiceApiService

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

@return interface{}

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceUpdateV2 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceUpdateV2(ctx context.Context, abeUuid string, body ExamplepbABitOfEverything, localVarOptionals *ABitOfEverythingServiceUpdateV2Opts) (interface{}, *http.Response, error)

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceUpdateV22 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceUpdateV22(ctx context.Context, abeUuid string, body ExamplepbABitOfEverything, localVarOptionals *ABitOfEverythingServiceUpdateV22Opts) (interface{}, *http.Response, error)

func (*ABitOfEverythingServiceApiService) ABitOfEverythingServiceUpdateV23 

func (a *ABitOfEverythingServiceApiService) ABitOfEverythingServiceUpdateV23(ctx context.Context, abeUuid string, body ExamplepbUpdateV2Request) (interface{}, *http.Response, error)

ABitOfEverythingServiceApiService

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

@return interface{}

type ABitOfEverythingServiceCheckGetQueryParamsOpts 

type ABitOfEverythingServiceCheckGetQueryParamsOpts struct {
	SingleNestedAmount       optional.Int64
	SingleNestedOk           optional.String
	Uuid                     optional.String
	DoubleValue              optional.Float64
	Int64Value               optional.String
	Uint64Value              optional.String
	Int32Value               optional.Int32
	Fixed64Value             optional.String
	Fixed32Value             optional.Int64
	BoolValue                optional.Bool
	StringValue              optional.String
	BytesValue               optional.String
	Uint32Value              optional.Int64
	EnumValue                optional.String
	PathEnumValue            optional.String
	NestedPathEnumValue      optional.String
	Sfixed32Value            optional.Int32
	Sfixed64Value            optional.String
	Sint32Value              optional.Int32
	Sint64Value              optional.String
	RepeatedStringValue      optional.Interface
	OneofString              optional.String
	NonConventionalNameValue optional.String
	TimestampValue           optional.Time
	RepeatedEnumValue        optional.Interface
	RepeatedEnumAnnotation   optional.Interface
	EnumValueAnnotation      optional.String
	RepeatedStringAnnotation optional.Interface
	NestedAnnotationAmount   optional.Int64
	NestedAnnotationOk       optional.String
	Int64OverrideType        optional.Int64
}

type ABitOfEverythingServiceCheckNestedEnumGetQueryParamsOpts 

type ABitOfEverythingServiceCheckNestedEnumGetQueryParamsOpts struct {
	SingleNestedName         optional.String
	SingleNestedAmount       optional.Int64
	Uuid                     optional.String
	DoubleValue              optional.Float64
	Int64Value               optional.String
	Uint64Value              optional.String
	Int32Value               optional.Int32
	Fixed64Value             optional.String
	Fixed32Value             optional.Int64
	BoolValue                optional.Bool
	StringValue              optional.String
	BytesValue               optional.String
	Uint32Value              optional.Int64
	EnumValue                optional.String
	PathEnumValue            optional.String
	NestedPathEnumValue      optional.String
	Sfixed32Value            optional.Int32
	Sfixed64Value            optional.String
	Sint32Value              optional.Int32
	Sint64Value              optional.String
	RepeatedStringValue      optional.Interface
	OneofString              optional.String
	NonConventionalNameValue optional.String
	TimestampValue           optional.Time
	RepeatedEnumValue        optional.Interface
	RepeatedEnumAnnotation   optional.Interface
	EnumValueAnnotation      optional.String
	RepeatedStringAnnotation optional.Interface
	NestedAnnotationName     optional.String
	NestedAnnotationAmount   optional.Int64
	Int64OverrideType        optional.Int64
}

type ABitOfEverythingServiceCheckPostQueryParamsOpts 

type ABitOfEverythingServiceCheckPostQueryParamsOpts struct {
	Uuid                     optional.String
	DoubleValue              optional.Float64
	Int64Value               optional.String
	Uint64Value              optional.String
	Int32Value               optional.Int32
	Fixed64Value             optional.String
	Fixed32Value             optional.Int64
	BoolValue                optional.Bool
	BytesValue               optional.String
	Uint32Value              optional.Int64
	EnumValue                optional.String
	PathEnumValue            optional.String
	NestedPathEnumValue      optional.String
	Sfixed32Value            optional.Int32
	Sfixed64Value            optional.String
	Sint32Value              optional.Int32
	Sint64Value              optional.String
	RepeatedStringValue      optional.Interface
	OneofString              optional.String
	NonConventionalNameValue optional.String
	TimestampValue           optional.Time
	RepeatedEnumValue        optional.Interface
	RepeatedEnumAnnotation   optional.Interface
	EnumValueAnnotation      optional.String
	RepeatedStringAnnotation optional.Interface
	NestedAnnotationName     optional.String
	NestedAnnotationAmount   optional.Int64
	NestedAnnotationOk       optional.String
	Int64OverrideType        optional.Int64
}

type ABitOfEverythingServiceCreateBookOpts 

type ABitOfEverythingServiceCreateBookOpts struct {
	BookId optional.String
}

type ABitOfEverythingServiceEcho3Opts 

type ABitOfEverythingServiceEcho3Opts struct {
	Value optional.String
}

type ABitOfEverythingServiceGetQueryOpts 

type ABitOfEverythingServiceGetQueryOpts struct {
	SingleNestedName         optional.String
	SingleNestedAmount       optional.Int64
	SingleNestedOk           optional.String
	DoubleValue              optional.Float64
	Int64Value               optional.String
	Uint64Value              optional.String
	Int32Value               optional.Int32
	Fixed64Value             optional.String
	Fixed32Value             optional.Int64
	BoolValue                optional.Bool
	StringValue              optional.String
	BytesValue               optional.String
	Uint32Value              optional.Int64
	EnumValue                optional.String
	PathEnumValue            optional.String
	NestedPathEnumValue      optional.String
	Sfixed32Value            optional.Int32
	Sfixed64Value            optional.String
	Sint32Value              optional.Int32
	Sint64Value              optional.String
	RepeatedStringValue      optional.Interface
	OneofString              optional.String
	NonConventionalNameValue optional.String
	TimestampValue           optional.Time
	RepeatedEnumValue        optional.Interface
	RepeatedEnumAnnotation   optional.Interface
	EnumValueAnnotation      optional.String
	RepeatedStringAnnotation optional.Interface
	NestedAnnotationName     optional.String
	NestedAnnotationAmount   optional.Int64
	NestedAnnotationOk       optional.String
	Int64OverrideType        optional.Int64
}

type ABitOfEverythingServiceUpdateV22Opts 

type ABitOfEverythingServiceUpdateV22Opts struct {
	UpdateMaskPaths optional.Interface
}

type ABitOfEverythingServiceUpdateV2Opts 

type ABitOfEverythingServiceUpdateV2Opts struct {
	UpdateMaskPaths optional.Interface
}

type APIClient 

type APIClient struct {
	ABitOfEverythingServiceApi *ABitOfEverythingServiceApiService

	CamelCaseServiceNameApi *CamelCaseServiceNameApiService

	EchoRpcApi *EchoRpcApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the A Bit of Everything 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 CamelCaseServiceNameApiService 

type CamelCaseServiceNameApiService service

func (*CamelCaseServiceNameApiService) CamelCaseServiceNameEmpty 

func (a *CamelCaseServiceNameApiService) CamelCaseServiceNameEmpty(ctx context.Context) (interface{}, *http.Response, error)

CamelCaseServiceNameApiService

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

@return interface{}

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 EchoRpcApiService 

type EchoRpcApiService service

func (*EchoRpcApiService) ABitOfEverythingServiceEcho 

func (a *EchoRpcApiService) ABitOfEverythingServiceEcho(ctx context.Context, value string) (SubStringMessage, *http.Response, error)

EchoRpcApiService Summary: Echo rpc Description Echo

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

@return SubStringMessage

func (*EchoRpcApiService) ABitOfEverythingServiceEcho2 

func (a *EchoRpcApiService) ABitOfEverythingServiceEcho2(ctx context.Context, body string) (SubStringMessage, *http.Response, error)

EchoRpcApiService Summary: Echo rpc Description Echo

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

@return SubStringMessage

func (*EchoRpcApiService) ABitOfEverythingServiceEcho3 

func (a *EchoRpcApiService) ABitOfEverythingServiceEcho3(ctx context.Context, localVarOptionals *ABitOfEverythingServiceEcho3Opts) (SubStringMessage, *http.Response, error)

type ExamplepbABitOfEverything 

type ExamplepbABitOfEverything struct {
	SingleNested *ABitOfEverythingNested  `json:"single_nested,omitempty"`
	Uuid         string                   `json:"uuid"`
	Nested       []ABitOfEverythingNested `json:"nested,omitempty"`
	// Float value field
	FloatValue               float32                           `json:"float_value,omitempty"`
	DoubleValue              float64                           `json:"double_value"`
	Int64Value               string                            `json:"int64_value"`
	Uint64Value              string                            `json:"uint64_value,omitempty"`
	Int32Value               int32                             `json:"int32_value,omitempty"`
	Fixed64Value             string                            `json:"fixed64_value,omitempty"`
	Fixed32Value             int64                             `json:"fixed32_value,omitempty"`
	BoolValue                bool                              `json:"bool_value,omitempty"`
	StringValue              string                            `json:"string_value,omitempty"`
	BytesValue               string                            `json:"bytes_value,omitempty"`
	Uint32Value              int64                             `json:"uint32_value,omitempty"`
	EnumValue                *ExamplepbNumericEnum             `json:"enum_value,omitempty"`
	PathEnumValue            *PathenumPathEnum                 `json:"path_enum_value,omitempty"`
	NestedPathEnumValue      *MessagePathEnumNestedPathEnum    `json:"nested_path_enum_value,omitempty"`
	Sfixed32Value            int32                             `json:"sfixed32_value,omitempty"`
	Sfixed64Value            string                            `json:"sfixed64_value,omitempty"`
	Sint32Value              int32                             `json:"sint32_value,omitempty"`
	Sint64Value              string                            `json:"sint64_value,omitempty"`
	RepeatedStringValue      []string                          `json:"repeated_string_value,omitempty"`
	OneofEmpty               *interface{}                      `json:"oneof_empty,omitempty"`
	OneofString              string                            `json:"oneof_string,omitempty"`
	MapValue                 map[string]ExamplepbNumericEnum   `json:"map_value,omitempty"`
	MappedStringValue        map[string]string                 `json:"mapped_string_value,omitempty"`
	MappedNestedValue        map[string]ABitOfEverythingNested `json:"mapped_nested_value,omitempty"`
	NonConventionalNameValue string                            `json:"nonConventionalNameValue,omitempty"`
	TimestampValue           time.Time                         `json:"timestamp_value,omitempty"`
	RepeatedEnumValue        []ExamplepbNumericEnum            `json:"repeated_enum_value,omitempty"`
	// Repeated numeric enum description.
	RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeated_enum_annotation,omitempty"`
	// Numeric enum description.
	EnumValueAnnotation *ExamplepbNumericEnum `json:"enum_value_annotation,omitempty"`
	// Repeated string description.
	RepeatedStringAnnotation []string `json:"repeated_string_annotation,omitempty"`
	// Repeated nested object description.
	RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeated_nested_annotation,omitempty"`
	// Nested object description.
	NestedAnnotation  *ABitOfEverythingNested `json:"nested_annotation,omitempty"`
	Int64OverrideType int64                   `json:"int64_override_type,omitempty"`
}

Intentionaly complicated message type to cover many features of Protobuf.

type ExamplepbABitOfEverythingRepeated 

type ExamplepbABitOfEverythingRepeated struct {
	PathRepeatedFloatValue    []float32              `json:"path_repeated_float_value,omitempty"`
	PathRepeatedDoubleValue   []float64              `json:"path_repeated_double_value,omitempty"`
	PathRepeatedInt64Value    []string               `json:"path_repeated_int64_value,omitempty"`
	PathRepeatedUint64Value   []string               `json:"path_repeated_uint64_value,omitempty"`
	PathRepeatedInt32Value    []int32                `json:"path_repeated_int32_value,omitempty"`
	PathRepeatedFixed64Value  []string               `json:"path_repeated_fixed64_value,omitempty"`
	PathRepeatedFixed32Value  []int64                `json:"path_repeated_fixed32_value,omitempty"`
	PathRepeatedBoolValue     []bool                 `json:"path_repeated_bool_value,omitempty"`
	PathRepeatedStringValue   []string               `json:"path_repeated_string_value,omitempty"`
	PathRepeatedBytesValue    []string               `json:"path_repeated_bytes_value,omitempty"`
	PathRepeatedUint32Value   []int64                `json:"path_repeated_uint32_value,omitempty"`
	PathRepeatedEnumValue     []ExamplepbNumericEnum `json:"path_repeated_enum_value,omitempty"`
	PathRepeatedSfixed32Value []int32                `json:"path_repeated_sfixed32_value,omitempty"`
	PathRepeatedSfixed64Value []string               `json:"path_repeated_sfixed64_value,omitempty"`
	PathRepeatedSint32Value   []int32                `json:"path_repeated_sint32_value,omitempty"`
	PathRepeatedSint64Value   []string               `json:"path_repeated_sint64_value,omitempty"`
}

type ExamplepbBody 

type ExamplepbBody struct {
	Name string `json:"name,omitempty"`
}

type ExamplepbBook 

type ExamplepbBook struct {
	// The resource name of the book.  Format: `publishers/{publisher}/books/{book}`  Example: `publishers/1257894000000000000/books/my-book`
	Name string `json:"name,omitempty"`
	// Output only. The book's ID.
	Id string `json:"id,omitempty"`
	// Output only. Creation time of the book.
	CreateTime time.Time `json:"create_time,omitempty"`
}

An example resource type from AIP-123 used to test the behavior described in the CreateBookRequest message. See: https://google.aip.dev/123

type ExamplepbErrorObject 

type ExamplepbErrorObject struct {
	// Response code
	Code int32 `json:"code,omitempty"`
	// Response message
	Message string `json:"message,omitempty"`
}

type ExamplepbErrorResponse 

type ExamplepbErrorResponse struct {
	// Unique event identifier for server requests
	CorrelationId string                `json:"correlationId,omitempty"`
	Error_        *ExamplepbErrorObject `json:"error,omitempty"`
}

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

func (ExamplepbNumericEnum) String 

func (e ExamplepbNumericEnum) String() string

String returns a string representation of "NumericEnum"

func (ExamplepbNumericEnum) UnmarshalJSON 

func (e ExamplepbNumericEnum) UnmarshalJSON(b []byte) error

UnmarshalJSON does a no-op unmarshal to ExamplepbNumericEnum. It just validates that the input is sane.

type ExamplepbUpdateV2Request 

type ExamplepbUpdateV2Request struct {
	Abe        *ExamplepbABitOfEverything `json:"abe,omitempty"`
	UpdateMask *ProtobufFieldMask         `json:"update_mask,omitempty"`
}

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 MessagePathEnumNestedPathEnum 

type MessagePathEnumNestedPathEnum string
const (
	GHI_MessagePathEnumNestedPathEnum MessagePathEnumNestedPathEnum = "GHI"
	JKL_MessagePathEnumNestedPathEnum MessagePathEnumNestedPathEnum = "JKL"
)

List of MessagePathEnumNestedPathEnum

func (MessagePathEnumNestedPathEnum) String 

func (e MessagePathEnumNestedPathEnum) String() string

String returns a string representation of "MessagePathEnum"

func (MessagePathEnumNestedPathEnum) UnmarshalJSON 

func (e MessagePathEnumNestedPathEnum) UnmarshalJSON(b []byte) error

UnmarshalJSON does a no-op unmarshal to MessagePathEnumNestedPathEnum. It just validates that the input is sane.

type NestedDeepEnum 

type NestedDeepEnum string

NestedDeepEnum : DeepEnum is one or zero. - FALSE: FALSE is false. - TRUE: TRUE is true. 

const (
	FALSE_NestedDeepEnum NestedDeepEnum = "FALSE"
	TRUE_NestedDeepEnum  NestedDeepEnum = "TRUE"
)

List of NestedDeepEnum

type PathenumPathEnum 

type PathenumPathEnum string
const (
	ABC_PathenumPathEnum PathenumPathEnum = "ABC"
	DEF_PathenumPathEnum PathenumPathEnum = "DEF"
)

List of pathenumPathEnum

func (PathenumPathEnum) String 

func (e PathenumPathEnum) String() string

String returns a string representation of "PathEnum"

func (PathenumPathEnum) UnmarshalJSON 

func (e PathenumPathEnum) UnmarshalJSON(b []byte) error

UnmarshalJSON does a no-op unmarshal to PathenumPathEnum. It just validates that the input is sane.

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.
	TypeUrl string `json:"type_url,omitempty"`
	// Must be a valid serialized protocol buffer of the above specified type.
	Value string `json:"value,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 := 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 ProtobufFieldMask 

type ProtobufFieldMask struct {
	// The set of field mask paths.
	Paths []string `json:"paths,omitempty"`
}

paths: \"f.a\" paths: \"f.b.d\" Here `f` represents a field in some root message, `a` and `b` fields in the message found in `f`, and `d` a field found in the message in `f.b`. Field masks are used to specify a subset of fields that should be returned by a get operation or modified by an update operation. Field masks also have a custom JSON encoding (see below). # Field Masks in Projections When used in the context of a projection, a response message or sub-message is filtered by the API to only contain those fields as specified in the mask. For example, if the mask in the previous example is applied to a response message as follows: f { a : 22 b { d : 1 x : 2 } y : 13 } z: 8 The result will not contain specific values for fields x,y and z (their value will be set to the default, and omitted in proto text output): f { a : 22 b { d : 1 } } A repeated field is not allowed except at the last position of a paths string. If a FieldMask object is not present in a get operation, the operation applies to all fields (as if a FieldMask of all fields had been specified). Note that a field mask does not necessarily apply to the top-level response message. In case of a REST get operation, the field mask applies directly to the response, but in case of a REST list operation, the mask instead applies to each individual message in the returned resource list. In case of a REST custom method, other definitions may be used. Where the mask applies will be clearly documented together with its declaration in the API. In any case, the effect on the returned resource/resources is required behavior for APIs. # Field Masks in Update Operations A field mask in update operations specifies which fields of the targeted resource are going to be updated. The API is required to only change the values of the fields as specified in the mask and leave the others untouched. If a resource is passed in to describe the updated values, the API ignores the values of all fields not covered by the mask. If a repeated field is specified for an update operation, new values will be appended to the existing repeated field in the target resource. Note that a repeated field is only allowed in the last position of a `paths` string. If a sub-message is specified in the last position of the field mask for an update operation, then new value will be merged into the existing sub-message in the target resource. For example, given the target message: f { b { d: 1 x: 2 } c: [1] } And an update message: f { b { d: 10 } c: [2] } then if the field mask is: paths: [\"f.b\", \"f.c\"] then the result will be: f { b { d: 10 x: 2 } c: [1, 2] } An implementation may provide options to override this default behavior for repeated and message fields. In order to reset a field's value to the default, the field must be in the mask and set to the default value in the provided resource. Hence, in order to reset all fields of a resource, provide a default instance of the resource and set all fields in the mask, or do not provide a mask as described below. If a field mask is not present on update, the operation applies to all fields (as if a field mask of all fields has been specified). Note that in the presence of schema evolution, this may mean that fields the client does not know and has therefore not filled into the request will be reset to their default. If this is unwanted behavior, a specific service may require a client to always specify a field mask, producing an error if not. As with get operations, the location of the resource which describes the updated values in the request message depends on the operation kind. In any case, the effect of the field mask is required to be honored by the API. ## Considerations for HTTP REST The HTTP kind of an update operation which uses a field mask must be set to PATCH instead of PUT in order to satisfy HTTP semantics (PUT must only be used for full updates). # JSON Encoding of Field Masks In JSON, a field mask is encoded as a single string where paths are separated by a comma. Fields name in each path are converted to/from lower-camel naming conventions. As an example, consider the following message declarations: message Profile { User user = 1; Photo photo = 2; } message User { string display_name = 1; string address = 2; } In proto a field mask for `Profile` may look as such: mask { paths: \"user.display_name\" paths: \"photo\" } In JSON, the same mask is represented as below: { mask: \"user.displayName,photo\" } # Field Masks and Oneof Fields Field masks treat fields in oneofs just as regular fields. Consider the following message: message SampleMessage { oneof test_oneof { string name = 4; SubMessage sub_message = 9; } } The field mask can be: mask { paths: \"name\" } Or: mask { paths: \"sub_message\" } Note that oneof type names (\"test_oneof\" in this case) cannot be used in paths. ## Field Mask Verification The implementation of any API method which has a FieldMask type field in the request should verify the included field paths, and return an `INVALID_ARGUMENT` error if any path is unmappable.

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 SubStringMessage 

type SubStringMessage struct {
	Value string `json:"value,omitempty"`
}

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.