resource

type Action struct {
	// Name is the name of the action.
	Name string

	// Do performs the action on the resource.
	// It should return an error if the action failed.
	// The index is provided to add or delete resources.
	Do func(ctx context.Context, index Indexer, client *scw.Client) error
}

type Actionable interface {
	Resource

	// Actions returns the list of actions that can be performed on the resource.
	Actions() []Action
}

type CockpitMetadata struct {
	// CanViewLogs is true if the logs associated with the resource can be viewed Scaleway Cockpit.
	CanViewLogs bool

	// ResourceName is the name of the resource in Scaleway Cockpit.
	ResourceName string

	// ResourceID is the ID of the resource in Scaleway Cockpit.
	ResourceID string

	// ResourceType is the type of the resource in Scaleway Cockpit.
	ResourceType string
}

type GlobalLocality string

type Index struct {
	Store  Storer
	Search Searcher
}

type Indexer interface {
	// Index indexes the given resource.
	Index(ctx context.Context, r Resource) error

	// Deindex deindexes the given resource.
	Deindex(ctx context.Context, r Resource) error
}

type Locality interface {
	IsRegion() bool
	IsZone() bool
	fmt.Stringer
}

type Log struct {
	Timestamp time.Time
	Line      string
}

type Metadata struct {
	// Name is the name of the resource.
	Name string `json:"name"`

	// ID is the unique identifier of the resource.
	ID string `json:"id"`

	// ProjectID is the unique identifier of the project the resource belongs to.
	ProjectID string `json:"project_id"`

	// Status is the status of the resource.
	// Maybe nil if not available.
	Status *Status `json:"status"`

	// Description is the description of the resource.
	// May be empty.
	Description *string `json:"description"`

	// CreatedAt is the date the resource was created.
	// Maybe nil if not available.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// Tags is the list of tags associated with the resource.
	Tags []string `json:"tags"`

	// Type is the type of the resource.
	Type Type `json:"type"`

	// Locality is the locality of the resource.
	Locality Locality `json:"locality,omitempty"`
}

type Monitorer interface {
	// Logs returns the logs of a resource.
	Logs(ctx context.Context, r Resource) ([]Log, error)
}

type Predicate func(r Resource) bool

type Region scw.Region

type Resource interface {
	// Metadata returns the metadatas of the resource.
	Metadata() Metadata

	// CockpitMetadata returns the metadatas of the resource for Scaleway Cockpit.
	CockpitMetadata() CockpitMetadata

	// Delete deletes the resource.
	// It will also remove the resource from the index.
	Delete(ctx context.Context, index Indexer, client *scw.Client) error
}

type Searcher interface {
	// Search searches for resources. Returns a list of resource IDs that match the query.
	Search(ctx context.Context, query string) (SetOfIDs, error)

	// Index indexes a resource.
	Index(r Resource) error

	// Deindex deindexes a resource.
	Deindex(r Resource) error
}

type SetOfIDs = map[string]struct{}

type Status string

type Storer interface {
	// Store stores a resource.
	Store(ctx context.Context, r Resource) error

	// ListAllResources returns all resources.
	ListAllResources(ctx context.Context) ([]Resource, error)

	// DeleteResource deletes a resource.
	DeleteResource(ctx context.Context, r Resource) error
}

type Type int

type Zone scw.Zone