com.vmware.content.library.item.downloadsession

Class FileTypes.Info

java.lang.Object

com.vmware.content.library.item.downloadsession.FileTypes.Info

All Implemented Interfaces:

StaticStructure, Structure, Serializable

Enclosing interface:

FileTypes

public static final class FileTypes.Info
extends Object
implements Serializable, StaticStructure

The Info class defines the downloaded file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileTypes.Info.Builder Builder class for FileTypes.Info.

Constructor Summary

Constructors

Constructor and Description
FileTypes.Info() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Structure> T	_convertTo(Class<T> clazz) Converts this structure into an instance of the provided class structure if possible.
String	_getCanonicalName() Returns the canonical name of the structure.
static String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal API, subject to change in future versions.
StructValue	_getDataValue() Returns this Structure represented in the dynamic DataValue model.
DataValue	_getDynamicField(String fieldName) Get dynamic filed value.
Set<String>	_getDynamicFieldNames() Get the names of the dynamic fields in the structure.
com.vmware.vapi.bindings.type.StructType	_getType() WARNING: Internal API, subject to change in future versions.
boolean	_hasTypeNameOf(Class<? extends Structure> clazz) Checks that the runtime type name matches the type name from the binding class.
static FileTypes.Info	_newInstance(StructValue structValue) WARNING: Internal API, 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.
void	_setDynamicField(String fieldName, DataValue fieldValue) Sets a dynamic field value.
void	_validate() Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
boolean	equals(Object obj)
long	getBytesTransferred() The number of bytes that have been transferred by the server so far for making this file prepared for download.
FileTypes.ChecksumInfo	getChecksumInfo() The checksum information of the file.
TransferEndpoint	getDownloadEndpoint() Endpoint at which the file is available for download.
LocalizableMessage	getErrorMessage() Error message for a failed preparation when the prepare status is FileTypes.PrepareStatus.ERROR.
String	getName() The name of the file.
Long	getSize() The file size, in bytes.
FileTypes.PrepareStatus	getStatus() The preparation status (UNPREPARED, PREPARE_REQUESTED, PREPARING, PREPARED, ERROR) of the file.
int	hashCode()
void	setBytesTransferred(long bytesTransferred) The number of bytes that have been transferred by the server so far for making this file prepared for download.
void	setChecksumInfo(FileTypes.ChecksumInfo checksumInfo) The checksum information of the file.
void	setDownloadEndpoint(TransferEndpoint downloadEndpoint) Endpoint at which the file is available for download.
void	setErrorMessage(LocalizableMessage errorMessage) Error message for a failed preparation when the prepare status is FileTypes.PrepareStatus.ERROR.
void	setName(String name) The name of the file.
void	setSize(Long size) The file size, in bytes.
void	setStatus(FileTypes.PrepareStatus status) The preparation status (UNPREPARED, PREPARE_REQUESTED, PREPARING, PREPARED, ERROR) of the file.
String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FileTypes.Info

public FileTypes.Info()

Default constructor.

Method Detail

getName

public String getName()

The name of the file.

Returns:

The current value of the property.

setName

public void setName(String name)

The name of the file.

Parameters:

name - New value for the property.

getSize

public Long getSize()

The file size, in bytes. This property may not be available immediately. It is guaranteed to be set when the client finishes downloading the file.

Returns:

The current value of the property.

setSize

public void setSize(Long size)

The file size, in bytes. This property may not be available immediately. It is guaranteed to be set when the client finishes downloading the file.

Parameters:

size - New value for the property.

getBytesTransferred

public long getBytesTransferred()

The number of bytes that have been transferred by the server so far for making this file prepared for download. This value may stay at zero till the client starts downloading the file.

Returns:

The current value of the property.

setBytesTransferred

public void setBytesTransferred(long bytesTransferred)

The number of bytes that have been transferred by the server so far for making this file prepared for download. This value may stay at zero till the client starts downloading the file.

Parameters:

bytesTransferred - New value for the property.

getStatus

public FileTypes.PrepareStatus getStatus()

The preparation status (UNPREPARED, PREPARE_REQUESTED, PREPARING, PREPARED, ERROR) of the file.

Returns:

The current value of the property.

setStatus

public void setStatus(FileTypes.PrepareStatus status)

The preparation status (UNPREPARED, PREPARE_REQUESTED, PREPARING, PREPARED, ERROR) of the file.

Parameters:

status - New value for the property.

getDownloadEndpoint

public TransferEndpoint getDownloadEndpoint()

Endpoint at which the file is available for download. The value is valid only when the getStatus() is FileTypes.PrepareStatus.PREPARED. This property won't be set until the file status is FileTypes.PrepareStatus.PREPARED.

Returns:

The current value of the property.

setDownloadEndpoint

public void setDownloadEndpoint(TransferEndpoint downloadEndpoint)

Endpoint at which the file is available for download. The value is valid only when the getStatus() is FileTypes.PrepareStatus.PREPARED. This property won't be set until the file status is FileTypes.PrepareStatus.PREPARED.

Parameters:

downloadEndpoint - New value for the property.

getChecksumInfo

public FileTypes.ChecksumInfo getChecksumInfo()

The checksum information of the file. When the download is complete, you can retrieve the checksum from the File.get(java.lang.String, java.lang.String) method to verify the checksum for the downloaded file. The checksum is always calculated for the downloaded file, but this property won't be set until the download is complete.

Returns:

The current value of the property.

setChecksumInfo

public void setChecksumInfo(FileTypes.ChecksumInfo checksumInfo)

The checksum information of the file. When the download is complete, you can retrieve the checksum from the File.get(java.lang.String, java.lang.String) method to verify the checksum for the downloaded file. The checksum is always calculated for the downloaded file, but this property won't be set until the download is complete.

Parameters:

checksumInfo - New value for the property.

getErrorMessage

public LocalizableMessage getErrorMessage()

Error message for a failed preparation when the prepare status is FileTypes.PrepareStatus.ERROR. This property won't be set unless there was an error with the file transfer.

Returns:

The current value of the property.

setErrorMessage

public void setErrorMessage(LocalizableMessage errorMessage)

Error message for a failed preparation when the prepare status is FileTypes.PrepareStatus.ERROR. This property won't be set unless there was an error with the file transfer.

Parameters:

errorMessage - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Description copied from interface: StaticStructure

WARNING: Internal API, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.

Specified by:

_getType in interface StaticStructure

Returns:

the static bindings StructType

_getDataValue

public StructValue _getDataValue()

Description copied from interface: Structure

Returns this Structure represented in the dynamic DataValue model.

Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.

Specified by:

_getDataValue in interface Structure

Returns:

StructValue representing this structure

_validate

public void _validate()

Description copied from interface: StaticStructure

Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.

More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:

all fields of the union required for that value of the discriminant are set fields of the union that are not allowed for that value of the discriminant are not set any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:

_validate in interface StaticStructure

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.

In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf

public boolean _hasTypeNameOf(Class<? extends Structure> clazz)

Description copied from interface: Structure

Checks that the runtime type name matches the type name from the binding class.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

true if this structures type name matches exactly the provided class type name.

_convertTo

public <T extends Structure> T _convertTo(Class<T> clazz)

Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField

public void _setDynamicField(String fieldName,
                    DataValue fieldValue)

Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField

public DataValue _getDynamicField(String fieldName)

Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames

public Set<String> _getDynamicFieldNames()

Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_getClassType

public static com.vmware.vapi.bindings.type.StructType _getClassType()

WARNING: Internal API, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public String _getCanonicalName()

Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName

public static String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static FileTypes.Info _newInstance(StructValue structValue)

WARNING: Internal API, 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