com.wavefront.slug.dashboard.DashboardSlugBuilder Maven / Gradle / Ivy
Show all versions of slug-generator Show documentation
/*
* Copyright 2019 VMware, Inc.
* SPDX-License-Identifier: Apache-2.0
*/
package com.wavefront.slug.dashboard;
import org.joda.time.ReadableInstant;
/**
* Interface of {@link DashboardSlugBuilder}
*
* @author Yutian Wu ([email protected])
*/
public interface DashboardSlugBuilder {
/**
* Set the start millis.
*
* *Notice* If {@link #setLiveRefresh} is not called and liveliness is not set to False, the start
* time will be changed after accessing using the url, because liveliness will always start from
* the latest time.
*
* @param startMillis Start millis.
* @return The builder.
*/
DashboardSlugBuilder setStart(long startMillis);
/**
* Set the start instant.
*
* *Notice* If {@link #setLiveRefresh} is not called and liveliness is not set to False, the start
* time will be changed after accessing using the url, because liveliness will always start from
* the latest time.
*
* @param instant The start instant.
* @return The builder.
*/
DashboardSlugBuilder setStart(ReadableInstant instant);
/**
* Set the end millis.
*
* *Notice* If {@link #setLiveRefresh} is not called and liveliness is not set to False, the end
* time will only be used to calculate the duration, because liveliness will always start from
* the latest time.
*
* @param endMillis End millis.
* @return The builder.
*/
DashboardSlugBuilder setEnd(long endMillis);
/**
* Set the end millis.
*
* *Notice* If {@link #setLiveRefresh} is not called and liveliness is not set to False, the end
* time will only be used to calculate the duration, because liveliness will always start from
* the latest time.
*
* @param instant The end instant.
* @return The builder.
*/
DashboardSlugBuilder setEnd(ReadableInstant instant);
/**
* Set the flag whether we want to turn on live refresh (default is off, so used it when you want
* to turn on live refresh).
*
* @param enableLiveRefresh Whether we want to turn on live refresh
* @return The builder.
*/
DashboardSlugBuilder setLiveRefresh(boolean enableLiveRefresh);
/**
* Set the live refresh window size, this value needs to be provided if live refresh is turned on
* or default is `2h`.
*
* @param windowSize The window size.
* @return The builder.
*/
DashboardSlugBuilder setWindowSize(String windowSize);
/**
* Sets the comparison option for the entire dashboard. Valid values are determined by the FE.
* Possible values include: "1d", "1w", "1m". Defaults to null.
*
* @param compare Comparison option to set for the dashboard.
* @return The builder.
*/
DashboardSlugBuilder setCompare(String compare);
/**
* Sets the value of a simple dashboard variable in the dashboard. Because a simple dashboard
* variable is used as a constant in Wavefront's dashboard, you hardly need to use this method.
*
* There are three caveats when using this method:
*
* 1. The name is the variable name you defined when you create a dashboard variable, not its
* display name. You can get the name of the variable by hovering your cursor over your dashboard
* variable display name.
*
* 2. This is not a place to define a new dashboard variable. Instead, it is a place to assign a
* value to the existing variable.
*
* 3. Slug builder won't check whether the value is valid or not. If the value does not match the
* original value defined in the dashboard, our frontend will use the value, leading to the
* charts loading issue.
*
* @param name Name of the dashboard variable (Not label)
* @param value Value of the variable. If it is null, it will use
the default one.
* @return The builder.
*/
DashboardSlugBuilder setSimpleDashboardVariable(String name, String value);
/**
* Sets the value of a list dashboard variable in the dashboard.
*
* There are three caveats when using this method:
*
* 1. The name is the variable name you defined when you create a dashboard variable, not its
* display name. You can get the name of the variable by hovering your cursor over your dashboard
* variable display name.
*
* 2. This is not a place to define a new dashboard variable. Instead, it is a place to assign a
* value to the existing variable.
*
* 3. Slug builder won't check whether the value is valid or not. If the value is not defined in
* the original list of values, our frontend redirects you to the dashboard using the default
* value for this variable.
*
* @param name Name of the dashboard variable (Not label).
* @param selected The selected value from the list of values. If it is null, it
* will use the default one.
* @return The builder.
*/
DashboardSlugBuilder setListDashboardVariable(String name, String selected);
/**
* Sets the value of a list dashboard variable in the dashboard.
*
* There are three caveats when using this method:
*
* 1. The name is the variable name you defined when you create a dashboard variable, not its
* display name. You can get the name of the variable by hovering your cursor over your dashboard
* variable display name.
*
* 2. This is not a place to define a new dashboard variable. Instead, it is a place to assign a
* value to the existing variable.
*
* 3. Slug builder won't check whether the value is valid or not. If the value is not returned in
* the original query defined for this dynamic variable, our frontend redirects you to the
* dashboard with the default value of the dashboard variable.
*
* @param name Name of the dashboard variable (Not label).
* @param value Value of the dashboard variable. If it is null, it will use
* the default one.
* @return The builder.
*/
DashboardSlugBuilder setDynamicDashboardVariable(String name, String value);
/**
* Build the dashboard slug.
*
* @return The dashboard slug.
*/
String build();
/**
* Build and escape the dashboard slug to be used in the dashboard url.
*/
String buildAndEscape();
}