All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.signalfx.inputs.SingleValueChartState Maven / Gradle / Ivy

There is a newer version: 7.5.0
Show newest version
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.signalfx.inputs;

import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.signalfx.inputs.SingleValueChartColorScaleArgs;
import com.pulumi.signalfx.inputs.SingleValueChartVizOptionArgs;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


public final class SingleValueChartState extends com.pulumi.resources.ResourceArgs {

    public static final SingleValueChartState Empty = new SingleValueChartState();

    /**
     * Must be `"Dimension"`, `"Scale"` or `"Metric"`. `"Dimension"` by default.
     * 
     */
    @Import(name="colorBy")
    private @Nullable Output colorBy;

    /**
     * @return Must be `"Dimension"`, `"Scale"` or `"Metric"`. `"Dimension"` by default.
     * 
     */
    public Optional> colorBy() {
        return Optional.ofNullable(this.colorBy);
    }

    /**
     * Single color range including both the color to display for that range and the borders of the range. Example: `[{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]`. Look at this [link](https://docs.signalfx.com/en/latest/charts/chart-options-tab.html).
     * 
     */
    @Import(name="colorScales")
    private @Nullable Output> colorScales;

    /**
     * @return Single color range including both the color to display for that range and the borders of the range. Example: `[{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]`. Look at this [link](https://docs.signalfx.com/en/latest/charts/chart-options-tab.html).
     * 
     */
    public Optional>> colorScales() {
        return Optional.ofNullable(this.colorScales);
    }

    /**
     * Description of the chart.
     * 
     */
    @Import(name="description")
    private @Nullable Output description;

    /**
     * @return Description of the chart.
     * 
     */
    public Optional> description() {
        return Optional.ofNullable(this.description);
    }

    /**
     * Whether to hide the timestamp in the chart. `false` by default.
     * 
     */
    @Import(name="isTimestampHidden")
    private @Nullable Output isTimestampHidden;

    /**
     * @return Whether to hide the timestamp in the chart. `false` by default.
     * 
     */
    public Optional> isTimestampHidden() {
        return Optional.ofNullable(this.isTimestampHidden);
    }

    /**
     * How long (in seconds) to wait for late datapoints
     * 
     */
    @Import(name="maxDelay")
    private @Nullable Output maxDelay;

    /**
     * @return How long (in seconds) to wait for late datapoints
     * 
     */
    public Optional> maxDelay() {
        return Optional.ofNullable(this.maxDelay);
    }

    /**
     * The maximum precision to for value displayed.
     * 
     */
    @Import(name="maxPrecision")
    private @Nullable Output maxPrecision;

    /**
     * @return The maximum precision to for value displayed.
     * 
     */
    public Optional> maxPrecision() {
        return Optional.ofNullable(this.maxPrecision);
    }

    /**
     * Name of the chart.
     * 
     */
    @Import(name="name")
    private @Nullable Output name;

    /**
     * @return Name of the chart.
     * 
     */
    public Optional> name() {
        return Optional.ofNullable(this.name);
    }

    /**
     * Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
     * 
     */
    @Import(name="programText")
    private @Nullable Output programText;

    /**
     * @return Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
     * 
     */
    public Optional> programText() {
        return Optional.ofNullable(this.programText);
    }

    /**
     * How often (in seconds) to refresh the value.
     * 
     */
    @Import(name="refreshInterval")
    private @Nullable Output refreshInterval;

    /**
     * @return How often (in seconds) to refresh the value.
     * 
     */
    public Optional> refreshInterval() {
        return Optional.ofNullable(this.refreshInterval);
    }

    /**
     * The type of secondary visualization. Can be `None`, `Radial`, `Linear`, or `Sparkline`. If unset, the Splunk Observability Cloud default is used (`None`).
     * 
     */
    @Import(name="secondaryVisualization")
    private @Nullable Output secondaryVisualization;

    /**
     * @return The type of secondary visualization. Can be `None`, `Radial`, `Linear`, or `Sparkline`. If unset, the Splunk Observability Cloud default is used (`None`).
     * 
     */
    public Optional> secondaryVisualization() {
        return Optional.ofNullable(this.secondaryVisualization);
    }

    /**
     * Whether to show a trend line below the current value. `false` by default.
     * 
     */
    @Import(name="showSparkLine")
    private @Nullable Output showSparkLine;

    /**
     * @return Whether to show a trend line below the current value. `false` by default.
     * 
     */
    public Optional> showSparkLine() {
        return Optional.ofNullable(this.showSparkLine);
    }

    /**
     * The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
     * 
     */
    @Import(name="timezone")
    private @Nullable Output timezone;

    /**
     * @return The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
     * 
     */
    public Optional> timezone() {
        return Optional.ofNullable(this.timezone);
    }

    /**
     * Must be `"Metric"` or `"Binary"`. `"Metric"` by default.
     * 
     */
    @Import(name="unitPrefix")
    private @Nullable Output unitPrefix;

    /**
     * @return Must be `"Metric"` or `"Binary"`. `"Metric"` by default.
     * 
     */
    public Optional> unitPrefix() {
        return Optional.ofNullable(this.unitPrefix);
    }

    /**
     * The URL of the chart.
     * 
     */
    @Import(name="url")
    private @Nullable Output url;

    /**
     * @return The URL of the chart.
     * 
     */
    public Optional> url() {
        return Optional.ofNullable(this.url);
    }

    /**
     * Plot-level customization options, associated with a publish statement.
     * 
     */
    @Import(name="vizOptions")
    private @Nullable Output> vizOptions;

    /**
     * @return Plot-level customization options, associated with a publish statement.
     * 
     */
    public Optional>> vizOptions() {
        return Optional.ofNullable(this.vizOptions);
    }

    private SingleValueChartState() {}

    private SingleValueChartState(SingleValueChartState $) {
        this.colorBy = $.colorBy;
        this.colorScales = $.colorScales;
        this.description = $.description;
        this.isTimestampHidden = $.isTimestampHidden;
        this.maxDelay = $.maxDelay;
        this.maxPrecision = $.maxPrecision;
        this.name = $.name;
        this.programText = $.programText;
        this.refreshInterval = $.refreshInterval;
        this.secondaryVisualization = $.secondaryVisualization;
        this.showSparkLine = $.showSparkLine;
        this.timezone = $.timezone;
        this.unitPrefix = $.unitPrefix;
        this.url = $.url;
        this.vizOptions = $.vizOptions;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(SingleValueChartState defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private SingleValueChartState $;

        public Builder() {
            $ = new SingleValueChartState();
        }

        public Builder(SingleValueChartState defaults) {
            $ = new SingleValueChartState(Objects.requireNonNull(defaults));
        }

        /**
         * @param colorBy Must be `"Dimension"`, `"Scale"` or `"Metric"`. `"Dimension"` by default.
         * 
         * @return builder
         * 
         */
        public Builder colorBy(@Nullable Output colorBy) {
            $.colorBy = colorBy;
            return this;
        }

        /**
         * @param colorBy Must be `"Dimension"`, `"Scale"` or `"Metric"`. `"Dimension"` by default.
         * 
         * @return builder
         * 
         */
        public Builder colorBy(String colorBy) {
            return colorBy(Output.of(colorBy));
        }

        /**
         * @param colorScales Single color range including both the color to display for that range and the borders of the range. Example: `[{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]`. Look at this [link](https://docs.signalfx.com/en/latest/charts/chart-options-tab.html).
         * 
         * @return builder
         * 
         */
        public Builder colorScales(@Nullable Output> colorScales) {
            $.colorScales = colorScales;
            return this;
        }

        /**
         * @param colorScales Single color range including both the color to display for that range and the borders of the range. Example: `[{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]`. Look at this [link](https://docs.signalfx.com/en/latest/charts/chart-options-tab.html).
         * 
         * @return builder
         * 
         */
        public Builder colorScales(List colorScales) {
            return colorScales(Output.of(colorScales));
        }

        /**
         * @param colorScales Single color range including both the color to display for that range and the borders of the range. Example: `[{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]`. Look at this [link](https://docs.signalfx.com/en/latest/charts/chart-options-tab.html).
         * 
         * @return builder
         * 
         */
        public Builder colorScales(SingleValueChartColorScaleArgs... colorScales) {
            return colorScales(List.of(colorScales));
        }

        /**
         * @param description Description of the chart.
         * 
         * @return builder
         * 
         */
        public Builder description(@Nullable Output description) {
            $.description = description;
            return this;
        }

        /**
         * @param description Description of the chart.
         * 
         * @return builder
         * 
         */
        public Builder description(String description) {
            return description(Output.of(description));
        }

        /**
         * @param isTimestampHidden Whether to hide the timestamp in the chart. `false` by default.
         * 
         * @return builder
         * 
         */
        public Builder isTimestampHidden(@Nullable Output isTimestampHidden) {
            $.isTimestampHidden = isTimestampHidden;
            return this;
        }

        /**
         * @param isTimestampHidden Whether to hide the timestamp in the chart. `false` by default.
         * 
         * @return builder
         * 
         */
        public Builder isTimestampHidden(Boolean isTimestampHidden) {
            return isTimestampHidden(Output.of(isTimestampHidden));
        }

        /**
         * @param maxDelay How long (in seconds) to wait for late datapoints
         * 
         * @return builder
         * 
         */
        public Builder maxDelay(@Nullable Output maxDelay) {
            $.maxDelay = maxDelay;
            return this;
        }

        /**
         * @param maxDelay How long (in seconds) to wait for late datapoints
         * 
         * @return builder
         * 
         */
        public Builder maxDelay(Integer maxDelay) {
            return maxDelay(Output.of(maxDelay));
        }

        /**
         * @param maxPrecision The maximum precision to for value displayed.
         * 
         * @return builder
         * 
         */
        public Builder maxPrecision(@Nullable Output maxPrecision) {
            $.maxPrecision = maxPrecision;
            return this;
        }

        /**
         * @param maxPrecision The maximum precision to for value displayed.
         * 
         * @return builder
         * 
         */
        public Builder maxPrecision(Integer maxPrecision) {
            return maxPrecision(Output.of(maxPrecision));
        }

        /**
         * @param name Name of the chart.
         * 
         * @return builder
         * 
         */
        public Builder name(@Nullable Output name) {
            $.name = name;
            return this;
        }

        /**
         * @param name Name of the chart.
         * 
         * @return builder
         * 
         */
        public Builder name(String name) {
            return name(Output.of(name));
        }

        /**
         * @param programText Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
         * 
         * @return builder
         * 
         */
        public Builder programText(@Nullable Output programText) {
            $.programText = programText;
            return this;
        }

        /**
         * @param programText Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
         * 
         * @return builder
         * 
         */
        public Builder programText(String programText) {
            return programText(Output.of(programText));
        }

        /**
         * @param refreshInterval How often (in seconds) to refresh the value.
         * 
         * @return builder
         * 
         */
        public Builder refreshInterval(@Nullable Output refreshInterval) {
            $.refreshInterval = refreshInterval;
            return this;
        }

        /**
         * @param refreshInterval How often (in seconds) to refresh the value.
         * 
         * @return builder
         * 
         */
        public Builder refreshInterval(Integer refreshInterval) {
            return refreshInterval(Output.of(refreshInterval));
        }

        /**
         * @param secondaryVisualization The type of secondary visualization. Can be `None`, `Radial`, `Linear`, or `Sparkline`. If unset, the Splunk Observability Cloud default is used (`None`).
         * 
         * @return builder
         * 
         */
        public Builder secondaryVisualization(@Nullable Output secondaryVisualization) {
            $.secondaryVisualization = secondaryVisualization;
            return this;
        }

        /**
         * @param secondaryVisualization The type of secondary visualization. Can be `None`, `Radial`, `Linear`, or `Sparkline`. If unset, the Splunk Observability Cloud default is used (`None`).
         * 
         * @return builder
         * 
         */
        public Builder secondaryVisualization(String secondaryVisualization) {
            return secondaryVisualization(Output.of(secondaryVisualization));
        }

        /**
         * @param showSparkLine Whether to show a trend line below the current value. `false` by default.
         * 
         * @return builder
         * 
         */
        public Builder showSparkLine(@Nullable Output showSparkLine) {
            $.showSparkLine = showSparkLine;
            return this;
        }

        /**
         * @param showSparkLine Whether to show a trend line below the current value. `false` by default.
         * 
         * @return builder
         * 
         */
        public Builder showSparkLine(Boolean showSparkLine) {
            return showSparkLine(Output.of(showSparkLine));
        }

        /**
         * @param timezone The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
         * 
         * @return builder
         * 
         */
        public Builder timezone(@Nullable Output timezone) {
            $.timezone = timezone;
            return this;
        }

        /**
         * @param timezone The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
         * 
         * @return builder
         * 
         */
        public Builder timezone(String timezone) {
            return timezone(Output.of(timezone));
        }

        /**
         * @param unitPrefix Must be `"Metric"` or `"Binary"`. `"Metric"` by default.
         * 
         * @return builder
         * 
         */
        public Builder unitPrefix(@Nullable Output unitPrefix) {
            $.unitPrefix = unitPrefix;
            return this;
        }

        /**
         * @param unitPrefix Must be `"Metric"` or `"Binary"`. `"Metric"` by default.
         * 
         * @return builder
         * 
         */
        public Builder unitPrefix(String unitPrefix) {
            return unitPrefix(Output.of(unitPrefix));
        }

        /**
         * @param url The URL of the chart.
         * 
         * @return builder
         * 
         */
        public Builder url(@Nullable Output url) {
            $.url = url;
            return this;
        }

        /**
         * @param url The URL of the chart.
         * 
         * @return builder
         * 
         */
        public Builder url(String url) {
            return url(Output.of(url));
        }

        /**
         * @param vizOptions Plot-level customization options, associated with a publish statement.
         * 
         * @return builder
         * 
         */
        public Builder vizOptions(@Nullable Output> vizOptions) {
            $.vizOptions = vizOptions;
            return this;
        }

        /**
         * @param vizOptions Plot-level customization options, associated with a publish statement.
         * 
         * @return builder
         * 
         */
        public Builder vizOptions(List vizOptions) {
            return vizOptions(Output.of(vizOptions));
        }

        /**
         * @param vizOptions Plot-level customization options, associated with a publish statement.
         * 
         * @return builder
         * 
         */
        public Builder vizOptions(SingleValueChartVizOptionArgs... vizOptions) {
            return vizOptions(List.of(vizOptions));
        }

        public SingleValueChartState build() {
            return $;
        }
    }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy