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