Package com.vmware.nsx_policy.model
Class LegendWidgetConfiguration.Builder
- java.lang.Object
-
- com.vmware.nsx_policy.model.LegendWidgetConfiguration.Builder
-
- Enclosing class:
- LegendWidgetConfiguration
public static final class LegendWidgetConfiguration.Builder extends java.lang.Object
Builder class forLegendWidgetConfiguration
.
-
-
Constructor Summary
Constructors Constructor Description Builder()
Constructor with parameters for the required properties ofLegendWidgetConfiguration
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LegendWidgetConfiguration
build()
LegendWidgetConfiguration.Builder
setCondition(java.lang.String condition)
If the condition is met then the widget will be displayed to UI.LegendWidgetConfiguration.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.LegendWidgetConfiguration.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.LegendWidgetConfiguration.Builder
setDatasources(java.util.List<Datasource> datasources)
The 'datasources' represent the sources from which data will be fetched.LegendWidgetConfiguration.Builder
setDefaultFilterValue(java.util.List<DefaultFilterValue> defaultFilterValue)
Default filter values to be passed to datasources.LegendWidgetConfiguration.Builder
setDescription(java.lang.String description)
Description of this resourceLegendWidgetConfiguration.Builder
setDisplayName(java.lang.String displayName)
Title of the widget.LegendWidgetConfiguration.Builder
setDrilldownId(java.lang.String drilldownId)
Id of drilldown widget, if any.LegendWidgetConfiguration.Builder
setFeatureSet(FeatureSet featureSet)
LegendWidgetConfiguration.Builder
setFilter(java.lang.String filter)
Id of filter widget for subscription, if any.LegendWidgetConfiguration.Builder
setFilters(java.util.List<java.lang.String> filters)
A List of filter applied to this widget configuration.LegendWidgetConfiguration.Builder
setFilterValueRequired(java.lang.Boolean filterValueRequired)
Flag to indicate that widget will continue to work without filter value.LegendWidgetConfiguration.Builder
setFooter(Footer footer)
LegendWidgetConfiguration.Builder
setIcons(java.util.List<Icon> icons)
Icons to be applied at dashboard for widgets and UI elements.LegendWidgetConfiguration.Builder
setId(java.lang.String id)
Unique identifier of this resourceLegendWidgetConfiguration.Builder
setIsDrilldown(java.lang.Boolean isDrilldown)
Set to true if this widget should be used as a drilldown.LegendWidgetConfiguration.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.LegendWidgetConfiguration.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.LegendWidgetConfiguration.Builder
setLayout(Legend layout)
LegendWidgetConfiguration.Builder
setLegend(Legend legend)
LegendWidgetConfiguration.Builder
setLinks(java.util.List<ResourceLink> links)
The server will populate this field when returing the resource.LegendWidgetConfiguration.Builder
setPlotConfigs(java.util.List<WidgetPlotConfiguration> plotConfigs)
List of plotting configuration for a given widget.LegendWidgetConfiguration.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.LegendWidgetConfiguration.Builder
setRevision(java.lang.Long revision)
The _revision property describes the current revision of the resource.LegendWidgetConfiguration.Builder
setRowspan(java.lang.Long rowspan)
Represents the vertical span of the widget / container.LegendWidgetConfiguration.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.LegendWidgetConfiguration.Builder
setSelf(SelfResourceLink self)
LegendWidgetConfiguration.Builder
setShared(java.lang.Boolean shared)
Please use the property 'shared' of View instead of this.LegendWidgetConfiguration.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.LegendWidgetConfiguration.Builder
setSourceWidgetId(java.lang.String sourceWidgetId)
Id of source widget, if any.LegendWidgetConfiguration.Builder
setSpan(java.lang.Long span)
Represents the horizontal span of the widget / container.LegendWidgetConfiguration.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.LegendWidgetConfiguration.Builder
setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API userLegendWidgetConfiguration.Builder
setWeight(java.lang.Long weight)
Specify relavite weight in WidgetItem for placement in a view.
-
-
-
Constructor Detail
-
Builder
public Builder()
Constructor with parameters for the required properties ofLegendWidgetConfiguration
.
-
-
Method Detail
-
setLayout
public LegendWidgetConfiguration.Builder setLayout(Legend layout)
- Parameters:
layout
- New value for the property.
-
setSourceWidgetId
public LegendWidgetConfiguration.Builder setSourceWidgetId(java.lang.String sourceWidgetId)
Id of source widget, if any. Id should be a valid id of an existing widget. This property can be used to identify the source of the data for this legend widget.- Parameters:
sourceWidgetId
- New value for the property.
-
setLinks
public LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.Builder setSelf(SelfResourceLink self)
- Parameters:
self
- New value for the property.
-
setRevision
public LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.Builder setDescription(java.lang.String description)
Description of this resource- Parameters:
description
- New value for the property.
-
setDisplayName
public LegendWidgetConfiguration.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 LegendWidgetConfiguration.Builder setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id
- New value for the property.
-
setTags
public LegendWidgetConfiguration.Builder setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags
- New value for the property.
-
setCondition
public LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.Builder setFeatureSet(FeatureSet featureSet)
- Parameters:
featureSet
- New value for the property.
-
setFilter
public LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.Builder setFooter(Footer footer)
- Parameters:
footer
- New value for the property.
-
setIcons
public LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.Builder setLegend(Legend legend)
- Parameters:
legend
- New value for the property.
-
setPlotConfigs
public LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration.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 LegendWidgetConfiguration build()
-
-