streams

package
v1.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 14, 2020 License: Apache-2.0 Imports: 7 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivatePipelineRequest

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

type AdditionalProperties map[string][]string

AdditionalProperties contain the properties in an activate/deactivate response

type ArgumentModel added in v1.6.0

type ArgumentModel struct {
	Name     *string `json:"name,omitempty"`
	Optional *bool   `json:"optional,omitempty"`
	Type     *string `json:"type,omitempty"`
}

type CollectJobRequest added in v1.8.0

type CollectJobRequest struct {
	// The ID of the connection that is assigned to this collect job.
	ConnectionId string `json:"connectionId"`
	// The ID of the connector this collect job uses.
	ConnectorId string `json:"connectorId"`
	// The description of the collect job.
	Description string `json:"description"`
	// The name of the collect job.
	Name string `json:"name"`
	// The key-value pairs of parameters for this collect job. Collect jobs may have some configurations that are required, which all collect jobs must provide values for. For configuration values of type BYTES, the provided values must be Base64 encoded.
	Parameters map[string]interface{} `json:"parameters"`
}

type CollectJobResponse added in v1.8.0

type CollectJobResponse struct {
	ActivePipelinesUsing []map[string]interface{} `json:"activePipelinesUsing,omitempty"`
	ConnectionId         *string                  `json:"connectionId,omitempty"`
	ConnectorId          *string                  `json:"connectorId,omitempty"`
	CreateDate           *int64                   `json:"createDate,omitempty"`
	CreateUserId         *string                  `json:"createUserId,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"`
	Parameters           map[string]interface{}   `json:"parameters,omitempty"`
	Status               *string                  `json:"status,omitempty"`
	Version              *int64                   `json:"version,omitempty"`
}

type CollectJobStartStopResponse added in v1.8.0

type CollectJobStartStopResponse struct {
	Id     *string `json:"id,omitempty"`
	Status *string `json:"status,omitempty"`
}

type ConnectionPatchRequest

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

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

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

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

type ConnectionSaveResponse struct {
	ConnectorId  *string                `json:"connectorId,omitempty"`
	CreateDate   *int64                 `json:"createDate,omitempty"`
	CreateUserId *string                `json:"createUserId,omitempty"`
	Data         map[string]interface{} `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

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

type ConnectorResponse

type ConnectorResponse struct {
	Config        map[string]interface{}   `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

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 DecompileRequest added in v1.6.0

type DecompileRequest struct {
	Upl Pipeline `json:"upl"`
}

type DecompileResponse added in v1.6.0

type DecompileResponse struct {
	Spl *string `json:"spl,omitempty"`
}

type ErrorResponse added in v1.6.0

type ErrorResponse struct {
	Code     *string                `json:"code,omitempty"`
	Details  []MapOfstringAndstring `json:"details,omitempty"`
	Message  *string                `json:"message,omitempty"`
	MoreInfo *string                `json:"moreInfo,omitempty"`
}

type FilesMetaDataResponse added in v1.6.0

type FilesMetaDataResponse struct {
	Files []UploadFile `json:"files,omitempty"`
}

type FunctionModel added in v1.6.0

type FunctionModel struct {
	Arguments  []ArgumentModel        `json:"arguments,omitempty"`
	Attributes map[string]interface{} `json:"attributes,omitempty"`
	Op         *string                `json:"op,omitempty"`
	Outputs    []ArgumentModel        `json:"outputs,omitempty"`
	ResolvedId *string                `json:"resolvedId,omitempty"`
}

type GetCollectJobQueryParams added in v1.8.0

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

GetCollectJobQueryParams represents valid query parameters for the GetCollectJob operation For convenience GetCollectJobQueryParams can be formed in a single statement, for example:

`v := GetCollectJobQueryParams{}.SetVersion(...)`

func (GetCollectJobQueryParams) SetVersion added in v1.8.0

type GetInputSchemaRequest

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

type GetLookupTableQueryParams added in v1.6.0

type GetLookupTableQueryParams struct {
	// Offset : offset
	Offset *int32 `key:"offset"`
	// Size : size
	Size *int32 `key:"size"`
}

GetLookupTableQueryParams represents valid query parameters for the GetLookupTable operation For convenience GetLookupTableQueryParams can be formed in a single statement, for example:

`v := GetLookupTableQueryParams{}.SetOffset(...).SetSize(...)`

func (GetLookupTableQueryParams) SetOffset added in v1.6.0

func (GetLookupTableQueryParams) SetSize added in v1.6.0

type GetOutputSchemaRequest

type GetOutputSchemaRequest struct {
	UplJson Pipeline `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

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

GetPipelineQueryParams represents valid query parameters for the GetPipeline operation For convenience GetPipelineQueryParams can be formed in a single statement, for example:

`v := GetPipelineQueryParams{}.SetVersion(...)`

func (GetPipelineQueryParams) SetVersion

type GetPipelinesStatusQueryParams

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"`
}

GetPipelinesStatusQueryParams represents valid query parameters for the GetPipelinesStatus operation For convenience GetPipelinesStatusQueryParams can be formed in a single statement, for example:

`v := GetPipelinesStatusQueryParams{}.SetActivated(...).SetCreateUserId(...).SetName(...).SetOffset(...).SetPageSize(...).SetSortDir(...).SetSortField(...)`

func (GetPipelinesStatusQueryParams) SetActivated

func (GetPipelinesStatusQueryParams) SetCreateUserId

func (GetPipelinesStatusQueryParams) SetName

func (GetPipelinesStatusQueryParams) SetOffset

func (GetPipelinesStatusQueryParams) SetPageSize

func (GetPipelinesStatusQueryParams) SetSortDir

func (GetPipelinesStatusQueryParams) SetSortField

type GetPluginsQueryParams added in v1.8.0

type GetPluginsQueryParams 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"`
}

GetPluginsQueryParams represents valid query parameters for the GetPlugins operation For convenience GetPluginsQueryParams can be formed in a single statement, for example:

`v := GetPluginsQueryParams{}.SetOffset(...).SetPageSize(...).SetSortDir(...).SetSortField(...)`

func (GetPluginsQueryParams) SetOffset added in v1.8.0

func (GetPluginsQueryParams) SetPageSize added in v1.8.0

func (GetPluginsQueryParams) SetSortDir added in v1.8.0

func (GetPluginsQueryParams) SetSortField added in v1.8.0

type GetRegistryQueryParams

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

GetRegistryQueryParams represents valid query parameters for the GetRegistry operation For convenience GetRegistryQueryParams can be formed in a single statement, for example:

`v := GetRegistryQueryParams{}.SetLocal(...)`

func (GetRegistryQueryParams) SetLocal

type GetTemplateQueryParams

type GetTemplateQueryParams struct {
	// Version : Template version
	Version *int64 `key:"version"`
}

GetTemplateQueryParams represents valid query parameters for the GetTemplate operation For convenience GetTemplateQueryParams can be formed in a single statement, for example:

`v := GetTemplateQueryParams{}.SetVersion(...)`

func (GetTemplateQueryParams) SetVersion

type ListConnectionsQueryParams

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"`
}

ListConnectionsQueryParams represents valid query parameters for the ListConnections operation For convenience ListConnectionsQueryParams can be formed in a single statement, for example:

`v := ListConnectionsQueryParams{}.SetConnectorId(...).SetCreateUserId(...).SetFunctionId(...).SetName(...).SetOffset(...).SetPageSize(...).SetShowSecretNames(...).SetSortDir(...).SetSortField(...)`

func (ListConnectionsQueryParams) SetConnectorId

func (ListConnectionsQueryParams) SetCreateUserId

func (ListConnectionsQueryParams) SetFunctionId

func (ListConnectionsQueryParams) SetName

func (ListConnectionsQueryParams) SetOffset

func (ListConnectionsQueryParams) SetPageSize

func (ListConnectionsQueryParams) SetShowSecretNames

func (ListConnectionsQueryParams) SetSortDir

func (ListConnectionsQueryParams) SetSortField

type ListPipelinesQueryParams

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"`
}

ListPipelinesQueryParams represents valid query parameters for the ListPipelines operation For convenience ListPipelinesQueryParams can be formed in a single statement, for example:

`v := ListPipelinesQueryParams{}.SetActivated(...).SetCreateUserId(...).SetIncludeData(...).SetName(...).SetOffset(...).SetPageSize(...).SetSortDir(...).SetSortField(...)`

func (ListPipelinesQueryParams) SetActivated

func (ListPipelinesQueryParams) SetCreateUserId

func (ListPipelinesQueryParams) SetIncludeData

func (ListPipelinesQueryParams) SetName

func (ListPipelinesQueryParams) SetOffset

func (ListPipelinesQueryParams) SetPageSize

func (ListPipelinesQueryParams) SetSortDir

func (ListPipelinesQueryParams) SetSortField

type ListRulesPackagesQueryParams added in v1.9.0

type ListRulesPackagesQueryParams struct {
	// SortDir : sortDir
	SortDir string `key:"sortDir"`
	// SortField : sortField
	SortField string `key:"sortField"`
}

ListRulesPackagesQueryParams represents valid query parameters for the ListRulesPackages operation For convenience ListRulesPackagesQueryParams can be formed in a single statement, for example:

`v := ListRulesPackagesQueryParams{}.SetSortDir(...).SetSortField(...)`

func (ListRulesPackagesQueryParams) SetSortDir added in v1.9.0

func (ListRulesPackagesQueryParams) SetSortField added in v1.9.0

type ListTemplatesQueryParams

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"`
}

ListTemplatesQueryParams represents valid query parameters for the ListTemplates operation For convenience ListTemplatesQueryParams can be formed in a single statement, for example:

`v := ListTemplatesQueryParams{}.SetOffset(...).SetPageSize(...).SetSortDir(...).SetSortField(...)`

func (ListTemplatesQueryParams) SetOffset

func (ListTemplatesQueryParams) SetPageSize

func (ListTemplatesQueryParams) SetSortDir

func (ListTemplatesQueryParams) SetSortField

type LookupTableResponse added in v1.6.0

type LookupTableResponse struct {
	Data  []map[string]interface{} `json:"data,omitempty"`
	Types map[string]string        `json:"types,omitempty"`
}

type MapOfstringAndobject

type MapOfstringAndobject map[string]interface{}

type MapOfstringAndstring added in v1.6.0

type MapOfstringAndstring map[string]interface{}

type MetricsResponse

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

type NodeMetrics

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

type PaginatedResponseOfCollectJobResponse added in v1.9.0

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

type PaginatedResponseOfConnectionResponse

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

type PaginatedResponseOfConnectorResponse

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

type PaginatedResponseOfPipelineJobStatus

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

type PaginatedResponseOfPipelineResponse

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

type PaginatedResponseOfPlugin added in v1.8.0

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

type PaginatedResponseOfRulesResponse added in v1.9.0

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

type PaginatedResponseOfTemplateResponse

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

type PartialTemplateRequest

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

PartialTemplateRequest contains the template request data for partial update operation

type Pipeline added in v1.6.0

type Pipeline struct {
	// A list of links between the output of one pipeline function and the input of another pipeline function.
	Edges []PipelineEdge `json:"edges"`
	// The functions in your entire pipeline, including each function's operations, attributes, and properties.
	Nodes []PipelineNode `json:"nodes"`
	// Optional metadata specified by client. Not to be interpreted by the platform
	Attributes    map[string]interface{} `json:"attributes,omitempty"`
	MigrationInfo *PipelineMigrationInfo `json:"migrationInfo,omitempty"`
}

type PipelineEdge added in v1.6.0

type PipelineEdge struct {
	SourceNode *string `json:"sourceNode,omitempty"`
	SourcePort *string `json:"sourcePort,omitempty"`
	TargetNode *string `json:"targetNode,omitempty"`
	TargetPort *string `json:"targetPort,omitempty"`
}

type PipelineJobStatus

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

type PipelineMigrationInfo added in v1.6.0

type PipelineMigrationInfo struct {
	CanMigrate       *bool  `json:"canMigrate,omitempty"`
	CreateApiVersion *int32 `json:"createApiVersion,omitempty"`
	TargetApiVersion *int32 `json:"targetApiVersion,omitempty"`
}

type PipelineNode added in v1.6.0

type PipelineNode struct {
	// A unique identifier for the function.
	Id string `json:"id"`
	// The operation name.
	Op string `json:"op"`
	// Function arguments keyed by argument name.
	Arguments map[string]interface{} `json:"arguments,omitempty"`
	// For internal use only. This field is ignored.
	Attributes map[string]interface{} `json:"attributes,omitempty"`
	// The identifier describing the operation name and required argument types. This field is ignored.
	ResolvedId *string `json:"resolvedId,omitempty"`
	// If present, creates a named statement when decompiling to SPL2. For example, \"$events = | from splunk_firehose();\".
	StatementName *string `json:"statementName,omitempty"`
}

type PipelinePatchRequest

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         *Pipeline `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

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"`
}

PipelineQueryParams contains the query parameters that can be provided by the user to fetch specific pipelines

type PipelineReactivateResponse

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

type PipelineReactivateResponsePipelineReactivationStatus

type PipelineReactivateResponsePipelineReactivationStatus string
const (
	PipelineReactivateResponsePipelineReactivationStatusActivated                        PipelineReactivateResponsePipelineReactivationStatus = "activated"
	PipelineReactivateResponsePipelineReactivationStatusCurrentVersionInvalid            PipelineReactivateResponsePipelineReactivationStatus = "currentVersionInvalid"
	PipelineReactivateResponsePipelineReactivationStatusFailedToDeactivateCurrentVersion PipelineReactivateResponsePipelineReactivationStatus = "failedToDeactivateCurrentVersion"
	PipelineReactivateResponsePipelineReactivationStatusNotActivated                     PipelineReactivateResponsePipelineReactivationStatus = "notActivated"
	PipelineReactivateResponsePipelineReactivationStatusRolledBack                       PipelineReactivateResponsePipelineReactivationStatus = "rolledBack"
	PipelineReactivateResponsePipelineReactivationStatusRolledBackError                  PipelineReactivateResponsePipelineReactivationStatus = "rolledBackError"
)

List of PipelineReactivateResponsePipelineReactivationStatus

type PipelineRequest

type PipelineRequest struct {
	Data Pipeline `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 description of the pipeline. Defaults to null.
	Description *string `json:"description,omitempty"`
}

type PipelineResponse

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                     *Pipeline               `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

type PipelineResponseStatus string
const (
	PipelineResponseStatusCreated    PipelineResponseStatus = "CREATED"
	PipelineResponseStatusActivated  PipelineResponseStatus = "ACTIVATED"
	PipelineResponseStatusFailed     PipelineResponseStatus = "FAILED"
	PipelineResponseStatusRestarting PipelineResponseStatus = "RESTARTING"
	PipelineResponseStatusFinished   PipelineResponseStatus = "FINISHED"
)

List of PipelineResponseStatus

type PipelineStatusQueryParams

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"`
}

PipelineStatusQueryParams contains the query parameters that can be provided by the user to fetch specific pipeline job statuses

type Plugin added in v1.8.0

type Plugin struct {
	Description      *string `json:"description,omitempty"`
	IsDeleted        *bool   `json:"isDeleted,omitempty"`
	LastUpdateDate   *int64  `json:"lastUpdateDate,omitempty"`
	LastUpdateUserId *string `json:"lastUpdateUserId,omitempty"`
	Name             *string `json:"name,omitempty"`
	PluginId         *string `json:"pluginId,omitempty"`
	TenantId         *string `json:"tenantId,omitempty"`
}

type PluginPatchRequest added in v1.8.0

type PluginPatchRequest struct {
	// Plugin description
	Description *string `json:"description,omitempty"`
	// Plugin name
	Name *string `json:"name,omitempty"`
}

type PluginRequest added in v1.8.0

type PluginRequest struct {
	// Plugin description
	Description string `json:"description"`
	// Plugin name
	Name string `json:"name"`
}

type PreviewData

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"`
	RuleMetrics            []RuleMetrics          `json:"ruleMetrics,omitempty"`
	TenantId               *string                `json:"tenantId,omitempty"`
}

type PreviewNode

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

type PreviewSessionStartRequest

type PreviewSessionStartRequest struct {
	Upl Pipeline `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"`
}

type PreviewStartResponse

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

type PreviewState

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 ReactivatePipelineRequest added in v1.8.0

type ReactivatePipelineRequest struct {
	// 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 reactivate 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 RegistryModel added in v1.6.0

type RegistryModel struct {
	Categories []string        `json:"categories,omitempty"`
	Functions  []FunctionModel `json:"functions,omitempty"`
}

type Response

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

type RuleMetrics added in v1.6.0

type RuleMetrics struct {
	MatchCount      *int64  `json:"matchCount,omitempty"`
	MatchPercentage *int64  `json:"matchPercentage,omitempty"`
	Name            *string `json:"name,omitempty"`
}

Represents the metrics for a particular rule.

type RulesActionsResponse added in v1.9.0

type RulesActionsResponse struct {
	Arguments map[string]interface{} `json:"arguments,omitempty"`
	Kind      *string                `json:"kind,omitempty"`
}

type RulesRequest added in v1.9.0

type RulesRequest struct {
	// The arguments for the rules
	Arguments map[string]interface{} `json:"arguments"`
	// Unique id of the rules package
	ExternalId string `json:"externalId"`
	// Rules kind
	Kind string `json:"kind"`
	// The name of the rules
	Name string `json:"name"`
	// The sourcetype that the rules has to be applied
	Sourcetype string `json:"sourcetype"`
	// Sourcetype definition
	SourcetypeDefinition string `json:"sourcetypeDefinition"`
	// The version of the rules
	Version     string  `json:"version"`
	Description *string `json:"description,omitempty"`
	// The description of the rules. Defaults to null.
	RulesDescription *string `json:"rulesDescription,omitempty"`
	// Sourcetype description
	SourcetypeDescription *string `json:"sourcetypeDescription,omitempty"`
}

type RulesResponse added in v1.9.0

type RulesResponse struct {
	CreateDate       *int64                              `json:"createDate,omitempty"`
	CreateUserId     *string                             `json:"createUserId,omitempty"`
	Description      *string                             `json:"description,omitempty"`
	ExternalId       *string                             `json:"externalId,omitempty"`
	LastUpdateDate   *int64                              `json:"lastUpdateDate,omitempty"`
	LastUpdateUserId *string                             `json:"lastUpdateUserId,omitempty"`
	Name             *string                             `json:"name,omitempty"`
	Sourcetypes      map[string]RulesSourcetypesResponse `json:"sourcetypes,omitempty"`
	TenantId         *string                             `json:"tenantId,omitempty"`
	Version          *string                             `json:"version,omitempty"`
}

type RulesSourcetypesResponse added in v1.9.0

type RulesSourcetypesResponse struct {
	Actions     []RulesActionsResponse `json:"actions,omitempty"`
	Definition  *string                `json:"definition,omitempty"`
	Description *string                `json:"description,omitempty"`
}

type Service

type Service services.BaseService

func NewService

func NewService(iClient services.IClient) *Service

NewService creates a new streams service client from the given Config

func (*Service) ActivatePipeline

func (s *Service) ActivatePipeline(id string, activatePipelineRequest ActivatePipelineRequest, resp ...*http.Response) (*Response, error)

ActivatePipeline - Activates an existing pipeline. Parameters:

id: Pipeline ID
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

func (*Service) Compile added in v1.6.0

func (s *Service) Compile(splCompileRequest SplCompileRequest, resp ...*http.Response) (*Pipeline, error)

Compile - Compiles SPL2 and returns streams JSON. Parameters:

splCompileRequest: 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

func (*Service) CreateCollectJob added in v1.8.0

func (s *Service) CreateCollectJob(collectJobRequest CollectJobRequest, resp ...*http.Response) (*CollectJobResponse, error)

CreateCollectJob - Create a new collect job. Parameters:

collectJobRequest: 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

func (*Service) CreateConnection

func (s *Service) CreateConnection(connectionRequest ConnectionRequest, resp ...*http.Response) (*ConnectionSaveResponse, 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

func (*Service) CreatePipeline

func (s *Service) CreatePipeline(pipelineRequest PipelineRequest, resp ...*http.Response) (*PipelineResponse, 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

func (*Service) CreateRulesPackage added in v1.9.0

func (s *Service) CreateRulesPackage(rulesRequest RulesRequest, resp ...*http.Response) (*RulesResponse, error)

CreateRulesPackage - Creates a new RulesPackage Parameters:

rulesRequest: 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

func (*Service) CreateTemplate

func (s *Service) CreateTemplate(templateRequest TemplateRequest, resp ...*http.Response) (*TemplateResponse, 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

func (*Service) DeactivatePipeline

func (s *Service) DeactivatePipeline(id string, deactivatePipelineRequest DeactivatePipelineRequest, resp ...*http.Response) (*Response, error)

DeactivatePipeline - Deactivates an existing pipeline. Parameters:

id: Pipeline ID
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

func (*Service) Decompile added in v1.6.0

func (s *Service) Decompile(decompileRequest DecompileRequest, resp ...*http.Response) (*DecompileResponse, error)

Decompile - Decompiles UPL and returns SPL. Parameters:

decompileRequest: 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

func (*Service) DeleteCollectJob added in v1.8.0

func (s *Service) DeleteCollectJob(id string, resp ...*http.Response) error

DeleteCollectJob - Delete a collect job. Parameters:

id: Collect Job ID
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

func (*Service) DeleteConnection

func (s *Service) DeleteConnection(connectionId string, resp ...*http.Response) error

DeleteConnection - Delete all versions of a connection by its id. Parameters:

connectionId: Connection ID
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

func (*Service) DeleteFile added in v1.6.0

func (s *Service) DeleteFile(fileId string, resp ...*http.Response) error

DeleteFile - Delete file. Parameters:

fileId: File ID
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

func (*Service) DeletePipeline

func (s *Service) DeletePipeline(id string, resp ...*http.Response) error

DeletePipeline - Removes a pipeline. Parameters:

id: Pipeline ID
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

func (*Service) DeletePlugin added in v1.8.0

func (s *Service) DeletePlugin(pluginId string, resp ...*http.Response) (*string, error)

DeletePlugin - Delete an admin plugin Parameters:

pluginId: Plugin ID
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

func (*Service) DeleteTemplate

func (s *Service) DeleteTemplate(templateId string, resp ...*http.Response) error

DeleteTemplate - Removes a template with a specific ID. Parameters:

templateId: Template ID
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

func (*Service) GetCollectJob added in v1.8.0

func (s *Service) GetCollectJob(id string, query *GetCollectJobQueryParams, resp ...*http.Response) (*CollectJobResponse, error)

GetCollectJob - Get a collect job. Parameters:

id: Collect Job ID
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

func (*Service) GetFileMetadata added in v1.7.0

func (s *Service) GetFileMetadata(fileId string, resp ...*http.Response) (*UploadFile, error)

GetFileMetadata - Get file metadata. Parameters:

fileId: File ID
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

func (*Service) GetFilesMetadata added in v1.6.0

func (s *Service) GetFilesMetadata(resp ...*http.Response) (*FilesMetaDataResponse, error)

GetFilesMetadata - Returns files metadata. 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

func (*Service) GetInputSchema

func (s *Service) GetInputSchema(getInputSchemaRequest GetInputSchemaRequest, resp ...*http.Response) (*UplType, error)

GetInputSchema - Returns the input schema for a function in a pipeline. Parameters:

getInputSchemaRequest: 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

func (*Service) GetLookupTable added in v1.6.0

func (s *Service) GetLookupTable(connectionId string, query *GetLookupTableQueryParams, resp ...*http.Response) (*LookupTableResponse, error)

GetLookupTable - Returns lookup table results. Parameters:

connectionId: Connection ID
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

func (*Service) GetOutputSchema

func (s *Service) GetOutputSchema(getOutputSchemaRequest GetOutputSchemaRequest, resp ...*http.Response) (map[string]UplType, error)

GetOutputSchema - Returns the output schema for a specified function in a pipeline. Parameters:

getOutputSchemaRequest: 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

func (*Service) GetPipeline

func (s *Service) GetPipeline(id string, query *GetPipelineQueryParams, resp ...*http.Response) (*PipelineResponse, error)

GetPipeline - Returns an individual pipeline by version. Parameters:

id: Pipeline ID
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

func (*Service) GetPipelineLatestMetrics

func (s *Service) GetPipelineLatestMetrics(id string, resp ...*http.Response) (*MetricsResponse, error)

GetPipelineLatestMetrics - Returns the latest metrics for a single pipeline. Parameters:

id: Pipeline ID
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

func (*Service) GetPipelinesStatus

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

func (*Service) GetPlugins added in v1.8.0

func (s *Service) GetPlugins(query *GetPluginsQueryParams, resp ...*http.Response) (*PaginatedResponseOfPlugin, error)

GetPlugins - Returns all the plugins that are available for all tenants. 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

func (*Service) GetPreviewData

func (s *Service) GetPreviewData(previewSessionId int64, resp ...*http.Response) (*PreviewData, error)

GetPreviewData - Returns the preview data for a session. Parameters:

previewSessionId: Preview Session ID
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

func (*Service) GetPreviewSession

func (s *Service) GetPreviewSession(previewSessionId int64, resp ...*http.Response) (*PreviewState, error)

GetPreviewSession - Returns information from a preview session. Parameters:

previewSessionId: Preview Session ID
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

func (*Service) GetPreviewSessionLatestMetrics

func (s *Service) GetPreviewSessionLatestMetrics(previewSessionId int64, resp ...*http.Response) (*MetricsResponse, error)

GetPreviewSessionLatestMetrics - Returns the latest metrics for a preview session. Parameters:

previewSessionId: Preview Session ID
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

func (*Service) GetRegistry

func (s *Service) GetRegistry(query *GetRegistryQueryParams, resp ...*http.Response) (*RegistryModel, 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

func (*Service) GetRulesPackage added in v1.9.0

func (s *Service) GetRulesPackage(externalId string, resp ...*http.Response) (*RulesResponse, error)

GetRulesPackage - Returns the rules package with specific id Parameters:

externalId: RulesPackage ID
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

func (*Service) GetTemplate

func (s *Service) GetTemplate(templateId string, query *GetTemplateQueryParams, resp ...*http.Response) (*TemplateResponse, error)

GetTemplate - Returns an individual template by version. Parameters:

templateId: Template ID
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

func (*Service) ListCollectJobs added in v1.9.0

func (s *Service) ListCollectJobs(resp ...*http.Response) (*PaginatedResponseOfCollectJobResponse, error)

ListCollectJobs - Get all collect jobs. 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

func (*Service) ListConnections

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

func (*Service) ListConnectors

func (s *Service) ListConnectors(resp ...*http.Response) (*PaginatedResponseOfConnectorResponse, 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

func (*Service) ListPipelines

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

func (*Service) ListRulesPackages added in v1.9.0

func (s *Service) ListRulesPackages(query *ListRulesPackagesQueryParams, resp ...*http.Response) (*PaginatedResponseOfRulesResponse, error)

ListRulesPackages - Returns all rules packages. 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

func (*Service) ListTemplates

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

func (*Service) PatchPipeline added in v1.6.0

func (s *Service) PatchPipeline(id string, pipelinePatchRequest PipelinePatchRequest, resp ...*http.Response) (*PipelineResponse, error)

PatchPipeline - Patches an existing pipeline. Parameters:

id: Pipeline ID
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

func (*Service) PatchPlugin added in v1.8.0

func (s *Service) PatchPlugin(pluginId string, pluginPatchRequest PluginPatchRequest, resp ...*http.Response) (*Plugin, error)

PatchPlugin - Patch an existing admin plugin. Parameters:

pluginId: Plugin ID
pluginPatchRequest: PluginRequest 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

func (*Service) PutConnection

func (s *Service) PutConnection(connectionId string, connectionPutRequest ConnectionPutRequest, resp ...*http.Response) (*ConnectionSaveResponse, error)

PutConnection - Updates an existing DSP connection. Parameters:

connectionId: Connection ID
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

func (*Service) PutTemplate

func (s *Service) PutTemplate(templateId string, templatePutRequest TemplatePutRequest, resp ...*http.Response) (*TemplateResponse, error)

PutTemplate - Updates an existing template. Parameters:

templateId: Template ID
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

func (*Service) ReactivatePipeline

func (s *Service) ReactivatePipeline(id string, reactivatePipelineRequest ReactivatePipelineRequest, resp ...*http.Response) (*PipelineReactivateResponse, error)

ReactivatePipeline - Reactivate a pipeline Parameters:

id: Pipeline ID
reactivatePipelineRequest: 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

func (*Service) RegisterPlugin added in v1.8.0

func (s *Service) RegisterPlugin(pluginRequest PluginRequest, resp ...*http.Response) (*Plugin, error)

RegisterPlugin - Register a new plugin that's available for all tenants. Parameters:

pluginRequest: 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

func (*Service) StartCollectJob added in v1.8.0

func (s *Service) StartCollectJob(id string, resp ...*http.Response) (*CollectJobStartStopResponse, error)

StartCollectJob - Start a collect job. Parameters:

id: Collect Job ID
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

func (*Service) StartPreview

func (s *Service) StartPreview(previewSessionStartRequest PreviewSessionStartRequest, resp ...*http.Response) (*PreviewStartResponse, 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

func (*Service) StopCollectJob added in v1.8.0

func (s *Service) StopCollectJob(id string, resp ...*http.Response) (*CollectJobStartStopResponse, error)

StopCollectJob - Stop a collect job. Parameters:

id: Collect Job ID
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

func (*Service) StopPreview

func (s *Service) StopPreview(previewSessionId int64, resp ...*http.Response) error

StopPreview - Stops a preview session. Parameters:

previewSessionId: Preview Session ID
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

func (*Service) UpdateConnection

func (s *Service) UpdateConnection(connectionId string, connectionPatchRequest ConnectionPatchRequest, resp ...*http.Response) (*ConnectionSaveResponse, error)

UpdateConnection - Patches an existing DSP connection. Parameters:

connectionId: Connection ID
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

func (*Service) UpdatePipeline

func (s *Service) UpdatePipeline(id string, pipelineRequest PipelineRequest, resp ...*http.Response) (*PipelineResponse, error)

UpdatePipeline - Updates an existing pipeline. Parameters:

id: Pipeline ID
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

func (*Service) UpdatePlugin added in v1.8.0

func (s *Service) UpdatePlugin(pluginId string, pluginRequest PluginRequest, resp ...*http.Response) (*Plugin, error)

UpdatePlugin - Update admin plugin info. Parameters:

pluginId: Plugin ID
pluginRequest: PluginRequest 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

func (*Service) UpdateTemplate

func (s *Service) UpdateTemplate(templateId string, templatePatchRequest TemplatePatchRequest, resp ...*http.Response) (*TemplateResponse, error)

UpdateTemplate - Patches an existing template. Parameters:

templateId: Template ID
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

func (*Service) UploadFiles added in v1.6.0

func (s *Service) UploadFiles(filename string, resp ...*http.Response) error

UploadFiles - Upload a CSV or text file that contains events. Parameters:

filename
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

func (*Service) UploadFilesStream added in v1.6.0

func (s *Service) UploadFilesStream(stream io.Reader, resp ...*http.Response) error

UploadFilesStream - Upload stream of io.Reader. Parameters:

stream
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

func (*Service) ValidatePipeline

func (s *Service) ValidatePipeline(validateRequest ValidateRequest, resp ...*http.Response) (*ValidateResponse, error)

ValidatePipeline - Verifies whether the Streams JSON is valid. Parameters:

validateRequest: 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

type Servicer

type Servicer interface {
	/*
		ActivatePipeline - Activates an existing pipeline.
		Parameters:
			id: Pipeline ID
			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)
	/*
		Compile - Compiles SPL2 and returns streams JSON.
		Parameters:
			splCompileRequest: 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
	*/
	Compile(splCompileRequest SplCompileRequest, resp ...*http.Response) (*Pipeline, error)
	/*
		CreateCollectJob - Create a new collect job.
		Parameters:
			collectJobRequest: 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
	*/
	CreateCollectJob(collectJobRequest CollectJobRequest, resp ...*http.Response) (*CollectJobResponse, 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)
	/*
		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)
	/*
		CreateRulesPackage - Creates a new RulesPackage
		Parameters:
			rulesRequest: 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
	*/
	CreateRulesPackage(rulesRequest RulesRequest, resp ...*http.Response) (*RulesResponse, 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: Pipeline ID
			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)
	/*
		Decompile - Decompiles UPL and returns SPL.
		Parameters:
			decompileRequest: 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
	*/
	Decompile(decompileRequest DecompileRequest, resp ...*http.Response) (*DecompileResponse, error)
	/*
		DeleteCollectJob - Delete a collect job.
		Parameters:
			id: Collect Job ID
			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
	*/
	DeleteCollectJob(id string, resp ...*http.Response) error
	/*
		DeleteConnection - Delete all versions of a connection by its id.
		Parameters:
			connectionId: Connection ID
			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
	/*
		DeleteFile - Delete file.
		Parameters:
			fileId: File ID
			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
	*/
	DeleteFile(fileId string, resp ...*http.Response) error
	/*
		DeletePipeline - Removes a pipeline.
		Parameters:
			id: Pipeline ID
			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) error
	/*
		DeletePlugin - Delete an admin plugin
		Parameters:
			pluginId: Plugin ID
			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
	*/
	DeletePlugin(pluginId string, resp ...*http.Response) (*string, error)
	/*
		DeleteTemplate - Removes a template with a specific ID.
		Parameters:
			templateId: Template ID
			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
	/*
		GetCollectJob - Get a collect job.
		Parameters:
			id: Collect Job ID
			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
	*/
	GetCollectJob(id string, query *GetCollectJobQueryParams, resp ...*http.Response) (*CollectJobResponse, error)
	/*
		GetFileMetadata - Get file metadata.
		Parameters:
			fileId: File ID
			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
	*/
	GetFileMetadata(fileId string, resp ...*http.Response) (*UploadFile, error)
	/*
		GetFilesMetadata - Returns files metadata.
		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
	*/
	GetFilesMetadata(resp ...*http.Response) (*FilesMetaDataResponse, error)
	/*
		GetInputSchema - Returns the input schema for a function in a pipeline.
		Parameters:
			getInputSchemaRequest: 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
	*/
	GetInputSchema(getInputSchemaRequest GetInputSchemaRequest, resp ...*http.Response) (*UplType, error)
	/*
		GetLookupTable - Returns lookup table results.
		Parameters:
			connectionId: Connection ID
			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
	*/
	GetLookupTable(connectionId string, query *GetLookupTableQueryParams, resp ...*http.Response) (*LookupTableResponse, error)
	/*
		GetOutputSchema - Returns the output schema for a specified function in a pipeline.
		Parameters:
			getOutputSchemaRequest: 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
	*/
	GetOutputSchema(getOutputSchemaRequest GetOutputSchemaRequest, resp ...*http.Response) (map[string]UplType, error)
	/*
		GetPipeline - Returns an individual pipeline by version.
		Parameters:
			id: Pipeline ID
			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: Pipeline ID
			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)
	/*
		GetPlugins - Returns all the plugins that are available for all tenants.
		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
	*/
	GetPlugins(query *GetPluginsQueryParams, resp ...*http.Response) (*PaginatedResponseOfPlugin, error)
	/*
		GetPreviewData - Returns the preview data for a session.
		Parameters:
			previewSessionId: Preview Session ID
			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: Preview Session ID
			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: Preview Session ID
			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) (*RegistryModel, error)
	/*
		GetRulesPackage - Returns the rules package with specific id
		Parameters:
			externalId: RulesPackage ID
			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
	*/
	GetRulesPackage(externalId string, resp ...*http.Response) (*RulesResponse, error)
	/*
		GetTemplate - Returns an individual template by version.
		Parameters:
			templateId: Template ID
			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)
	/*
		ListCollectJobs - Get all collect jobs.
		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
	*/
	ListCollectJobs(resp ...*http.Response) (*PaginatedResponseOfCollectJobResponse, 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)
	/*
		ListRulesPackages - Returns all rules packages.
		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
	*/
	ListRulesPackages(query *ListRulesPackagesQueryParams, resp ...*http.Response) (*PaginatedResponseOfRulesResponse, 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)
	/*
		PatchPipeline - Patches an existing pipeline.
		Parameters:
			id: Pipeline ID
			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
	*/
	PatchPipeline(id string, pipelinePatchRequest PipelinePatchRequest, resp ...*http.Response) (*PipelineResponse, error)
	/*
		PatchPlugin - Patch an existing admin plugin.
		Parameters:
			pluginId: Plugin ID
			pluginPatchRequest: PluginRequest 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
	*/
	PatchPlugin(pluginId string, pluginPatchRequest PluginPatchRequest, resp ...*http.Response) (*Plugin, error)
	/*
		PutConnection - Updates an existing DSP connection.
		Parameters:
			connectionId: Connection ID
			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)
	/*
		PutTemplate - Updates an existing template.
		Parameters:
			templateId: Template ID
			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 ID
			reactivatePipelineRequest: 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
	*/
	ReactivatePipeline(id string, reactivatePipelineRequest ReactivatePipelineRequest, resp ...*http.Response) (*PipelineReactivateResponse, error)
	/*
		RegisterPlugin - Register a new plugin that's available for all tenants.
		Parameters:
			pluginRequest: 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
	*/
	RegisterPlugin(pluginRequest PluginRequest, resp ...*http.Response) (*Plugin, error)
	/*
		StartCollectJob - Start a collect job.
		Parameters:
			id: Collect Job ID
			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
	*/
	StartCollectJob(id string, resp ...*http.Response) (*CollectJobStartStopResponse, 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)
	/*
		StopCollectJob - Stop a collect job.
		Parameters:
			id: Collect Job ID
			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
	*/
	StopCollectJob(id string, resp ...*http.Response) (*CollectJobStartStopResponse, error)
	/*
		StopPreview - Stops a preview session.
		Parameters:
			previewSessionId: Preview Session ID
			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) error
	/*
		UpdateConnection - Patches an existing DSP connection.
		Parameters:
			connectionId: Connection ID
			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)
	/*
		UpdatePipeline - Updates an existing pipeline.
		Parameters:
			id: Pipeline ID
			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
	*/
	UpdatePipeline(id string, pipelineRequest PipelineRequest, resp ...*http.Response) (*PipelineResponse, error)
	/*
		UpdatePlugin - Update admin plugin info.
		Parameters:
			pluginId: Plugin ID
			pluginRequest: PluginRequest 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
	*/
	UpdatePlugin(pluginId string, pluginRequest PluginRequest, resp ...*http.Response) (*Plugin, error)
	/*
		UpdateTemplate - Patches an existing template.
		Parameters:
			templateId: Template ID
			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: 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
	*/
	ValidatePipeline(validateRequest ValidateRequest, resp ...*http.Response) (*ValidateResponse, error)
}

Servicer represents the interface for implementing all endpoints for this service

type SplCompileRequest

type SplCompileRequest struct {
	// The SPL2 representation of a pipeline or function parameters.
	Spl string `json:"spl"`
	// A boolean flag to indicate whether the pipeline should be validated.
	Validate *bool `json:"validate,omitempty"`
}

type TemplatePatchRequest

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

type TemplatePutRequest

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

type TemplateRequest

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

type TemplateResponse

type TemplateResponse struct {
	CreateDate    *int64    `json:"createDate,omitempty"`
	CreateUserId  *string   `json:"createUserId,omitempty"`
	Data          *Pipeline `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 UplType

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

type UploadFile added in v1.6.0

type UploadFile struct {
	CreatedDate   *int64  `json:"createdDate,omitempty"`
	CreatedUserId *string `json:"createdUserId,omitempty"`
	Filename      *string `json:"filename,omitempty"`
	Id            *string `json:"id,omitempty"`
	Sha256        *string `json:"sha256,omitempty"`
	TenantId      *string `json:"tenantId,omitempty"`
}

type ValidateRequest

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

type ValidateResponse

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL