feat: add go-client docs (#3263)
* feat: add go-client docs
* feat: add go-client docs
* feat: add go-client docs
* feat: add go-client docs
* feat: add go-client docs
* fix: refactor the directory
* fix: refactor the directory
* feat: supplement the model
* feat: supplement the model
* fix : demo fail
* fix : demo fail
* fix : demo fail
diff --git a/streampipes-client-go/docs/content/en/_index.md b/streampipes-client-go/docs/content/en/_index.md
index f852fea..2d70e27 100644
--- a/streampipes-client-go/docs/content/en/_index.md
+++ b/streampipes-client-go/docs/content/en/_index.md
@@ -2,21 +2,21 @@
title: Apache StreamPipesocs
---
<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one or more
- ~ contributor license agreements. See the NOTICE file distributed with
- ~ this work for additional information regarding copyright ownership.
- ~ The ASF licenses this file to You under the Apache License, Version 2.0
- ~ (the "License"); you may not use this file except in compliance with
- ~ the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing, software
- ~ distributed under the License is distributed on an "AS IS" BASIS,
- ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- ~ See the License for the specific language governing permissions and
- ~ limitations under the License.
- ~
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
-->
{{< blocks/cover title="Welcome to StreamPipes Go" image_anchor="top" height="full" >}}
diff --git a/streampipes-client-go/docs/content/en/docs/_index.md b/streampipes-client-go/docs/content/en/docs/_index.md
index 2f6e16f..7952ce6 100644
--- a/streampipes-client-go/docs/content/en/docs/_index.md
+++ b/streampipes-client-go/docs/content/en/docs/_index.md
@@ -4,21 +4,21 @@
menu: {main: {weight: 20}}
---
<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one or more
- ~ contributor license agreements. See the NOTICE file distributed with
- ~ this work for additional information regarding copyright ownership.
- ~ The ASF licenses this file to You under the Apache License, Version 2.0
- ~ (the "License"); you may not use this file except in compliance with
- ~ the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing, software
- ~ distributed under the License is distributed on an "AS IS" BASIS,
- ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- ~ See the License for the specific language governing permissions and
- ~ limitations under the License.
- ~
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
-->
{{% pageinfo %}}
diff --git a/streampipes-client-go/docs/content/en/docs/contribution-guidelines.md b/streampipes-client-go/docs/content/en/docs/contribution-guidelines.md
index c9f0ca0..a5836d8 100644
--- a/streampipes-client-go/docs/content/en/docs/contribution-guidelines.md
+++ b/streampipes-client-go/docs/content/en/docs/contribution-guidelines.md
@@ -4,21 +4,21 @@
weight: 10
---
<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one or more
- ~ contributor license agreements. See the NOTICE file distributed with
- ~ this work for additional information regarding copyright ownership.
- ~ The ASF licenses this file to You under the Apache License, Version 2.0
- ~ (the "License"); you may not use this file except in compliance with
- ~ the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing, software
- ~ distributed under the License is distributed on an "AS IS" BASIS,
- ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- ~ See the License for the specific language governing permissions and
- ~ limitations under the License.
- ~
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
-->
{{% pageinfo %}}
diff --git a/streampipes-client-go/docs/content/en/docs/getting-started/_index.md b/streampipes-client-go/docs/content/en/docs/getting-started/_index.md
index 1eba1d7..c930741 100644
--- a/streampipes-client-go/docs/content/en/docs/getting-started/_index.md
+++ b/streampipes-client-go/docs/content/en/docs/getting-started/_index.md
@@ -4,21 +4,21 @@
weight: 2
---
<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one or more
- ~ contributor license agreements. See the NOTICE file distributed with
- ~ this work for additional information regarding copyright ownership.
- ~ The ASF licenses this file to You under the Apache License, Version 2.0
- ~ (the "License"); you may not use this file except in compliance with
- ~ the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing, software
- ~ distributed under the License is distributed on an "AS IS" BASIS,
- ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- ~ See the License for the specific language governing permissions and
- ~ limitations under the License.
- ~
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
-->
{{% pageinfo %}}
diff --git a/streampipes-client-go/docs/content/en/docs/getting-started/first-steps.md b/streampipes-client-go/docs/content/en/docs/getting-started/first-steps.md
index 8b2135c..2d28e43 100644
--- a/streampipes-client-go/docs/content/en/docs/getting-started/first-steps.md
+++ b/streampipes-client-go/docs/content/en/docs/getting-started/first-steps.md
@@ -5,21 +5,21 @@
First Steps to use StreamPipes Go.
---
<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one or more
- ~ contributor license agreements. See the NOTICE file distributed with
- ~ this work for additional information regarding copyright ownership.
- ~ The ASF licenses this file to You under the Apache License, Version 2.0
- ~ (the "License"); you may not use this file except in compliance with
- ~ the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing, software
- ~ distributed under the License is distributed on an "AS IS" BASIS,
- ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- ~ See the License for the specific language governing permissions and
- ~ limitations under the License.
- ~
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
-->
{{% pageinfo %}}
@@ -47,3 +47,14 @@
If you do not have it set up yet, please refer to the [Apache StreamPipes installation guide](https://streampipes.apache.org/docs/try-installation/) for detailed instructions on how to install and configure it on your system.
Once these requirements are met, you are ready to proceed with the next step Quickstart in the setup process!
+
+## 3. Installation StreamPipes Go library
+
+The StreamPipes Go library is meant to work with Go 1.21 and above. You can install the latest development version from GitHub, as so:
+
+```bash
+go get https://github.com/apache/streampipes
+// if you want to have the current development state you can also execute
+go get https://github.com/apache/streampipes/streampipes-client-go
+// the corresponding documentation can be found here: https://streampipes.apache.org/docs/docs/python/dev/
+```
\ No newline at end of file
diff --git a/streampipes-client-go/docs/content/en/docs/getting-started/quickstart.md b/streampipes-client-go/docs/content/en/docs/getting-started/quickstart.md
index e2498e2..0be3662 100644
--- a/streampipes-client-go/docs/content/en/docs/getting-started/quickstart.md
+++ b/streampipes-client-go/docs/content/en/docs/getting-started/quickstart.md
@@ -4,21 +4,21 @@
Quickstart to use StreamPipes Go.
---
<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one or more
- ~ contributor license agreements. See the NOTICE file distributed with
- ~ this work for additional information regarding copyright ownership.
- ~ The ASF licenses this file to You under the Apache License, Version 2.0
- ~ (the "License"); you may not use this file except in compliance with
- ~ the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing, software
- ~ distributed under the License is distributed on an "AS IS" BASIS,
- ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- ~ See the License for the specific language governing permissions and
- ~ limitations under the License.
- ~
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
-->
{{% pageinfo %}}
diff --git a/streampipes-client-go/docs/content/en/docs/overview.md b/streampipes-client-go/docs/content/en/docs/overview.md
index 8d31e43..41215a9 100644
--- a/streampipes-client-go/docs/content/en/docs/overview.md
+++ b/streampipes-client-go/docs/content/en/docs/overview.md
@@ -4,21 +4,21 @@
weight: 1
---
<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one or more
- ~ contributor license agreements. See the NOTICE file distributed with
- ~ this work for additional information regarding copyright ownership.
- ~ The ASF licenses this file to You under the Apache License, Version 2.0
- ~ (the "License"); you may not use this file except in compliance with
- ~ the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing, software
- ~ distributed under the License is distributed on an "AS IS" BASIS,
- ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- ~ See the License for the specific language governing permissions and
- ~ limitations under the License.
- ~
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
-->
{{% pageinfo %}}
diff --git a/streampipes-client-go/docs/content/en/docs/reference/_index.md b/streampipes-client-go/docs/content/en/docs/reference/_index.md
index 97f44a4..99b4804 100644
--- a/streampipes-client-go/docs/content/en/docs/reference/_index.md
+++ b/streampipes-client-go/docs/content/en/docs/reference/_index.md
@@ -4,21 +4,21 @@
weight: 9
---
<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one or more
- ~ contributor license agreements. See the NOTICE file distributed with
- ~ this work for additional information regarding copyright ownership.
- ~ The ASF licenses this file to You under the Apache License, Version 2.0
- ~ (the "License"); you may not use this file except in compliance with
- ~ the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing, software
- ~ distributed under the License is distributed on an "AS IS" BASIS,
- ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- ~ See the License for the specific language governing permissions and
- ~ limitations under the License.
- ~
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
-->
{{% pageinfo %}}
diff --git a/streampipes-client-go/docs/content/en/docs/reference/parameter-reference.md b/streampipes-client-go/docs/content/en/docs/reference/parameter-reference.md
index 7f10d38..dd1e697 100644
--- a/streampipes-client-go/docs/content/en/docs/reference/parameter-reference.md
+++ b/streampipes-client-go/docs/content/en/docs/reference/parameter-reference.md
@@ -5,21 +5,21 @@
date: 2024-06-26
---
<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one or more
- ~ contributor license agreements. See the NOTICE file distributed with
- ~ this work for additional information regarding copyright ownership.
- ~ The ASF licenses this file to You under the Apache License, Version 2.0
- ~ (the "License"); you may not use this file except in compliance with
- ~ the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing, software
- ~ distributed under the License is distributed on an "AS IS" BASIS,
- ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- ~ See the License for the specific language governing permissions and
- ~ limitations under the License.
- ~
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
-->
{{% pageinfo %}}
diff --git a/streampipes-client-go/docs/content/en/docs/tutorials/Introduction-to-streampipes-go.md b/streampipes-client-go/docs/content/en/docs/tutorials/Introduction-to-streampipes-go.md
index d5530b5..f2bf7f0 100644
--- a/streampipes-client-go/docs/content/en/docs/tutorials/Introduction-to-streampipes-go.md
+++ b/streampipes-client-go/docs/content/en/docs/tutorials/Introduction-to-streampipes-go.md
@@ -6,21 +6,21 @@
weight: 4
---
<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one or more
- ~ contributor license agreements. See the NOTICE file distributed with
- ~ this work for additional information regarding copyright ownership.
- ~ The ASF licenses this file to You under the Apache License, Version 2.0
- ~ (the "License"); you may not use this file except in compliance with
- ~ the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing, software
- ~ distributed under the License is distributed on an "AS IS" BASIS,
- ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- ~ See the License for the specific language governing permissions and
- ~ limitations under the License.
- ~
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
-->
{{% pageinfo %}}
@@ -28,3 +28,5 @@
{{% /pageinfo %}}
Apache StreamPipes aims to enable non-technical users to connect and analyze IoT data streams. To this end, it provides an easy-to-use and convenient user interface that allows one to connect to an IoT data source and create some visual graphs within a few minutes.
+
+--- StreamPipes Go-Client
\ No newline at end of file
diff --git a/streampipes-client-go/docs/content/en/docs/tutorials/ManageAdapter.md b/streampipes-client-go/docs/content/en/docs/tutorials/ManageAdapter.md
new file mode 100644
index 0000000..059700c
--- /dev/null
+++ b/streampipes-client-go/docs/content/en/docs/tutorials/ManageAdapter.md
@@ -0,0 +1,72 @@
+<!--
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
+ -->
+
+### Manage StreamPipes Adapter
+---
+## Initialize Go-Client
+```bash
+import (
+ "log"
+ "github.com/apache/streampipes/streampipes-client-go/streampipes"
+ "github.com/apache/streampipes/streampipes-client-go/streampipes/config"
+)
+func main() {
+ clientConfig := config.StreamPipesClientConfig{
+ Url: "http://localhost:8030",
+ Credential: config.StreamPipesApiKeyCredentials{
+ UserName: "<Your-User-Name>",
+ ApiKey: "<Your-API-Key>",
+ },
+ }
+
+ streamPipesClient, err := streampipes.NewStreamPipesClient(clientConfig)
+ if err != nil {
+ log.Fatal(err)
+ }
+
+}
+```
+
+### Create a StreamPipes Adapter
+
+```bash
+ // Populating go-model as a data source is not supported at this time,This is because the inheritance of the model has not been resolved for the time being.
+ adapterData = `json`
+ adapter = []byte(adapterData)
+ err := streamPipesClient.Adapter().CreateAdapter(adapterData)
+```
+
+### Get a StreamPipes Adapter
+
+```bash
+ streampipesAdapter, err := streamPipesClient.Adapter().GetSingleAdapter("adapterId")
+```
+
+### Start a StreamPipes Adapter
+
+```bash
+ err := streamPipesClient.Adapter().StartSingleAdapter("adapterId")
+```
+
+### Stop a StreamPipes Adapter
+
+```bash
+ err := streamPipesClient.Adapter().StopSingleAdapter("adapterId")
+```
+
+### ...
\ No newline at end of file
diff --git a/streampipes-client-go/docs/content/en/docs/tutorials/ManagePipeline.md b/streampipes-client-go/docs/content/en/docs/tutorials/ManagePipeline.md
new file mode 100644
index 0000000..39bf323
--- /dev/null
+++ b/streampipes-client-go/docs/content/en/docs/tutorials/ManagePipeline.md
@@ -0,0 +1,72 @@
+<!--
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
+ -->
+
+### Manage StreamPipes Pipeline
+---
+## Initialize Go-Client
+```bash
+import (
+ "log"
+ "github.com/apache/streampipes/streampipes-client-go/streampipes"
+ "github.com/apache/streampipes/streampipes-client-go/streampipes/config"
+)
+func main() {
+ clientConfig := config.StreamPipesClientConfig{
+ Url: "http://localhost:8030",
+ Credential: config.StreamPipesApiKeyCredentials{
+ UserName: "<Your-User-Name>",
+ ApiKey: "<Your-API-Key>",
+ },
+ }
+
+ streamPipesClient, err := streampipes.NewStreamPipesClient(clientConfig)
+ if err != nil {
+ log.Fatal(err)
+ }
+
+}
+```
+
+### Create a StreamPipes Pipeline
+
+```bash
+ // Populating go-model as a data source is not supported at this time,This is because the inheritance of the model has not been resolved for the time being.
+ pipelineData = `json`
+ pipeline = []byte(pipelineData)
+ responseMsg,err := streamPipesClient.Pipeline().CreatePipeline(pipelineData)
+```
+
+### Get a StreamPipes Pipeline
+
+```bash
+ streampipesPipeline, err := streamPipesClient.Pipeline().GetSinglePipelineStatus("pipelineId")
+```
+
+### Start a StreamPipes Pipeline
+
+```bash
+ operationStatus, err := streamPipesClient.Pipeline().StartSinglePipeline("pipelineId")
+```
+
+### Stop a StreamPipes Pipeline
+
+```bash
+ operationStatus, err := streamPipesClient.Pipeline().StopSinglePipeline("pipelineId")
+```
+
+### ...
\ No newline at end of file
diff --git a/streampipes-client-go/docs/content/en/docs/tutorials/_index.md b/streampipes-client-go/docs/content/en/docs/tutorials/_index.md
index 9714093..8a3674e 100644
--- a/streampipes-client-go/docs/content/en/docs/tutorials/_index.md
+++ b/streampipes-client-go/docs/content/en/docs/tutorials/_index.md
@@ -5,21 +5,21 @@
weight: 8
---
<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one or more
- ~ contributor license agreements. See the NOTICE file distributed with
- ~ this work for additional information regarding copyright ownership.
- ~ The ASF licenses this file to You under the Apache License, Version 2.0
- ~ (the "License"); you may not use this file except in compliance with
- ~ the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing, software
- ~ distributed under the License is distributed on an "AS IS" BASIS,
- ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- ~ See the License for the specific language governing permissions and
- ~ limitations under the License.
- ~
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
-->
{{% pageinfo %}}
diff --git a/streampipes-client-go/docs/content/en/search.md b/streampipes-client-go/docs/content/en/search.md
index acd8ec8..802db90 100644
--- a/streampipes-client-go/docs/content/en/search.md
+++ b/streampipes-client-go/docs/content/en/search.md
@@ -3,19 +3,19 @@
layout: search
---
<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one or more
- ~ contributor license agreements. See the NOTICE file distributed with
- ~ this work for additional information regarding copyright ownership.
- ~ The ASF licenses this file to You under the Apache License, Version 2.0
- ~ (the "License"); you may not use this file except in compliance with
- ~ the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing, software
- ~ distributed under the License is distributed on an "AS IS" BASIS,
- ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- ~ See the License for the specific language governing permissions and
- ~ limitations under the License.
- ~
+ // Licensed to the Apache Software Foundation (ASF) under one or more
+ // contributor license agreements. See the NOTICE file distributed with
+ // this work for additional information regarding copyright ownership.
+ // The ASF licenses this file to You under the Apache License, Version 2.0
+ // (the "License"); you may not use this file except in compliance with
+ // the License. You may obtain a copy of the License at
+ //
+ // http://www.apache.org/licenses/LICENSE-2.0
+ //
+ // Unless required by applicable law or agreed to in writing, software
+ // distributed under the License is distributed on an "AS IS" BASIS,
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ // See the License for the specific language governing permissions and
+ // limitations under the License.
+ //
-->
