VmGuestFilesystemFilesListResult

The Files.ListResult structure describes the results of a Files.list operation.


Properties

files Required

A list of Files.Summary structures containing information for all the matching files.


status Required

The last status for the iterator that indicates whether any more results can be expected if the caller continues to make requests for more data using the iterator.

Possible values are: READYEND_OF_DATA


integer
total Required

The total number of results from the Files.list. This is a hint to the user of the iterator regarding how many items are available to be retrieved. The total could change if the inventory of items are being changed.


integer
end_index Optional

Positional index into the logical item list of the last item returned in the list of results. The first item in the logical item list has an index of 0. This is a hint to the user of the iterator regarding the logical position in the iteration. For example, this can be used to display to the user which page of the iteration is being shown. The total could change if the inventory of items are being changed. If unset no items were returned.


integer
start_index Optional

Positional index into the logical item list of the first item returned in the list of results. The first item in the logical item list has an index of 0. This is a hint to the user of the iterator regarding the logical position in the iteration. For example, this can be used to display to the user which page of the iteration is being shown. The total could change if the inventory of items are being changed. If unset no items were returned.

JSON Example

{
    "files": [
        {
            "filename": "string",
            "size": 0,
            "type": "enum"
        }
    ],
    "status": "enum",
    "total": 0
}
Feedback

Was this page helpful?