position

Documentation

Index

• type Position
  • func ParseSDKPosition(rp sdk.Position) (Position, error)
  • func (p Position) FormatSDKPosition() (sdk.Position, error)
  • func (p Position) Validate() error

Types

type Position

type Position struct {
	// IteratorType is the type of the current iterator.
	IteratorType models.IteratorType `json:"iterator_type" validate:"required,iterator_type"`

	// CreatedAt is the Unix time from which the system should receive events of the resource in the CDC iterator.
	CreatedAt int64 `json:"created_at" validate:"required"`

	// Cursor is the resource or event identifier for receiving shifted data in the following requests.
	Cursor string `json:"cursor"`

	// Index is the current index of the returning record from the batch of previously received resources.
	Index int `json:"index"`
}

A Position represents a Stripe position.

func ParseSDKPosition

func ParseSDKPosition(rp sdk.Position) (Position, error)

ParseSDKPosition unmarshal sdk.Position and returns Position.

func (Position) FormatSDKPosition

func (p Position) FormatSDKPosition() (sdk.Position, error)

FormatSDKPosition marshals Position and returns sdk.Position.

func (Position) Validate

func (p Position) Validate() error

Validate validates position fields.