com.vmware.nsx_policy.model

Class OdsRunbookInvocationStatus

java.lang.Object

com.vmware.nsx_policy.model.OdsRunbookInvocationStatus

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class OdsRunbookInvocationStatus
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The runtime status 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	OdsRunbookInvocationStatus.Builder Builder class for OdsRunbookInvocationStatus.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields
static java.lang.String	OPERATION_STATE_ABORTED
static java.lang.String	OPERATION_STATE_ARG_INVALID
static java.lang.String	OPERATION_STATE_BUSY_REJECTED
static java.lang.String	OPERATION_STATE_FINISHED
static java.lang.String	OPERATION_STATE_GENERAL_ERROR
static java.lang.String	OPERATION_STATE_NONE
static java.lang.String	OPERATION_STATE_QUEUED
static java.lang.String	OPERATION_STATE_RUNBOOK_NOT_ENABLED
static java.lang.String	OPERATION_STATE_RUNBOOK_NOT_FOUND
static java.lang.String	OPERATION_STATE_RUNNING
static java.lang.String	OPERATION_STATE_THROTTLED
static java.lang.String	REQUEST_STATUS_CONNECTION_ERROR
static java.lang.String	REQUEST_STATUS_SUCCESS
static java.lang.String	REQUEST_STATUS_TIMEOUT

Constructor Summary

Constructors

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

Method Summary

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 OdsRunbookInvocationStatus	_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 OdsRunbookInvocationStatus	_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	getOperationState() Possible values are: OPERATION_STATE_NONE OPERATION_STATE_RUNBOOK_NOT_FOUND OPERATION_STATE_QUEUED OPERATION_STATE_BUSY_REJECTED OPERATION_STATE_THROTTLED OPERATION_STATE_ARG_INVALID OPERATION_STATE_RUNNING OPERATION_STATE_FINISHED OPERATION_STATE_GENERAL_ERROR OPERATION_STATE_RUNBOOK_NOT_ENABLED OPERATION_STATE_ABORTED Operation state of an invocation of an Online Diagnostic System runbook on its target node.
java.lang.String	getRequestStatus() Possible values are: REQUEST_STATUS_SUCCESS REQUEST_STATUS_CONNECTION_ERROR REQUEST_STATUS_TIMEOUT Request status of an invocation of an Online Diagnostic System runbook.
int	hashCode()
void	setOperationState(java.lang.String operationState) Possible values are: OPERATION_STATE_NONE OPERATION_STATE_RUNBOOK_NOT_FOUND OPERATION_STATE_QUEUED OPERATION_STATE_BUSY_REJECTED OPERATION_STATE_THROTTLED OPERATION_STATE_ARG_INVALID OPERATION_STATE_RUNNING OPERATION_STATE_FINISHED OPERATION_STATE_GENERAL_ERROR OPERATION_STATE_RUNBOOK_NOT_ENABLED OPERATION_STATE_ABORTED Operation state of an invocation of an Online Diagnostic System runbook on its target node.
void	setRequestStatus(java.lang.String requestStatus) Possible values are: REQUEST_STATUS_SUCCESS REQUEST_STATUS_CONNECTION_ERROR REQUEST_STATUS_TIMEOUT Request status of an invocation of an Online Diagnostic System runbook.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

OPERATION_STATE_NONE

public static final java.lang.String OPERATION_STATE_NONE

See Also:

Constant Field Values

OPERATION_STATE_RUNBOOK_NOT_FOUND

public static final java.lang.String OPERATION_STATE_RUNBOOK_NOT_FOUND

See Also:

Constant Field Values

OPERATION_STATE_QUEUED

public static final java.lang.String OPERATION_STATE_QUEUED

See Also:

Constant Field Values

OPERATION_STATE_BUSY_REJECTED

public static final java.lang.String OPERATION_STATE_BUSY_REJECTED

See Also:

Constant Field Values

OPERATION_STATE_THROTTLED

public static final java.lang.String OPERATION_STATE_THROTTLED

See Also:

Constant Field Values

OPERATION_STATE_ARG_INVALID

public static final java.lang.String OPERATION_STATE_ARG_INVALID

See Also:

Constant Field Values

OPERATION_STATE_RUNNING

public static final java.lang.String OPERATION_STATE_RUNNING

See Also:

Constant Field Values

OPERATION_STATE_FINISHED

public static final java.lang.String OPERATION_STATE_FINISHED

See Also:

Constant Field Values

OPERATION_STATE_GENERAL_ERROR

public static final java.lang.String OPERATION_STATE_GENERAL_ERROR

See Also:

Constant Field Values

OPERATION_STATE_RUNBOOK_NOT_ENABLED

public static final java.lang.String OPERATION_STATE_RUNBOOK_NOT_ENABLED

See Also:

Constant Field Values

OPERATION_STATE_ABORTED

public static final java.lang.String OPERATION_STATE_ABORTED

See Also:

Constant Field Values

REQUEST_STATUS_SUCCESS

public static final java.lang.String REQUEST_STATUS_SUCCESS

See Also:

Constant Field Values

REQUEST_STATUS_CONNECTION_ERROR

public static final java.lang.String REQUEST_STATUS_CONNECTION_ERROR

See Also:

Constant Field Values

REQUEST_STATUS_TIMEOUT

public static final java.lang.String REQUEST_STATUS_TIMEOUT

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

OdsRunbookInvocationStatus

public OdsRunbookInvocationStatus()

Default constructor.

OdsRunbookInvocationStatus

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

Method Detail

getOperationState

public java.lang.String getOperationState()

Possible values are:

• OPERATION_STATE_NONE
• OPERATION_STATE_RUNBOOK_NOT_FOUND
• OPERATION_STATE_QUEUED
• OPERATION_STATE_BUSY_REJECTED
• OPERATION_STATE_THROTTLED
• OPERATION_STATE_ARG_INVALID
• OPERATION_STATE_RUNNING
• OPERATION_STATE_FINISHED
• OPERATION_STATE_GENERAL_ERROR
• OPERATION_STATE_RUNBOOK_NOT_ENABLED
• OPERATION_STATE_ABORTED

Operation state of an invocation of an Online Diagnostic System runbook on its target node. NONE - No operation state is available. RUNBOOK_NOT_FOUND - The specified runbook does not exist on the target. QUEUED - The runbook invocation is queued to be scheduled. BUSY_REJECTED - The runbook invocation is rejected because the runbook runner on the target node is busy. THROTTLED - The runbook invocation is rejected by throttling check. ARG_INVALID - The runbook invocation is rejected by argument validation. RUNNING - The runbook invocation is running. FINISHED - The runbook invocation is finished. GENERAL_ERROR - Runbook invocation fails with some internal errors. RUNBOOK_NOT_ENABLED - The specified runbook is not enabled on the target. ABORTED - The runbook invocation is cancelled. 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.

setOperationState

public void setOperationState(java.lang.String operationState)

Possible values are:

• OPERATION_STATE_NONE
• OPERATION_STATE_RUNBOOK_NOT_FOUND
• OPERATION_STATE_QUEUED
• OPERATION_STATE_BUSY_REJECTED
• OPERATION_STATE_THROTTLED
• OPERATION_STATE_ARG_INVALID
• OPERATION_STATE_RUNNING
• OPERATION_STATE_FINISHED
• OPERATION_STATE_GENERAL_ERROR
• OPERATION_STATE_RUNBOOK_NOT_ENABLED
• OPERATION_STATE_ABORTED

Operation state of an invocation of an Online Diagnostic System runbook on its target node. NONE - No operation state is available. RUNBOOK_NOT_FOUND - The specified runbook does not exist on the target. QUEUED - The runbook invocation is queued to be scheduled. BUSY_REJECTED - The runbook invocation is rejected because the runbook runner on the target node is busy. THROTTLED - The runbook invocation is rejected by throttling check. ARG_INVALID - The runbook invocation is rejected by argument validation. RUNNING - The runbook invocation is running. FINISHED - The runbook invocation is finished. GENERAL_ERROR - Runbook invocation fails with some internal errors. RUNBOOK_NOT_ENABLED - The specified runbook is not enabled on the target. ABORTED - The runbook invocation is cancelled. 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:

operationState - New value for the property.

getRequestStatus

public java.lang.String getRequestStatus()

Possible values are:

• REQUEST_STATUS_SUCCESS
• REQUEST_STATUS_CONNECTION_ERROR
• REQUEST_STATUS_TIMEOUT

Request status of an invocation of an Online Diagnostic System runbook. SUCCESS - The runbook invocation request is acknowledged by the target. CONNECTION_ERROR - The runbook invocation request cannot be dispatched to the target because the messaging channel is broken. TIMEOUT - The runbook invocation request was acknowledged by the target, but it did not report operational state of the terminating class to NSX in time. 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.

setRequestStatus

public void setRequestStatus(java.lang.String requestStatus)

Possible values are:

• REQUEST_STATUS_SUCCESS
• REQUEST_STATUS_CONNECTION_ERROR
• REQUEST_STATUS_TIMEOUT

Request status of an invocation of an Online Diagnostic System runbook. SUCCESS - The runbook invocation request is acknowledged by the target. CONNECTION_ERROR - The runbook invocation request cannot be dispatched to the target because the messaging channel is broken. TIMEOUT - The runbook invocation request was acknowledged by the target, but it did not report operational state of the terminating class to NSX in time. 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:

requestStatus - 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 OdsRunbookInvocationStatus _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 OdsRunbookInvocationStatus _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.