com.grafana.foundation.dashboard.DataTransformerConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grafana-foundation-sdk Show documentation

A set of tools, types and libraries for building and manipulating Grafana objects.

There is a newer version: 11.3.0-1730898216

Show newest version

// Code generated - EDITING IS FUTILE. DO NOT EDIT.

package com.grafana.foundation.dashboard;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectWriter;
import com.fasterxml.jackson.annotation.JsonInclude;

// Transformations allow to manipulate data returned by a query before the system applies a visualization.
// Using transformations you can: rename fields, join time series data, perform mathematical operations across queries,
// use the output of one transformation as the input to another transformation, etc.
public class DataTransformerConfig {
    // Unique identifier of transformer
    @JsonProperty("id")
    public String id;
    // Disabled transformations are skipped
    @JsonInclude(JsonInclude.Include.NON_NULL)
    @JsonProperty("disabled")
    public Boolean disabled;
    // Optional frame matcher. When missing it will be applied to all results
    @JsonInclude(JsonInclude.Include.NON_NULL)
    @JsonProperty("filter")
    public MatcherConfig filter;
    // Where to pull DataFrames from as input to transformation
    @JsonInclude(JsonInclude.Include.NON_NULL)
    @JsonProperty("topic")
    public DataTransformerConfigTopic topic;
    // Options to be passed to the transformer
    // Valid options depend on the transformer id
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    @JsonProperty("options")
    public Object options;
    
    public String toJSON() throws JsonProcessingException {
        ObjectWriter ow = new ObjectMapper().writer().withDefaultPrettyPrinter();
        return ow.writeValueAsString(this);
    }

}