Failure detection API - JSON models

JSON models of the Failure detection rules API vary greatly, depending on the type of some objects. Here you can find JSON models for each variation.

Variations of the FdpTagPredicate object

The FdpTagPredicate object is the base of tag conditions for failure detection parameter sets. The actual set of fields depends on the type of the condition.

STRING_EQUALS

The FdpTagStringStartsWith object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
ignoreCase boolean optional
value string

The reference value. The condition is fulfilled when the tag (which is a string) starts with this value.

optional

STRING_STARTS_WITH

The FdpTagStringEquals object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
ignoreCase boolean optional
value string

The reference value. The condition is fulfilled when the tag (which is a string) equals this value.

optional

STRING_ENDS_WITH

The FdpTagStringEndsWith object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
ignoreCase boolean optional
value string

The reference value. The condition is fulfilled when the tag (which is a string) ends with this value.

optional

STRING_CONTAINS_SUBSTRING

The FdpTagStringContainsSubstring object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
ignoreCase boolean optional
value string

The reference value. The condition is fulfilled when the tag (which is a string) contains this value.

optional

INTEGER_EQUALS

The FdpTagIntegerEquals object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
value string

The reference value.

optional

INTEGER_LESS_THAN

The FdpTagIntegerLessThan object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
value string

The reference value.

optional

INTEGER_LESS_THAN_OR_EQUAL

The FdpTagIntegerLessThanOrEqual object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
value string

The reference value.

optional

INTEGER_GREATER_THAN

The FdpTagIntegerGreaterThan object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
value string

The reference value.

optional

INTEGER_GREATER_THAN_OR_EQUAL

The FdpTagIntegerGreaterThanOrEqual object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
value string

The reference value.

optional

DOUBLE_EQUALS

The FdpTagDoubleEquals object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
value number

The reference value.

optional

DOUBLE_LESS_THAN

The FdpTagDoubleLessThan object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
value number

The reference value.

optional

DOUBLE_LESS_THAN_OR_EQUAL

The FdpTagDoubleLessThanOrEqual object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
value number

The reference value.

optional

DOUBLE_GREATER_THAN

The FdpTagDoubleGreaterThan object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
value number

The reference value.

optional

DOUBLE_GREATER_THAN_OR_EQUAL

The FdpTagDoubleGreaterThanOrEqual object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EQUALS -> FdpTagDoubleEquals
  • DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
  • DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
  • DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
  • DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual
required
value number

The reference value.

optional

Variations of the FdcPredicate object

The FdcPredicate object is the base for predicates of a failure detection rule's condition. The actual set of fields depends on the type of the condition.

STRING_EQUALS

The FdcPredicateStringEquals object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
ignoreCase boolean

The condition is case sensitive (false) or case insensitive (true).

If not set, then false is used, making the condition case sensitive.

required
values string[]

A list of reference values. The condition is fulfilled when the attribute (which is a string) equals any of these.

required

STRING_STARTS_WITH

The FdcPredicateStringStartsWith object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
ignoreCase boolean

The condition is case sensitive (false) or case insensitive (true).

If not set, then false is used, making the condition case sensitive.

required
values string[]

A list of reference values. The condition is fulfilled when the attribute (which is a string) start with any of these.

required

STRING_ENDS_WITH

The FdcPredicateStringEndsWith object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
ignoreCase boolean

The condition is case sensitive (false) or case insensitive (true).

If not set, then false is used, making the condition case sensitive.

required
values string[]

A list of reference values. The condition is fulfilled when the attribute (which is a string) ends with any of these.

required

STRING_CONTAINS_SUBSTRING

The FdcPredicateStringContains object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
ignoreCase boolean

The condition is case sensitive (false) or case insensitive (true).

If not set, then false is used, making the condition case sensitive.

required
values string[]

A list of reference values. The condition is fulfilled when the attribute (which is a string) contains any of these.

required

INTEGER_EQUALS

The FdcPredicateIntegerEquals object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
values integer[]

The reference value. The condition is fulfilled when the attribute (which is an integer) equals any of these.

required

INTEGER_LESS_THAN

The FdcPredicateIntegerLessThan object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
value integer

The reference value. The condition is fulfilled when the attribute (which is an integer) is less than this value.

optional

INTEGER_LESS_THAN_OR_EQUAL

The FdcPredicateIntegerLessThanOrEqual object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
value integer

The reference value. The condition is fulfilled when the attribute (which is an integer) is less than or equals this value.

optional

INTEGER_GREATER_THAN

The FdcPredicateIntegerGreaterThan object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
value integer

The reference value. The condition is fulfilled when the attribute (which is an integer) is greater than this value.

optional

INTEGER_GREATER_THAN_OR_EQUAL

The FdcPredicateIntegerGreaterThanOrEqual object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
value integer

The reference value. The condition is fulfilled when the attribute (which is an integer) is greater than or equals this value.

optional

LONG_EQUALS

The FdcPredicateLongEquals object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
values string[]

A list of reference values. The condition is fulfilled when the attribute (which is a long) equals any of these.

required

LONG_LESS_THAN

The FdcPredicateLongLessThan object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
value string

The reference value. The condition is fulfilled when the attribute (which is a long) is less than this value.

optional

LONG_LESS_THAN_OR_EQUAL

The FdcPredicateLongLessThanOrEqual object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
value string

The reference value. The condition is fulfilled when the attribute (which is a long) is less than or equals this value.

optional

LONG_GREATER_THAN

The FdcPredicateLongGreaterThan object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
value string

The reference value. The condition is fulfilled when the attribute (which is a long) is greater than this value.

optional

LONG_GREATER_THAN_OR_EQUAL

The FdcPredicateLongGreaterThanOrEqual object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
value string

The reference value. The condition is fulfilled when the attribute (which is a long) is greater than or equals this value.

optional

TAG_KEY_EQUALS

The FdcPredicateTagKeyEquals object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
keys string[]

A list of reference values. The condition is fulfilled when the attribute (which is the key of a tag) equals any of these.

optional

TAG_EQUALS

The FdcPredicateTagEquals object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
keys string[]

A list of reference tag keys.

The condition is fulfilled when the tag matches any key:value pair, consisting of a key and a value that are at the same position in the respective list.

optional
values string[]

A list of reference tag values.

The condition is fulfilled when the tag matches any key:value pair, consisting of a key and a value that are at the same position in the respective list.

optional

SERVICE_TYPE_EQUALS

The FdcPredicateServiceTypeEquals object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
values string[]

A list of reference values. The condition is fulfilled when the attribute (which is the type of the service) equals any of these.

optional

MANAGEMENT_ZONES_CONTAINS_ALL

The FdcPredicateManagementZonesContainsAll object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
values string[]

A list of reference values. The condition is fulfilled when the attribute (which is a set of management zones) contains all the reference values.

Specify the ID or the name of the management zone here.

optional

SET_OF_INTEGERS_CONTAINS_ANY

The FdcPredicateLongLessThan object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
value string

The reference value. The condition is fulfilled when the attribute (which is a long) is less than this value.

optional

SET_OF_INTEGERS_CONTAINS_ALL

The FdcPredicateLongLessThan object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
required
value string

The reference value. The condition is fulfilled when the attribute (which is a long) is less than this value.

optional