Fileinfo, Filesimplefilter, Fileresponseinformation – Brocade Virtual ADX XML API Programmer’s Guide (Supporting ADX v03.1.00) User Manual

Page 104

Advertising
background image

94

Brocade Virtual ADX XML API Programmer’s Guide

53-1003248-01

Data structures

3

FileInfo

This structure is a high-level description for directory and file information.

FileResponseInformation

This structure is the high-level description of clock details.

FileSimpleFilter

This structure is a high-level description of filter for Files and Directories information.

TABLE 233

Attributes

arameter

Type

Presence

Rules

Description

Location

driveLocationEnum

Mandatory

Specifies the drive location
information.

directoryPath string

Optional

Either “directoryPath” or
“filename” is Mandatory.
Both “directoryPath” and
“filename” can exist
together.

Specifies a relative directory
path

filename

string

Optional

Either “directoryPath” or
“filename” is Mandatory.
Both “directoryPath” and
“filename” can exist
together.

Specifies a file name.

size

unsignedInt

Optional

(READ-ONLY)

type

string

Optional(READ
-ONLY)

Specifies the type whether
directory or a regular file.

date

string

Optional(READ
-ONLY)

Specifies the modified date
and time.

TABLE 234

Attributes

Name

Type

Required

Rules

Description

timeRetrievedAt

string

Optional

Time retrieved at

totalFileSize

unsignedInt

Optional

The total size of the file.

totalLinesRetrieved

unsignedInt

Optional

The sum of lines that were retrieved.

endOfFile

boolean

Optional

Denotes the end of file.

TABLE 235

Attributes

Parameters

Type

Presence

Rules

Description

Field

fileFilterFieldEnum

Mandatory

Filter field name.

operator

filterOperatorEnum

Mandatory

Filter operator type.

value

string

Optional

Ignored when “operator”
value is “RANGE”.

Value of the field for
filtering.

Advertising