GmOperationalState (Java SDK for NSX Global Policy API 4.1.0.2.0)

java.lang.Object
- com.vmware.nsx_global_policy.model.GmOperationalState

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class GmOperationalState
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Represents the switchover operational state of Global Manager. Offers information about the current switchover operation including status from each Global Manager node and the errors if any.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GmOperationalState.Builder
Builder class for GmOperationalState.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`CONSOLIDATED_PROGRESS_COMPLETED`
`static java.lang.String`	`CONSOLIDATED_PROGRESS_FAILED`
`static java.lang.String`	`CONSOLIDATED_PROGRESS_IN_PROGRESS`
`static java.lang.String`	`STATUS_ACTIVE`
`static java.lang.String`	`STATUS_DECOMMISSIONED`
`static java.lang.String`	`STATUS_NONE`
`static java.lang.String`	`STATUS_STANDBY`
`static java.lang.String`	`STATUS_SWITCHING_TO_ACTIVE`
`static java.lang.String`	`STATUS_SWITCHING_TO_STANDBY`

Constructor Summary

Constructors
Modifier Constructor and Description

GmOperationalState()
Default constructor.

protected GmOperationalState(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`GmOperationalState()` Default constructor.
`protected`	`GmOperationalState(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 GmOperationalState`	`_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 GmOperationalState`	`_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)`
`java.lang.String`	`getConsolidatedProgress()` Possible values are: `CONSOLIDATED_PROGRESS_IN_PROGRESS` `CONSOLIDATED_PROGRESS_COMPLETED` `CONSOLIDATED_PROGRESS_FAILED` Consolidated status of the current operation
`java.lang.Long`	`getEndTime()` End time of the switchover operation format: int64
`java.util.List<java.lang.String>`	`getErrors()` Errors if any
`java.util.List<GmNodeStatus>`	`getNodeStatuses()` Switchover status from each NSX Global Manager appliance node
`java.lang.Long`	`getSiteManagerRef()` Timestamp reference for the change provided by SiteManager format: int64
`java.lang.Long`	`getStartTime()` Start time of the switchover operation format: int64
`java.lang.String`	`getStatus()` Possible values are: `STATUS_NONE` `STATUS_ACTIVE` `STATUS_STANDBY` `STATUS_SWITCHING_TO_ACTIVE` `STATUS_SWITCHING_TO_STANDBY` `STATUS_DECOMMISSIONED` The current switchover operation requested.
`java.util.List<java.lang.String>`	`getWarnings()` Errors if any
`int`	`hashCode()`
`void`	`setConsolidatedProgress(java.lang.String consolidatedProgress)` Possible values are: `CONSOLIDATED_PROGRESS_IN_PROGRESS` `CONSOLIDATED_PROGRESS_COMPLETED` `CONSOLIDATED_PROGRESS_FAILED` Consolidated status of the current operation
`void`	`setEndTime(java.lang.Long endTime)` End time of the switchover operation format: int64
`void`	`setErrors(java.util.List<java.lang.String> errors)` Errors if any
`void`	`setNodeStatuses(java.util.List<GmNodeStatus> nodeStatuses)` Switchover status from each NSX Global Manager appliance node
`void`	`setSiteManagerRef(java.lang.Long siteManagerRef)` Timestamp reference for the change provided by SiteManager format: int64
`void`	`setStartTime(java.lang.Long startTime)` Start time of the switchover operation format: int64
`void`	`setStatus(java.lang.String status)` Possible values are: `STATUS_NONE` `STATUS_ACTIVE` `STATUS_STANDBY` `STATUS_SWITCHING_TO_ACTIVE` `STATUS_SWITCHING_TO_STANDBY` `STATUS_DECOMMISSIONED` The current switchover operation requested.
`void`	`setWarnings(java.util.List<java.lang.String> warnings)` Errors if any
`java.lang.String`	`toString()`

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

- Field Detail
  - CONSOLIDATED_PROGRESS_IN_PROGRESS
```
public static final java.lang.String CONSOLIDATED_PROGRESS_IN_PROGRESS
```
    See Also:
    
    Constant Field Values
  - CONSOLIDATED_PROGRESS_COMPLETED
```
public static final java.lang.String CONSOLIDATED_PROGRESS_COMPLETED
```
    See Also:
    
    Constant Field Values
  - CONSOLIDATED_PROGRESS_FAILED
```
public static final java.lang.String CONSOLIDATED_PROGRESS_FAILED
```
    See Also:
    
    Constant Field Values
  - STATUS_NONE
```
public static final java.lang.String STATUS_NONE
```
    See Also:
    
    Constant Field Values
  - STATUS_ACTIVE
```
public static final java.lang.String STATUS_ACTIVE
```
    See Also:
    
    Constant Field Values
  - STATUS_STANDBY
```
public static final java.lang.String STATUS_STANDBY
```
    See Also:
    
    Constant Field Values
  - STATUS_SWITCHING_TO_ACTIVE
```
public static final java.lang.String STATUS_SWITCHING_TO_ACTIVE
```
    See Also:
    
    Constant Field Values
  - STATUS_SWITCHING_TO_STANDBY
```
public static final java.lang.String STATUS_SWITCHING_TO_STANDBY
```
    See Also:
    
    Constant Field Values
  - STATUS_DECOMMISSIONED
```
public static final java.lang.String STATUS_DECOMMISSIONED
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - GmOperationalState
```
public GmOperationalState()
```
    Default constructor.
  - GmOperationalState
```
protected GmOperationalState(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getConsolidatedProgress
```
public java.lang.String getConsolidatedProgress()
```
    Possible values are:
    Consolidated status of the current operation
    Returns:
    
    The current value of the property.
  - setConsolidatedProgress
```
public void setConsolidatedProgress(java.lang.String consolidatedProgress)
```
    Possible values are:
    Consolidated status of the current operation
    Parameters:
    
    consolidatedProgress - New value for the property.
  - getEndTime
```
public java.lang.Long getEndTime()
```
    End time of the switchover operation format: int64
    
    Returns:
    
    The current value of the property.
  - setEndTime
```
public void setEndTime(java.lang.Long endTime)
```
    End time of the switchover operation format: int64
    
    Parameters:
    
    endTime - New value for the property.
  - getErrors
```
public java.util.List<java.lang.String> getErrors()
```
    Errors if any
    
    Returns:
    
    The current value of the property.
  - setErrors
```
public void setErrors(java.util.List<java.lang.String> errors)
```
    Errors if any
    
    Parameters:
    
    errors - New value for the property.
  - getNodeStatuses
```
public java.util.List<GmNodeStatus> getNodeStatuses()
```
    Switchover status from each NSX Global Manager appliance node
    
    Returns:
    
    The current value of the property.
  - setNodeStatuses
```
public void setNodeStatuses(java.util.List<GmNodeStatus> nodeStatuses)
```
    Switchover status from each NSX Global Manager appliance node
    
    Parameters:
    
    nodeStatuses - New value for the property.
  - getSiteManagerRef
```
public java.lang.Long getSiteManagerRef()
```
    Timestamp reference for the change provided by SiteManager format: int64
    
    Returns:
    
    The current value of the property.
  - setSiteManagerRef
```
public void setSiteManagerRef(java.lang.Long siteManagerRef)
```
    Timestamp reference for the change provided by SiteManager format: int64
    
    Parameters:
    
    siteManagerRef - New value for the property.
  - getStartTime
```
public java.lang.Long getStartTime()
```
    Start time of the switchover operation format: int64
    
    Returns:
    
    The current value of the property.
  - setStartTime
```
public void setStartTime(java.lang.Long startTime)
```
    Start time of the switchover operation format: int64
    
    Parameters:
    
    startTime - New value for the property.
  - getStatus
```
public java.lang.String getStatus()
```
    Possible values are:
    The current switchover operation requested.
    Returns:
    
    The current value of the property.
  - setStatus
```
public void setStatus(java.lang.String status)
```
    Possible values are:
    The current switchover operation requested.
    Parameters:
    
    status - New value for the property.
  - getWarnings
```
public java.util.List<java.lang.String> getWarnings()
```
    Errors if any
    
    Returns:
    
    The current value of the property.
  - setWarnings
```
public void setWarnings(java.util.List<java.lang.String> warnings)
```
    Errors if any
    
    Parameters:
    
    warnings - 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 GmOperationalState _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 GmOperationalState _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class GmOperationalState

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONSOLIDATED_PROGRESS_IN_PROGRESS

CONSOLIDATED_PROGRESS_COMPLETED

CONSOLIDATED_PROGRESS_FAILED

STATUS_NONE

STATUS_ACTIVE

STATUS_STANDBY

STATUS_SWITCHING_TO_ACTIVE

STATUS_SWITCHING_TO_STANDBY

STATUS_DECOMMISSIONED

__dynamicStructureFields

Constructor Detail

GmOperationalState

GmOperationalState

Method Detail

getConsolidatedProgress

setConsolidatedProgress

getEndTime

setEndTime

getErrors

setErrors

getNodeStatuses

setNodeStatuses

getSiteManagerRef

setSiteManagerRef

getStartTime

setStartTime

getStatus

setStatus

getWarnings

setWarnings

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2