protocol

type Pipeline struct {
	// The name of the pipeline.
	Name string
}

type QueueMessage struct {
	// UniqueId is a unique id to identify this message. It may be used for
	// de-duplication by the stream processing.
	UniqueId ksuid.KSUID

	// Pipelines are the named pipelines to place the message on. You can think
	// of a pipeline as a series of unordered named queues.
	//
	// If there are multiple Pipelines set, then the message will be pushed
	// to each one. Pushing to Pipelines is atomic from the client, but not
	// guaranteed by the hyperscalr ingress plane. Hyperscalr ingress place will
	// attempt to push to the configured Pipelines optimistically on it's
	// end. This is the same as if multiple calls by the client were made to
	// single Pipelines.
	Pipelines []Pipeline

	// Payload message body of what you want pushed into the queue.
	//
	// It does have restrictions on size. The server is likely to reject
	// QueueMessage with total size greater than 32 KB.
	Payload []byte

	// The destination where the payload will be sent.
	WebhookDestination *Webhook
}

type Webhook struct {
	// The http request Method, i.e. GET, POST.
	Method string

	// Headers to be set in the http request.
	// To understand how this is serialized, see:
	//   - https://golang.org/pkg/net/http/#Header.Write
	//   - https://golang.org/pkg/net/textproto/#Reader.ReadMIMEHeader
	Headers []byte

	// URL encoded query paramaters to be set in the http request.
	// This is marshaled and unmarshaled using Encode and ParseQuery.
	//   - https://golang.org/pkg/net/url/#Values.Encode
	//   - https://golang.org/pkg/net/url/#ParseQuery
	QueryParams string

	// URL to send the request to. You may include query parameters in the Url.
	// The QueryParams specified seperately will be appended to this Url before
	// making the request.
	//
	// This is marshaled and unmarshaled using MarshalBinary and UnmarshalBinary.
	//   - https://golang.org/pkg/net/url/#Values
	//   - https://golang.org/pkg/net/url/#ParseRequestURI
	//   - https://golang.org/pkg/net/url/#URL.MarshalBinary
	//   - https://golang.org/pkg/net/url/#URL.UnmarshalBinary
	Url []byte
}