OdsRunbookInvocationReport (NSX Policy API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class OdsRunbookInvocationReport
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The report of the invocation of an Online Diagnostic System runbook.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OdsRunbookInvocationReport.Builder
Builder class for OdsRunbookInvocationReport.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`INVALID_REASON_CANCELLED`
`static java.lang.String`	`INVALID_REASON_INTERNAL_ERROR`
`static java.lang.String`	`INVALID_REASON_TIMEOUT`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`OdsRunbookInvocationReport()` Default constructor.
`protected`	`OdsRunbookInvocationReport(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 OdsRunbookInvocationReport`	`_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 OdsRunbookInvocationReport`	`_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`	`getErrorDetail()` The error detail of the invalid report.
`java.lang.String`	`getInvalidReason()` Possible values are: `INVALID_REASON_TIMEOUT` `INVALID_REASON_CANCELLED` `INVALID_REASON_INTERNAL_ERROR` The reason why this report is invalid.
`java.lang.String`	`getInvocationId()` The universally unique identifier for invocation of an Online Diagnostic System runbook.
`java.lang.Long`	`getRecommendationCode()` Online Diagnostic System recommendation code of the runbook invocation.
`java.lang.String`	`getRecommendationMessage()` Online Diagnostic System recommendation message of the runbook invocation.
`java.lang.Long`	`getResultCode()` Online Diagnostic System result code of the runbook invocation.
`java.lang.String`	`getResultMessage()` Online Diagnostic System result message of the runbook invocation.
`OdsRunbookInvocationStatus`	`getStatus()`
`java.util.List<OdsRunbookInvocationStepInfo>`	`getStepDetails()` Details of performed steps in the invocation of an Online Diagnostic System runbook.
`OdsRunbookSysInfo`	`getSysInfo()`
`java.lang.String`	`getTargetNode()` Identifier of an appliance node or transport node where the execution of an Online Diagnostic System runbook happens.
`java.lang.Long`	`getTimestamp()` The timestamp when the report of an Online Diagnostic System runbook is generated in milliseconds epoch.
`int`	`hashCode()`
`void`	`setErrorDetail(java.lang.String errorDetail)` The error detail of the invalid report.
`void`	`setInvalidReason(java.lang.String invalidReason)` Possible values are: `INVALID_REASON_TIMEOUT` `INVALID_REASON_CANCELLED` `INVALID_REASON_INTERNAL_ERROR` The reason why this report is invalid.
`void`	`setInvocationId(java.lang.String invocationId)` The universally unique identifier for invocation of an Online Diagnostic System runbook.
`void`	`setRecommendationCode(java.lang.Long recommendationCode)` Online Diagnostic System recommendation code of the runbook invocation.
`void`	`setRecommendationMessage(java.lang.String recommendationMessage)` Online Diagnostic System recommendation message of the runbook invocation.
`void`	`setResultCode(java.lang.Long resultCode)` Online Diagnostic System result code of the runbook invocation.
`void`	`setResultMessage(java.lang.String resultMessage)` Online Diagnostic System result message of the runbook invocation.
`void`	`setStatus(OdsRunbookInvocationStatus status)`
`void`	`setStepDetails(java.util.List<OdsRunbookInvocationStepInfo> stepDetails)` Details of performed steps in the invocation of an Online Diagnostic System runbook.
`void`	`setSysInfo(OdsRunbookSysInfo sysInfo)`
`void`	`setTargetNode(java.lang.String targetNode)` Identifier of an appliance node or transport node where the execution of an Online Diagnostic System runbook happens.
`void`	`setTimestamp(java.lang.Long timestamp)` The timestamp when the report of an Online Diagnostic System runbook is generated in milliseconds epoch.
`java.lang.String`	`toString()`

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

- Field Detail
  - INVALID_REASON_TIMEOUT
```
public static final java.lang.String INVALID_REASON_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - INVALID_REASON_CANCELLED
```
public static final java.lang.String INVALID_REASON_CANCELLED
```
    See Also:
    
    Constant Field Values
  - INVALID_REASON_INTERNAL_ERROR
```
public static final java.lang.String INVALID_REASON_INTERNAL_ERROR
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - OdsRunbookInvocationReport
```
public OdsRunbookInvocationReport()
```
    Default constructor.
  - OdsRunbookInvocationReport
```
protected OdsRunbookInvocationReport(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getErrorDetail
```
public java.lang.String getErrorDetail()
```
    The error detail of the invalid report. 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.
  - setErrorDetail
```
public void setErrorDetail(java.lang.String errorDetail)
```
    The error detail of the invalid report. 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:
    
    errorDetail - New value for the property.
  - getInvalidReason
```
public java.lang.String getInvalidReason()
```
    Possible values are:
    The reason why this report is invalid. TIMEOUT - The invocation is timeout. CANCELLED - The invocation is cancelled. INTERNAL_ERROR - The invocation ends up with error. 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.
  - setInvalidReason
```
public void setInvalidReason(java.lang.String invalidReason)
```
    Possible values are:
    The reason why this report is invalid. TIMEOUT - The invocation is timeout. CANCELLED - The invocation is cancelled. INTERNAL_ERROR - The invocation ends up with error. 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:
    
    invalidReason - New value for the property.
  - getInvocationId
```
public java.lang.String getInvocationId()
```
    The universally unique identifier for invocation of an Online Diagnostic System runbook. 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.
  - setInvocationId
```
public void setInvocationId(java.lang.String invocationId)
```
    The universally unique identifier for invocation of an Online Diagnostic System runbook. 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:
    
    invocationId - New value for the property.
  - getRecommendationCode
```
public java.lang.Long getRecommendationCode()
```
    Online Diagnostic System recommendation code of the runbook invocation. 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.
  - setRecommendationCode
```
public void setRecommendationCode(java.lang.Long recommendationCode)
```
    Online Diagnostic System recommendation code of the runbook invocation. 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:
    
    recommendationCode - New value for the property.
  - getRecommendationMessage
```
public java.lang.String getRecommendationMessage()
```
    Online Diagnostic System recommendation message of the runbook invocation. 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.
  - setRecommendationMessage
```
public void setRecommendationMessage(java.lang.String recommendationMessage)
```
    Online Diagnostic System recommendation message of the runbook invocation. 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:
    
    recommendationMessage - New value for the property.
  - getResultCode
```
public java.lang.Long getResultCode()
```
    Online Diagnostic System result code of the runbook invocation. 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.
  - setResultCode
```
public void setResultCode(java.lang.Long resultCode)
```
    Online Diagnostic System result code of the runbook invocation. 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:
    
    resultCode - New value for the property.
  - getResultMessage
```
public java.lang.String getResultMessage()
```
    Online Diagnostic System result message of the runbook invocation. 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.
  - setResultMessage
```
public void setResultMessage(java.lang.String resultMessage)
```
    Online Diagnostic System result message of the runbook invocation. 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:
    
    resultMessage - New value for the property.
  - getStatus
```
public OdsRunbookInvocationStatus getStatus()
```
    Returns:
    
    The current value of the property.
  - setStatus
```
public void setStatus(OdsRunbookInvocationStatus status)
```
    Parameters:
    
    status - New value for the property.
  - getStepDetails
```
public java.util.List<OdsRunbookInvocationStepInfo> getStepDetails()
```
    Details of performed steps in the invocation of an Online Diagnostic System runbook. 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.
  - setStepDetails
```
public void setStepDetails(java.util.List<OdsRunbookInvocationStepInfo> stepDetails)
```
    Details of performed steps in the invocation of an Online Diagnostic System runbook. 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:
    
    stepDetails - New value for the property.
  - getSysInfo
```
public OdsRunbookSysInfo getSysInfo()
```
    Returns:
    
    The current value of the property.
  - setSysInfo
```
public void setSysInfo(OdsRunbookSysInfo sysInfo)
```
    Parameters:
    
    sysInfo - New value for the property.
  - getTargetNode
```
public java.lang.String getTargetNode()
```
    Identifier of an appliance node or transport node where the execution of an Online Diagnostic System runbook happens. 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.
  - setTargetNode
```
public void setTargetNode(java.lang.String targetNode)
```
    Identifier of an appliance node or transport node where the execution of an Online Diagnostic System runbook happens. 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:
    
    targetNode - New value for the property.
  - getTimestamp
```
public java.lang.Long getTimestamp()
```
    The timestamp when the report of an Online Diagnostic System runbook is generated in milliseconds epoch. 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.
  - setTimestamp
```
public void setTimestamp(java.lang.Long timestamp)
```
    The timestamp when the report of an Online Diagnostic System runbook is generated in milliseconds epoch. 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:
    
    timestamp - 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 OdsRunbookInvocationReport _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 OdsRunbookInvocationReport _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class OdsRunbookInvocationReport

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INVALID_REASON_TIMEOUT

INVALID_REASON_CANCELLED

INVALID_REASON_INTERNAL_ERROR

__dynamicStructureFields

Constructor Detail

OdsRunbookInvocationReport

OdsRunbookInvocationReport

Method Detail

getErrorDetail

setErrorDetail

getInvalidReason

setInvalidReason

getInvocationId

setInvocationId

getRecommendationCode

setRecommendationCode

getRecommendationMessage

setRecommendationMessage

getResultCode

setResultCode

getResultMessage

setResultMessage

getStatus

setStatus

getStepDetails

setStepDetails

getSysInfo

setSysInfo

getTargetNode

setTargetNode

getTimestamp

setTimestamp

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2