Merge pull request #206 from bonitoo-io/feat/tasks

feat: adding Tasks API

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## 2.2.0 [in progress]
 ### Features
+1. [#206](https://github.com/influxdata/influxdb-client-go/pull/206) Adding TasksAPI for managing tasks and associated logs and runs.
 
 ### Bug fixes
 

api/buckets.go

@@ -85,7 +85,9 @@ func (b *bucketsAPI) getBuckets(ctx context.Context, params *domain.GetBucketsPa
 	for _, opt := range pagingOptions {
 		opt(options)
 	}
-	params.Limit = &options.limit
+	if options.limit > 0 {
+		params.Limit = &options.limit
+	}
 	params.Offset = &options.offset
 
 	response, err := b.apiClient.GetBucketsWithResponse(ctx, params)

api/examples_test.go

@@ -402,3 +402,57 @@ func ExampleDeleteAPI() {
 	// Close the client
 	client.Close()
 }
+
+func ExampleTasksAPI() {
+	// Create a new client using an InfluxDB server base URL and an authentication token
+	client := influxdb2.NewClient("http://localhost:8086", "my-token")
+
+	ctx := context.Background()
+	// Get Delete API client
+	tasksAPI := client.TasksAPI()
+	// Get organization that will own task
+	myorg, err := client.OrganizationsAPI().FindOrganizationByName(ctx, "my-org")
+	if err != nil {
+		panic(err)
+	}
+	// task flux script from https://www.influxdata.com/blog/writing-tasks-and-setting-up-alerts-for-influxdb-cloud/
+	flux := `fruitCollected = from(bucket: “farming”)
+  |> range(start: -task.every)
+  |> filter(fn: (r)  => (r._measurement == “totalFruitsCollected))
+  |> filter(fn: (r)  => (r._field == “fruits))
+  |> group(columns: [“farmName”])
+  |> aggregateWindow(fn: sum, every: task.every)
+  |> map(fn: (r) => {
+    return: _time: r._time,  _stop: r._stop, _start: r._start, _measurement: “fruitCollectionRate”, _field: “fruits”, _value: r._value, farmName: farmName, 
+  }
+})
+
+fruitCollected 
+  |> to(bucket: “farming”)
+`
+	task, err := tasksAPI.CreateTaskWithEvery(ctx, "fruitCollectedRate", flux, "1h", *myorg.Id)
+	if err != nil {
+		panic(err)
+	}
+	// Force running a task
+	run, err := tasksAPI.RunManually(ctx, task)
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println("Forced run completed on ", *run.FinishedAt, " with status ", *run.Status)
+
+	// Print logs
+	logs, err := tasksAPI.FindRunLogs(ctx, run)
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println("Log:")
+	for _, logEvent := range logs {
+		fmt.Println(" Time:", *logEvent.Time, ", Message: ", *logEvent.Message)
+	}
+
+	// Close the client
+	client.Close()
+}

api/organizations.go

@@ -74,7 +74,9 @@ func (o *organizationsAPI) getOrganizations(ctx context.Context, params *domain.
 	for _, opt := range pagingOptions {
 		opt(options)
 	}
-	params.Limit = &options.limit
+	if options.limit > 0 {
+		params.Limit = &options.limit
+	}
 	params.Offset = &options.offset
 	params.Descending = &options.descending
 	response, err := o.apiClient.GetOrgsWithResponse(ctx, params)

api/paging.go

@@ -15,7 +15,7 @@ type Paging struct {
 	// Default 0.
 	offset domain.Offset
 	// Maximum number of items returned.
-	// Default 20, minimum 1 and maximum 100.
+	// Default 0 - not applied
 	limit domain.Limit
 	// What field should be used for sorting
 	sortBy string
@@ -26,21 +26,14 @@ type Paging struct {
 	after domain.After
 }
 
-// defaultPagingOptions returns default paging options: offset 0, limit 20, default sorting, ascending
+// defaultPagingOptions returns default paging options: offset 0, limit 0 (not applied), default sorting, ascending
 func defaultPaging() *Paging {
-	return &Paging{limit: 20, offset: 0, sortBy: "", descending: false, after: ""}
+	return &Paging{limit: 0, offset: 0, sortBy: "", descending: false, after: ""}
 }
 
 // PagingWithLimit sets limit option - maximum number of items returned.
-// Default 20, minimum 1 and maximum 100.
 func PagingWithLimit(limit int) PagingOption {
 	return func(p *Paging) {
-		if limit > 100 {
-			limit = 100
-		}
-		if limit < 1 {
-			limit = 1
-		}
 		p.limit = domain.Limit(limit)
 	}
 }

api/paging_test.go

@@ -26,9 +26,9 @@ func TestPaging(t *testing.T) {
 
 	paging = &Paging{}
 	PagingWithLimit(0)(paging)
-	assert.Equal(t, domain.Limit(1), paging.limit)
+	assert.Equal(t, domain.Limit(0), paging.limit)
 
 	paging = &Paging{}
 	PagingWithLimit(1000)(paging)
-	assert.Equal(t, domain.Limit(100), paging.limit)
+	assert.Equal(t, domain.Limit(1000), paging.limit)
 }