manage

type BlueprintValidation struct {
	// The ID for a blueprint validation request.
	ID string `json:"id"`
	// The status of the blueprint validation.
	Status BlueprintValidationStatus `json:"status"`
	// The location of the blueprint that is being validated.
	BlueprintLocation string `json:"blueprintLocation"`
	// The unix timestamp in seconds when the validation request was created.
	Created int64 `json:"created"`
}

type BlueprintValidationNotFound struct {
	ID string
}

type BlueprintValidationStatus string

type Changeset struct {
	// The ID for a change set.
	ID string `json:"id"`
	// The ID of the instance that is being used for the change
	// staging process.
	// This will only be present if the change set is for updating
	// an existing blueprint instance deployment.
	InstanceID string `json:"instanceId,omitempty"`
	// Determines if the change set is for destroying the blueprint
	// instance.
	Destroy bool `json:"destroy"`
	// The status of the change staging process.
	Status ChangesetStatus `json:"status"`
	// The location of the blueprint that is being used for the change
	// staging process.
	BlueprintLocation string `json:"blueprintLocation"`
	// The changes that are produced by the change staging process.
	Changes *changes.BlueprintChanges `json:"changes,omitempty"`
	// The unix timestamp in seconds when the change set was created.
	Created int64 `json:"created"`
}

type ChangesetNotFound struct {
	ID string
}

type ChangesetStatus string

type Changesets interface {
	// Get a change set for the given ID.
	Get(ctx context.Context, id string) (*Changeset, error)

	// Save a new change set for a change staging request.
	Save(
		ctx context.Context,
		changeset *Changeset,
	) error

	// Cleanup removes all change sets that are older
	// than the given threshold date.
	Cleanup(ctx context.Context, thresholdDate time.Time) error
}

type Entity interface {
	// GetID returns the ID of the entity.
	GetID() string
	// GetCreated returns the creation time of the entity
	// as a Unix timestamp in seconds.
	GetCreated() int64
}

type Event struct {
	// A unique ID for the event.
	ID string `json:"id"`
	// The type of event that occurred.
	Type string `json:"type"`
	// The type of channel that the event is associated with.
	ChannelType string `json:"channelType"`
	// The ID of the channel that the event is associated with.
	ChannelID string `json:"channelId"`
	// Data is a JSON encoded string that contains the event data.
	Data string `json:"data"`
	// The unix timestamp in seconds when the event was created.
	Timestamp int64 `json:"timestamp"`
	// Whether or not the current event represents the end of a stream.
	End bool `json:"end"`
}

type EventNotFound struct {
	ID string
}

type EventStreamParams struct {
	// The type of channel to listen to.
	ChannelType string `json:"channelType"`
	// The ID of the channel to listen to.
	// This is used to identify the event stream
	// for a specific blueprint validation, change staging process or deployment.
	ChannelID string `json:"channelId"`
	// The ID of the event to start listening from.
	// If this is not provided, the stream will start from the earliest retained
	// event in the channel.
	// This is exclusive, meaning that the event with this ID will not be included
	// in the stream.
	StartingEventID string `json:"startingEventId,omitempty"`
}

type Events interface {
	// Get an event by ID.
	Get(ctx context.Context, id string) (Event, error)

	// Save a new event for blueprint validation, change staging or deployment.
	Save(ctx context.Context, event *Event) error

	// Stream events for a given channel, starting at an optional event ID.
	// The channel ID is used to identify the event stream
	// for a specific blueprint validation, change staging process or deployment.
	// A channel is returned that can be used to stop the stream.
	// Once the caller knows that they are done with the stream,
	// it must send an empty struct to the channel to stop the stream.
	Stream(
		ctx context.Context,
		params *EventStreamParams,
		streamTo chan Event,
		errChan chan error,
	) (chan struct{}, error)

	// Cleanup removes all events that are older
	// than the given threshold date.
	Cleanup(ctx context.Context, thresholdDate time.Time) error
}

type Validation interface {
	// Get a blueprint validation for the given ID.
	Get(ctx context.Context, id string) (*BlueprintValidation, error)

	// Save a new blueprint validation for a request to validate a blueprint.
	Save(
		ctx context.Context,
		validation *BlueprintValidation,
	) error

	// Cleanup removes all blueprint validations that are older
	// than the given threshold date.
	Cleanup(ctx context.Context, thresholdDate time.Time) error
}