resource

Documentation

Overview

Package resource defines an interface for recording changes to InfluxDB resources.

A resource is an entity in our system, e.g. an organization, task or bucket. A change includes the creation, update or deletion of a resource.

Index

• Constants
• type Change
• type ChangeType
• type Logger

Constants

const (
	// Create a resource.
	Create ChangeType = "create"
	// Put a resource.
	Put = "put"
	// Update a resource.
	Update = "update"
	// Delete a resource
	Delete = "delete"
)

Types

type Change

type Change struct {
	// Type of change.
	Type ChangeType
	// ResourceID of the changed resource.
	ResourceID platform.ID
	// ResourceType that was changed.
	ResourceType influxdb.ResourceType
	// OrganizationID of the organization owning the changed resource.
	OrganizationID platform.ID
	// UserID of the user changing the resource.
	UserID platform.ID
	// ResourceBody after the change.
	ResourceBody []byte
	// Time when the resource was changed.
	Time time.Time
}

Change to a resource.

type ChangeType

type ChangeType string

Type of change.

type Logger

type Logger interface {
	// Log a change to a resource.
	Log(Change) error
}

Logger records changes to resources.