Documentation
¶
Overview ¶
Package export serves projected space data via HTTP zip routes. URL: /p/spacewave-core/export/u/{idx}/so/{soId}/... URL: /p/spacewave-core/export-batch/{base-path}/{b64}/{filename}.zip The /p/spacewave-core/ prefix is stripped by the web runtime.
Index ¶
- Constants
- Variables
- func NewFactory(b bus.Bus) controller.Factory
- type Config
- func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *Config) CloneVT() *Config
- func (this *Config) EqualMessageVT(thatMsg any) bool
- func (this *Config) EqualVT(that *Config) bool
- func (c *Config) EqualsConfig(other config.Config) bool
- func (c *Config) GetConfigID() string
- func (x *Config) MarshalJSON() ([]byte, error)
- func (x *Config) MarshalProtoJSON(s *json.MarshalState)
- func (x *Config) MarshalProtoText() string
- func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Config) MarshalToVT(dAtA []byte) (int, error)
- func (m *Config) MarshalVT() (dAtA []byte, err error)
- func (*Config) ProtoMessage()
- func (x *Config) Reset()
- func (m *Config) SizeVT() (n int)
- func (x *Config) String() string
- func (x *Config) UnmarshalJSON(b []byte) error
- func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *Config) UnmarshalVT(dAtA []byte) error
- func (c *Config) Validate() error
- type Controller
- type ExportBatchRequest
- func (m *ExportBatchRequest) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *ExportBatchRequest) CloneVT() *ExportBatchRequest
- func (this *ExportBatchRequest) EqualMessageVT(thatMsg any) bool
- func (this *ExportBatchRequest) EqualVT(that *ExportBatchRequest) bool
- func (x *ExportBatchRequest) GetPaths() []string
- func (x *ExportBatchRequest) MarshalJSON() ([]byte, error)
- func (x *ExportBatchRequest) MarshalProtoJSON(s *json.MarshalState)
- func (x *ExportBatchRequest) MarshalProtoText() string
- func (m *ExportBatchRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *ExportBatchRequest) MarshalToVT(dAtA []byte) (int, error)
- func (m *ExportBatchRequest) MarshalVT() (dAtA []byte, err error)
- func (*ExportBatchRequest) ProtoMessage()
- func (x *ExportBatchRequest) Reset()
- func (m *ExportBatchRequest) SizeVT() (n int)
- func (x *ExportBatchRequest) String() string
- func (x *ExportBatchRequest) UnmarshalJSON(b []byte) error
- func (x *ExportBatchRequest) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *ExportBatchRequest) UnmarshalVT(dAtA []byte) error
Constants ¶
const ConfigID = ControllerID
ConfigID is the config identifier.
const ControllerID = "space/http/export"
ControllerID is the controller identifier.
Variables ¶
var Version = semver.MustParse("0.0.1")
Version is the controller version.
Functions ¶
func NewFactory ¶
func NewFactory(b bus.Bus) controller.Factory
NewFactory constructs the controller factory.
Types ¶
type Config ¶
type Config struct {
// contains filtered or unexported fields
}
Config configures the export controller.
func (*Config) CloneMessageVT ¶
func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*Config) EqualMessageVT ¶
func (*Config) EqualsConfig ¶
EqualsConfig checks if the config is equal to another.
func (*Config) GetConfigID ¶
GetConfigID returns the unique string for this configuration type.
func (*Config) MarshalJSON ¶
MarshalJSON marshals the Config to JSON.
func (*Config) MarshalProtoJSON ¶
func (x *Config) MarshalProtoJSON(s *json.MarshalState)
MarshalProtoJSON marshals the Config message to JSON.
func (*Config) MarshalProtoText ¶
func (*Config) MarshalToSizedBufferVT ¶
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) UnmarshalJSON ¶
UnmarshalJSON unmarshals the Config from JSON.
func (*Config) UnmarshalProtoJSON ¶
func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)
UnmarshalProtoJSON unmarshals the Config message from JSON.
func (*Config) UnmarshalVT ¶
type Controller ¶
type Controller struct {
*bus.BusController[*Config]
}
Controller serves projected space zip archives for download via LookupHTTPHandler.
func (*Controller) Execute ¶
func (c *Controller) Execute(ctx context.Context) error
Execute executes the controller.
func (*Controller) HandleDirective ¶
func (c *Controller) HandleDirective(ctx context.Context, di directive.Instance) ([]directive.Resolver, error)
HandleDirective asks if the handler can resolve the directive.
func (*Controller) ServeHTTP ¶
func (c *Controller) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP parses projected export paths and dispatches zip export.
type ExportBatchRequest ¶
type ExportBatchRequest struct {
Paths []string `protobuf:"bytes,1,rep,name=paths,proto3" json:"paths,omitempty"`
// contains filtered or unexported fields
}
ExportBatchRequest lists descendant paths relative to one projected base path.
func (*ExportBatchRequest) CloneMessageVT ¶
func (m *ExportBatchRequest) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*ExportBatchRequest) CloneVT ¶
func (m *ExportBatchRequest) CloneVT() *ExportBatchRequest
func (*ExportBatchRequest) EqualMessageVT ¶
func (this *ExportBatchRequest) EqualMessageVT(thatMsg any) bool
func (*ExportBatchRequest) EqualVT ¶
func (this *ExportBatchRequest) EqualVT(that *ExportBatchRequest) bool
func (*ExportBatchRequest) GetPaths ¶
func (x *ExportBatchRequest) GetPaths() []string
func (*ExportBatchRequest) MarshalJSON ¶
func (x *ExportBatchRequest) MarshalJSON() ([]byte, error)
MarshalJSON marshals the ExportBatchRequest to JSON.
func (*ExportBatchRequest) MarshalProtoJSON ¶
func (x *ExportBatchRequest) MarshalProtoJSON(s *json.MarshalState)
MarshalProtoJSON marshals the ExportBatchRequest message to JSON.
func (*ExportBatchRequest) MarshalProtoText ¶
func (x *ExportBatchRequest) MarshalProtoText() string
func (*ExportBatchRequest) MarshalToSizedBufferVT ¶
func (m *ExportBatchRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*ExportBatchRequest) MarshalToVT ¶
func (m *ExportBatchRequest) MarshalToVT(dAtA []byte) (int, error)
func (*ExportBatchRequest) MarshalVT ¶
func (m *ExportBatchRequest) MarshalVT() (dAtA []byte, err error)
func (*ExportBatchRequest) ProtoMessage ¶
func (*ExportBatchRequest) ProtoMessage()
func (*ExportBatchRequest) Reset ¶
func (x *ExportBatchRequest) Reset()
func (*ExportBatchRequest) SizeVT ¶
func (m *ExportBatchRequest) SizeVT() (n int)
func (*ExportBatchRequest) String ¶
func (x *ExportBatchRequest) String() string
func (*ExportBatchRequest) UnmarshalJSON ¶
func (x *ExportBatchRequest) UnmarshalJSON(b []byte) error
UnmarshalJSON unmarshals the ExportBatchRequest from JSON.
func (*ExportBatchRequest) UnmarshalProtoJSON ¶
func (x *ExportBatchRequest) UnmarshalProtoJSON(s *json.UnmarshalState)
UnmarshalProtoJSON unmarshals the ExportBatchRequest message from JSON.
func (*ExportBatchRequest) UnmarshalVT ¶
func (m *ExportBatchRequest) UnmarshalVT(dAtA []byte) error