BackupUiFramesInfo (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.BackupUiFramesInfo

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class BackupUiFramesInfo
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BackupUiFramesInfo.Builder
Builder class for BackupUiFramesInfo.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ACTIVE_GM_ACTIVE`
`static java.lang.String`	`ACTIVE_GM_INVALID`
`static java.lang.String`	`ACTIVE_GM_NONE`
`static java.lang.String`	`ACTIVE_GM_STANDBY`
`static java.lang.String`	`API_ENDPOINT_GLOBAL_MANAGER`
`static java.lang.String`	`API_ENDPOINT_ICA`
`static java.lang.String`	`API_ENDPOINT_NSXAPI`
`static java.lang.String`	`FRAME_TYPE_GLOBAL_MANAGER`
`static java.lang.String`	`FRAME_TYPE_LOCAL_LOCAL_MANAGER`
`static java.lang.String`	`FRAME_TYPE_LOCAL_MANAGER`
`static java.lang.String`	`FRAME_TYPE_NSX_INTELLIGENCE`

Constructor Summary

Constructors
Modifier Constructor and Description

BackupUiFramesInfo()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`BackupUiFramesInfo()` Default constructor.
`protected`	`BackupUiFramesInfo(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 BackupUiFramesInfo`	`_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 BackupUiFramesInfo`	`_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`	`getActiveGm()` Possible values are: `ACTIVE_GM_ACTIVE` `ACTIVE_GM_STANDBY` `ACTIVE_GM_NONE` `ACTIVE_GM_INVALID` Does site have active GM 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`	`getApiEndpoint()` Possible values are: `API_ENDPOINT_GLOBAL_MANAGER` `API_ENDPOINT_NSXAPI` `API_ENDPOINT_ICA` prefix to be used for api call 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`	`getFrameType()` Possible values are: `FRAME_TYPE_GLOBAL_MANAGER` `FRAME_TYPE_LOCAL_MANAGER` `FRAME_TYPE_LOCAL_LOCAL_MANAGER` `FRAME_TYPE_NSX_INTELLIGENCE` Type of service, for which backup is handled 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`	`getSiteId()` Id of the site 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`	`getSiteVersion()` Version of the site This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`int`	`hashCode()`
`void`	`setActiveGm(java.lang.String activeGm)` Possible values are: `ACTIVE_GM_ACTIVE` `ACTIVE_GM_STANDBY` `ACTIVE_GM_NONE` `ACTIVE_GM_INVALID` Does site have active GM 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`	`setApiEndpoint(java.lang.String apiEndpoint)` Possible values are: `API_ENDPOINT_GLOBAL_MANAGER` `API_ENDPOINT_NSXAPI` `API_ENDPOINT_ICA` prefix to be used for api call 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`	`setFrameType(java.lang.String frameType)` Possible values are: `FRAME_TYPE_GLOBAL_MANAGER` `FRAME_TYPE_LOCAL_MANAGER` `FRAME_TYPE_LOCAL_LOCAL_MANAGER` `FRAME_TYPE_NSX_INTELLIGENCE` Type of service, for which backup is handled 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`	`setSiteId(java.lang.String siteId)` Id of the site 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`	`setSiteVersion(java.lang.String siteVersion)` Version of the site 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`	`toString()`

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

- Field Detail
  - ACTIVE_GM_ACTIVE
```
public static final java.lang.String ACTIVE_GM_ACTIVE
```
    See Also:
    
    Constant Field Values
  - ACTIVE_GM_STANDBY
```
public static final java.lang.String ACTIVE_GM_STANDBY
```
    See Also:
    
    Constant Field Values
  - ACTIVE_GM_NONE
```
public static final java.lang.String ACTIVE_GM_NONE
```
    See Also:
    
    Constant Field Values
  - ACTIVE_GM_INVALID
```
public static final java.lang.String ACTIVE_GM_INVALID
```
    See Also:
    
    Constant Field Values
  - API_ENDPOINT_GLOBAL_MANAGER
```
public static final java.lang.String API_ENDPOINT_GLOBAL_MANAGER
```
    See Also:
    
    Constant Field Values
  - API_ENDPOINT_NSXAPI
```
public static final java.lang.String API_ENDPOINT_NSXAPI
```
    See Also:
    
    Constant Field Values
  - API_ENDPOINT_ICA
```
public static final java.lang.String API_ENDPOINT_ICA
```
    See Also:
    
    Constant Field Values
  - FRAME_TYPE_GLOBAL_MANAGER
```
public static final java.lang.String FRAME_TYPE_GLOBAL_MANAGER
```
    See Also:
    
    Constant Field Values
  - FRAME_TYPE_LOCAL_MANAGER
```
public static final java.lang.String FRAME_TYPE_LOCAL_MANAGER
```
    See Also:
    
    Constant Field Values
  - FRAME_TYPE_LOCAL_LOCAL_MANAGER
```
public static final java.lang.String FRAME_TYPE_LOCAL_LOCAL_MANAGER
```
    See Also:
    
    Constant Field Values
  - FRAME_TYPE_NSX_INTELLIGENCE
```
public static final java.lang.String FRAME_TYPE_NSX_INTELLIGENCE
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - BackupUiFramesInfo
```
public BackupUiFramesInfo()
```
    Default constructor.
  - BackupUiFramesInfo
```
protected BackupUiFramesInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getActiveGm
```
public java.lang.String getActiveGm()
```
    Possible values are:
    Does site have active GM 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.
  - setActiveGm
```
public void setActiveGm(java.lang.String activeGm)
```
    Possible values are:
    Does site have active GM 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:
    
    activeGm - New value for the property.
  - getApiEndpoint
```
public java.lang.String getApiEndpoint()
```
    Possible values are:
    prefix to be used for api call 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.
  - setApiEndpoint
```
public void setApiEndpoint(java.lang.String apiEndpoint)
```
    Possible values are:
    prefix to be used for api call 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:
    
    apiEndpoint - New value for the property.
  - getFrameType
```
public java.lang.String getFrameType()
```
    Possible values are:
    Type of service, for which backup is handled 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.
  - setFrameType
```
public void setFrameType(java.lang.String frameType)
```
    Possible values are:
    Type of service, for which backup is handled 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:
    
    frameType - New value for the property.
  - getSiteId
```
public java.lang.String getSiteId()
```
    Id of the site 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.
  - setSiteId
```
public void setSiteId(java.lang.String siteId)
```
    Id of the site 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:
    
    siteId - New value for the property.
  - getSiteVersion
```
public java.lang.String getSiteVersion()
```
    Version of the site 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.
  - setSiteVersion
```
public void setSiteVersion(java.lang.String siteVersion)
```
    Version of the site 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:
    
    siteVersion - 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 BackupUiFramesInfo _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 BackupUiFramesInfo _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class BackupUiFramesInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTIVE_GM_ACTIVE

ACTIVE_GM_STANDBY

ACTIVE_GM_NONE

ACTIVE_GM_INVALID

API_ENDPOINT_GLOBAL_MANAGER

API_ENDPOINT_NSXAPI

API_ENDPOINT_ICA

FRAME_TYPE_GLOBAL_MANAGER

FRAME_TYPE_LOCAL_MANAGER

FRAME_TYPE_LOCAL_LOCAL_MANAGER

FRAME_TYPE_NSX_INTELLIGENCE

__dynamicStructureFields

Constructor Detail

BackupUiFramesInfo

BackupUiFramesInfo

Method Detail

getActiveGm

setActiveGm

getApiEndpoint

setApiEndpoint

getFrameType

setFrameType

getSiteId

setSiteId

getSiteVersion

setSiteVersion

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2