com.vmware.content.library.item

Class StorageTypes.Info

java.lang.Object

com.vmware.content.library.item.StorageTypes.Info

All Implemented Interfaces:

StaticStructure, Structure, Serializable

Enclosing interface:

StorageTypes

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

The Info class is the expanded form of FileTypes.Info that includes details about the storage backing for a file in a library item.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
StorageTypes.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 StorageTypes.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)
boolean	getCached() Indicates whether the file is on disk or not.
FileTypes.ChecksumInfo	getChecksumInfo() A checksum for validating the content of the file.
String	getName() The name of the file.
long	getSize() The file size, in bytes.
StorageBacking	getStorageBacking() The storage backing on which this object resides.
List<URI>	getStorageUris() URIs that identify the file on the storage backing.
String	getVersion() The version of this file; incremented when a new copy of the file is uploaded.
int	hashCode()
void	setCached(boolean cached) Indicates whether the file is on disk or not.
void	setChecksumInfo(FileTypes.ChecksumInfo checksumInfo) A checksum for validating the content of the file.
void	setName(String name) The name of the file.
void	setSize(long size) The file size, in bytes.
void	setStorageBacking(StorageBacking storageBacking) The storage backing on which this object resides.
void	setStorageUris(List<URI> storageUris) URIs that identify the file on the storage backing.
void	setVersion(String version) The version of this file; incremented when a new copy of the file is uploaded.
String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StorageTypes.Info

public StorageTypes.Info()

Default constructor.

Method Detail

getStorageBacking

public StorageBacking getStorageBacking()

The storage backing on which this object resides.

Returns:

The current value of the property.

setStorageBacking

public void setStorageBacking(StorageBacking storageBacking)

The storage backing on which this object resides.

Parameters:

storageBacking - New value for the property.

getStorageUris

public List<URI> getStorageUris()

URIs that identify the file on the storage backing.

These URIs may be specific to the backing and may need interpretation by the client. A client that understands a URI scheme in this list may use that URI to directly access the file on the storage backing. This can provide high-performance support for file manipulation.

Returns:

The current value of the property.

setStorageUris

public void setStorageUris(List<URI> storageUris)

URIs that identify the file on the storage backing.

These URIs may be specific to the backing and may need interpretation by the client. A client that understands a URI scheme in this list may use that URI to directly access the file on the storage backing. This can provide high-performance support for file manipulation.

Parameters:

storageUris - New value for the property.

getChecksumInfo

public FileTypes.ChecksumInfo getChecksumInfo()

A checksum for validating the content of the file.

This value can be used to verify that a transfer was completed without errors.

A checksum cannot always be calculated, and the value will be null if the file does not have content.

Returns:

The current value of the property.

setChecksumInfo

public void setChecksumInfo(FileTypes.ChecksumInfo checksumInfo)

A checksum for validating the content of the file.

This value can be used to verify that a transfer was completed without errors.

A checksum cannot always be calculated, and the value will be null if the file does not have content.

Parameters:

checksumInfo - New value for the property.

getName

public String getName()

The name of the file.

This value will be unique within the library item for each file. It cannot be an empty string.

Returns:

The current value of the property.

setName

public void setName(String name)

The name of the file.

This value will be unique within the library item for each file. It cannot be an empty string.

Parameters:

name - New value for the property.

getSize

public long getSize()

The file size, in bytes. The file size is the storage used and not the uploaded or provisioned size. For example, when uploading a disk to a datastore, the amount of storage that the disk consumes may be different from the disk file size. When the file is not cached, the size is 0.

Returns:

The current value of the property.

setSize

public void setSize(long size)

The file size, in bytes. The file size is the storage used and not the uploaded or provisioned size. For example, when uploading a disk to a datastore, the amount of storage that the disk consumes may be different from the disk file size. When the file is not cached, the size is 0.

Parameters:

size - New value for the property.

getCached

public boolean getCached()

Indicates whether the file is on disk or not.

Returns:

The current value of the property.

setCached

public void setCached(boolean cached)

Indicates whether the file is on disk or not.

Parameters:

cached - New value for the property.

getVersion

public String getVersion()

The version of this file; incremented when a new copy of the file is uploaded.

Returns:

The current value of the property.

setVersion

public void setVersion(String version)

The version of this file; incremented when a new copy of the file is uploaded.

Parameters:

version - 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 StorageTypes.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