ConsolidatedRealizedStatus (NSX Policy API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx_policy.model.ConsolidatedRealizedStatus

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ConsolidatedRealizedStatus
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Consolidated Realized Status of an intent object across enforcement points.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConsolidatedRealizedStatus.Builder
Builder class for ConsolidatedRealizedStatus.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConsolidatedRealizedStatus.Builder` Builder class for `ConsolidatedRealizedStatus`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`PUBLISH_STATUS_ERROR`
`static java.lang.String`	`PUBLISH_STATUS_REALIZED`
`static java.lang.String`	`PUBLISH_STATUS_UNAVAILABLE`
`static java.lang.String`	`PUBLISH_STATUS_UNREALIZED`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ConsolidatedRealizedStatus()` Default constructor.
`protected`	`ConsolidatedRealizedStatus(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static ConsolidatedRealizedStatus`	`_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.
`static ConsolidatedRealizedStatus`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`ConsolidatedStatus`	`getConsolidatedStatus()`
`java.util.List<ConsolidatedStatusPerEnforcementPoint>`	`getConsolidatedStatusPerEnforcementPoint()` List of Consolidated Realized Status per enforcement point.
`java.lang.String`	`getIntentPath()` Intent path of object, forward slashes must be escaped using %2F.
`java.lang.String`	`getIntentVersion()` Represent highest intent version across all realized objects This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getPublishStatus()` Possible values are: `PUBLISH_STATUS_UNAVAILABLE` `PUBLISH_STATUS_UNREALIZED` `PUBLISH_STATUS_REALIZED` `PUBLISH_STATUS_ERROR` Aggregated Realization state of this object
`java.lang.Long`	`getPublishTime()` This is the time when our system detects that data has been pushed to the transport nodes.
`java.lang.String`	`getSiteUuid()` Site UUID supplied for realized site.
`java.lang.Long`	`getTimeTakenForRealization()` This is an approximate time taken for the realization of the intent to the data path.
`int`	`hashCode()`
`void`	`setConsolidatedStatus(ConsolidatedStatus consolidatedStatus)`
`void`	`setConsolidatedStatusPerEnforcementPoint(java.util.List<ConsolidatedStatusPerEnforcementPoint> consolidatedStatusPerEnforcementPoint)` List of Consolidated Realized Status per enforcement point.
`void`	`setIntentPath(java.lang.String intentPath)` Intent path of object, forward slashes must be escaped using %2F.
`void`	`setIntentVersion(java.lang.String intentVersion)` Represent highest intent version across all realized objects This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setPublishStatus(java.lang.String publishStatus)` Possible values are: `PUBLISH_STATUS_UNAVAILABLE` `PUBLISH_STATUS_UNREALIZED` `PUBLISH_STATUS_REALIZED` `PUBLISH_STATUS_ERROR` Aggregated Realization state of this object
`void`	`setPublishTime(java.lang.Long publishTime)` This is the time when our system detects that data has been pushed to the transport nodes.
`void`	`setSiteUuid(java.lang.String siteUuid)` Site UUID supplied for realized site.
`void`	`setTimeTakenForRealization(java.lang.Long timeTakenForRealization)` This is an approximate time taken for the realization of the intent to the data path.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - PUBLISH_STATUS_UNAVAILABLE
```
public static final java.lang.String PUBLISH_STATUS_UNAVAILABLE
```
    See Also:
    
    Constant Field Values
  - PUBLISH_STATUS_UNREALIZED
```
public static final java.lang.String PUBLISH_STATUS_UNREALIZED
```
    See Also:
    
    Constant Field Values
  - PUBLISH_STATUS_REALIZED
```
public static final java.lang.String PUBLISH_STATUS_REALIZED
```
    See Also:
    
    Constant Field Values
  - PUBLISH_STATUS_ERROR
```
public static final java.lang.String PUBLISH_STATUS_ERROR
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ConsolidatedRealizedStatus
```
public ConsolidatedRealizedStatus()
```
    Default constructor.
  - ConsolidatedRealizedStatus
```
protected ConsolidatedRealizedStatus(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getIntentPath
```
public java.lang.String getIntentPath()
```
    Intent path of object, forward slashes must be escaped using %2F. 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.
  - setIntentPath
```
public void setIntentPath(java.lang.String intentPath)
```
    Intent path of object, forward slashes must be escaped using %2F. 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:
    
    intentPath - New value for the property.
  - getConsolidatedStatus
```
public ConsolidatedStatus getConsolidatedStatus()
```
    Returns:
    
    The current value of the property.
  - setConsolidatedStatus
```
public void setConsolidatedStatus(ConsolidatedStatus consolidatedStatus)
```
    Parameters:
    
    consolidatedStatus - New value for the property.
  - getConsolidatedStatusPerEnforcementPoint
```
public java.util.List<ConsolidatedStatusPerEnforcementPoint> getConsolidatedStatusPerEnforcementPoint()
```
    List of Consolidated Realized Status per enforcement point. 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.
  - setConsolidatedStatusPerEnforcementPoint
```
public void setConsolidatedStatusPerEnforcementPoint(java.util.List<ConsolidatedStatusPerEnforcementPoint> consolidatedStatusPerEnforcementPoint)
```
    List of Consolidated Realized Status per enforcement point. 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:
    
    consolidatedStatusPerEnforcementPoint - New value for the property.
  - getIntentVersion
```
public java.lang.String getIntentVersion()
```
    Represent highest intent version across all realized objects 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.
  - setIntentVersion
```
public void setIntentVersion(java.lang.String intentVersion)
```
    Represent highest intent version across all realized objects 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:
    
    intentVersion - New value for the property.
  - getPublishStatus
```
public java.lang.String getPublishStatus()
```
    Possible values are:
    Aggregated Realization state of this object
    Returns:
    
    The current value of the property.
  - setPublishStatus
```
public void setPublishStatus(java.lang.String publishStatus)
```
    Possible values are:
    Aggregated Realization state of this object
    Parameters:
    
    publishStatus - New value for the property.
  - getPublishTime
```
public java.lang.Long getPublishTime()
```
    This is the time when our system detects that data has been pushed to the transport nodes. This is based on a poll mechanism and hence this is not the accurate time when the intent was published at the data path. The value of -1 indicates that either the publishing is still in progress or the runtime status is UNKNOWN and hence not available. The Runtime status can be UNKNOWN if one or more hosts are down and the rules could not be sent to those hosts. When the host comes up, the runtime status will change to SUCCESS but the publish_time will show the value of the last realization time. Any new configuration change after this will start reflecting the proper value for publish_time 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.
  - setPublishTime
```
public void setPublishTime(java.lang.Long publishTime)
```
    This is the time when our system detects that data has been pushed to the transport nodes. This is based on a poll mechanism and hence this is not the accurate time when the intent was published at the data path. The value of -1 indicates that either the publishing is still in progress or the runtime status is UNKNOWN and hence not available. The Runtime status can be UNKNOWN if one or more hosts are down and the rules could not be sent to those hosts. When the host comes up, the runtime status will change to SUCCESS but the publish_time will show the value of the last realization time. Any new configuration change after this will start reflecting the proper value for publish_time 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:
    
    publishTime - New value for the property.
  - getSiteUuid
```
public java.lang.String getSiteUuid()
```
    Site UUID supplied for realized site.
    
    Returns:
    
    The current value of the property.
  - setSiteUuid
```
public void setSiteUuid(java.lang.String siteUuid)
```
    Site UUID supplied for realized site.
    
    Parameters:
    
    siteUuid - New value for the property.
  - getTimeTakenForRealization
```
public java.lang.Long getTimeTakenForRealization()
```
    This is an approximate time taken for the realization of the intent to the data path. The actual time taken could be lesser than what is reported here. The value of -1 indicates that either the publishing is still in progress or the runtime status is UNKNOWN and hence not available. The Runtime status can be UNKNOWN if one or more hosts are down and the rules could not be sent to those hosts. When the host comes up, the runtime status will change to SUCCESS but the time taken for realization will show the value of the last realization time. Any new configuration change after this will start reflecting the proper value for time_taken_for_realization. format: int64
    
    Returns:
    
    The current value of the property.
  - setTimeTakenForRealization
```
public void setTimeTakenForRealization(java.lang.Long timeTakenForRealization)
```
    This is an approximate time taken for the realization of the intent to the data path. The actual time taken could be lesser than what is reported here. The value of -1 indicates that either the publishing is still in progress or the runtime status is UNKNOWN and hence not available. The Runtime status can be UNKNOWN if one or more hosts are down and the rules could not be sent to those hosts. When the host comes up, the runtime status will change to SUCCESS but the time taken for realization will show the value of the last realization time. Any new configuration change after this will start reflecting the proper value for time_taken_for_realization. format: int64
    
    Parameters:
    
    timeTakenForRealization - 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 ConsolidatedRealizedStatus _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 ConsolidatedRealizedStatus _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ConsolidatedRealizedStatus

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PUBLISH_STATUS_UNAVAILABLE

PUBLISH_STATUS_UNREALIZED

PUBLISH_STATUS_REALIZED

PUBLISH_STATUS_ERROR

__dynamicStructureFields

Constructor Detail

ConsolidatedRealizedStatus

ConsolidatedRealizedStatus

Method Detail

getIntentPath

setIntentPath

getConsolidatedStatus

setConsolidatedStatus

getConsolidatedStatusPerEnforcementPoint

setConsolidatedStatusPerEnforcementPoint

getIntentVersion

setIntentVersion

getPublishStatus

setPublishStatus

getPublishTime

setPublishTime

getSiteUuid

setSiteUuid

getTimeTakenForRealization

setTimeTakenForRealization

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2