com.vmware.nsx.model

Class CustomWidgetConfiguration.Builder

java.lang.Object

com.vmware.nsx.model.CustomWidgetConfiguration.Builder

Enclosing class:

CustomWidgetConfiguration

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

Builder class for CustomWidgetConfiguration.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CustomWidgetConfiguration	build()
CustomWidgetConfiguration.Builder	setCondition(java.lang.String condition) If the condition is met then the widget will be displayed to UI.
CustomWidgetConfiguration.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.
CustomWidgetConfiguration.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.
CustomWidgetConfiguration.Builder	setDatasources(java.util.List<Datasource> datasources) The 'datasources' represent the sources from which data will be fetched.
CustomWidgetConfiguration.Builder	setDefaultFilterValue(java.util.List<DefaultFilterValue> defaultFilterValue) Default filter values to be passed to datasources.
CustomWidgetConfiguration.Builder	setDescription(java.lang.String description) Description of this resource
CustomWidgetConfiguration.Builder	setDisplayName(java.lang.String displayName) Title of the widget.
CustomWidgetConfiguration.Builder	setDrilldownId(java.lang.String drilldownId) Id of drilldown widget, if any.
CustomWidgetConfiguration.Builder	setFeatureSet(FeatureSet featureSet)
CustomWidgetConfiguration.Builder	setFilter(java.lang.String filter) Id of filter widget for subscription, if any.
CustomWidgetConfiguration.Builder	setFilters(java.util.List<java.lang.String> filters) A List of filter applied to this widget configuration.
CustomWidgetConfiguration.Builder	setFilterValueRequired(java.lang.Boolean filterValueRequired) Flag to indicate that widget will continue to work without filter value.
CustomWidgetConfiguration.Builder	setFooter(Footer footer)
CustomWidgetConfiguration.Builder	setIcons(java.util.List<Icon> icons) Icons to be applied at dashboard for widgets and UI elements.
CustomWidgetConfiguration.Builder	setId(java.lang.String id) Unique identifier of this resource
CustomWidgetConfiguration.Builder	setIsDrilldown(java.lang.Boolean isDrilldown) Set to true if this widget should be used as a drilldown.
CustomWidgetConfiguration.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.
CustomWidgetConfiguration.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.
CustomWidgetConfiguration.Builder	setLegend(Legend legend)
CustomWidgetConfiguration.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
CustomWidgetConfiguration.Builder	setPlotConfigs(java.util.List<WidgetPlotConfiguration> plotConfigs) List of plotting configuration for a given widget.
CustomWidgetConfiguration.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.
CustomWidgetConfiguration.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
CustomWidgetConfiguration.Builder	setRowspan(java.lang.Long rowspan) Represents the vertical span of the widget / container.
CustomWidgetConfiguration.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.
CustomWidgetConfiguration.Builder	setSelf(SelfResourceLink self)
CustomWidgetConfiguration.Builder	setShared(java.lang.Boolean shared) Please use the property 'shared' of View instead of this.
CustomWidgetConfiguration.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.
CustomWidgetConfiguration.Builder	setSpan(java.lang.Long span) Represents the horizontal span of the widget / container.
CustomWidgetConfiguration.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.
CustomWidgetConfiguration.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
CustomWidgetConfiguration.Builder	setUiComponentIdentifier(java.lang.String uiComponentIdentifier) User defined component selector to be rendered inside view/container.
CustomWidgetConfiguration.Builder	setWeight(java.lang.Long weight) Specify relavite weight in WidgetItem for placement in a view.

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 CustomWidgetConfiguration.

Method Detail

setUiComponentIdentifier

public CustomWidgetConfiguration.Builder setUiComponentIdentifier(java.lang.String uiComponentIdentifier)

User defined component selector to be rendered inside view/container.

Parameters:

uiComponentIdentifier - New value for the property.

setLinks

public CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

public CustomWidgetConfiguration.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 CustomWidgetConfiguration.Builder setId(java.lang.String id)

Unique identifier of this resource

Parameters:

id - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setCondition

public CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.Builder setFeatureSet(FeatureSet featureSet)

Parameters:

featureSet - New value for the property.

setFilter

public CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.Builder setFooter(Footer footer)

Parameters:

footer - New value for the property.

setIcons

public CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.Builder setLegend(Legend legend)

Parameters:

legend - New value for the property.

setPlotConfigs

public CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration.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 CustomWidgetConfiguration build()