streams

type ActivatePipelineRequest struct {
	// Set to true to activate the latest version of the pipeline. Set to false to use the previously activated version of the pipeline. Defaults to true.
	ActivateLatestVersion *bool `json:"activateLatestVersion,omitempty"`
	// Set to true to allow the pipeline to ignore any unused progress states. In some cases, when a data pipeline is changed, the progress state will be stored for functions that no longer exist, so this must be set to activate a pipeline in this state. Defaults to false.
	AllowNonRestoredState *bool `json:"allowNonRestoredState,omitempty"`
	// Set to true to start reading from the latest input rather than from where the pipeline's previous run left off, which can cause data loss. Defaults to false.
	SkipRestoreState *bool `json:"skipRestoreState,omitempty"`
}

type AdditionalProperties map[string][]string

type ConnectionPatchRequest struct {
	// The key-value pairs of configurations for this connection. Connectors may have some configurations that are required, which all connections must provide values for. For configuration values of type BYTES, the provided values must be Base64 encoded.
	Data map[string]interface{} `json:"data,omitempty"`
	// The description of the connection.
	Description *string `json:"description,omitempty"`
	// The name of the connection.
	Name *string `json:"name,omitempty"`
}

type ConnectionPutRequest struct {
	// The key-value pairs of configurations for this connection. Connectors may have some configurations that are required, which all connections must provide values for. For configuration values of type BYTES, the provided values must be Base64 encoded.
	Data map[string]interface{} `json:"data"`
	// The description of the connection.
	Description string `json:"description"`
	// The name of the connection.
	Name string `json:"name"`
}

type ConnectionRequest struct {
	// The ID of the parent connector.
	ConnectorId string `json:"connectorId"`
	// The key-value pairs of configurations for this connection. Connectors may have some configurations that are required, which all connections must provide values for. For configuration values of type BYTES, the provided values must be Base64 encoded.
	Data map[string]interface{} `json:"data"`
	// The description of the connection.
	Description string `json:"description"`
	// The name of the connection.
	Name string `json:"name"`
}

type ConnectionResponse struct {
	ActivePipelinesUsing []map[string]interface{}    `json:"activePipelinesUsing,omitempty"`
	ConnectorId          *string                     `json:"connectorId,omitempty"`
	ConnectorName        *string                     `json:"connectorName,omitempty"`
	CreateDate           *int64                      `json:"createDate,omitempty"`
	CreateUserId         *string                     `json:"createUserId,omitempty"`
	Id                   *string                     `json:"id,omitempty"`
	LastUpdateDate       *int64                      `json:"lastUpdateDate,omitempty"`
	LastUpdateUserId     *string                     `json:"lastUpdateUserId,omitempty"`
	Versions             []ConnectionVersionResponse `json:"versions,omitempty"`
}

type ConnectionSaveResponse struct {
	ConnectorId  *string     `json:"connectorId,omitempty"`
	CreateDate   *int64      `json:"createDate,omitempty"`
	CreateUserId *string     `json:"createUserId,omitempty"`
	Data         *ObjectNode `json:"data,omitempty"`
	Description  *string     `json:"description,omitempty"`
	Id           *string     `json:"id,omitempty"`
	Name         *string     `json:"name,omitempty"`
	Version      *int64      `json:"version,omitempty"`
}

type ConnectionVersionResponse struct {
	CreateDate   *int64      `json:"createDate,omitempty"`
	CreateUserId *string     `json:"createUserId,omitempty"`
	Data         *ObjectNode `json:"data,omitempty"`
	Description  *string     `json:"description,omitempty"`
	Name         *string     `json:"name,omitempty"`
	Version      *int64      `json:"version,omitempty"`
}

type ConnectorResponse struct {
	Config        *ObjectNode              `json:"config,omitempty"`
	ConnectorType *string                  `json:"connectorType,omitempty"`
	Description   *string                  `json:"description,omitempty"`
	Functions     []map[string]interface{} `json:"functions,omitempty"`
	Hidden        *bool                    `json:"hidden,omitempty"`
	Id            *string                  `json:"id,omitempty"`
	Name          *string                  `json:"name,omitempty"`
	PanelUrl      *string                  `json:"panelUrl,omitempty"`
	Tag           *string                  `json:"tag,omitempty"`
}

type DeactivatePipelineRequest struct {
	// Set to true to skip saving the state of a deactivated pipeline. When the pipeline is later activated, it will start with the newest data and skip any data that arrived after this deactivation, which can cause data loss. Defaults to false.
	SkipSavepoint *bool `json:"skipSavepoint,omitempty"`
}

type DslCompilationRequest struct {
	// The Streams DSL representation of a pipeline.
	Dsl string `json:"dsl"`
}

type GetInputSchemaRequest struct {
	// The function ID.
	NodeUuid string `json:"nodeUuid"`
	// The name of the input port.
	TargetPortName string      `json:"targetPortName"`
	UplJson        UplPipeline `json:"uplJson"`
}

type GetOutputSchemaRequest struct {
	UplJson UplPipeline `json:"uplJson"`
	// The function ID. If omitted, returns the output schema for all functions.
	NodeUuid *string `json:"nodeUuid,omitempty"`
	// The name of the output port. Deprecated.
	SourcePortName *string `json:"sourcePortName,omitempty"`
}

type GetPipelineQueryParams struct {
	// Version : version
	Version string `key:"version"`
}

type GetPipelinesStatusQueryParams struct {
	// Activated : activated
	Activated *bool `key:"activated"`
	// CreateUserId : createUserId
	CreateUserId string `key:"createUserId"`
	// Name : name
	Name string `key:"name"`
	// Offset : offset
	Offset *int32 `key:"offset"`
	// PageSize : pageSize
	PageSize *int32 `key:"pageSize"`
	// SortDir : sortDir
	SortDir string `key:"sortDir"`
	// SortField : sortField
	SortField string `key:"sortField"`
}

type GetRegistryQueryParams struct {
	// Local : local
	Local *bool `key:"local"`
}

type GetTemplateQueryParams struct {
	// Version : version of the template
	Version *int64 `key:"version"`
}

type GroupArgumentsNode struct {
	// The argument name for your group function.
	GroupArg string `json:"groupArg"`
	// Group function argument position number.
	Position int32 `json:"position"`
	// The group function's data type.
	Type string `json:"type"`
}

type GroupExpandRequest struct {
	// Function arguments for the given id. Overrides default values.
	Arguments map[string]interface{} `json:"arguments"`
	// The ID associated with your group function in the pipeline Streams JSON
	Id string `json:"id"`
}

type GroupFunctionArgsMappingNode struct {
	// List of mappings from group function argument to function argument.
	Arguments []GroupFunctionArgsNode `json:"arguments"`
	// The function id to map to a group function argument.
	FunctionId string `json:"functionId"`
}

type GroupFunctionArgsNode struct {
	// Function argument name.
	FunctionArg string `json:"functionArg"`
	// The argument name for your group function.
	GroupArg string `json:"groupArg"`
}

type GroupPatchRequest struct {
	// Group function arguments list.
	Arguments []GroupArgumentsNode `json:"arguments,omitempty"`
	Ast       *UplPipeline         `json:"ast,omitempty"`
	// Attributes map for function.
	Attributes map[string]interface{} `json:"attributes,omitempty"`
	// Categories for this function.
	Categories []int64 `json:"categories,omitempty"`
	// Group function mappings list.
	Mappings []GroupFunctionArgsMappingNode `json:"mappings,omitempty"`
	// The name for the group function.
	Name *string `json:"name,omitempty"`
	// The data type of the output of your function.
	OutputType *string `json:"outputType,omitempty"`
	Scalar     *bool   `json:"scalar,omitempty"`
	Variadic   *bool   `json:"variadic,omitempty"`
}

type GroupPutRequest struct {
	// The group function arguments list.
	Arguments []GroupArgumentsNode `json:"arguments"`
	Ast       UplPipeline          `json:"ast"`
	// The attributes map for function.
	Attributes map[string]interface{} `json:"attributes"`
	// The categories for this function.
	Categories []int64 `json:"categories"`
	// The group function mappings list.
	Mappings []GroupFunctionArgsMappingNode `json:"mappings"`
	// The group function name.
	Name string `json:"name"`
	// The data type of the function's output.
	OutputType string `json:"outputType"`
	Scalar     *bool  `json:"scalar,omitempty"`
	Variadic   *bool  `json:"variadic,omitempty"`
}

type GroupRequest struct {
	// The group function arguments list.
	Arguments []GroupArgumentsNode `json:"arguments"`
	Ast       UplPipeline          `json:"ast"`
	// The attributes map for function.
	Attributes map[string]interface{} `json:"attributes"`
	// The categories for this function.
	Categories []int64 `json:"categories"`
	// The group function mappings list.
	Mappings []GroupFunctionArgsMappingNode `json:"mappings"`
	// The group function name.
	Name string `json:"name"`
	// The data type of the function's output.
	OutputType string `json:"outputType"`
	Scalar     *bool  `json:"scalar,omitempty"`
	Variadic   *bool  `json:"variadic,omitempty"`
}

type GroupResponse struct {
	Arguments        []GroupArgumentsNode           `json:"arguments,omitempty"`
	Ast              *UplPipeline                   `json:"ast,omitempty"`
	Attributes       map[string]interface{}         `json:"attributes,omitempty"`
	Categories       []int64                        `json:"categories,omitempty"`
	CreateDate       *int64                         `json:"createDate,omitempty"`
	CreateUserId     *string                        `json:"createUserId,omitempty"`
	GroupId          *string                        `json:"groupId,omitempty"`
	LastUpdateDate   *int64                         `json:"lastUpdateDate,omitempty"`
	LastUpdateUserId *string                        `json:"lastUpdateUserId,omitempty"`
	Mappings         []GroupFunctionArgsMappingNode `json:"mappings,omitempty"`
	Name             *string                        `json:"name,omitempty"`
	OutputType       *string                        `json:"outputType,omitempty"`
	Scalar           *bool                          `json:"scalar,omitempty"`
	TenantId         *string                        `json:"tenantId,omitempty"`
	Variadic         *bool                          `json:"variadic,omitempty"`
}

type ListConnectionsQueryParams struct {
	ConnectorId     string `key:"connectorId"`
	CreateUserId    string `key:"createUserId"`
	FunctionId      string `key:"functionId"`
	Name            string `key:"name"`
	Offset          *int32 `key:"offset"`
	PageSize        *int32 `key:"pageSize"`
	ShowSecretNames string `key:"showSecretNames"`
	// SortDir : Specify either ascending ('asc') or descending ('desc') sort order for a given field (sortField), which must be set for sortDir to apply. Defaults to 'asc'.
	SortDir   string `key:"sortDir"`
	SortField string `key:"sortField"`
}

type ListPipelinesQueryParams struct {
	// Activated : activated
	Activated *bool `key:"activated"`
	// CreateUserId : createUserId
	CreateUserId string `key:"createUserId"`
	// IncludeData : includeData
	IncludeData *bool `key:"includeData"`
	// Name : name
	Name string `key:"name"`
	// Offset : offset
	Offset *int32 `key:"offset"`
	// PageSize : pageSize
	PageSize *int32 `key:"pageSize"`
	// SortDir : sortDir
	SortDir string `key:"sortDir"`
	// SortField : sortField
	SortField string `key:"sortField"`
}

type ListTemplatesQueryParams struct {
	// Offset : offset
	Offset *int32 `key:"offset"`
	// PageSize : pageSize
	PageSize *int32 `key:"pageSize"`
	// SortDir : sortDir
	SortDir string `key:"sortDir"`
	// SortField : sortField
	SortField string `key:"sortField"`
}

type MapOfstringAndobject map[string]interface{}

type MetricsResponse struct {
	Nodes map[string]NodeMetrics `json:"nodes,omitempty"`
}

type NodeMetrics struct {
	Metrics map[string]interface{} `json:"metrics,omitempty"`
}

type ObjectNode struct {
	Array               *bool               `json:"array,omitempty"`
	BigDecimal          *bool               `json:"bigDecimal,omitempty"`
	BigInteger          *bool               `json:"bigInteger,omitempty"`
	Binary              *bool               `json:"binary,omitempty"`
	Boolean             *bool               `json:"boolean,omitempty"`
	ContainerNode       *bool               `json:"containerNode,omitempty"`
	Double              *bool               `json:"double,omitempty"`
	Float               *bool               `json:"float,omitempty"`
	FloatingPointNumber *bool               `json:"floatingPointNumber,omitempty"`
	Int                 *bool               `json:"int,omitempty"`
	IntegralNumber      *bool               `json:"integralNumber,omitempty"`
	Long                *bool               `json:"long,omitempty"`
	MissingNode         *bool               `json:"missingNode,omitempty"`
	NodeType            *ObjectNodeNodeType `json:"nodeType,omitempty"`
	Null                *bool               `json:"null,omitempty"`
	Number              *bool               `json:"number,omitempty"`
	Object              *bool               `json:"object,omitempty"`
	Pojo                *bool               `json:"pojo,omitempty"`
	Short               *bool               `json:"short,omitempty"`
	Textual             *bool               `json:"textual,omitempty"`
	ValueNode           *bool               `json:"valueNode,omitempty"`
}

type ObjectNodeNodeType string

type PaginatedResponseOfConnectionResponse struct {
	Items []ConnectionResponse `json:"items,omitempty"`
	Total *int64               `json:"total,omitempty"`
}

type PaginatedResponseOfConnectorResponse struct {
	Items []ConnectorResponse `json:"items,omitempty"`
	Total *int64              `json:"total,omitempty"`
}

type PaginatedResponseOfPipelineJobStatus struct {
	Items []PipelineJobStatus `json:"items,omitempty"`
	Total *int64              `json:"total,omitempty"`
}

type PaginatedResponseOfPipelineResponse struct {
	Items []PipelineResponse `json:"items,omitempty"`
	Total *int64             `json:"total,omitempty"`
}

type PaginatedResponseOfTemplateResponse struct {
	Items []TemplateResponse `json:"items,omitempty"`
	Total *int64             `json:"total,omitempty"`
}

type PartialTemplateRequest struct {
	Data        *UplPipeline `json:"data,omitempty"`
	Description *string      `json:"description,omitempty"`
	Name        *string      `json:"name,omitempty"`
}

type PipelineDeleteResponse struct {
	CouldDeactivate *bool `json:"couldDeactivate,omitempty"`
	Running         *bool `json:"running,omitempty"`
}

type PipelineJobStatus struct {
	JobId      *string `json:"jobId,omitempty"`
	JobStatus  *string `json:"jobStatus,omitempty"`
	PipelineId *string `json:"pipelineId,omitempty"`
}

type PipelinePatchRequest struct {
	// Set to true to bypass initial pipeline validation upon creation. The pipeline still needs to be validated before activation. Defaults to false.
	BypassValidation *bool `json:"bypassValidation,omitempty"`
	// The user that created the pipeline. Deprecated.
	CreateUserId *string      `json:"createUserId,omitempty"`
	Data         *UplPipeline `json:"data,omitempty"`
	// The description of the pipeline. Defaults to null.
	Description *string `json:"description,omitempty"`
	// The name of the pipeline.
	Name *string `json:"name,omitempty"`
}

type PipelineQueryParams struct {
	Offset       *int32  `json:"offset,omitempty"`
	PageSize     *int32  `json:"pageSize,omitempty"`
	SortField    *string `json:"sortField,omitempty"`
	SortDir      *string `json:"sortDir,omitempty"`
	Activated    *bool   `json:"activated,omitempty"`
	CreateUserID *string `json:"createUserId,omitempty"`
	Name         *string `json:"name,omitempty"`
	IncludeData  *bool   `json:"includeData,omitempty"`
}

type PipelineReactivateResponse struct {
	CurrentlyActiveVersion     *int64                                                `json:"currentlyActiveVersion,omitempty"`
	PipelineId                 *string                                               `json:"pipelineId,omitempty"`
	PipelineReactivationStatus *PipelineReactivateResponsePipelineReactivationStatus `json:"pipelineReactivationStatus,omitempty"`
}

type PipelineReactivateResponsePipelineReactivationStatus string

type PipelineRequest struct {
	Data UplPipeline `json:"data"`
	// The name of the pipeline.
	Name string `json:"name"`
	// Set to true to bypass initial pipeline validation upon creation. The pipeline still needs to be validated before activation. Defaults to false.
	BypassValidation *bool `json:"bypassValidation,omitempty"`
	// The user that created the pipeline. Deprecated.
	CreateUserId *string `json:"createUserId,omitempty"`
	// The description of the pipeline. Defaults to null.
	Description *string `json:"description,omitempty"`
}

type PipelineResponse struct {
	ActivatedDate            *int64                  `json:"activatedDate,omitempty"`
	ActivatedUserId          *string                 `json:"activatedUserId,omitempty"`
	ActivatedVersion         *int64                  `json:"activatedVersion,omitempty"`
	CreateDate               *int64                  `json:"createDate,omitempty"`
	CreateUserId             *string                 `json:"createUserId,omitempty"`
	CurrentVersion           *int64                  `json:"currentVersion,omitempty"`
	Data                     *UplPipeline            `json:"data,omitempty"`
	Description              *string                 `json:"description,omitempty"`
	Id                       *string                 `json:"id,omitempty"`
	LastUpdateDate           *int64                  `json:"lastUpdateDate,omitempty"`
	LastUpdateUserId         *string                 `json:"lastUpdateUserId,omitempty"`
	Name                     *string                 `json:"name,omitempty"`
	Status                   *PipelineResponseStatus `json:"status,omitempty"`
	StatusMessage            *string                 `json:"statusMessage,omitempty"`
	StreamingConfigurationId *int64                  `json:"streamingConfigurationId,omitempty"`
	TenantId                 *string                 `json:"tenantId,omitempty"`
	ValidationMessages       []string                `json:"validationMessages,omitempty"`
	Version                  *int64                  `json:"version,omitempty"`
}

type PipelineResponseStatus string

type PipelineStatusQueryParams struct {
	Offset       *int32  `json:"offset,omitempty"`
	PageSize     *int32  `json:"pageSize,omitempty"`
	SortField    *string `json:"sortField,omitempty"`
	SortDir      *string `json:"sortDir,omitempty"`
	Activated    *bool   `json:"activated,omitempty"`
	CreateUserID *string `json:"createUserId,omitempty"`
	Name         *string `json:"name,omitempty"`
}

type PipelinesMergeRequest struct {
	InputTree UplPipeline `json:"inputTree"`
	MainTree  UplPipeline `json:"mainTree"`
	// The function ID of the merge target in the main pipeline.
	TargetNode string `json:"targetNode"`
	// The input port of the merge target in the main pipeline.
	TargetPort string `json:"targetPort"`
}

type PreviewData struct {
	CurrentNumberOfRecords *int32                 `json:"currentNumberOfRecords,omitempty"`
	Nodes                  map[string]PreviewNode `json:"nodes,omitempty"`
	PreviewId              *string                `json:"previewId,omitempty"`
	RecordsPerPipeline     *int32                 `json:"recordsPerPipeline,omitempty"`
	TenantId               *string                `json:"tenantId,omitempty"`
}

type PreviewNode struct {
	NodeName *string      `json:"nodeName,omitempty"`
	Records  []ObjectNode `json:"records,omitempty"`
}

type PreviewSessionStartRequest struct {
	Upl UplPipeline `json:"upl"`
	// The maximum number of events per function. Defaults to 100.
	RecordsLimit *int32 `json:"recordsLimit,omitempty"`
	// The maximum number of events per pipeline. Defaults to 10000.
	RecordsPerPipeline *int32 `json:"recordsPerPipeline,omitempty"`
	// The maximum lifetime of a session, in milliseconds. Defaults to 300,000.
	SessionLifetimeMs *int64 `json:"sessionLifetimeMs,omitempty"`
	// Deprecated. Must be null if set.
	StreamingConfigurationId *int64 `json:"streamingConfigurationId,omitempty"`
	// Deprecated. Must be true if set.
	UseNewData *bool `json:"useNewData,omitempty"`
}

type PreviewStartResponse struct {
	PreviewId *int64 `json:"previewId,omitempty"`
}

type PreviewState struct {
	ActivatedDate          *int64  `json:"activatedDate,omitempty"`
	CreatedDate            *int64  `json:"createdDate,omitempty"`
	CurrentNumberOfRecords *int32  `json:"currentNumberOfRecords,omitempty"`
	JobId                  *string `json:"jobId,omitempty"`
	PreviewId              *int64  `json:"previewId,omitempty"`
	RecordsPerPipeline     *int32  `json:"recordsPerPipeline,omitempty"`
}

type Response struct {
	// Only set for /activate endpoint
	Activated *string `json:"activated,omitempty"`
	// Only set for /deactivate endpoint
	Deactivated *string `json:"deactivated,omitempty"`
}

type Service services.BaseService

type Servicer interface {
	/*
		ActivatePipeline - Activates an existing pipeline.
		Parameters:
			id: id of the pipeline to activate
			activatePipelineRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ActivatePipeline(id string, activatePipelineRequest ActivatePipelineRequest, resp ...*http.Response) (*Response, error)
	/*
		CompileDSL - Compiles the Streams DSL and returns Streams JSON.
		Parameters:
			dslCompilationRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CompileDSL(dslCompilationRequest DslCompilationRequest, resp ...*http.Response) (*UplPipeline, error)
	/*
		CreateConnection - Create a new DSP connection.
		Parameters:
			connectionRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateConnection(connectionRequest ConnectionRequest, resp ...*http.Response) (*ConnectionSaveResponse, error)
	/*
		CreateGroup - Create a new group function by combining the Streams JSON of two or more functions.
		Parameters:
			groupRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateGroup(groupRequest GroupRequest, resp ...*http.Response) (*GroupResponse, error)
	/*
		CreatePipeline - Creates a pipeline.
		Parameters:
			pipelineRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreatePipeline(pipelineRequest PipelineRequest, resp ...*http.Response) (*PipelineResponse, error)
	/*
		CreateTemplate - Creates a template for a tenant.
		Parameters:
			templateRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateTemplate(templateRequest TemplateRequest, resp ...*http.Response) (*TemplateResponse, error)
	/*
		DeactivatePipeline - Deactivates an existing pipeline.
		Parameters:
			id: id of the pipeline to deactivate
			deactivatePipelineRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeactivatePipeline(id string, deactivatePipelineRequest DeactivatePipelineRequest, resp ...*http.Response) (*Response, error)
	/*
		DeleteConnection - Delete all versions of a connection by its id.
		Parameters:
			connectionId: ID of the connection
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteConnection(connectionId string, resp ...*http.Response) error
	/*
		DeleteGroup - Removes an existing group.
		Parameters:
			groupId: The group function's ID from the function registry
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteGroup(groupId string, resp ...*http.Response) error
	/*
		DeletePipeline - Removes a pipeline.
		Parameters:
			id: id of the pipeline to delete
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeletePipeline(id string, resp ...*http.Response) (*PipelineDeleteResponse, error)
	/*
		DeleteTemplate - Removes a template with a specific ID.
		Parameters:
			templateId: ID of the template to delete
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteTemplate(templateId string, resp ...*http.Response) error
	/*
		ExpandGroup - Creates and returns the expanded version of a group.
		Parameters:
			groupId: The group function's ID from the function registry
			groupExpandRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ExpandGroup(groupId string, groupExpandRequest GroupExpandRequest, resp ...*http.Response) (*UplPipeline, error)
	/*
		ExpandPipeline - Returns the entire Streams JSON, including the expanded Streams JSON of any group functions in the pipeline.
		Parameters:
			uplPipeline: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ExpandPipeline(uplPipeline UplPipeline, resp ...*http.Response) (*UplPipeline, error)
	/*
		GetGroup - Returns the full Streams JSON of a group.
		Parameters:
			groupId: The group function's ID from the function registry
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetGroup(groupId string, resp ...*http.Response) (*GroupResponse, error)
	/*
		GetInputSchema - Returns the input schema for a function in a pipeline.
		Parameters:
			getInputSchemaRequest: Input Schema Request
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetInputSchema(getInputSchemaRequest GetInputSchemaRequest, resp ...*http.Response) (*UplType, error)
	/*
		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.
		Parameters:
			getOutputSchemaRequest: Output Schema Request
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetOutputSchema(getOutputSchemaRequest GetOutputSchemaRequest, resp ...*http.Response) (map[string]UplType, error)
	/*
		GetPipeline - Returns an individual pipeline by version.
		Parameters:
			id: id of the pipeline to get
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetPipeline(id string, query *GetPipelineQueryParams, resp ...*http.Response) (*PipelineResponse, error)
	/*
		GetPipelineLatestMetrics - Returns the latest metrics for a single pipeline.
		Parameters:
			id: ID of the pipeline to get metrics for
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetPipelineLatestMetrics(id string, resp ...*http.Response) (*MetricsResponse, error)
	/*
		GetPipelinesStatus - Returns the status of pipelines from the underlying streaming system.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetPipelinesStatus(query *GetPipelinesStatusQueryParams, resp ...*http.Response) (*PaginatedResponseOfPipelineJobStatus, error)
	/*
		GetPreviewData - Returns the preview data for a session.
		Parameters:
			previewSessionId: ID of the preview session
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetPreviewData(previewSessionId int64, resp ...*http.Response) (*PreviewData, error)
	/*
		GetPreviewSession - Returns information from a preview session.
		Parameters:
			previewSessionId: ID of the preview session
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetPreviewSession(previewSessionId int64, resp ...*http.Response) (*PreviewState, error)
	/*
		GetPreviewSessionLatestMetrics - Returns the latest metrics for a preview session.
		Parameters:
			previewSessionId: ID of the preview session
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetPreviewSessionLatestMetrics(previewSessionId int64, resp ...*http.Response) (*MetricsResponse, error)
	/*
		GetRegistry - Returns all functions in JSON format.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetRegistry(query *GetRegistryQueryParams, resp ...*http.Response) (*UplRegistry, error)
	/*
		GetTemplate - Returns an individual template by version.
		Parameters:
			templateId: ID of the template
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetTemplate(templateId string, query *GetTemplateQueryParams, resp ...*http.Response) (*TemplateResponse, error)
	/*
		ListConnections - Returns a list of connections (latest versions only) by tenant ID.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListConnections(query *ListConnectionsQueryParams, resp ...*http.Response) (*PaginatedResponseOfConnectionResponse, error)
	/*
		ListConnectors - Returns a list of the available connectors.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListConnectors(resp ...*http.Response) (*PaginatedResponseOfConnectorResponse, error)
	/*
		ListPipelines - Returns all pipelines.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListPipelines(query *ListPipelinesQueryParams, resp ...*http.Response) (*PaginatedResponseOfPipelineResponse, error)
	/*
		ListTemplates - Returns a list of all templates.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListTemplates(query *ListTemplatesQueryParams, resp ...*http.Response) (*PaginatedResponseOfTemplateResponse, error)
	/*
		MergePipelines - Combines two Streams JSON programs.
		Parameters:
			pipelinesMergeRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	MergePipelines(pipelinesMergeRequest PipelinesMergeRequest, resp ...*http.Response) (*UplPipeline, error)
	/*
		PutConnection - Modifies an existing DSP connection.
		Parameters:
			connectionId: ID of the connection
			connectionPutRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	PutConnection(connectionId string, connectionPutRequest ConnectionPutRequest, resp ...*http.Response) (*ConnectionSaveResponse, error)
	/*
		PutGroup - Update a group function combining the Streams JSON of two or more functions.
		Parameters:
			groupId: The group function's ID from the function registry
			groupPutRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	PutGroup(groupId string, groupPutRequest GroupPutRequest, resp ...*http.Response) (*GroupResponse, error)
	/*
		PutTemplate - Updates an existing template.
		Parameters:
			templateId: ID of the template
			templatePutRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	PutTemplate(templateId string, templatePutRequest TemplatePutRequest, resp ...*http.Response) (*TemplateResponse, error)
	/*
		ReactivatePipeline - Reactivate a pipeline
		Parameters:
			id: Pipeline UUID to reactivate
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ReactivatePipeline(id string, resp ...*http.Response) (*PipelineReactivateResponse, error)
	/*
		StartPreview - Creates a preview session for a pipeline.
		Parameters:
			previewSessionStartRequest: Parameters to start a new Preview session
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	StartPreview(previewSessionStartRequest PreviewSessionStartRequest, resp ...*http.Response) (*PreviewStartResponse, error)
	/*
		StopPreview - Stops a preview session.
		Parameters:
			previewSessionId: ID of the preview session
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	StopPreview(previewSessionId int64, resp ...*http.Response) (*string, error)
	/*
		UpdateConnection - Partially modifies an existing DSP connection.
		Parameters:
			connectionId: ID of the connection
			connectionPatchRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdateConnection(connectionId string, connectionPatchRequest ConnectionPatchRequest, resp ...*http.Response) (*ConnectionSaveResponse, error)
	/*
		UpdateGroup - Modify a group function by combining the Streams JSON of two or more functions.
		Parameters:
			groupId: The group function's ID from the function registry
			groupPatchRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdateGroup(groupId string, groupPatchRequest GroupPatchRequest, resp ...*http.Response) (*GroupResponse, error)
	/*
		UpdatePipeline - Partially modifies an existing pipeline.
		Parameters:
			id: id of the pipeline to update
			pipelinePatchRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdatePipeline(id string, pipelinePatchRequest PipelinePatchRequest, resp ...*http.Response) (*PipelineResponse, error)
	/*
		UpdateTemplate - Partially modifies an existing template.
		Parameters:
			templateId: ID of the template
			templatePatchRequest: Request JSON
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdateTemplate(templateId string, templatePatchRequest TemplatePatchRequest, resp ...*http.Response) (*TemplateResponse, error)
	/*
		ValidatePipeline - Verifies whether the Streams JSON is valid.
		Parameters:
			validateRequest: JSON UPL to validate
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ValidatePipeline(validateRequest ValidateRequest, resp ...*http.Response) (*ValidateResponse, error)
}

type TemplatePatchRequest struct {
	Data *UplPipeline `json:"data,omitempty"`
	// Template description
	Description *string `json:"description,omitempty"`
	// Template name
	Name *string `json:"name,omitempty"`
}

type TemplatePutRequest struct {
	Data UplPipeline `json:"data"`
	// Template description
	Description string `json:"description"`
	// Template name
	Name string `json:"name"`
}

type TemplateRequest struct {
	Data UplPipeline `json:"data"`
	// Template description
	Description string `json:"description"`
	// Template name
	Name string `json:"name"`
}

type TemplateResponse struct {
	CreateDate    *int64       `json:"createDate,omitempty"`
	CreateUserId  *string      `json:"createUserId,omitempty"`
	Data          *UplPipeline `json:"data,omitempty"`
	Description   *string      `json:"description,omitempty"`
	Name          *string      `json:"name,omitempty"`
	OwnerTenantId *string      `json:"ownerTenantId,omitempty"`
	TemplateId    *string      `json:"templateId,omitempty"`
	Version       *int64       `json:"version,omitempty"`
}

type UplArgument struct {
	Type        string      `json:"type"`
	ElementType interface{} `json:"elementType,omitempty"`
}

type UplCategory struct {
	Id   int64  `json:"id"`
	Name string `json:"name"`
}

type UplEdge struct {
	// The source function's (node's) id
	SourceNode string `json:"sourceNode"`
	// The source function's (node's) port
	SourcePort string `json:"sourcePort"`
	// The target function's (node's) id
	TargetNode string `json:"targetNode"`
	// The target function's (node's) port
	TargetPort string                 `json:"targetPort"`
	Attributes map[string]interface{} `json:"attributes,omitempty"`
}

type UplFunction struct {
	Arguments  map[string]UplArgument `json:"arguments,omitempty"`
	Attributes map[string]interface{} `json:"attributes,omitempty"`
	Categories []int64                `json:"categories,omitempty"`
	Id         *string                `json:"id,omitempty"`
	IsVariadic *bool                  `json:"isVariadic,omitempty"`
	Op         *string                `json:"op,omitempty"`
	Output     *UplArgument           `json:"output,omitempty"`
	ResolvedId *string                `json:"resolvedId,omitempty"`
}

type UplNode struct {
	// The function's (node's) UUID
	Id string `json:"id"`
	// The function's ID or its API name
	Op string `json:"op"`
	// Optional key-value pair for a function (node)
	Attributes map[string]interface{} `json:"attributes,omitempty"`
	ResolvedId *string                `json:"resolvedId,omitempty"`
}

type UplPipeline struct {
	// A list of links or connections between the output of one pipeline function and the input of another pipeline function
	Edges []UplEdge `json:"edges"`
	// The functions (or nodes) in your entire pipeline, including each function's operations, attributes, and properties
	Nodes interface{} `json:"nodes"`
	// The UUIDs of all sink functions in a given pipeline
	RootNode []string `json:"rootNode"`
}

type UplRegistry struct {
	Categories []UplCategory `json:"categories,omitempty"`
	Functions  []UplFunction `json:"functions,omitempty"`
	Types      []UplType     `json:"types,omitempty"`
}

type UplType struct {
	FieldName  *string   `json:"fieldName,omitempty"`
	Parameters []UplType `json:"parameters,omitempty"`
	Type       *string   `json:"type,omitempty"`
}

type ValidateRequest struct {
	Upl UplPipeline `json:"upl"`
}

type ValidateResponse struct {
	Success            *bool    `json:"success,omitempty"`
	ValidationMessages []string `json:"validationMessages,omitempty"`
}