Package com.vmware.nsx_policy.model

Class WidgetConfiguration

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class WidgetConfiguration
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Describes the configuration of a widget to be displayed on the dashboard. WidgetConfiguration is a base type that provides attributes of a widget in-general.
    See Also:
    Serialized Form

    • Field Detail

      • _TYPE_IDENTIFIER

        public static final java.lang.String _TYPE_IDENTIFIER
        Identifier denoting this class, when it is used in polymorphic context.

        This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.

        See Also:
        Constant Field Values

      • RESOURCE_TYPE_LABELVALUECONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_LABELVALUECONFIGURATION
        See Also:
        Constant Field Values

      • RESOURCE_TYPE_DONUTCONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_DONUTCONFIGURATION
        See Also:
        Constant Field Values

      • RESOURCE_TYPE_MULTIWIDGETCONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_MULTIWIDGETCONFIGURATION
        See Also:
        Constant Field Values

      • RESOURCE_TYPE_CONTAINERCONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_CONTAINERCONFIGURATION
        See Also:
        Constant Field Values

      • RESOURCE_TYPE_STATSCONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_STATSCONFIGURATION
        See Also:
        Constant Field Values

      • RESOURCE_TYPE_GRIDCONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_GRIDCONFIGURATION
        See Also:
        Constant Field Values

      • RESOURCE_TYPE_GRAPHCONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_GRAPHCONFIGURATION
        See Also:
        Constant Field Values

      • RESOURCE_TYPE_CUSTOMWIDGETCONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_CUSTOMWIDGETCONFIGURATION
        See Also:
        Constant Field Values

      • RESOURCE_TYPE_CUSTOMFILTERWIDGETCONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_CUSTOMFILTERWIDGETCONFIGURATION
        See Also:
        Constant Field Values

      • RESOURCE_TYPE_TIMERANGEDROPDOWNFILTERWIDGETCONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_TIMERANGEDROPDOWNFILTERWIDGETCONFIGURATION
        See Also:
        Constant Field Values

      • RESOURCE_TYPE_DROPDOWNFILTERWIDGETCONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_DROPDOWNFILTERWIDGETCONFIGURATION
        See Also:
        Constant Field Values

      • RESOURCE_TYPE_SPACERWIDGETCONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_SPACERWIDGETCONFIGURATION
        See Also:
        Constant Field Values

      • RESOURCE_TYPE_LEGENDWIDGETCONFIGURATION

        public static final java.lang.String RESOURCE_TYPE_LEGENDWIDGETCONFIGURATION
        See Also:
        Constant Field Values

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields

    • Constructor Detail

      • WidgetConfiguration

        public WidgetConfiguration()
        Default constructor.

      • WidgetConfiguration

        protected WidgetConfiguration​(com.vmware.vapi.data.StructValue __dynamicStructureFields)

    • Method Detail

      • getLinks

        public java.util.List<ResourceLink> getLinks()
        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.
        Returns:
        The current value of the property.

      • setLinks

        public void 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.

      • getSchema

        public java.lang.String getSchema()
        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.
        Returns:
        The current value of the property.

      • setSchema

        public void 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.

      • getSelf

        public SelfResourceLink getSelf()
        Returns:
        The current value of the property.

      • setSelf

        public void setSelf​(SelfResourceLink self)
        Parameters:
        self - New value for the property.

      • getRevision

        public java.lang.Long getRevision()
        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
        Returns:
        The current value of the property.

      • setRevision

        public void 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.

      • getCreateTime

        public java.lang.Long getCreateTime()
        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.
        Returns:
        The current value of the property.

      • setCreateTime

        public void 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.

      • getCreateUser

        public java.lang.String getCreateUser()
        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.
        Returns:
        The current value of the property.

      • setCreateUser

        public void 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.

      • getLastModifiedTime

        public java.lang.Long getLastModifiedTime()
        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.
        Returns:
        The current value of the property.

      • setLastModifiedTime

        public void 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.

      • getLastModifiedUser

        public java.lang.String getLastModifiedUser()
        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.
        Returns:
        The current value of the property.

      • setLastModifiedUser

        public void 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.

      • getProtection

        public java.lang.String getProtection()
        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.
        Returns:
        The current value of the property.

      • setProtection

        public void 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.

      • getSystemOwned

        public java.lang.Boolean getSystemOwned()
        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.
        Returns:
        The current value of the property.

      • setSystemOwned

        public void 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.

      • getDescription

        public java.lang.String getDescription()
        Description of this resource
        Returns:
        The current value of the property.

      • setDescription

        public void setDescription​(java.lang.String description)
        Description of this resource
        Parameters:
        description - New value for the property.

      • getDisplayName

        public java.lang.String getDisplayName()
        Title of the widget. If display_name is omitted, the widget will be shown without a title.
        Returns:
        The current value of the property.

      • setDisplayName

        public void 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.

      • getId

        public java.lang.String getId()
        Unique identifier of this resource
        Returns:
        The current value of the property.

      • setId

        public void setId​(java.lang.String id)
        Unique identifier of this resource
        Parameters:
        id - New value for the property.

      • getTags

        public java.util.List<Tag> getTags()
        Opaque identifiers meaningful to the API user
        Returns:
        The current value of the property.

      • setTags

        public void setTags​(java.util.List<Tag> tags)
        Opaque identifiers meaningful to the API user
        Parameters:
        tags - New value for the property.

      • getCondition

        public java.lang.String getCondition()
        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.
        Returns:
        The current value of the property.

      • setCondition

        public void 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.

      • getDatasources

        public java.util.List<Datasource> getDatasources()
        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.
        Returns:
        The current value of the property.

      • setDatasources

        public void 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.

      • getDefaultFilterValue

        public java.util.List<DefaultFilterValue> getDefaultFilterValue()
        Default filter values to be passed to datasources. This will be used when the report is requested without filter values.
        Returns:
        The current value of the property.

      • setDefaultFilterValue

        public void 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.

      • getDrilldownId

        public java.lang.String getDrilldownId()
        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.
        Returns:
        The current value of the property.

      • setDrilldownId

        public void 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.

      • getFeatureSet

        public FeatureSet getFeatureSet()
        Returns:
        The current value of the property.

      • setFeatureSet

        public void setFeatureSet​(FeatureSet featureSet)
        Parameters:
        featureSet - New value for the property.

      • getFilter

        @Deprecated
public java.lang.String getFilter()
        Deprecated.
        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.
        Returns:
        The current value of the property.

      • setFilter

        @Deprecated
public void setFilter​(java.lang.String filter)
        Deprecated.
        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.

      • getFilterValueRequired

        public java.lang.Boolean getFilterValueRequired()
        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.
        Returns:
        The current value of the property.

      • setFilterValueRequired

        public void 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.

      • getFilters

        public java.util.List<java.lang.String> getFilters()
        A List of filter applied to this widget configuration. This will be used to identify the filters applied to this widget.
        Returns:
        The current value of the property.

      • setFilters

        public void 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.

      • getFooter

        public Footer getFooter()
        Returns:
        The current value of the property.

      • setFooter

        public void setFooter​(Footer footer)
        Parameters:
        footer - New value for the property.

      • getIcons

        public java.util.List<Icon> getIcons()
        Icons to be applied at dashboard for widgets and UI elements.
        Returns:
        The current value of the property.

      • setIcons

        public void setIcons​(java.util.List<Icon> icons)
        Icons to be applied at dashboard for widgets and UI elements.
        Parameters:
        icons - New value for the property.

      • getIsDrilldown

        public java.lang.Boolean getIsDrilldown()
        Set to true if this widget should be used as a drilldown.
        Returns:
        The current value of the property.

      • setIsDrilldown

        public void setIsDrilldown​(java.lang.Boolean isDrilldown)
        Set to true if this widget should be used as a drilldown.
        Parameters:
        isDrilldown - New value for the property.

      • getLegend

        public Legend getLegend()
        Returns:
        The current value of the property.

      • setLegend

        public void setLegend​(Legend legend)
        Parameters:
        legend - New value for the property.

      • getPlotConfigs

        public java.util.List<WidgetPlotConfiguration> getPlotConfigs()
        List of plotting configuration for a given widget. Widget plotting configurations which are common across all the widgets types should be define here.
        Returns:
        The current value of the property.

      • setPlotConfigs

        public void 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.

      • getRowspan

        public java.lang.Long getRowspan()
        Represents the vertical span of the widget / container. 1 Row span is equal to 20px. format: int32
        Returns:
        The current value of the property.

      • setRowspan

        public void 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.

      • getShared

        @Deprecated
public java.lang.Boolean getShared()
        Deprecated.
        Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.
        Returns:
        The current value of the property.

      • setShared

        @Deprecated
public void setShared​(java.lang.Boolean shared)
        Deprecated.
        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.

      • getShowHeader

        public java.lang.Boolean getShowHeader()
        If the value of this field is set to true then card header will be displayed otherwise only card will be displayed without header.
        Returns:
        The current value of the property.

      • setShowHeader

        public void 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.

      • getSpan

        public java.lang.Long getSpan()
        Represents the horizontal span of the widget / container. format: int32
        Returns:
        The current value of the property.

      • setSpan

        public void setSpan​(java.lang.Long span)
        Represents the horizontal span of the widget / container. format: int32
        Parameters:
        span - New value for the property.

      • getWeight

        @Deprecated
public java.lang.Long getWeight()
        Deprecated.
        Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32
        Returns:
        The current value of the property.

      • setWeight

        @Deprecated
public void setWeight​(java.lang.Long weight)
        Deprecated.
        Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32
        Parameters:
        weight - New value for the property.

      • _getType

        public com.vmware.vapi.bindings.type.StructType _getType()
        Specified by:
        _getType in interface com.vmware.vapi.bindings.StaticStructure

      • _getDataValue

        public com.vmware.vapi.data.StructValue _getDataValue()
        Specified by:
        _getDataValue in interface com.vmware.vapi.bindings.Structure

      • _updateDataValue

        protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)

      • _validate

        public void _validate()
        Specified by:
        _validate in interface com.vmware.vapi.bindings.StaticStructure

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface com.vmware.vapi.bindings.StaticStructure
        Overrides:
        toString in class java.lang.Object

      • _hasTypeNameOf

        public boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
        Specified by:
        _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

      • _convertTo

        public <T extends com.vmware.vapi.bindings.Structure> T _convertTo​(java.lang.Class<T> clazz)
        Specified by:
        _convertTo in interface com.vmware.vapi.bindings.Structure

      • _setDynamicField

        public void _setDynamicField​(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
        Specified by:
        _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

      • _getDynamicField

        public com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)
        Specified by:
        _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

      • _getDynamicFieldNames

        public java.util.Set<java.lang.String> _getDynamicFieldNames()
        Specified by:
        _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

      • _getClassType

        public static com.vmware.vapi.bindings.type.StructType _getClassType()
        WARNING: Internal method, subject to change in future versions.
        Returns:
        StructType instance representing the static bindings type for this Structure.

      • _getCanonicalName

        public java.lang.String _getCanonicalName()
        Specified by:
        _getCanonicalName in interface com.vmware.vapi.bindings.Structure

      • _getCanonicalTypeName

        public static java.lang.String _getCanonicalTypeName()
        Returns the canonical type name. See _getCanonicalName().
        Returns:
        canonical type name

      • _newInstance

        public static WidgetConfiguration _newInstance​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Returns new instance of this binding class and injects the provided data value.
        WARNING: The returned object is not fully initialized.
        Parameters:
        structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
        Returns:
        the static bindings StructType

      • _newInstance2

        public static WidgetConfiguration _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.