com.vmware.esx.settings.clusters.configuration

Class ImportResult

java.lang.Object

com.vmware.esx.settings.clusters.configuration.ImportResult

All Implemented Interfaces:

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

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

This ImportResult class contains properties that describe the result of importing a configuration document in the cluster. This class was added in vSphere API 8.0.1.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImportResult.Builder Builder class for ImportResult.
static class	ImportResult.Status This enum indicates whether the configuration document was imported successfully in the cluster.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	ImportResult() Default constructor.
protected	ImportResult(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 ImportResult	_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 ImportResult	_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	getCommit() This identifier refers to the commit action of importing the desired configuration document.
java.util.List<ValidationError>	getErrors() Lists all validation errors identified in the configuration document.
ImportResult.Status	getStatus() This property was added in vSphere API 8.0.1.0.
int	hashCode()
void	setCommit(java.lang.String commit) This identifier refers to the commit action of importing the desired configuration document.
void	setErrors(java.util.List<ValidationError> errors) Lists all validation errors identified in the configuration document.
void	setStatus(ImportResult.Status status) This property was added in vSphere API 8.0.1.0.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

ImportResult

public ImportResult()

Default constructor.

ImportResult

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

Method Detail

getStatus

public ImportResult.Status getStatus()

This property was added in vSphere API 8.0.1.0.

Returns:

The current value of the property.

setStatus

public void setStatus(ImportResult.Status status)

This property was added in vSphere API 8.0.1.0.

Parameters:

status - New value for the property.

getCommit

public java.lang.String getCommit()

This identifier refers to the commit action of importing the desired configuration document. This identifier can be used in the apply API. This property was added in vSphere API 8.0.1.0. This property is optional and it is only relevant when the value of getStatus() is ImportResult.Status.OK.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

setCommit

public void setCommit(java.lang.String commit)

This identifier refers to the commit action of importing the desired configuration document. This identifier can be used in the apply API. This property was added in vSphere API 8.0.1.0. This property is optional and it is only relevant when the value of getStatus() is ImportResult.Status.OK.

Parameters:

commit - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

getErrors

public java.util.List<ValidationError> getErrors()

Lists all validation errors identified in the configuration document. This property was added in vSphere API 8.0.1.0. This is set when #success is false.

Returns:

The current value of the property.

setErrors

public void setErrors(java.util.List<ValidationError> errors)

Lists all validation errors identified in the configuration document. This property was added in vSphere API 8.0.1.0. This is set when #success is false.

Parameters:

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

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