shared

Documentation

Index

• type OperationSupport
• type OperationSupportMatrix
  • func (r *OperationSupportMatrix) UnmarshalJSON(data []byte) (err error)
• type ResponsesPage
  • func (r *ResponsesPage[T]) GetNextPage() (res *ResponsesPage[T], err error)
  • func (r *ResponsesPage[T]) SetPageConfig(cfg *requestconfig.RequestConfig, res *http.Response)
  • func (r *ResponsesPage[T]) UnmarshalJSON(data []byte) (err error)
• type ResponsesPageAutoPager
  • func NewResponsesPageAutoPager[T any](page *ResponsesPage[T], err error) *ResponsesPageAutoPager[T]
  • func (r *ResponsesPageAutoPager[T]) Current() T
  • func (r *ResponsesPageAutoPager[T]) Err() error
  • func (r *ResponsesPageAutoPager[T]) Index() int
  • func (r *ResponsesPageAutoPager[T]) Next() bool
• type SinglePage
  • func (r *SinglePage[T]) GetNextPage() (res *SinglePage[T], err error)
  • func (r *SinglePage[T]) SetPageConfig(cfg *requestconfig.RequestConfig, res *http.Response)
  • func (r *SinglePage[T]) UnmarshalJSON(data []byte) (err error)
• type SinglePageAutoPager
  • func NewSinglePageAutoPager[T any](page *SinglePage[T], err error) *SinglePageAutoPager[T]
  • func (r *SinglePageAutoPager[T]) Current() T
  • func (r *SinglePageAutoPager[T]) Err() error
  • func (r *SinglePageAutoPager[T]) Index() int
  • func (r *SinglePageAutoPager[T]) Next() bool

Types

type OperationSupport

type OperationSupport string

• `supported`: This operation is supported by both the provider and Finch <br>
• `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider <br>
• `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support <br>
• `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch

const (
	OperationSupportSupported              OperationSupport = "supported"
	OperationSupportNotSupportedByFinch    OperationSupport = "not_supported_by_finch"
	OperationSupportNotSupportedByProvider OperationSupport = "not_supported_by_provider"
	OperationSupportClientAccessOnly       OperationSupport = "client_access_only"
)

type OperationSupportMatrix

type OperationSupportMatrix struct {
	//   - `supported`: This operation is supported by both the provider and Finch <br>
	//   - `not_supported_by_finch`: This operation is not supported by Finch but
	//     supported by the provider <br>
	//   - `not_supported_by_provider`: This operation is not supported by the provider,
	//     so Finch cannot support <br>
	//   - `client_access_only`: This behavior is supported by the provider, but only
	//     available to the client and not to Finch
	Create OperationSupport `json:"create"`
	//   - `supported`: This operation is supported by both the provider and Finch <br>
	//   - `not_supported_by_finch`: This operation is not supported by Finch but
	//     supported by the provider <br>
	//   - `not_supported_by_provider`: This operation is not supported by the provider,
	//     so Finch cannot support <br>
	//   - `client_access_only`: This behavior is supported by the provider, but only
	//     available to the client and not to Finch
	Delete OperationSupport `json:"delete"`
	//   - `supported`: This operation is supported by both the provider and Finch <br>
	//   - `not_supported_by_finch`: This operation is not supported by Finch but
	//     supported by the provider <br>
	//   - `not_supported_by_provider`: This operation is not supported by the provider,
	//     so Finch cannot support <br>
	//   - `client_access_only`: This behavior is supported by the provider, but only
	//     available to the client and not to Finch
	Read OperationSupport `json:"read"`
	//   - `supported`: This operation is supported by both the provider and Finch <br>
	//   - `not_supported_by_finch`: This operation is not supported by Finch but
	//     supported by the provider <br>
	//   - `not_supported_by_provider`: This operation is not supported by the provider,
	//     so Finch cannot support <br>
	//   - `client_access_only`: This behavior is supported by the provider, but only
	//     available to the client and not to Finch
	Update OperationSupport           `json:"update"`
	JSON   operationSupportMatrixJSON `json:"-"`
}

func (*OperationSupportMatrix) UnmarshalJSON

func (r *OperationSupportMatrix) UnmarshalJSON(data []byte) (err error)

type ResponsesPage

type ResponsesPage[T any] struct {
	Responses []T               `json:"responses,required"`
	JSON      responsesPageJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*ResponsesPage[T]) GetNextPage

func (r *ResponsesPage[T]) GetNextPage() (res *ResponsesPage[T], err error)

NextPage returns the next page as defined by this pagination style. When there is no next page, this function will return a 'nil' for the page value, but will not return an error

func (*ResponsesPage[T]) SetPageConfig

func (r *ResponsesPage[T]) SetPageConfig(cfg *requestconfig.RequestConfig, res *http.Response)

func (*ResponsesPage[T]) UnmarshalJSON

func (r *ResponsesPage[T]) UnmarshalJSON(data []byte) (err error)

type ResponsesPageAutoPager

type ResponsesPageAutoPager[T any] struct {
	// contains filtered or unexported fields
}

func NewResponsesPageAutoPager

func NewResponsesPageAutoPager[T any](page *ResponsesPage[T], err error) *ResponsesPageAutoPager[T]

func (*ResponsesPageAutoPager[T]) Current

func (r *ResponsesPageAutoPager[T]) Current() T

func (*ResponsesPageAutoPager[T]) Err

func (r *ResponsesPageAutoPager[T]) Err() error

func (*ResponsesPageAutoPager[T]) Index

func (r *ResponsesPageAutoPager[T]) Index() int

func (*ResponsesPageAutoPager[T]) Next

func (r *ResponsesPageAutoPager[T]) Next() bool

type SinglePage

type SinglePage[T any] struct {
	Items []T            `json:"-,inline"`
	JSON  singlePageJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*SinglePage[T]) GetNextPage

func (r *SinglePage[T]) GetNextPage() (res *SinglePage[T], err error)

NextPage returns the next page as defined by this pagination style. When there is no next page, this function will return a 'nil' for the page value, but will not return an error

func (*SinglePage[T]) SetPageConfig

func (r *SinglePage[T]) SetPageConfig(cfg *requestconfig.RequestConfig, res *http.Response)

func (*SinglePage[T]) UnmarshalJSON

func (r *SinglePage[T]) UnmarshalJSON(data []byte) (err error)

type SinglePageAutoPager

type SinglePageAutoPager[T any] struct {
	// contains filtered or unexported fields
}

func NewSinglePageAutoPager

func NewSinglePageAutoPager[T any](page *SinglePage[T], err error) *SinglePageAutoPager[T]

func (*SinglePageAutoPager[T]) Current

func (r *SinglePageAutoPager[T]) Current() T

func (*SinglePageAutoPager[T]) Err

func (r *SinglePageAutoPager[T]) Err() error

func (*SinglePageAutoPager[T]) Index

func (r *SinglePageAutoPager[T]) Index() int

func (*SinglePageAutoPager[T]) Next

func (r *SinglePageAutoPager[T]) Next() bool