com.vmware.vcenter.tagging

Class AssociationsTypes.LastIterationStatus

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<AssociationsTypes.LastIterationStatus>

com.vmware.vcenter.tagging.AssociationsTypes.LastIterationStatus

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

AssociationsTypes

public static final class AssociationsTypes.LastIterationStatus
extends ApiEnumeration<AssociationsTypes.LastIterationStatus>

The last status for the iterator. A field of this type is returned as part of the result and indicates to the caller of the API whether it can continue to make requests for more data.

The last status only reports on the state of the iteration at the time data was last returned. As a result, it not does guarantee if the next call will succeed in getting more data or not.

Failures to retrieve results will be returned as Error responses. These last statuses are only returned when the iterator is operating as expected.

. This enumeration was added in vSphere API 7.0.0.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssociationsTypes.LastIterationStatus.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static AssociationsTypes.LastIterationStatus	END_OF_DATA Iterator has finished iterating through its inventory.
static AssociationsTypes.LastIterationStatus	READY Iterator has more data pending and is ready to provide it.

Method Summary

Modifier and Type	Method and Description
AssociationsTypes.LastIterationStatus.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static AssociationsTypes.LastIterationStatus	valueOf(java.lang.String name) Returns the enumeration constant for the specified name.
static AssociationsTypes.LastIterationStatus[]	values() Retrieve all enumeration constants pre-defined by this enumeration class.

Methods inherited from class com.vmware.vapi.bindings.ApiEnumeration

buildNameMap, equals, hashCode, name, toString

Methods inherited from class java.lang.Object

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

Field Detail

READY

public static final AssociationsTypes.LastIterationStatus READY

Iterator has more data pending and is ready to provide it. The caller can request the next page of data at any time.

The number of results returned may be less than the usual size. In other words, the iterator may not fill the page. The iterator has returned at least 1 result.

. This constant field was added in vSphere API 7.0.0.

END_OF_DATA

public static final AssociationsTypes.LastIterationStatus END_OF_DATA

Iterator has finished iterating through its inventory. There are currently no more entities to return and the caller can terminate iteration. If the iterator returned some data, the marker may be set to allow the iterator to continue from where it left off when additional data does become available. This value is used to indicate that all available data has been returned by the iterator. This constant field was added in vSphere API 7.0.0.

Method Detail

values

public static AssociationsTypes.LastIterationStatus[] values()

Retrieve all enumeration constants pre-defined by this enumeration class.

Additional instances might exist at runtime, for example to represent a new constant added to this enumeration class in subsequent version of the API. Such new constant is represented as instance of AssociationsTypes.LastIterationStatus but is not pre-defined.

Returns:

Array of all pre-defined enumeration constants. Never null.

valueOf

public static AssociationsTypes.LastIterationStatus valueOf(java.lang.String name)

Returns the enumeration constant for the specified name.

If the name matches exactly the identifier used to declare an enumeration constant from this enumeration class, the constant in question will be returned.

Otherwise, a new instance of AssociationsTypes.LastIterationStatus will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the AssociationsTypes.LastIterationStatus.Values._UNKNOWN enum constant from the native Java enum.

Parameters:

name - The name of the constant to return. Must not be null.

Returns:

Enumeration constant for the specified name. Never null.

isUnknown

public boolean isUnknown()

Checks if this enumeration constant is unknown. Unknown is a constant that is not one of the pre-defined ones for this enumeration class. Also see valueOf(java.lang.String) and values().

Returns:

true if this constant is unknown, and false otherwise.

getEnumValue

public AssociationsTypes.LastIterationStatus.Values getEnumValue()

Returns a native Java enum constant representing this enumeration constant. The result is useful for usual handling of Java enum, for example it can be used in switch statements.

If this enumeration constant is unknown, then AssociationsTypes.LastIterationStatus.Values._UNKNOWN enum constant is returned.

The native Java enum is AssociationsTypes.LastIterationStatus.Values.

Returns:

The Java enum constant. Never null.