com.vmware.content.library.item.updatesession

Class PreviewInfo

java.lang.Object

com.vmware.content.library.item.updatesession.PreviewInfo

All Implemented Interfaces:

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

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

The PreviewInfo class contains information about the files being uploaded in the update session. This class was added in vSphere API 6.8.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PreviewInfo.Builder Builder class for PreviewInfo.
static class	PreviewInfo.State The State enumeration class defines the state of the update session's preview.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	PreviewInfo() Default constructor.
protected	PreviewInfo(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 PreviewInfo	_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 PreviewInfo	_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.util.List<java.lang.String>	getCertChain() Certificate chain in base64 format.
CertificateInfo	getCertificateInfo() The certificate information of the signed update session content.
PreviewInfo.State	getState() Indicates the state of the preview of the update session.
java.util.List<PreviewWarningInfo>	getWarnings() The list of warnings raised for this update session.
int	hashCode()
void	setCertChain(java.util.List<java.lang.String> certChain) Certificate chain in base64 format.
void	setCertificateInfo(CertificateInfo certificateInfo) The certificate information of the signed update session content.
void	setState(PreviewInfo.State state) Indicates the state of the preview of the update session.
void	setWarnings(java.util.List<PreviewWarningInfo> warnings) The list of warnings raised for this update session.
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

PreviewInfo

public PreviewInfo()

Default constructor.

PreviewInfo

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

Method Detail

getState

public PreviewInfo.State getState()

Indicates the state of the preview of the update session. This property was added in vSphere API 6.8.

Returns:

The current value of the property.

setState

public void setState(PreviewInfo.State state)

Indicates the state of the preview of the update session. This property was added in vSphere API 6.8.

Parameters:

state - New value for the property.

getCertificateInfo

public CertificateInfo getCertificateInfo()

The certificate information of the signed update session content. This property was added in vSphere API 6.8. This property is null if the update session content is not signed.

Returns:

The current value of the property.

setCertificateInfo

public void setCertificateInfo(CertificateInfo certificateInfo)

The certificate information of the signed update session content. This property was added in vSphere API 6.8. This property is null if the update session content is not signed.

Parameters:

certificateInfo - New value for the property.

getWarnings

public java.util.List<PreviewWarningInfo> getWarnings()

The list of warnings raised for this update session. Any warning which is not ignored by the client will, by default, fail the update session during session complete operation. This property was added in vSphere API 6.8. This property is optional and it is only relevant when the value of getState() is PreviewInfo.State.AVAILABLE.

Returns:

The current value of the property.

setWarnings

public void setWarnings(java.util.List<PreviewWarningInfo> warnings)

The list of warnings raised for this update session. Any warning which is not ignored by the client will, by default, fail the update session during session complete operation. This property was added in vSphere API 6.8. This property is optional and it is only relevant when the value of getState() is PreviewInfo.State.AVAILABLE.

Parameters:

warnings - New value for the property.

getCertChain

public java.util.List<java.lang.String> getCertChain()

Certificate chain in base64 format. This property was added in vSphere API 7.0.3.0. This property is null if the update session content is not signed.

Returns:

The current value of the property.

setCertChain

public void setCertChain(java.util.List<java.lang.String> certChain)

Certificate chain in base64 format. This property was added in vSphere API 7.0.3.0. This property is null if the update session content is not signed.

Parameters:

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

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