Com::Vmware::Content::Library::Item::File::Info Class Reference

Inheritance diagram for Com::Vmware::Content::Library::Item::File::Info:

Avaliable Methods
public method	set_version ()
public method	get_cached ()
public method	set_name ()
public method	get_checksum_info ()
public method	set_size ()
public method	set_checksum_info ()
public method	set_cached ()
public method	get_version ()
public method	new ()
public method	get_name ()
public method	get_size ()

Detailed Description

The Com::Vmware::Content::Library::Item::File::Info class provides information about a file in Content Library Service storage.

A file is an actual stored object for a library item. An item will have zero files initially, but one or more can be uploaded to the item.

Member Function Documentation

public method Com::Vmware::Content::Library::Item::File::Info::get_cached

(

)

Gets the value of 'cached' property.

Return values

cached

- The current value of the field. Indicates whether the file is on disk or not. boolean#

Code:

public method Com::Vmware::Content::Library::Item::File::Info::get_checksum_info

(

)

Gets the value of 'checksum_info' property.

Return values

checksum_info

- The current value of the field. A checksum for validating the content of the file.

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

Optional#

Code:

public method Com::Vmware::Content::Library::Item::File::Info::get_name

(

)

Gets the value of 'name' property.

Return values

name	- The current value of the field. The name of the file.

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

String#

Code:

public method Com::Vmware::Content::Library::Item::File::Info::get_size

(

)

Gets the value of 'size' property.

Return values

size

- The current value of the field. 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. long#

Code:

public method Com::Vmware::Content::Library::Item::File::Info::get_version

(

)

Gets the value of 'version' property.

Return values

version

- The current value of the field. The version of this file; incremented when a new copy of the file is uploaded. String#

Code:

public method Com::Vmware::Content::Library::Item::File::Info::new

(

)

Constructor to initialize the Com::Vmware::Content::Library::Item::File::Info structure

Return values

Blessed

object

Code:

public method Com::Vmware::Content::Library::Item::File::Info::set_cached

(

)

Sets the given value for 'cached' property.

Parameters

cached

- New value for the field. Indicates whether the file is on disk or not.

Code:

public method Com::Vmware::Content::Library::Item::File::Info::set_checksum_info

(

)

Sets the given value for 'checksum_info' property.

Parameters

checksum_info

- New value for the field. A checksum for validating the content of the file.

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

Code:

public method Com::Vmware::Content::Library::Item::File::Info::set_name

(

)

Sets the given value for 'name' property.

Parameters

name	- New value for the field. The name of the file.

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

Code:

public method Com::Vmware::Content::Library::Item::File::Info::set_size

(

)

Sets the given value for 'size' property.

Parameters

size

- New value for the field. 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.

Code:

public method Com::Vmware::Content::Library::Item::File::Info::set_version

(

)

Sets the given value for 'version' property.

Parameters

version

- New value for the field. The version of this file; incremented when a new copy of the file is uploaded.

Code:

---

The documentation for this class was generated from the following file:

• Com/Vmware/Content/Library/Item/File.pm