Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

restli

package

Go to main page

Versions in this module

v1

v1.2.0

Oct 12, 2022

v1.1.2

Aug 23, 2022

v1.1.1

Jun 11, 2022

v1.1.0

Jun 2, 2022

Changes in this version

+ const ApplicationJsonContentType

+ const ContentTypeHeader

+ const FormUrlEncodedContentType

+ const MethodOverrideHeader

+ const MultipartBoundary

+ const MultipartMixedContentType

+ func DecodeTunnelledQuery(req *http.Request) (err error)

+ func EncodeTunnelledQuery(httpMethod, query string, body []byte) (newBody []byte, headers http.Header)

type Client

+ HostnameResolver HostnameResolver

+ QueryTunnellingThreshold int

type RequestContext

+ func (c *RequestContext) RequestPath() string

v1.0.8

Apr 7, 2022

v1.0.7

Apr 4, 2022

v1.0.6

Apr 2, 2022

v1.0.5

Mar 30, 2022

v1.0.4

Mar 29, 2022

v1.0.3

Mar 28, 2022

Changes in this version

+ const ErrorResponseHeader

+ const IDHeader

+ const MethodHeader

+ 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

+ const PatchField

+ const ProtocolVersion

+ const ProtocolVersionHeader

+ var MethodNameMapping = func() map[string]Method { ... }()

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

+ var RequiredPatchRecordFields = restlicodec.RequiredFields

+ var StandardLogger stdLogger

+ func AddResponseHeadersCaptor(ctx context.Context) (context.Context, http.Header)

+ func BatchCreate(c *Client, ctx context.Context, rp ResourcePath, entities []V, ...) (createdEntities []*restlidata.CreatedEntity[K], err error)

+ func BatchCreateWithReturnEntity(c *Client, ctx context.Context, rp ResourcePath, entities []V, ...) (createdEntities []*restlidata.CreatedAndReturnedEntity[K, V], err error)

+ func BatchDelete(c *Client, ctx context.Context, rp ResourcePath, keys []K, ...) (*restlidata.BatchResponse[K, *restlidata.BatchEntityUpdateResponse], error)

+ func BatchGet(c *Client, ctx context.Context, rp ResourcePath, keys []K, ...) (*restlidata.BatchResponse[K, V], error)

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

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

+ func BoolPointer(v bool) *bool

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

+ func Create(c *Client, ctx context.Context, rp ResourcePath, create V, ...) (*restlidata.CreatedEntity[K], error)

+ func CreateWithReturnEntity(c *Client, ctx context.Context, rp ResourcePath, create V, ...) (*restlidata.CreatedAndReturnedEntity[K, V], error)

+ func Delete(c *Client, ctx context.Context, rp ResourcePath, query QueryParamsEncoder) error

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

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

+ func DoAndIgnore(c *Client, req *http.Request) (*http.Response, error)

+ func DoAndUnmarshal(c *Client, req *http.Request, unmarshaler restlicodec.GenericUnmarshaler[V]) (v V, res *http.Response, err error)

+ func ExtraRequestHeaders(ctx context.Context, headers http.Header) context.Context

+ func Find(c *Client, ctx context.Context, rp ResourcePath, query QueryParamsEncoder) (results *restlidata.Elements[V], err error)

+ func FindWithMetadata(c *Client, ctx context.Context, rp ResourcePath, query QueryParamsEncoder) (results *restlidata.ElementsWithMetadata[V, M], err error)

+ func Float32Pointer(v float32) *float32

+ func Float64Pointer(v float64) *float64

+ func Get(c *Client, ctx context.Context, rp ResourcePath, query QueryParamsEncoder) (v V, err error)

+ func GetActionNameFromContext(ctx context.Context) string

+ func GetAll(c *Client, ctx context.Context, rp ResourcePath, query QueryParamsEncoder) (results *restlidata.Elements[V], err error)

+ func GetEntitySegmentsFromContext(ctx context.Context) []restlicodec.Reader

+ func GetFinderNameFromContext(ctx context.Context) string

+ func Int32Pointer(v int32) *int32

+ func Int64Pointer(v int64) *int64

+ func IsErrorResponse(res *http.Response) error

+ func NewCreateRequest(c *Client, ctx context.Context, rp ResourcePath, query QueryParamsEncoder, ...) (*http.Request, error)

+ func NewDeleteRequest(c *Client, ctx context.Context, rp ResourcePath, query QueryParamsEncoder, ...) (*http.Request, error)

+ func NewGetRequest(c *Client, ctx context.Context, rp ResourcePath, query QueryParamsEncoder, ...) (*http.Request, error)

+ func NewJsonRequest(c *Client, ctx context.Context, rp ResourcePath, query QueryParamsEncoder, ...) (*http.Request, error)

+ func PartialUpdate(c *Client, ctx context.Context, rp ResourcePath, patch PV, ...) error

+ func RegisterAction(s Server, segments []ResourcePathSegment, name string, ...)

+ func RegisterActionWithResults(s Server, segments []ResourcePathSegment, name string, ...)

+ func RegisterBatchCreate(s Server, segments []ResourcePathSegment, readOnlyFields restlicodec.PathSpec, ...)

+ func RegisterBatchCreateWithReturnEntity(s Server, segments []ResourcePathSegment, readOnlyFields restlicodec.PathSpec, ...)

+ func RegisterBatchDelete(s Server, segments []ResourcePathSegment, ...)

+ func RegisterBatchGet(s Server, segments []ResourcePathSegment, ...)

+ func RegisterBatchPartialUpdate(s Server, segments []ResourcePathSegment, ...)

+ func RegisterBatchUpdate(s Server, segments []ResourcePathSegment, ...)

+ func RegisterCreate(s Server, segments []ResourcePathSegment, readOnlyFields restlicodec.PathSpec, ...)

+ func RegisterCreateWithReturnEntity(s Server, segments []ResourcePathSegment, readOnlyFields restlicodec.PathSpec, ...)

+ func RegisterDelete(s Server, segments []ResourcePathSegment, ...)

+ func RegisterFinder(s Server, segments []ResourcePathSegment, name string, ...)

+ func RegisterFinderWithMetadata(s Server, segments []ResourcePathSegment, name string, ...)

+ func RegisterGet(s Server, segments []ResourcePathSegment, ...)

+ func RegisterGetAll(s Server, segments []ResourcePathSegment, ...)

+ func RegisterPartialUpdate(s Server, segments []ResourcePathSegment, excludedFields restlicodec.PathSpec, ...)

+ func RegisterUpdate(s Server, segments []ResourcePathSegment, ...)

+ func SetJsonAcceptHeader(req *http.Request)

+ func SetJsonContentTypeHeader(req *http.Request)

+ func SetLocation(ctx *RequestContext, c *restlidata.CreatedEntity[K]) error

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

+ func StringPointer(v string) *string

+ func StringPointerf(format string, args ...any) *string

+ func UnmarshalResourcePath(segments []restlicodec.Reader) (t T, err error)

+ func Update(c *Client, ctx context.Context, rp ResourcePath, update V, ...) error

+ type ActionQueryParam string

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

+ type Client struct

+ StrictResponseDeserialization bool

+ func (c *Client) Do(req *http.Request) (*http.Response, error)

+ func (c *Client) FormatQueryUrl(rp ResourcePath, query QueryParamsEncoder) (*url.URL, error)

+ type CreateResponseHasNoEntityHeaderError struct

+ Response *http.Response

+ func (c CreateResponseHasNoEntityHeaderError) Error() string

+ type Error struct

+ DeserializationError error

+ Response *http.Response

+ ResponseBody []byte

+ type Filter interface

+ PostRequest func(ctx context.Context, responseHeaders http.Header) error

+ PreRequest func(req *http.Request) (context.Context, error)

+ type HostnameResolver interface

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

+ type IllegalEnumConstant struct

+ Constant int

+ Enum string

+ func (i *IllegalEnumConstant) Error() string

+ type IllegalPartialUpdateError struct

+ Field string

+ Message string

+ RecordType string

+ func (c *IllegalPartialUpdateError) Error() string

+ type LoggingRoundTripper struct

+ Logger logger

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

+ type Method int

+ func GetMethodFromContext(ctx context.Context) Method

+ func (i Method) String() string

+ type PartialUpdateFieldChecker struct

+ HasDeletes bool

+ HasSets bool

+ RecordType string

+ func (c *PartialUpdateFieldChecker) CheckField(checker restlicodec.KeyChecker, fieldName string, isDeleteSet bool, ...) error

+ type QueryParamsEncoder interface

+ EncodeQueryParams func() (string, error)

+ type QueryParamsString string

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

+ type RequestContext struct

+ Request *http.Request

+ ResponseHeaders http.Header

+ ResponseStatus int

+ type ResourcePath interface

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

+ RootResource func() string

+ type ResourcePathSegment struct

+ func GetResourcePathSegmentsFromContext(ctx context.Context) []ResourcePathSegment

+ func NewResourcePathSegment(name string, isCollection bool) ResourcePathSegment

+ type ResourcePathString string

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

+ func (s ResourcePathString) RootResource() string

+ type ResourcePathUnmarshaler interface

+ NewInstance func() T

+ UnmarshalResourcePath func(segments []restlicodec.Reader) error

+ type Server interface

+ AddToMux func(mux *http.ServeMux)

+ Handler func() http.Handler

+ func NewPrefixedServer(prefix string, filters ...Filter) Server

+ func NewServer(filters ...Filter) Server

+ type SimpleHostnameResolver struct

+ Hostname *url.URL

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

+ type SliceBatchQueryParams struct

+ func (s *SliceBatchQueryParams[T]) DecodeQueryParams(reader restlicodec.QueryParamsReader) (ids []T, err error)

+ func (s *SliceBatchQueryParams[T]) NewInstance() *SliceBatchQueryParams[T]

+ type UnexpectedStatusCodeError struct

+ Response *http.Response

+ ResponseBody []byte

+ func (u *UnexpectedStatusCodeError) Error() string

+ type UnknownEnumValue struct

+ Enum string

+ Value string

+ func (u *UnknownEnumValue) Error() string

+ type UnsupportedRestLiProtocolVersion struct

+ ReturnedVersion string

+ func (u *UnsupportedRestLiProtocolVersion) Error() string

Other modules containing this package

github.com/PapaCharlie/go-restli/v2