vSphere Web Services API


Data Object - SearchIndexPredicate(vim.SearchIndex.Predicate)

Property of
SearchIndexFilter
Extends
DynamicData
Since
vSphere API Release 9.1.0.0

Data Object Description

Properties

Name Type Description
arrayOperator*xsd:string

The operator should be used only for properties, which return an array as their value. It specifies one of the options defined in ArrayOperator. The operator MUST be set for array values and unset for non-array values. This operator MUST always be used in combination with Predicate#operator.
comparableList*xsd:anyType[]

The list of values to test for equality or inequality against the property value when operator ComparisonOperator#In or ComparisonOperator#NotIn is used. The type of each value in the list must be one of the types enumerated in #property. The list cannot be empty.

Must be set for operator ComparisonOperator#In or ComparisonOperator#NotIn.

comparableValue*xsd:anyType

The value against which to compare the property value. The type of the value must be one of the types enumerated in #property.

Must be set for all comparison operators except ComparisonOperator#In and ComparisonOperator#NotIn.

operatorxsd:string

The operator to use for comparison of the property value. Supported operators are listed in ComparisonOperator.
propertyPathxsd:string

Specifies the resource model property to be compared. Only properties of the following types may be used for comparisons in predicates:
  • {@code boolean}
  • {@code byte}
  • {@code short}
  • {@code int}
  • {@code long}
  • {@code float}
  • {@code double}
  • {@code String}
  • {@code Enum}
  • {@code ManagedObjectReference}
  • {@code DateTime}
  • {@code URI}

The property can be:

  • top level property name e.g. {@code runtime}
  • dot-separated chain of property names to indicate a child property. e.g. {@code runtime.powerState}
  • the special identifier property @moRef which will extract the corresponding identifier {@code ManagedObjectReference} of the object
If the property is an array of {@code DataObject} you can additionally:
  • index a specific object by its "key" property example with string key {@code config.network.pnic["key-vim.host.PhysicalNic-vmnic0"]} example with int key {@code config.hardware[10]}
  • get a specific property of specific object e.g. {@code config.network.pnic["key-vim.host.PhysicalNic-vmnic0"].mac}
  • use array aggregation to obtain specific properties from all elements e.g. {@code config.network.pnic[*].mac}
Please note that tupling is not supported in filters.


Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition