BackupOperationStatus (Java SDK for NSX Global Policy API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class BackupOperationStatus
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Backup operation status

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BackupOperationStatus.Builder
Builder class for BackupOperationStatus.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ERROR_CODE_BACKUP_AUTHENTICATION_FAILURE`
`static java.lang.String`	`ERROR_CODE_BACKUP_BAD_FINGERPRINT`
`static java.lang.String`	`ERROR_CODE_BACKUP_GENERIC_ERROR`
`static java.lang.String`	`ERROR_CODE_BACKUP_NOT_RUN_ON_MASTER`
`static java.lang.String`	`ERROR_CODE_BACKUP_PERMISSION_ERROR`
`static java.lang.String`	`ERROR_CODE_BACKUP_SERVER_UNREACHABLE`
`static java.lang.String`	`ERROR_CODE_BACKUP_TIMEOUT`
`static java.lang.String`	`ERROR_CODE_UPGRADE_IN_PROGRESS`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`BackupOperationStatus()` Default constructor.
`protected`	`BackupOperationStatus(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 BackupOperationStatus`	`_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 BackupOperationStatus`	`_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`	`getBackupId()` Unique identifier of a backup
`java.lang.Long`	`getEndTime()` Time when operation was ended format: int64
`java.lang.String`	`getErrorCode()` Possible values are: `ERROR_CODE_BACKUP_NOT_RUN_ON_MASTER` `ERROR_CODE_BACKUP_SERVER_UNREACHABLE` `ERROR_CODE_BACKUP_AUTHENTICATION_FAILURE` `ERROR_CODE_BACKUP_PERMISSION_ERROR` `ERROR_CODE_BACKUP_TIMEOUT` `ERROR_CODE_BACKUP_BAD_FINGERPRINT` `ERROR_CODE_BACKUP_GENERIC_ERROR` `ERROR_CODE_UPGRADE_IN_PROGRESS` Error code
`java.lang.String`	`getErrorMessage()` Error code details
`java.lang.Long`	`getStartTime()` Time when operation was started format: int64
`java.lang.Boolean`	`getSuccess()` True if backup is successfully completed, else false
`int`	`hashCode()`
`void`	`setBackupId(java.lang.String backupId)` Unique identifier of a backup
`void`	`setEndTime(java.lang.Long endTime)` Time when operation was ended format: int64
`void`	`setErrorCode(java.lang.String errorCode)` Possible values are: `ERROR_CODE_BACKUP_NOT_RUN_ON_MASTER` `ERROR_CODE_BACKUP_SERVER_UNREACHABLE` `ERROR_CODE_BACKUP_AUTHENTICATION_FAILURE` `ERROR_CODE_BACKUP_PERMISSION_ERROR` `ERROR_CODE_BACKUP_TIMEOUT` `ERROR_CODE_BACKUP_BAD_FINGERPRINT` `ERROR_CODE_BACKUP_GENERIC_ERROR` `ERROR_CODE_UPGRADE_IN_PROGRESS` Error code
`void`	`setErrorMessage(java.lang.String errorMessage)` Error code details
`void`	`setStartTime(java.lang.Long startTime)` Time when operation was started format: int64
`void`	`setSuccess(java.lang.Boolean success)` True if backup is successfully completed, else false
`java.lang.String`	`toString()`

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

- Field Detail
  - ERROR_CODE_BACKUP_NOT_RUN_ON_MASTER
```
public static final java.lang.String ERROR_CODE_BACKUP_NOT_RUN_ON_MASTER
```
    See Also:
    
    Constant Field Values
  - ERROR_CODE_BACKUP_SERVER_UNREACHABLE
```
public static final java.lang.String ERROR_CODE_BACKUP_SERVER_UNREACHABLE
```
    See Also:
    
    Constant Field Values
  - ERROR_CODE_BACKUP_AUTHENTICATION_FAILURE
```
public static final java.lang.String ERROR_CODE_BACKUP_AUTHENTICATION_FAILURE
```
    See Also:
    
    Constant Field Values
  - ERROR_CODE_BACKUP_PERMISSION_ERROR
```
public static final java.lang.String ERROR_CODE_BACKUP_PERMISSION_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_CODE_BACKUP_TIMEOUT
```
public static final java.lang.String ERROR_CODE_BACKUP_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - ERROR_CODE_BACKUP_BAD_FINGERPRINT
```
public static final java.lang.String ERROR_CODE_BACKUP_BAD_FINGERPRINT
```
    See Also:
    
    Constant Field Values
  - ERROR_CODE_BACKUP_GENERIC_ERROR
```
public static final java.lang.String ERROR_CODE_BACKUP_GENERIC_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_CODE_UPGRADE_IN_PROGRESS
```
public static final java.lang.String ERROR_CODE_UPGRADE_IN_PROGRESS
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - BackupOperationStatus
```
public BackupOperationStatus()
```
    Default constructor.
  - BackupOperationStatus
```
protected BackupOperationStatus(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getBackupId
```
public java.lang.String getBackupId()
```
    Unique identifier of a backup
    
    Returns:
    
    The current value of the property.
  - setBackupId
```
public void setBackupId(java.lang.String backupId)
```
    Unique identifier of a backup
    
    Parameters:
    
    backupId - New value for the property.
  - getEndTime
```
public java.lang.Long getEndTime()
```
    Time when operation was ended format: int64
    
    Returns:
    
    The current value of the property.
  - setEndTime
```
public void setEndTime(java.lang.Long endTime)
```
    Time when operation was ended format: int64
    
    Parameters:
    
    endTime - New value for the property.
  - getErrorCode
```
public java.lang.String getErrorCode()
```
    Possible values are:
    Error code
    Returns:
    
    The current value of the property.
  - setErrorCode
```
public void setErrorCode(java.lang.String errorCode)
```
    Possible values are:
    Error code
    Parameters:
    
    errorCode - New value for the property.
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Error code details
    
    Returns:
    
    The current value of the property.
  - setErrorMessage
```
public void setErrorMessage(java.lang.String errorMessage)
```
    Error code details
    
    Parameters:
    
    errorMessage - New value for the property.
  - getStartTime
```
public java.lang.Long getStartTime()
```
    Time when operation was started format: int64
    
    Returns:
    
    The current value of the property.
  - setStartTime
```
public void setStartTime(java.lang.Long startTime)
```
    Time when operation was started format: int64
    
    Parameters:
    
    startTime - New value for the property.
  - getSuccess
```
public java.lang.Boolean getSuccess()
```
    True if backup is successfully completed, else false
    
    Returns:
    
    The current value of the property.
  - setSuccess
```
public void setSuccess(java.lang.Boolean success)
```
    True if backup is successfully completed, else false
    
    Parameters:
    
    success - 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 BackupOperationStatus _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 BackupOperationStatus _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class BackupOperationStatus

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ERROR_CODE_BACKUP_NOT_RUN_ON_MASTER

ERROR_CODE_BACKUP_SERVER_UNREACHABLE

ERROR_CODE_BACKUP_AUTHENTICATION_FAILURE

ERROR_CODE_BACKUP_PERMISSION_ERROR

ERROR_CODE_BACKUP_TIMEOUT

ERROR_CODE_BACKUP_BAD_FINGERPRINT

ERROR_CODE_BACKUP_GENERIC_ERROR

ERROR_CODE_UPGRADE_IN_PROGRESS

__dynamicStructureFields

Constructor Detail

BackupOperationStatus

BackupOperationStatus

Method Detail

getBackupId

setBackupId

getEndTime

setEndTime

getErrorCode

setErrorCode

getErrorMessage

setErrorMessage

getStartTime

setStartTime

getSuccess

setSuccess

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2