com.vmware.nsx.model

Class GraphConfiguration.Builder

java.lang.Object

com.vmware.nsx.model.GraphConfiguration.Builder

Enclosing class:

GraphConfiguration

public static final class GraphConfiguration.Builder
extends java.lang.Object

Builder class for GraphConfiguration.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of GraphConfiguration.

Method Summary

Modifier and Type	Method and Description
GraphConfiguration	build()
GraphConfiguration.Builder	setAxes(Axes axes)
GraphConfiguration.Builder	setCondition(java.lang.String condition) If the condition is met then the widget will be displayed to UI.
GraphConfiguration.Builder	setCreateTime(java.lang.Long createTime) Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GraphConfiguration.Builder	setCreateUser(java.lang.String createUser) ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GraphConfiguration.Builder	setDatasources(java.util.List<Datasource> datasources) The 'datasources' represent the sources from which data will be fetched.
GraphConfiguration.Builder	setDefaultFilterValue(java.util.List<DefaultFilterValue> defaultFilterValue) Default filter values to be passed to datasources.
GraphConfiguration.Builder	setDescription(java.lang.String description) Description of this resource
GraphConfiguration.Builder	setDisplayName(java.lang.String displayName) Title of the widget.
GraphConfiguration.Builder	setDisplayxValue(java.lang.Boolean displayxValue) If true, value of a point is shown as label on X axis.
GraphConfiguration.Builder	setDrilldownId(java.lang.String drilldownId) Id of drilldown widget, if any.
GraphConfiguration.Builder	setFeatureSet(FeatureSet featureSet)
GraphConfiguration.Builder	setFilter(java.lang.String filter) Id of filter widget for subscription, if any.
GraphConfiguration.Builder	setFilters(java.util.List<java.lang.String> filters) A List of filter applied to this widget configuration.
GraphConfiguration.Builder	setFilterValueRequired(java.lang.Boolean filterValueRequired) Flag to indicate that widget will continue to work without filter value.
GraphConfiguration.Builder	setFooter(Footer footer)
GraphConfiguration.Builder	setGraphs(java.util.List<GraphDefinition> graphs) Graphs
GraphConfiguration.Builder	setGraphsColors(java.util.List<java.lang.String> graphsColors) An array of graphs colors which will be applied to each graph seperately.
GraphConfiguration.Builder	setIcons(java.util.List<Icon> icons) Icons to be applied at dashboard for widgets and UI elements.
GraphConfiguration.Builder	setId(java.lang.String id) Unique identifier of this resource
GraphConfiguration.Builder	setIsDrilldown(java.lang.Boolean isDrilldown) Set to true if this widget should be used as a drilldown.
GraphConfiguration.Builder	setLastModifiedTime(java.lang.Long lastModifiedTime) Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GraphConfiguration.Builder	setLastModifiedUser(java.lang.String lastModifiedUser) ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GraphConfiguration.Builder	setLegend(Legend legend)
GraphConfiguration.Builder	setLineChartPlotConfigs(java.util.List<LineChartPlotConfiguration> lineChartPlotConfigs) List of line chart plotting configuration.
GraphConfiguration.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
GraphConfiguration.Builder	setNavigation(java.lang.String navigation) Hyperlink of the specified UI page that provides details.
GraphConfiguration.Builder	setPlotConfigs(java.util.List<WidgetPlotConfiguration> plotConfigs) List of plotting configuration for a given widget.
GraphConfiguration.Builder	setProtection(java.lang.String protection) Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
GraphConfiguration.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
GraphConfiguration.Builder	setRowspan(java.lang.Long rowspan) Represents the vertical span of the widget / container.
GraphConfiguration.Builder	setSchema(java.lang.String schema) Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GraphConfiguration.Builder	setSelf(SelfResourceLink self)
GraphConfiguration.Builder	setShared(java.lang.Boolean shared) Please use the property 'shared' of View instead of this.
GraphConfiguration.Builder	setShowHeader(java.lang.Boolean showHeader) If the value of this field is set to true then card header will be displayed otherwise only card will be displayed without header.
GraphConfiguration.Builder	setSpan(java.lang.Long span) Represents the horizontal span of the widget / container.
GraphConfiguration.Builder	setSubType(java.lang.String subType) Possible values are: GraphConfiguration.SUB_TYPE_LINE_GRAPH GraphConfiguration.SUB_TYPE_BAR_GRAPH GraphConfiguration.SUB_TYPE_STACKED_BAR_GRAPH Describes the the type of graph.
GraphConfiguration.Builder	setSystemOwned(java.lang.Boolean systemOwned) Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GraphConfiguration.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
GraphConfiguration.Builder	setWeight(java.lang.Long weight) Specify relavite weight in WidgetItem for placement in a view.
GraphConfiguration.Builder	setxValueType(java.lang.String xValueType) Possible values are: GraphConfiguration.X_VALUE_TYPE_STRING GraphConfiguration.X_VALUE_TYPE_NUMBER GraphConfiguration.X_VALUE_TYPE_DATE GraphConfiguration.X_VALUE_TYPE_MILLISECOND GraphConfiguration.X_VALUE_TYPE_SECOND x value type.
GraphConfiguration.Builder	setyValueType(java.lang.String yValueType) Possible values are: GraphConfiguration.Y_VALUE_TYPE_INTEGER GraphConfiguration.Y_VALUE_TYPE_DOUBLE y value type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of GraphConfiguration.

Method Detail

setAxes

public GraphConfiguration.Builder setAxes(Axes axes)

Parameters:

axes - New value for the property.

setDisplayxValue

public GraphConfiguration.Builder setDisplayxValue(java.lang.Boolean displayxValue)

If true, value of a point is shown as label on X axis. If false, value of point is not shown as label on X axis. false can be useful in situations where there are too many points and showing the X value as label can clutter the X axis.

Parameters:

displayxValue - New value for the property.

setGraphs

public GraphConfiguration.Builder setGraphs(java.util.List<GraphDefinition> graphs)

Graphs

Parameters:

graphs - New value for the property.

setGraphsColors

public GraphConfiguration.Builder setGraphsColors(java.util.List<java.lang.String> graphsColors)

An array of graphs colors which will be applied to each graph seperately. if number of provided colors are smaller than number of graph in the widget then colors are applied in circular manner.

Parameters:

graphsColors - New value for the property.

setLineChartPlotConfigs

public GraphConfiguration.Builder setLineChartPlotConfigs(java.util.List<LineChartPlotConfiguration> lineChartPlotConfigs)

List of line chart plotting configuration. This plotting configuration will be applicable for the LINE_GRAPH only.

Parameters:

lineChartPlotConfigs - New value for the property.

setNavigation

public GraphConfiguration.Builder setNavigation(java.lang.String navigation)

Hyperlink of the specified UI page that provides details.

Parameters:

navigation - New value for the property.

setSubType

public GraphConfiguration.Builder setSubType(java.lang.String subType)

Possible values are:

• GraphConfiguration.SUB_TYPE_LINE_GRAPH
• GraphConfiguration.SUB_TYPE_BAR_GRAPH
• GraphConfiguration.SUB_TYPE_STACKED_BAR_GRAPH

Describes the the type of graph. LINE_GRAPH shows a line graph chart BAR_GRAPH shows a simple bar graph chart STACKED_BAR_GRAPH shows a stacked bar graph chart

Parameters:

subType - New value for the property.

setxValueType

public GraphConfiguration.Builder setxValueType(java.lang.String xValueType)

Possible values are:

• GraphConfiguration.X_VALUE_TYPE_STRING
• GraphConfiguration.X_VALUE_TYPE_NUMBER
• GraphConfiguration.X_VALUE_TYPE_DATE
• GraphConfiguration.X_VALUE_TYPE_MILLISECOND
• GraphConfiguration.X_VALUE_TYPE_SECOND

x value type.

Parameters:

xValueType - New value for the property.

setyValueType

public GraphConfiguration.Builder setyValueType(java.lang.String yValueType)

Possible values are:

• GraphConfiguration.Y_VALUE_TYPE_INTEGER
• GraphConfiguration.Y_VALUE_TYPE_DOUBLE

y value type.

Parameters:

yValueType - New value for the property.

setLinks

public GraphConfiguration.Builder setLinks(java.util.List<ResourceLink> links)

The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

links - New value for the property.

setSchema

public GraphConfiguration.Builder setSchema(java.lang.String schema)

Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

schema - New value for the property.

setSelf

public GraphConfiguration.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public GraphConfiguration.Builder setRevision(java.lang.Long revision)

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32

Parameters:

revision - New value for the property.

setCreateTime

public GraphConfiguration.Builder setCreateTime(java.lang.Long createTime)

Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

createTime - New value for the property.

setCreateUser

public GraphConfiguration.Builder setCreateUser(java.lang.String createUser)

ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

createUser - New value for the property.

setLastModifiedTime

public GraphConfiguration.Builder setLastModifiedTime(java.lang.Long lastModifiedTime)

Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

lastModifiedTime - New value for the property.

setLastModifiedUser

public GraphConfiguration.Builder setLastModifiedUser(java.lang.String lastModifiedUser)

ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

lastModifiedUser - New value for the property.

setProtection

public GraphConfiguration.Builder setProtection(java.lang.String protection)

Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

protection - New value for the property.

setSystemOwned

public GraphConfiguration.Builder setSystemOwned(java.lang.Boolean systemOwned)

Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

systemOwned - New value for the property.

setDescription

public GraphConfiguration.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

public GraphConfiguration.Builder setDisplayName(java.lang.String displayName)

Title of the widget. If display_name is omitted, the widget will be shown without a title.

Parameters:

displayName - New value for the property.

setId

public GraphConfiguration.Builder setId(java.lang.String id)

Unique identifier of this resource

Parameters:

id - New value for the property.

setTags

public GraphConfiguration.Builder setTags(java.util.List<Tag> tags)

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setCondition

public GraphConfiguration.Builder setCondition(java.lang.String condition)

If the condition is met then the widget will be displayed to UI. If no condition is provided, then the widget will be displayed unconditionally.

Parameters:

condition - New value for the property.

setDatasources

public GraphConfiguration.Builder setDatasources(java.util.List<Datasource> datasources)

The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.

Parameters:

datasources - New value for the property.

setDefaultFilterValue

public GraphConfiguration.Builder setDefaultFilterValue(java.util.List<DefaultFilterValue> defaultFilterValue)

Default filter values to be passed to datasources. This will be used when the report is requested without filter values.

Parameters:

defaultFilterValue - New value for the property.

setDrilldownId

public GraphConfiguration.Builder setDrilldownId(java.lang.String drilldownId)

Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.

Parameters:

drilldownId - New value for the property.

setFeatureSet

public GraphConfiguration.Builder setFeatureSet(FeatureSet featureSet)

Parameters:

featureSet - New value for the property.

setFilter

public GraphConfiguration.Builder setFilter(java.lang.String filter)

Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change. This field is deprecated instead use 'filters' property.

Parameters:

filter - New value for the property.

setFilterValueRequired

public GraphConfiguration.Builder setFilterValueRequired(java.lang.Boolean filterValueRequired)

Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.

Parameters:

filterValueRequired - New value for the property.

setFilters

public GraphConfiguration.Builder setFilters(java.util.List<java.lang.String> filters)

A List of filter applied to this widget configuration. This will be used to identify the filters applied to this widget.

Parameters:

filters - New value for the property.

setFooter

public GraphConfiguration.Builder setFooter(Footer footer)

Parameters:

footer - New value for the property.

setIcons

public GraphConfiguration.Builder setIcons(java.util.List<Icon> icons)

Icons to be applied at dashboard for widgets and UI elements.

Parameters:

icons - New value for the property.

setIsDrilldown

public GraphConfiguration.Builder setIsDrilldown(java.lang.Boolean isDrilldown)

Set to true if this widget should be used as a drilldown.

Parameters:

isDrilldown - New value for the property.

setLegend

public GraphConfiguration.Builder setLegend(Legend legend)

Parameters:

legend - New value for the property.

setPlotConfigs

public GraphConfiguration.Builder setPlotConfigs(java.util.List<WidgetPlotConfiguration> plotConfigs)

List of plotting configuration for a given widget. Widget plotting configurations which are common across all the widgets types should be define here.

Parameters:

plotConfigs - New value for the property.

setRowspan

public GraphConfiguration.Builder setRowspan(java.lang.Long rowspan)

Represents the vertical span of the widget / container. 1 Row span is equal to 20px. format: int32

Parameters:

rowspan - New value for the property.

setShared

public GraphConfiguration.Builder setShared(java.lang.Boolean shared)

Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.

Parameters:

shared - New value for the property.

setShowHeader

public GraphConfiguration.Builder setShowHeader(java.lang.Boolean showHeader)

If the value of this field is set to true then card header will be displayed otherwise only card will be displayed without header.

Parameters:

showHeader - New value for the property.

setSpan

public GraphConfiguration.Builder setSpan(java.lang.Long span)

Represents the horizontal span of the widget / container. format: int32

Parameters:

span - New value for the property.

setWeight

public GraphConfiguration.Builder setWeight(java.lang.Long weight)

Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32

Parameters:

weight - New value for the property.

build

public GraphConfiguration build()