protocol

Mar 1, 2022

Changes in this version

+ var NilQueryParams = fmt.Errorf("go-restli: Query params cannot be nil")

+ func BatchCreateRequest(ctx context.Context, url *url.URL, create []T, ...) (*http.Request, error)

+ func CreateRequest(ctx context.Context, url *url.URL, method RestLiMethod, ...) (*http.Request, error)

+ func DoActionRequest(c *RestLiClient, ctx context.Context, rp ResourcePath, query QueryParams, ...) (err error)

+ func DoActionRequestWithResults(c *RestLiClient, ctx context.Context, rp ResourcePath, query QueryParams, ...) (t T, err error)

+ func DoAndUnmarshal(c *RestLiClient, req *http.Request, ...) (v V, res *http.Response, err error)

+ func IntPointer(v int) *int

+ func NewDeleteRequest(ctx context.Context, url *url.URL, method RestLiMethod) (*http.Request, error)

+ func NewGetRequest(ctx context.Context, url *url.URL, method RestLiMethod) (*http.Request, error)

+ func NewJsonRequest(ctx context.Context, url *url.URL, httpMethod string, ...) (*http.Request, error)

+ type ActionQueryParam string

+ func (a ActionQueryParam) EncodeQueryParams() (string, error)

type BatchEntityUpdateResponse

+ func UnmarshalBatchEntityUpdateResponse(reader restlicodec.Reader) (r *BatchEntityUpdateResponse, err error)

+ type BatchQueryParams interface

+ EncodeQueryParams func(set batchkeyset.BatchKeySet[T]) (string, error)

+ type BatchRequestResponseError map[K]*stdtypes.ErrorResponse

+ func (b BatchRequestResponseError[K]) Error() string

+ type CollectionClient struct

+ BatchKeySetProvider func() batchkeyset.BatchKeySet[K]

+ CreateOnlyFields restlicodec.PathSpec

+ KeyUnmarshaler restlicodec.GenericUnmarshaler[K]

+ ReadOnlyFields restlicodec.PathSpec

+ func (c *CollectionClient[K, V, PV]) BatchCreate(ctx context.Context, rp ResourcePath, entities []V, query QueryParams) (createdEntities []*CreatedEntity[K], err error)

+ func (c *CollectionClient[K, V, PV]) BatchCreateRequest(ctx context.Context, rp ResourcePath, query QueryParams, method RestLiMethod, ...) (*http.Request, error)

+ func (c *CollectionClient[K, V, PV]) BatchCreateWithReturnEntity(ctx context.Context, rp ResourcePath, entities []V, query QueryParams) (createdEntities []*CreatedAndReturnedEntity[K, V], err error)

+ func (c *CollectionClient[K, V, PV]) BatchDelete(ctx context.Context, rp ResourcePath, keys []K, query BatchQueryParams[K]) (map[K]*BatchEntityUpdateResponse, error)

+ func (c *CollectionClient[K, V, PV]) BatchGet(ctx context.Context, rp ResourcePath, keys []K, query BatchQueryParams[K]) (map[K]V, error)

+ func (c *CollectionClient[K, V, PV]) BatchPartialUpdate(ctx context.Context, rp ResourcePath, entities map[K]PV, ...) (map[K]*BatchEntityUpdateResponse, error)

+ func (c *CollectionClient[K, V, PV]) BatchUpdate(ctx context.Context, rp ResourcePath, entities map[K]V, ...) (map[K]*BatchEntityUpdateResponse, error)

+ func (c *CollectionClient[K, V, PV]) Create(ctx context.Context, rp ResourcePath, create V, query QueryParams) (*CreatedEntity[K], error)

+ func (c *CollectionClient[K, V, PV]) CreateWithReturnEntity(ctx context.Context, rp ResourcePath, create V, query QueryParams) (*CreatedAndReturnedEntity[K, V], error)

+ func (c *CollectionClient[K, V, PV]) Find(ctx context.Context, rp ResourcePath, query QueryParams) (*FinderResults[V], error)

+ func (c *CollectionClient[K, V, PV]) NewCreateRequest(ctx context.Context, rp ResourcePath, query QueryParams, method RestLiMethod, ...) (*http.Request, error)

+ type CreatedAndReturnedEntity struct

+ Entity V

+ type CreatedEntity struct

+ Id K

+ Status int

+ type FinderResults struct

+ Results []T

+ Total *int

+ type FinderResultsWithMetadata struct

+ Metadata M

+ func FindWithMetadata(c *CollectionClient[K, V, PV], ctx context.Context, rp ResourcePath, ...) (results *FinderResultsWithMetadata[V, M], err error)

+ type IllegalPartialUpdateError struct

+ Field string

+ Message string

+ RecordType string

+ func (c *IllegalPartialUpdateError) Error() string

+ type PartialUpdateFieldChecker struct

+ HasDeletes bool

+ HasSets bool

+ RecordType string

+ func (c *PartialUpdateFieldChecker) CheckField(writer restlicodec.Writer, fieldName string, isDeleteSet bool, isSetSet bool, ...) error

+ type QueryParams interface

+ EncodeQueryParams func() (string, error)

+ type QueryParamsString string

+ func (q QueryParamsString) EncodeQueryParams() (string, error)

+ type ResourcePath interface

+ ResourcePath func() (path string, err error)

+ RootResource func() string

+ type ResourcePathString string

+ func (s ResourcePathString) ResourcePath() (string, error)

+ func (s ResourcePathString) RootResource() string

+ type SimpleClient struct

+ CreateAndReadOnlyFields restlicodec.PathSpec

+ EntityUnmarshaler restlicodec.GenericUnmarshaler[V]

+ func (c *SimpleClient[V, PV]) Delete(ctx context.Context, rp ResourcePath, query QueryParams) error

+ func (c *SimpleClient[V, PV]) Get(ctx context.Context, rp ResourcePath, query QueryParams) (v V, err error)

+ func (c *SimpleClient[V, PV]) NewDeleteRequest(ctx context.Context, rp ResourcePath, query QueryParams, method RestLiMethod) (*http.Request, error)

+ func (c *SimpleClient[V, PV]) NewGetRequest(ctx context.Context, rp ResourcePath, query QueryParams, method RestLiMethod) (*http.Request, error)

+ func (c *SimpleClient[V, PV]) NewJsonRequest(ctx context.Context, rp ResourcePath, query QueryParams, httpMethod string, ...) (*http.Request, error)

+ func (c *SimpleClient[V, PV]) PartialUpdate(ctx context.Context, rp ResourcePath, patch PV, query QueryParams) error

+ func (c *SimpleClient[V, PV]) Update(ctx context.Context, rp ResourcePath, update V, query QueryParams) error

Feb 1, 2022

Changes in this version

+ const UnknownEnum

+ type Enum int

+ func (e *Enum) ComputeHash() (hash fnv1a.Hash)

+ func (e *Enum) Equals(other *Enum) bool

+ func (e *Enum) IsUnknown() bool

Jan 26, 2022

Changes in this version

+ func BoolPointer(v bool) *bool

+ func BytesPointer(v []byte) *[]byte

+ func Float32Pointer(v float32) *float32

+ func Float64Pointer(v float64) *float64

+ func Int32Pointer(v int32) *int32

+ func Int64Pointer(v int64) *int64

+ func StringPointer(v string) *string

+ type IllegalEnumConstant struct

+ Constant int

+ Enum string

+ func (i *IllegalEnumConstant) Error() string

+ type UnknownEnumValue struct

+ Enum string

+ Value string

+ func (u *UnknownEnumValue) Error() string

+ type UnsupportedRestLiProtocolVersion struct

+ ReturnedVersion string

+ func (u *UnsupportedRestLiProtocolVersion) Error() string

Jan 11, 2022

Changes in this version

+ type BatchEntities map[string]restlicodec.Marshaler

+ func (b BatchEntities) Add(key restlicodec.Marshaler, value restlicodec.Marshaler) (err error)

+ func (b BatchEntities) MarshalRestLi(writer restlicodec.Writer) error

+ type BatchEntityIDsEncoder []restlicodec.WriteCloser

+ func (e *BatchEntityIDsEncoder) AddEntityID() restlicodec.Writer

+ func (e *BatchEntityIDsEncoder) Encode(paramNameWriter func(string) restlicodec.Writer) error

+ func (e *BatchEntityIDsEncoder) GenerateRawQuery() (string, error)

+ type BatchEntityUpdateResponse struct

+ Status int

+ func (b *BatchEntityUpdateResponse) UnmarshalRestLi(reader restlicodec.Reader) error

+ type BatchResultsReader func(keyReader restlicodec.Reader, valueReader restlicodec.Reader) (err error)

type RestLiClient

+ func (c *RestLiClient) DoBatchPartialUpdateRequest(ctx context.Context, url *url.URL, entities BatchEntities, ...) (err error)

Feb 4, 2021

Changes in this version

+ type PagingContext struct

+ Count *int32

+ Start *int32

+ func NewPagingContext(start int32, count int32) PagingContext

+ func (p *PagingContext) ComputeHash() (hash fnv1a.Hash)

+ func (p *PagingContext) EncodeQueryParams() (rawQuery string, err error)

+ func (p *PagingContext) Equals(other *PagingContext) bool

+ func (p *PagingContext) EqualsInterface(otherInterface interface{}) bool

+ type RawRecord map[string]interface

+ func (r *RawRecord) ComputeHash() (h fnv1a.Hash)

+ func (r *RawRecord) Equals(other *RawRecord) bool

+ func (r *RawRecord) EqualsInterface(otherInterface interface{}) bool

+ func (r *RawRecord) MarshalRestLi(writer restlicodec.Writer) error

+ func (r *RawRecord) UnmarshalRestLi(reader restlicodec.Reader) error

+ func (r *RawRecord) UnmarshalTo(obj restlicodec.Unmarshaler) error

Dec 3, 2020

Changes in this version

type RestLiClient

+ StrictResponseDeserialization bool

Nov 17, 2020

Changes in this version

type RestLiObject

+ EqualsInterface func(interface{}) bool

Nov 12, 2020

Changes in this version

+ type RestLiObject interface

+ ComputeHash func() fnv1a.Hash

+ Equals func(interface{}) bool

Sep 9, 2020

Changes in this version

+ type BatchMethodError struct

+ Errors []byte

+ Request *http.Request

+ Response *http.Response

+ Statuses []byte

+ func (b *BatchMethodError) Error() string

Sep 9, 2020

Changes in this version

+ type BatchRequestError []byte

+ func (b BatchRequestError) Error() string

Sep 9, 2020

Changes in this version

+ var StandardLogger stdLogger

Sep 2, 2020

Changes in this version

+ func GenerateBatchKeysParam(keyWriter restlicodec.ArrayWriter) (string, error)

type RestLiClient

+ func (c *RestLiClient) DoBatchGetRequest(ctx context.Context, url *url.URL, resultsReader restlicodec.MapReader) (err error)

Aug 25, 2020

Changes in this version

+ var EmptyRecord emptyRecord

+ func DeleteRequest(ctx context.Context, url *url.URL, method RestLiMethod) (*http.Request, error)

+ func GetRequest(ctx context.Context, url *url.URL, method RestLiMethod) (*http.Request, error)

+ func JsonRequest(ctx context.Context, url *url.URL, httpMethod string, ...) (*http.Request, error)

+ func RawJsonRequest(ctx context.Context, url *url.URL, httpMethod string, ...) (*http.Request, error)

+ type CreateResponseHasNoEntityHeaderError struct

+ Request *http.Request

+ Response *http.Response

+ func (c CreateResponseHasNoEntityHeaderError) Error() string

+ type LoggingRoundTripper struct

+ Logger logger

+ func (l *LoggingRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

+ type PartialUpdate struct

+ Patch restlicodec.Marshaler

+ func (p *PartialUpdate) MarshalRestLi(writer restlicodec.Writer) error

type RestLiClient

+ func (c *RestLiClient) DoActionRequest(ctx context.Context, url *url.URL, params restlicodec.Marshaler, ...) error

+ func (c *RestLiClient) DoCreateRequest(ctx context.Context, url *url.URL, create restlicodec.Marshaler, ...) (err error)

+ func (c *RestLiClient) DoDeleteRequest(ctx context.Context, url *url.URL) error

+ func (c *RestLiClient) DoFinderRequest(ctx context.Context, url *url.URL, results restlicodec.Unmarshaler) error

+ func (c *RestLiClient) DoGetRequest(ctx context.Context, url *url.URL, result restlicodec.Unmarshaler) error

+ func (c *RestLiClient) DoPartialUpdateRequest(ctx context.Context, url *url.URL, patch restlicodec.Marshaler) error

+ func (c *RestLiClient) DoUpdateRequest(ctx context.Context, url *url.URL, create restlicodec.Marshaler) error

type RestLiError

+ Request *http.Request

+ Response *http.Response

+ ResponseBody []byte

+ type SimpleHostnameResolver struct

+ Hostname *url.URL

+ func (s *SimpleHostnameResolver) ResolveHostnameAndContextForQuery(string, *url.URL) (*url.URL, error)

+ type UnexpectedStatusCodeError struct

+ Request *http.Request

+ Response *http.Response

+ ResponseBody []byte

+ func (u *UnexpectedStatusCodeError) Error() string

Aug 17, 2020

Changes in this version

+ var RestLiQueryEncoder = &RestLiCodec

+ var RestLiUrlPathEncoder = &RestLiCodec

Aug 14, 2020

Changes in this version

+ type RawComplexKey string

Jul 16, 2020

Changes in this version

+ const RestLiHeader_ID

+ type RestLiDecodable interface

+ RestLiDecode func(*RestLiCodec, string) error

Jul 14, 2020

Changes in this version

type RestLiCodec

+ func (r *RestLiCodec) Encode(e RestLiEncodable) (string, error)

Jan 21, 2020

Changes in this version

type RestLiCodec

+ func (r *RestLiCodec) DecodeBool(data string, v *bool) error

+ func (r *RestLiCodec) DecodeFloat32(data string, v *float32) error

+ func (r *RestLiCodec) DecodeFloat64(data string, v *float64) error

+ func (r *RestLiCodec) DecodeInt32(data string, v *int32) error

+ func (r *RestLiCodec) DecodeInt64(data string, v *int64) error

+ func (r *RestLiCodec) EncodeBool(v bool) string

+ func (r *RestLiCodec) EncodeFloat32(v float32) string

+ func (r *RestLiCodec) EncodeFloat64(v float64) string

+ func (r *RestLiCodec) EncodeInt32(v int32) string

+ func (r *RestLiCodec) EncodeInt64(v int64) string

Dec 12, 2019

Changes in this version

type HostnameResolver

+ ResolveHostnameAndContextForQuery func(serviceName string, query *url.URL) (*url.URL, error)

type SimpleHostnameSupplier

+ func (s *SimpleHostnameSupplier) ResolveHostnameAndContextForQuery(string, *url.URL) (*url.URL, error)

Dec 2, 2019

Changes in this version

+ const Method_Unknown

+ const Method_action

+ const Method_batch_create

+ const Method_batch_delete

+ const Method_batch_get

+ const Method_batch_partial_update

+ const Method_batch_update

+ const Method_create

+ const Method_delete

+ const Method_finder

+ const Method_get

+ const Method_get_all

+ const Method_partial_update

+ const Method_update

+ func SetJsonAcceptHeader(req *http.Request)

type RestLiClient

+ func (c *RestLiClient) DeleteRequest(url *url.URL, method RestLiMethod) (*http.Request, error)

+ func (c *RestLiClient) JsonPutRequest(url *url.URL, restLiMethod RestLiMethod, contents interface{}) (*http.Request, error)

type RestLiError

+ ResponseHeaders http.Header

+ func (r *RestLiError) Format(s fmt.State, verb rune)

type RestLiMethod

+ func (i RestLiMethod) String() string

May 16, 2019

Changes in this version

+ func SetJsonContentTypeHeader(req *http.Request)

type RestLiClient

+ func (c *RestLiClient) JsonPostRequest(url *url.URL, method RestLiMethod, contents interface{}) (*http.Request, error)

+ func (c *RestLiClient) RawPostRequest(url *url.URL, method RestLiMethod, contents []byte) (*http.Request, error)

May 8, 2019

Changes in this version

+ const MethodBatchCreate

+ const MethodBatchDelete

+ const MethodBatchGet

+ const MethodBatchPartialUpdate

+ const MethodBatchUpdate

+ const MethodCreate

+ const MethodDelete

+ const MethodGet

+ const MethodGetAll

+ const MethodPartialUpdate

+ const MethodUpdate

+ const NoMethod

+ const RestLiContentType

+ const RestLiHeader_ErrorResponse

+ const RestLiHeader_Method

+ const RestLiHeader_ProtocolVersion

+ const RestLiProtocolVersion

+ var RestLiMethodNameMapping = map[string]RestLiMethod

+ func SetRestLiHeaders(req *http.Request, method RestLiMethod)

type RestLiClient

+ func (c *RestLiClient) DoAndDecode(req *http.Request, v interface{}) error

+ func (c *RestLiClient) DoAndIgnore(req *http.Request) error

+ type RestLiMethod string

Apr 18, 2019

Changes in this version

+ type HostnameResolver interface

+ GetHostnameForQuery func(query string) (*url.URL, error)

type SimpleHostnameSupplier

+ func (s *SimpleHostnameSupplier) GetHostnameForQuery(string) (*url.URL, error)

Apr 8, 2019

Changes in this version

+ const RestliContentType

+ const RestliHeader_ErrorResponse

+ const RestliHeader_Id

+ const RestliHeader_Method

+ const RestliHeader_ProtocolVersion

+ const RestliProtocolVersion

+ var RestLiReducedEncoder = RestLiCodec

+ var RestLiUrlEncoder = RestLiCodec

+ func IsErrorResponse(res *http.Response) error

+ type Bytes []byte

+ func (b *Bytes) MarshalJSON() (data []byte, err error)

+ func (b *Bytes) RestLiEncodable()

+ func (b *Bytes) UnmarshalJSON(data []byte) (err error)

+ type RestLiClient struct

+ func (c *RestLiClient) Do(req *http.Request) (res *http.Response, err error)

+ func (c *RestLiClient) FormatQueryUrl(rawQuery string) (*url.URL, error)

+ func (c *RestLiClient) GetRequest(url string, method string) (*http.Request, error)

+ func (c *RestLiClient) PostRequest(url string, method string, contents interface{}) (*http.Request, error)

+ type RestLiCodec struct

+ func (r *RestLiCodec) DecodeBoolean(data string, v *bool) error

+ func (r *RestLiCodec) DecodeBytes(data string, v *Bytes) error

+ func (r *RestLiCodec) DecodeDouble(data string, v *float64) error

+ func (r *RestLiCodec) DecodeFloat(data string, v *float32) error

+ func (r *RestLiCodec) DecodeInt(data string, v *int32) error

+ func (r *RestLiCodec) DecodeLong(data string, v *int64) error

+ func (r *RestLiCodec) DecodeString(data string, v *string) error

+ func (r *RestLiCodec) EncodeBoolean(v bool) string

+ func (r *RestLiCodec) EncodeBytes(v Bytes) string

+ func (r *RestLiCodec) EncodeDouble(v float64) string

+ func (r *RestLiCodec) EncodeFloat(v float32) string

+ func (r *RestLiCodec) EncodeInt(v int32) string

+ func (r *RestLiCodec) EncodeLong(v int64) string

+ func (r *RestLiCodec) EncodeString(v string) string

+ type RestLiEncodable interface

+ RestLiDecode func(codec RestLiCodec, data string) (err error)

+ RestLiEncode func(codec RestLiCodec) (data string, err error)

+ type RestLiError struct

+ DeserializationError error

+ ExceptionClass string

+ FullResponse []byte

+ Message string

+ StackTrace string

+ Status int

+ func (r *RestLiError) Error() string

+ type RestLiHostnameSupplier interface

+ GetHostname func() (*url.URL, error)

+ type SimpleHostnameSupplier struct

+ Hostname *url.URL

+ func (s *SimpleHostnameSupplier) GetHostname() (*url.URL, error)