Documentation
¶
Overview ¶
Package streams -- generated by scloudgen !! DO NOT EDIT !!
Package streams -- generated by scloudgen !! DO NOT EDIT !!
Index ¶
- func ActivatePipeline(cmd *cobra.Command, args []string) error
- func CompileDSL(cmd *cobra.Command, args []string) error
- func CompileDSLOverride(filename string) (*model.UplPipeline, error)
- func CompileSPL(cmd *cobra.Command, args []string) error
- func CompileSPLOverride(filename string) (*model.UplPipeline, error)
- func CreateConnection(cmd *cobra.Command, args []string) error
- func CreateGroup(cmd *cobra.Command, args []string) error
- func CreateGroupOverride(filename string) (*model.GroupResponse, error)
- func CreatePipeline(cmd *cobra.Command, args []string) error
- func CreatePipelineOverride(bypassValidation *bool, description *string, name string, filename string) (*model.PipelineResponse, error)
- func CreateTemplate(cmd *cobra.Command, args []string) error
- func CreateTemplateOverride(description string, name string, filename string) (*model.TemplateResponse, error)
- func DeactivatePipeline(cmd *cobra.Command, args []string) error
- func DeleteConnection(cmd *cobra.Command, args []string) error
- func DeleteGroup(cmd *cobra.Command, args []string) error
- func DeletePipeline(cmd *cobra.Command, args []string) error
- func DeleteTemplate(cmd *cobra.Command, args []string) error
- func ExpandGroup(cmd *cobra.Command, args []string) error
- func ExpandPipeline(cmd *cobra.Command, args []string) error
- func ExpandPipelineOverride(filename string) (*model.UplPipeline, error)
- func GetGroup(cmd *cobra.Command, args []string) error
- func GetInputSchema(cmd *cobra.Command, args []string) error
- func GetInputSchemaOverride(nodeUuid string, targetPortName string, filename string) (*model.UplType, error)
- func GetOutputSchema(cmd *cobra.Command, args []string) error
- func GetOutputSchemaOverride(nodeUuid *string, sourcePortName *string, filename string) (map[string]model.UplType, error)
- func GetPipeline(cmd *cobra.Command, args []string) error
- func GetPipelineLatestMetrics(cmd *cobra.Command, args []string) error
- func GetPipelinesStatus(cmd *cobra.Command, args []string) error
- func GetPreviewData(cmd *cobra.Command, args []string) error
- func GetPreviewSession(cmd *cobra.Command, args []string) error
- func GetPreviewSessionLatestMetrics(cmd *cobra.Command, args []string) error
- func GetRegistry(cmd *cobra.Command, args []string) error
- func GetTemplate(cmd *cobra.Command, args []string) error
- func ListConnections(cmd *cobra.Command, args []string) error
- func ListConnectors(cmd *cobra.Command, args []string) error
- func ListPipelines(cmd *cobra.Command, args []string) error
- func ListTemplates(cmd *cobra.Command, args []string) error
- func MergePipelines(cmd *cobra.Command, args []string) error
- func MergePipelinesOverride(targetNode string, targetPort string, inputTreeFilename string, ...) (*model.UplPipeline, error)
- func PutConnection(cmd *cobra.Command, args []string) error
- func PutConnectionOverride(id string, filename string) (*model.ConnectionSaveResponse, error)
- func PutGroup(cmd *cobra.Command, args []string) error
- func PutGroupOverride(groupId string, filename string) (*model.GroupResponse, error)
- func PutTemplate(cmd *cobra.Command, args []string) error
- func PutTemplateOverride(templateId string, filename string) (*model.TemplateResponse, error)
- func ReactivatePipeline(cmd *cobra.Command, args []string) error
- func StartPreview(cmd *cobra.Command, args []string) error
- func StartPreviewOverride(filename string) (*model.PreviewStartResponse, error)
- func StopPreview(cmd *cobra.Command, args []string) error
- func UpdateConnection(cmd *cobra.Command, args []string) error
- func UpdateConnectionOverride(id string, filename string) (*model.ConnectionSaveResponse, error)
- func UpdateGroup(cmd *cobra.Command, args []string) error
- func UpdateGroupOverride(groupId string, filename string) (*model.GroupResponse, error)
- func UpdatePipeline(cmd *cobra.Command, args []string) error
- func UpdatePipelineOverride(id string, bypassValidation *bool, createUserId *string, description *string, ...) (*model.PipelineResponse, error)
- func UpdateTemplate(cmd *cobra.Command, args []string) error
- func UpdateTemplateOverride(templateId string, description *string, name *string, filename string) (*model.TemplateResponse, error)
- func ValidatePipeline(cmd *cobra.Command, args []string) error
- func ValidatePipelineOverride(filename string) (*model.ValidateResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ActivatePipeline ¶
ActivatePipeline Activates an existing pipeline.
func CompileDSL ¶
CompileDSL Compiles the Streams DSL and returns Streams JSON.
func CompileDSLOverride ¶
func CompileDSLOverride(filename string) (*model.UplPipeline, error)
CompileDSLOverride
func CompileSPL ¶
CompileSPL Compiles SPL2 and returns Streams JSON.
func CompileSPLOverride ¶
func CompileSPLOverride(filename string) (*model.UplPipeline, error)
CompileSPLOverride
func CreateConnection ¶
CreateConnection Create a new DSP connection.
func CreateGroup ¶
CreateGroup Create a new group function by combining the Streams JSON of two or more functions.
func CreateGroupOverride ¶
func CreateGroupOverride(filename string) (*model.GroupResponse, error)
CreateGroupOverride
func CreatePipeline ¶
CreatePipeline Creates a pipeline.
func CreatePipelineOverride ¶
func CreatePipelineOverride(bypassValidation *bool, description *string, name string, filename string) (*model.PipelineResponse, error)
CreatePipeline
func CreateTemplate ¶
CreateTemplate Creates a template for a tenant.
func CreateTemplateOverride ¶
func CreateTemplateOverride(description string, name string, filename string) (*model.TemplateResponse, error)
CreateTemplateOverride
func DeactivatePipeline ¶
DeactivatePipeline Deactivates an existing pipeline.
func DeleteConnection ¶
DeleteConnection Delete all versions of a connection by its id.
func DeleteGroup ¶
DeleteGroup Removes an existing group.
func DeletePipeline ¶
DeletePipeline Removes a pipeline.
func DeleteTemplate ¶
DeleteTemplate Removes a template with a specific ID.
func ExpandGroup ¶
ExpandGroup Creates and returns the expanded version of a group.
func ExpandPipeline ¶
ExpandPipeline Returns the entire Streams JSON, including the expanded Streams JSON of any group functions in the pipeline.
func ExpandPipelineOverride ¶
func ExpandPipelineOverride(filename string) (*model.UplPipeline, error)
ExpandPipelineOverride
func GetInputSchema ¶
GetInputSchema Returns the input schema for a function in a pipeline.
func GetInputSchemaOverride ¶
func GetInputSchemaOverride(nodeUuid string, targetPortName string, filename string) (*model.UplType, error)
GetInputSchemaOverride
func GetOutputSchema ¶
GetOutputSchema Returns the output schema for a specified function in a pipeline. If no function ID is specified, the request returns the output schema for all functions in a pipeline.
func GetOutputSchemaOverride ¶
func GetOutputSchemaOverride(nodeUuid *string, sourcePortName *string, filename string) (map[string]model.UplType, error)
GetOutputSchemaOverride
func GetPipeline ¶
GetPipeline Returns an individual pipeline by version.
func GetPipelineLatestMetrics ¶
GetPipelineLatestMetrics Returns the latest metrics for a single pipeline.
func GetPipelinesStatus ¶
GetPipelinesStatus Returns the status of pipelines from the underlying streaming system.
func GetPreviewData ¶
GetPreviewData Returns the preview data for a session.
func GetPreviewSession ¶
GetPreviewSession Returns information from a preview session.
func GetPreviewSessionLatestMetrics ¶
GetPreviewSessionLatestMetrics Returns the latest metrics for a preview session.
func GetRegistry ¶
GetRegistry Returns all functions in JSON format.
func GetTemplate ¶
GetTemplate Returns an individual template by version.
func ListConnections ¶
ListConnections Returns a list of connections (latest versions only) by tenant ID.
func ListConnectors ¶
ListConnectors Returns a list of the available connectors.
func ListPipelines ¶
ListPipelines Returns all pipelines.
func ListTemplates ¶
ListTemplates Returns a list of all templates.
func MergePipelines ¶
MergePipelines Combines two Streams JSON programs.
func MergePipelinesOverride ¶
func MergePipelinesOverride(targetNode string, targetPort string, inputTreeFilename string, mainTreeFilename string) (*model.UplPipeline, error)
MergePipelinesOverride
func PutConnection ¶
PutConnection Modifies an existing DSP connection.
func PutConnectionOverride ¶
func PutConnectionOverride(id string, filename string) (*model.ConnectionSaveResponse, error)
PutConnectionOverride
func PutGroup ¶
PutGroup Update a group function combining the Streams JSON of two or more functions.
func PutGroupOverride ¶
func PutGroupOverride(groupId string, filename string) (*model.GroupResponse, error)
PutGroupOverride
func PutTemplate ¶
PutTemplate Updates an existing template.
func PutTemplateOverride ¶
func PutTemplateOverride(templateId string, filename string) (*model.TemplateResponse, error)
PutTemplateOverride
func ReactivatePipeline ¶
ReactivatePipeline Reactivate a pipeline
func StartPreview ¶
StartPreview Creates a preview session for a pipeline.
func StartPreviewOverride ¶
func StartPreviewOverride(filename string) (*model.PreviewStartResponse, error)
StartPreviewOverride
func StopPreview ¶
StopPreview Stops a preview session.
func UpdateConnection ¶
UpdateConnection Partially modifies an existing DSP connection.
func UpdateConnectionOverride ¶
func UpdateConnectionOverride(id string, filename string) (*model.ConnectionSaveResponse, error)
UpdateConnectionOverride
func UpdateGroup ¶
UpdateGroup Modify a group function by combining the Streams JSON of two or more functions.
func UpdateGroupOverride ¶
func UpdateGroupOverride(groupId string, filename string) (*model.GroupResponse, error)
UpdateGroupOverride
func UpdatePipeline ¶
UpdatePipeline Partially modifies an existing pipeline.
func UpdatePipelineOverride ¶
func UpdatePipelineOverride(id string, bypassValidation *bool, createUserId *string, description *string, name *string, filename string) (*model.PipelineResponse, error)
UpdatePipelineOverride
func UpdateTemplate ¶
UpdateTemplate Partially modifies an existing template.
func UpdateTemplateOverride ¶
func UpdateTemplateOverride(templateId string, description *string, name *string, filename string) (*model.TemplateResponse, error)
UpdateTemplateOverride
func ValidatePipeline ¶
ValidatePipeline Verifies whether the Streams JSON is valid.
func ValidatePipelineOverride ¶
func ValidatePipelineOverride(filename string) (*model.ValidateResponse, error)
ValidatePipelineOverride
Types ¶
This section is empty.