q

Documentation

Index

• Variables
• func NewCloudTasksQ(cfg CloudTasksConfig, client *cloudtasks.Client) *cloudTasksQ
• func NewPubSubQ(client *pubsub.Client) *pubSubQ
• type CloudTasksConfig
• type CloudTasksOption
  • func ProcessAt(t time.Time) CloudTasksOption
• type CloudTasksOptionType
• type CloudTasksQ
• type PubSubMessage
  • func (m *PubSubMessage) GetGroup() string
  • func (m *PubSubMessage) GetName() string
  • func (m *PubSubMessage) GetUniqueKey() string
  • func (m *PubSubMessage) UnmarshalData(v interface{}) error
• type PubSubOption
  • func OrderedByTaskName() PubSubOption
  • func OrderedKey(key string) PubSubOption
• type PubSubOptionType
• type PubSubQ
• type QMessage
  • func NewQMessage(req *http.Request) (msg QMessage, err error)
  • func (m *QMessage) UnmarshalData(v interface{}) error
• type Task
  • func NewTask(typename string, payload interface{}, opts ...TaskOption) *Task
  • func (t Task) GetOptions() []TaskOption
  • func (t Task) GetPayload() interface{}
  • func (t Task) GetTypename() string
• type TaskInfo
• type TaskOption
  • func Group(key string) TaskOption
  • func UniqueKey(key string) TaskOption
• type TaskOptionType

Variables

var ErrTaskIsNil = fmt.Errorf("task is nil")

Functions

func NewCloudTasksQ

func NewCloudTasksQ(cfg CloudTasksConfig, client *cloudtasks.Client) *cloudTasksQ

func NewPubSubQ

func NewPubSubQ(client *pubsub.Client) *pubSubQ

Types

type CloudTasksConfig

type CloudTasksConfig struct {
	ProjectID           string
	LocationID          string
	BaseUrl             string
	ServiceAccountEmail string
}

type CloudTasksOption

type CloudTasksOption interface {
	// String returns a string representation of the option.
	String() string

	// Type describes the type of the option.
	Type() CloudTasksOptionType

	// Value returns a value used to create this option.
	Value() interface{}
}

func ProcessAt

func ProcessAt(t time.Time) CloudTasksOption

ProcessAt returns an option to specify when to process the given task.

type CloudTasksOptionType

type CloudTasksOptionType int

const (
	ProcessAtOpt CloudTasksOptionType = iota
)

type CloudTasksQ

type CloudTasksQ interface {
	// Enqueue enqueues a task with ClousTasks, and returns info.
	EnqueueWithInfo(ctx context.Context, task *Task, opts ...CloudTasksOption) (*TaskInfo, error)
	// Enqueue enqueues a task with ClousTasks.
	Enqueue(ctx context.Context, task *Task, opts ...CloudTasksOption) error
}

type PubSubMessage

type PubSubMessage struct {
	Message struct {
		ID          string            `json:"messageId"`
		PublishTime time.Time         `json:"publishTime"`
		Data        []byte            `json:"data,omitempty"`
		OrderingKey string            `json:"orderingKey,omitempty"`
		Attributes  map[string]string `json:"attributes,omitempty"`
	} `json:"message"`
	Subscription string `json:"subscription"`
}

PubSubMessage is the payload of a Pub/Sub event. See the documentation for more details: https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage

func (*PubSubMessage) GetGroup

func (m *PubSubMessage) GetGroup() string

func (*PubSubMessage) GetName

func (m *PubSubMessage) GetName() string

func (*PubSubMessage) GetUniqueKey

func (m *PubSubMessage) GetUniqueKey() string

func (*PubSubMessage) UnmarshalData

func (m *PubSubMessage) UnmarshalData(v interface{}) error

type PubSubOption

type PubSubOption interface {
	// String returns a string representation of the option.
	String() string

	// Type describes the type of the option.
	Type() PubSubOptionType

	// Value returns a value used to create this option.
	Value() interface{}
}

func OrderedByTaskName

func OrderedByTaskName() PubSubOption

Ordered returns an option to specify the ordered key.

func OrderedKey

func OrderedKey(key string) PubSubOption

Ordered returns an option to specify the ordered key.

type PubSubOptionType

type PubSubOptionType int

const (
	OrderedKeyOpt PubSubOptionType = iota
	OrderedByTaskNameOpt
)

type PubSubQ

type PubSubQ interface {
	// Enqueue enqueues a task with Pub/Sub, and returns info.
	EnqueueWithInfo(ctx context.Context, task *Task, opts ...PubSubOption) (*TaskInfo, error)
	// Enqueue enqueues a task with Pub/Sub.
	Enqueue(ctx context.Context, task *Task, opts ...PubSubOption) error
}

type QMessage

type QMessage struct {
	Name      string
	Group     string
	UniqueKey string
	Data      []byte
}

func NewQMessage

func NewQMessage(req *http.Request) (msg QMessage, err error)

func (*QMessage) UnmarshalData

func (m *QMessage) UnmarshalData(v interface{}) error

type Task

type Task struct {
	// contains filtered or unexported fields
}

Task represents a unit of work to be performed.

func NewTask

func NewTask(typename string, payload interface{}, opts ...TaskOption) *Task

NewTask returns a new Task given a type name and payload data that will be marshaled. Options can be passed to configure task processing behavior.

func (Task) GetOptions

func (t Task) GetOptions() []TaskOption

func (Task) GetPayload

func (t Task) GetPayload() interface{}

func (Task) GetTypename

func (t Task) GetTypename() string

type TaskInfo

type TaskInfo struct {
	ID string
}

type TaskOption

type TaskOption interface {
	// String returns a string representation of the option.
	String() string

	// Type describes the type of the option.
	Type() TaskOptionType

	// Value returns a value used to create this option.
	Value() interface{}
}

func Group

func Group(key string) TaskOption

Group returns an option to specify the group.

func UniqueKey

func UniqueKey(key string) TaskOption

UniqueKey returns an option to specify the unique key.

type TaskOptionType

type TaskOptionType int

const (
	UniqueKeyOpt TaskOptionType = iota
	GroupOpt
)