Query descriptors
A BSA_QueryDescriptor is the structure that is used in the query process to find an individual or set of objects. It contains those fields from the object descriptor that are searchable. When a query is performed, the enumeration fields must be specified. If they are unknown, they all allow an "ANY" enumeration. You must also specify the objectName.pathName. Wildcards are allowed for this field and "/*" is a valid pathname for querying. The other strings in the descriptor can be empty strings, but they are still used for comparison to find an object descriptor that matches the query descriptor. If these fields are unknown, wildcards are allowed here also. The start (createTime_from) and end (createTime_to) dates are not required.
The attributes of the BSA_QueryDescriptor are shown in the following table:
Table: BSA_QueryDescriptor Attributes
Attribute | Data Type |
|---|---|
objectOwner | (consisting of two parts) |
bsa_objectOwner | [fixed-length character string] |
app_objectOwner | [hierarchical character string] |
objectName | (consisting of two parts) |
objectSpaceName | [fixed-length character string] |
pathName | [hierarchical character string] |
createTime_from | [date-time] |
createTime_to | [date-time] |
CopyType | [enumeration] |
objectType | [enumeration] |
objectStatus | [enumeration] |
Note:
The createTime_from and createTime_to fields are not part of the XBSA specification for the BSA_QueryDescriptor structure. The NetBackup XBSA interface uses two reserved fields from the BSA_QueryDescriptor structure to allow this information to be used (if available) for the query. These fields are not required, although if the XBSA application can specify these dates, it can, in some instances, greatly speed up query time.