com.pulumi.signalfx.ListChartArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of signalfx Show documentation
Show all versions of signalfx Show documentation
A Pulumi package for creating and managing SignalFx resources.
// *** 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;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import com.pulumi.signalfx.inputs.ListChartColorScaleArgs;
import com.pulumi.signalfx.inputs.ListChartLegendOptionsFieldArgs;
import com.pulumi.signalfx.inputs.ListChartVizOptionArgs;
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 ListChartArgs extends com.pulumi.resources.ResourceArgs {
public static final ListChartArgs Empty = new ListChartArgs();
/**
* Must be one of `"Scale"`, `"Dimension"` or `"Metric"`. `"Dimension"` by default.
*
*/
@Import(name="colorBy")
private @Nullable Output colorBy;
/**
* @return Must be one of `"Scale"`, `"Dimension"` 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.splunk.com/observability/en/data-visualization/charts/chart-options.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.splunk.com/observability/en/data-visualization/charts/chart-options.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);
}
/**
* If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default.
*
*/
@Import(name="disableSampling")
private @Nullable Output disableSampling;
/**
* @return If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default.
*
*/
public Optional> disableSampling() {
return Optional.ofNullable(this.disableSampling);
}
/**
* Seconds since epoch. Used for visualization. Conflicts with `time_range`.
*
*/
@Import(name="endTime")
private @Nullable Output endTime;
/**
* @return Seconds since epoch. Used for visualization. Conflicts with `time_range`.
*
*/
public Optional> endTime() {
return Optional.ofNullable(this.endTime);
}
/**
* Determines whether to hide missing data points in the chart. If `true`, missing data points in the chart would be hidden. `false` by default.
*
*/
@Import(name="hideMissingValues")
private @Nullable Output hideMissingValues;
/**
* @return Determines whether to hide missing data points in the chart. If `true`, missing data points in the chart would be hidden. `false` by default.
*
*/
public Optional> hideMissingValues() {
return Optional.ofNullable(this.hideMissingValues);
}
/**
* List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legend_options_fields`.
*
* @deprecated
* Please use legend_options_fields
*
*/
@Deprecated /* Please use legend_options_fields */
@Import(name="legendFieldsToHides")
private @Nullable Output> legendFieldsToHides;
/**
* @return List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legend_options_fields`.
*
* @deprecated
* Please use legend_options_fields
*
*/
@Deprecated /* Please use legend_options_fields */
public Optional>> legendFieldsToHides() {
return Optional.ofNullable(this.legendFieldsToHides);
}
/**
* List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legend_fields_to_hide`.
*
*/
@Import(name="legendOptionsFields")
private @Nullable Output> legendOptionsFields;
/**
* @return List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legend_fields_to_hide`.
*
*/
public Optional>> legendOptionsFields() {
return Optional.ofNullable(this.legendOptionsFields);
}
/**
* 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);
}
/**
* Maximum number of digits to display when rounding values up or down.
*
*/
@Import(name="maxPrecision")
private @Nullable Output maxPrecision;
/**
* @return Maximum number of digits to display when rounding values up or down.
*
*/
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://developers.signalfx.com/signalflow_analytics/signalflow_overview.html#_signalflow_programming_language).
*
*/
@Import(name="programText", required=true)
private Output programText;
/**
* @return Signalflow program text for the chart. More info[in the Splunk Observability Cloud docs](https://developers.signalfx.com/signalflow_analytics/signalflow_overview.html#_signalflow_programming_language).
*
*/
public Output programText() {
return this.programText;
}
/**
* How often (in seconds) to refresh the values of the list.
*
*/
@Import(name="refreshInterval")
private @Nullable Output refreshInterval;
/**
* @return How often (in seconds) to refresh the values of the list.
*
*/
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 (`Sparkline`).
*
*/
@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 (`Sparkline`).
*
*/
public Optional> secondaryVisualization() {
return Optional.ofNullable(this.secondaryVisualization);
}
/**
* The property to use when sorting the elements. Use `value` if you want to sort by value. Must be prepended with `+` for ascending or `-` for descending (e.g. `-foo`). Note there are some special values for some of the options provided in the UX: `"value"` for Value, `"sf_originatingMetric"` for Metric, and `"sf_metric"` for plot.
*
*/
@Import(name="sortBy")
private @Nullable Output sortBy;
/**
* @return The property to use when sorting the elements. Use `value` if you want to sort by value. Must be prepended with `+` for ascending or `-` for descending (e.g. `-foo`). Note there are some special values for some of the options provided in the UX: `"value"` for Value, `"sf_originatingMetric"` for Metric, and `"sf_metric"` for plot.
*
*/
public Optional> sortBy() {
return Optional.ofNullable(this.sortBy);
}
/**
* Seconds since epoch. Used for visualization. Conflicts with `time_range`.
*
*/
@Import(name="startTime")
private @Nullable Output startTime;
/**
* @return Seconds since epoch. Used for visualization. Conflicts with `time_range`.
*
*/
public Optional> startTime() {
return Optional.ofNullable(this.startTime);
}
/**
* How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
*
*/
@Import(name="timeRange")
private @Nullable Output timeRange;
/**
* @return How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
*
*/
public Optional> timeRange() {
return Optional.ofNullable(this.timeRange);
}
/**
* The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
*
*/
@Import(name="timezone")
private @Nullable Output timezone;
/**
* @return The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
*
*/
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);
}
/**
* 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 ListChartArgs() {}
private ListChartArgs(ListChartArgs $) {
this.colorBy = $.colorBy;
this.colorScales = $.colorScales;
this.description = $.description;
this.disableSampling = $.disableSampling;
this.endTime = $.endTime;
this.hideMissingValues = $.hideMissingValues;
this.legendFieldsToHides = $.legendFieldsToHides;
this.legendOptionsFields = $.legendOptionsFields;
this.maxDelay = $.maxDelay;
this.maxPrecision = $.maxPrecision;
this.name = $.name;
this.programText = $.programText;
this.refreshInterval = $.refreshInterval;
this.secondaryVisualization = $.secondaryVisualization;
this.sortBy = $.sortBy;
this.startTime = $.startTime;
this.timeRange = $.timeRange;
this.timezone = $.timezone;
this.unitPrefix = $.unitPrefix;
this.vizOptions = $.vizOptions;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ListChartArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ListChartArgs $;
public Builder() {
$ = new ListChartArgs();
}
public Builder(ListChartArgs defaults) {
$ = new ListChartArgs(Objects.requireNonNull(defaults));
}
/**
* @param colorBy Must be one of `"Scale"`, `"Dimension"` or `"Metric"`. `"Dimension"` by default.
*
* @return builder
*
*/
public Builder colorBy(@Nullable Output colorBy) {
$.colorBy = colorBy;
return this;
}
/**
* @param colorBy Must be one of `"Scale"`, `"Dimension"` 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.splunk.com/observability/en/data-visualization/charts/chart-options.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.splunk.com/observability/en/data-visualization/charts/chart-options.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.splunk.com/observability/en/data-visualization/charts/chart-options.html).
*
* @return builder
*
*/
public Builder colorScales(ListChartColorScaleArgs... 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 disableSampling If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default.
*
* @return builder
*
*/
public Builder disableSampling(@Nullable Output disableSampling) {
$.disableSampling = disableSampling;
return this;
}
/**
* @param disableSampling If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default.
*
* @return builder
*
*/
public Builder disableSampling(Boolean disableSampling) {
return disableSampling(Output.of(disableSampling));
}
/**
* @param endTime Seconds since epoch. Used for visualization. Conflicts with `time_range`.
*
* @return builder
*
*/
public Builder endTime(@Nullable Output endTime) {
$.endTime = endTime;
return this;
}
/**
* @param endTime Seconds since epoch. Used for visualization. Conflicts with `time_range`.
*
* @return builder
*
*/
public Builder endTime(Integer endTime) {
return endTime(Output.of(endTime));
}
/**
* @param hideMissingValues Determines whether to hide missing data points in the chart. If `true`, missing data points in the chart would be hidden. `false` by default.
*
* @return builder
*
*/
public Builder hideMissingValues(@Nullable Output hideMissingValues) {
$.hideMissingValues = hideMissingValues;
return this;
}
/**
* @param hideMissingValues Determines whether to hide missing data points in the chart. If `true`, missing data points in the chart would be hidden. `false` by default.
*
* @return builder
*
*/
public Builder hideMissingValues(Boolean hideMissingValues) {
return hideMissingValues(Output.of(hideMissingValues));
}
/**
* @param legendFieldsToHides List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legend_options_fields`.
*
* @return builder
*
* @deprecated
* Please use legend_options_fields
*
*/
@Deprecated /* Please use legend_options_fields */
public Builder legendFieldsToHides(@Nullable Output> legendFieldsToHides) {
$.legendFieldsToHides = legendFieldsToHides;
return this;
}
/**
* @param legendFieldsToHides List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legend_options_fields`.
*
* @return builder
*
* @deprecated
* Please use legend_options_fields
*
*/
@Deprecated /* Please use legend_options_fields */
public Builder legendFieldsToHides(List legendFieldsToHides) {
return legendFieldsToHides(Output.of(legendFieldsToHides));
}
/**
* @param legendFieldsToHides List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legend_options_fields`.
*
* @return builder
*
* @deprecated
* Please use legend_options_fields
*
*/
@Deprecated /* Please use legend_options_fields */
public Builder legendFieldsToHides(String... legendFieldsToHides) {
return legendFieldsToHides(List.of(legendFieldsToHides));
}
/**
* @param legendOptionsFields List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legend_fields_to_hide`.
*
* @return builder
*
*/
public Builder legendOptionsFields(@Nullable Output> legendOptionsFields) {
$.legendOptionsFields = legendOptionsFields;
return this;
}
/**
* @param legendOptionsFields List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legend_fields_to_hide`.
*
* @return builder
*
*/
public Builder legendOptionsFields(List legendOptionsFields) {
return legendOptionsFields(Output.of(legendOptionsFields));
}
/**
* @param legendOptionsFields List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legend_fields_to_hide`.
*
* @return builder
*
*/
public Builder legendOptionsFields(ListChartLegendOptionsFieldArgs... legendOptionsFields) {
return legendOptionsFields(List.of(legendOptionsFields));
}
/**
* @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 Maximum number of digits to display when rounding values up or down.
*
* @return builder
*
*/
public Builder maxPrecision(@Nullable Output maxPrecision) {
$.maxPrecision = maxPrecision;
return this;
}
/**
* @param maxPrecision Maximum number of digits to display when rounding values up or down.
*
* @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://developers.signalfx.com/signalflow_analytics/signalflow_overview.html#_signalflow_programming_language).
*
* @return builder
*
*/
public Builder programText(Output programText) {
$.programText = programText;
return this;
}
/**
* @param programText Signalflow program text for the chart. More info[in the Splunk Observability Cloud docs](https://developers.signalfx.com/signalflow_analytics/signalflow_overview.html#_signalflow_programming_language).
*
* @return builder
*
*/
public Builder programText(String programText) {
return programText(Output.of(programText));
}
/**
* @param refreshInterval How often (in seconds) to refresh the values of the list.
*
* @return builder
*
*/
public Builder refreshInterval(@Nullable Output refreshInterval) {
$.refreshInterval = refreshInterval;
return this;
}
/**
* @param refreshInterval How often (in seconds) to refresh the values of the list.
*
* @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 (`Sparkline`).
*
* @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 (`Sparkline`).
*
* @return builder
*
*/
public Builder secondaryVisualization(String secondaryVisualization) {
return secondaryVisualization(Output.of(secondaryVisualization));
}
/**
* @param sortBy The property to use when sorting the elements. Use `value` if you want to sort by value. Must be prepended with `+` for ascending or `-` for descending (e.g. `-foo`). Note there are some special values for some of the options provided in the UX: `"value"` for Value, `"sf_originatingMetric"` for Metric, and `"sf_metric"` for plot.
*
* @return builder
*
*/
public Builder sortBy(@Nullable Output sortBy) {
$.sortBy = sortBy;
return this;
}
/**
* @param sortBy The property to use when sorting the elements. Use `value` if you want to sort by value. Must be prepended with `+` for ascending or `-` for descending (e.g. `-foo`). Note there are some special values for some of the options provided in the UX: `"value"` for Value, `"sf_originatingMetric"` for Metric, and `"sf_metric"` for plot.
*
* @return builder
*
*/
public Builder sortBy(String sortBy) {
return sortBy(Output.of(sortBy));
}
/**
* @param startTime Seconds since epoch. Used for visualization. Conflicts with `time_range`.
*
* @return builder
*
*/
public Builder startTime(@Nullable Output startTime) {
$.startTime = startTime;
return this;
}
/**
* @param startTime Seconds since epoch. Used for visualization. Conflicts with `time_range`.
*
* @return builder
*
*/
public Builder startTime(Integer startTime) {
return startTime(Output.of(startTime));
}
/**
* @param timeRange How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
*
* @return builder
*
*/
public Builder timeRange(@Nullable Output timeRange) {
$.timeRange = timeRange;
return this;
}
/**
* @param timeRange How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
*
* @return builder
*
*/
public Builder timeRange(Integer timeRange) {
return timeRange(Output.of(timeRange));
}
/**
* @param timezone The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
*
* @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, (default UTC).
*
* @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 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(ListChartVizOptionArgs... vizOptions) {
return vizOptions(List.of(vizOptions));
}
public ListChartArgs build() {
if ($.programText == null) {
throw new MissingRequiredPropertyException("ListChartArgs", "programText");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy