Categorygithub.com/turbot/flowpipe-sdk-go
modulepackage
1.0.0
Repository: https://github.com/turbot/flowpipe-sdk-go.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
20
Dependents
6
Files
17.5k SLOC

# README

Go SDK for Flowpipe

Flowpipe is a low-code workflow automation tool that aims to be simple yet powerful.

For help on getting started with Flowpipe, please visit https://flowpipe.io

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 0.1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit http://www.flowpipe.io

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import flowpipeapi "github.com/turbot/flowpipe-sdk-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), flowpipeapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), flowpipeapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), flowpipeapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), flowpipeapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://localhost/api/v0

ClassMethodHTTP requestDescription
IntegrationApiGetGet /integration/{integration_name}Get integration
IntegrationApiListGet /integrationList integrations
ModApiGetGet /mod/{mod_name}Get mod
NotifierApiGetGet /notifier/{notifier_name}Get notifier
NotifierApiListGet /notifierList notifiers
PipelineApiCommandPost /pipeline/{pipeline_name}/commandExecute a pipeline command
PipelineApiGetGet /pipeline/{pipeline_name}Get pipeline
PipelineApiListGet /pipelineList pipelines
ProcessApiGetGet /process/{process_id}Get process
ProcessApiGetExecutionGet /process/{process_id}/executionGet process execution
ProcessApiGetLogGet /process/{process_id}/log/process.jsonGet process log
ProcessApiListGet /processList processs
TriggerApiCommandPost /trigger/{trigger_name}/commandExecute a trigger command
TriggerApiGetGet /trigger/{trigger_name}Get trigger
TriggerApiListGet /triggerList triggers
VariableApiGetGet /variable/{variable_name}Get variable
VariableApiListGet /variableList variables

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

[email protected]

# Packages

No description provided by the author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
Hello returns a greeting for the named person.
IsNil checks if an input is nil.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewCmdPipeline instantiates a new CmdPipeline object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCmdPipelineWithDefaults instantiates a new CmdPipeline object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCmdTrigger instantiates a new CmdTrigger object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCmdTriggerWithDefaults instantiates a new CmdTrigger object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewErrorDetailModel instantiates a new ErrorDetailModel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorDetailModelWithDefaults instantiates a new ErrorDetailModel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewErrorModel instantiates a new ErrorModel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorModelWithDefaults instantiates a new ErrorModel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEventEventLogImpl instantiates a new EventEventLogImpl object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEventEventLogImplWithDefaults instantiates a new EventEventLogImpl object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExecutionExecution instantiates a new ExecutionExecution object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecutionExecutionWithDefaults instantiates a new ExecutionExecution object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExecutionPipelineExecution instantiates a new ExecutionPipelineExecution object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecutionPipelineExecutionWithDefaults instantiates a new ExecutionPipelineExecution object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExecutionSnapshot instantiates a new ExecutionSnapshot object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecutionSnapshotLayout instantiates a new ExecutionSnapshotLayout object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecutionSnapshotLayoutWithDefaults instantiates a new ExecutionSnapshotLayout object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExecutionSnapshotPanel instantiates a new ExecutionSnapshotPanel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecutionSnapshotPanelData instantiates a new ExecutionSnapshotPanelData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecutionSnapshotPanelDataColumn instantiates a new ExecutionSnapshotPanelDataColumn object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecutionSnapshotPanelDataColumnWithDefaults instantiates a new ExecutionSnapshotPanelDataColumn object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExecutionSnapshotPanelDataWithDefaults instantiates a new ExecutionSnapshotPanelData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExecutionSnapshotPanelWithDefaults instantiates a new ExecutionSnapshotPanel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExecutionSnapshotWithDefaults instantiates a new ExecutionSnapshot object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExecutionStepExecution instantiates a new ExecutionStepExecution object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecutionStepExecutionOutput instantiates a new ExecutionStepExecutionOutput object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecutionStepExecutionOutputWithDefaults instantiates a new ExecutionStepExecutionOutput object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExecutionStepExecutionStepForEach instantiates a new ExecutionStepExecutionStepForEach object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecutionStepExecutionStepForEachWithDefaults instantiates a new ExecutionStepExecutionStepForEach object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExecutionStepExecutionWithDefaults instantiates a new ExecutionStepExecution object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExecutionStepStatus instantiates a new ExecutionStepStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecutionStepStatusWithDefaults instantiates a new ExecutionStepStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFlowpipeRequire instantiates a new FlowpipeRequire object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFlowpipeRequireWithDefaults instantiates a new FlowpipeRequire object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFlowpipeResponseMetadata instantiates a new FlowpipeResponseMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFlowpipeResponseMetadataWithDefaults instantiates a new FlowpipeResponseMetadata object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFlowpipeTriggerResponseMetadata instantiates a new FlowpipeTriggerResponseMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFlowpipeTriggerResponseMetadataWithDefaults instantiates a new FlowpipeTriggerResponseMetadata object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFperrErrorDetailModel instantiates a new FperrErrorDetailModel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFperrErrorDetailModelWithDefaults instantiates a new FperrErrorDetailModel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFperrErrorModel instantiates a new FperrErrorModel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFperrErrorModelWithDefaults instantiates a new FperrErrorModel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFpIntegration instantiates a new FpIntegration object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFpIntegrationWithDefaults instantiates a new FpIntegration object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFpNotifier instantiates a new FpNotifier object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFpNotifierWithDefaults instantiates a new FpNotifier object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFpNotify instantiates a new FpNotify object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFpNotifyWithDefaults instantiates a new FpNotify object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFpPipeline instantiates a new FpPipeline object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFpPipelineParam instantiates a new FpPipelineParam object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFpPipelineParamWithDefaults instantiates a new FpPipelineParam object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFpPipelineWithDefaults instantiates a new FpPipeline object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFpTrigger instantiates a new FpTrigger object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFpTriggerPipeline instantiates a new FpTriggerPipeline object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFpTriggerPipelineWithDefaults instantiates a new FpTriggerPipeline object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFpTriggerWithDefaults instantiates a new FpTrigger object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFpVariable instantiates a new FpVariable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFpVariableWithDefaults instantiates a new FpVariable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetPipelineResponse instantiates a new GetPipelineResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetPipelineResponseWithDefaults instantiates a new GetPipelineResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewHclPos instantiates a new HclPos object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewHclPosWithDefaults instantiates a new HclPos object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewHclRange instantiates a new HclRange object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewHclRangeStart instantiates a new HclRangeStart object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewHclRangeStartWithDefaults instantiates a new HclRangeStart object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewHclRangeWithDefaults instantiates a new HclRange object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListIntegrationResponse instantiates a new ListIntegrationResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListIntegrationResponseWithDefaults instantiates a new ListIntegrationResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListNotifierResponse instantiates a new ListNotifierResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListNotifierResponseWithDefaults instantiates a new ListNotifierResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListPipelineResponse instantiates a new ListPipelineResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListPipelineResponseItem instantiates a new ListPipelineResponseItem object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListPipelineResponseItemWithDefaults instantiates a new ListPipelineResponseItem object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListPipelineResponseWithDefaults instantiates a new ListPipelineResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListProcessLogJSONResponse instantiates a new ListProcessLogJSONResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListProcessLogJSONResponseWithDefaults instantiates a new ListProcessLogJSONResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListProcessResponse instantiates a new ListProcessResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListProcessResponseWithDefaults instantiates a new ListProcessResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListTriggerResponse instantiates a new ListTriggerResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListTriggerResponseWithDefaults instantiates a new ListTriggerResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListVariableResponse instantiates a new ListVariableResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListVariableResponseWithDefaults instantiates a new ListVariableResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewMod instantiates a new Mod object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModconfigNextStepActionFromValue returns a pointer to a valid ModconfigNextStepAction for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewModconfigOutput instantiates a new ModconfigOutput object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModconfigOutputWithDefaults instantiates a new ModconfigOutput object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModconfigPipeline instantiates a new ModconfigPipeline object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModconfigPipelineOutput instantiates a new ModconfigPipelineOutput object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModconfigPipelineOutputWithDefaults instantiates a new ModconfigPipelineOutput object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModconfigPipelineParam instantiates a new ModconfigPipelineParam object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModconfigPipelineParamWithDefaults instantiates a new ModconfigPipelineParam object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModconfigPipelineWithDefaults instantiates a new ModconfigPipeline object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModconfigStepError instantiates a new ModconfigStepError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModconfigStepErrorWithDefaults instantiates a new ModconfigStepError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModconfigStepForEach instantiates a new ModconfigStepForEach object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModconfigStepForEachWithDefaults instantiates a new ModconfigStepForEach object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModconfigStepLoop instantiates a new ModconfigStepLoop object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModconfigStepLoopWithDefaults instantiates a new ModconfigStepLoop object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModconfigStepRetry instantiates a new ModconfigStepRetry object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModconfigStepRetryWithDefaults instantiates a new ModconfigStepRetry object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModVersionConstraint instantiates a new ModVersionConstraint object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModVersionConstraintWithDefaults instantiates a new ModVersionConstraint object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModWithDefaults instantiates a new Mod object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNextStepActionFromValue returns a pointer to a valid NextStepAction for the value passed as argument, or an error if the value passed is not allowed by the enum.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewOpenGraph instantiates a new OpenGraph object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOpenGraphWithDefaults instantiates a new OpenGraph object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOutput instantiates a new Output object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOutputWithDefaults instantiates a new Output object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPcerrErrorDetailModel instantiates a new PcerrErrorDetailModel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPcerrErrorDetailModelWithDefaults instantiates a new PcerrErrorDetailModel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPcerrErrorModel instantiates a new PcerrErrorModel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPcerrErrorModelWithDefaults instantiates a new PcerrErrorModel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPerrErrorDetailModel instantiates a new PerrErrorDetailModel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPerrErrorDetailModelWithDefaults instantiates a new PerrErrorDetailModel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPerrErrorModel instantiates a new PerrErrorModel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPerrErrorModelWithDefaults instantiates a new PerrErrorModel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPipeline instantiates a new Pipeline object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPipelineExecutionResponse instantiates a new PipelineExecutionResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPipelineExecutionResponseWithDefaults instantiates a new PipelineExecutionResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPipelineOutput instantiates a new PipelineOutput object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPipelineOutputWithDefaults instantiates a new PipelineOutput object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPipelineStep instantiates a new PipelineStep object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPipelineStepWithDefaults instantiates a new PipelineStep object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPipelineWithDefaults instantiates a new Pipeline object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewProcess instantiates a new Process object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewProcessEventLog instantiates a new ProcessEventLog object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewProcessEventLogWithDefaults instantiates a new ProcessEventLog object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewProcessOutputData instantiates a new ProcessOutputData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewProcessOutputDataWithDefaults instantiates a new ProcessOutputData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewProcessWithDefaults instantiates a new Process object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRequire instantiates a new Require object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRequireWithDefaults instantiates a new Require object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRunPipelineResponse instantiates a new RunPipelineResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRunPipelineResponseWithDefaults instantiates a new RunPipelineResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStepError instantiates a new StepError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStepErrorWithDefaults instantiates a new StepError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStepForEach instantiates a new StepForEach object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStepForEachWithDefaults instantiates a new StepForEach object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTrigger instantiates a new Trigger object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTriggerExecutionResponse instantiates a new TriggerExecutionResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTriggerExecutionResponseWithDefaults instantiates a new TriggerExecutionResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTriggerWithDefaults instantiates a new Trigger object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVariable instantiates a new Variable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVariableWithDefaults instantiates a new Variable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Constants

List of modconfig.NextStepAction.
List of modconfig.NextStepAction.
List of modconfig.NextStepAction.

# Variables

All allowed values of ModconfigNextStepAction enum.
All allowed values of NextStepAction enum.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

APIClient manages communication with the Flowpipe API v0.1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CmdPipeline struct for CmdPipeline.
CmdTrigger struct for CmdTrigger.
Configuration stores the configuration of the API client.
ErrorDetailModel struct for ErrorDetailModel.
ErrorModel struct for ErrorModel.
EventEventLogImpl struct for EventEventLogImpl.
ExecutionExecution struct for ExecutionExecution.
ExecutionPipelineExecution struct for ExecutionPipelineExecution.
ExecutionSnapshot struct for ExecutionSnapshot.
ExecutionSnapshotLayout struct for ExecutionSnapshotLayout.
ExecutionSnapshotPanel struct for ExecutionSnapshotPanel.
ExecutionSnapshotPanelData struct for ExecutionSnapshotPanelData.
ExecutionSnapshotPanelDataColumn struct for ExecutionSnapshotPanelDataColumn.
ExecutionStepExecution struct for ExecutionStepExecution.
ExecutionStepExecutionOutput Native/primitive output of the step.
ExecutionStepExecutionStepForEach for_each controls.
ExecutionStepStatus struct for ExecutionStepStatus.
FlowpipeRequire struct for FlowpipeRequire.
FlowpipeResponseMetadata struct for FlowpipeResponseMetadata.
FlowpipeTriggerResponseMetadata struct for FlowpipeTriggerResponseMetadata.
FperrErrorDetailModel struct for FperrErrorDetailModel.
FperrErrorModel struct for FperrErrorModel.
FpIntegration struct for FpIntegration.
FpNotifier struct for FpNotifier.
FpNotify struct for FpNotify.
FpPipeline struct for FpPipeline.
FpPipelineParam struct for FpPipelineParam.
FpTrigger struct for FpTrigger.
FpTriggerPipeline struct for FpTriggerPipeline.
FpVariable struct for FpVariable.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetPipelineResponse struct for GetPipelineResponse.
HclPos struct for HclPos.
HclRange struct for HclRange.
HclRangeStart Start and End represent the bounds of this range.
No description provided by the author
No description provided by the author
ListIntegrationResponse struct for ListIntegrationResponse.
ListNotifierResponse struct for ListNotifierResponse.
ListPipelineResponse struct for ListPipelineResponse.
ListPipelineResponseItem struct for ListPipelineResponseItem.
ListProcessLogJSONResponse struct for ListProcessLogJSONResponse.
ListProcessResponse struct for ListProcessResponse.
ListTriggerResponse struct for ListTriggerResponse.
ListVariableResponse struct for ListVariableResponse.
Mod struct for Mod.
No description provided by the author
ModconfigOutput struct for ModconfigOutput.
ModconfigPipeline struct for ModconfigPipeline.
ModconfigPipelineOutput struct for ModconfigPipelineOutput.
ModconfigPipelineParam struct for ModconfigPipelineParam.
ModconfigStepError struct for ModconfigStepError.
ModconfigStepForEach struct for ModconfigStepForEach.
ModconfigStepLoop struct for ModconfigStepLoop.
ModconfigStepRetry struct for ModconfigStepRetry.
ModVersionConstraint struct for ModVersionConstraint.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OpenGraph struct for OpenGraph.
Output struct for Output.
PcerrErrorDetailModel struct for PcerrErrorDetailModel.
PcerrErrorModel struct for PcerrErrorModel.
PerrErrorDetailModel struct for PerrErrorDetailModel.
PerrErrorModel struct for PerrErrorModel.
Pipeline struct for Pipeline.
No description provided by the author
No description provided by the author
No description provided by the author
PipelineExecutionResponse struct for PipelineExecutionResponse.
PipelineOutput struct for PipelineOutput.
PipelineStep struct for PipelineStep.
Process struct for Process.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ProcessEventLog struct for ProcessEventLog.
ProcessOutputData struct for ProcessOutputData.
Require struct for Require.
RunPipelineResponse struct for RunPipelineResponse.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
StepError struct for StepError.
StepForEach struct for StepForEach.
Trigger struct for Trigger.
No description provided by the author
No description provided by the author
No description provided by the author
TriggerExecutionResponse struct for TriggerExecutionResponse.
Variable struct for Variable.
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
No description provided by the author

# Type aliases

IntegrationApiService IntegrationApi service.
ModApiService ModApi service.
ModconfigNextStepAction the model 'ModconfigNextStepAction'.
NextStepAction the model 'NextStepAction'.
NotifierApiService NotifierApi service.
PipelineApiService PipelineApi service.
ProcessApiService ProcessApi service.
ServerConfigurations stores multiple ServerConfiguration items.
TriggerApiService TriggerApi service.
VariableApiService VariableApi service.