Batch Rules | Ruby API Client V1 (Deprecated)

This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.

Required API Key: any key with the editSettings ACL

Method signature

index.batch_rules(
  Array rules,
  Boolean forwardToReplicas,
  Boolean clearExistingRules
)

See code examples

About this method

Create or update a specified set of Rules, or all Rules.

Each Rule is created or updated, depending on whether a Rule with the same objectID already exists.

Examples

Copy

1
2
3
$rules = [$rule1, $rule2];

$index->saveRules($rules);

1
2
3
4
5
6
7
8
9
10
11
12
rules = [rule1, rule2]
forward_to_replicas = true
clear_existing_rules = true

# Save the rules.
index.batch_rules(rules)
# Save the rules and wait the end of indexing.
index.batch_rules!(rules)
# Save the rules, and forward them to all replicas of the index.
index.batch_rules(rules, forward_to_replicas)
# Replace all the rules in the index by the provided ones.
index.batch_rules(rules, forward_to_replicas, clear_existing_rules)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
const rules = [
  {
    objectID: 'rule-1',
    condition: {
      pattern: 'smartphone',
      anchoring: 'contains'
    },
    consequence: {
      params: {
        filters: 'category = 1'
      }
    }
  },
  {
    objectID: 'rule-2',
    condition: {
      pattern: 'tv',
      anchoring: 'contains'
    },
    consequence: {
      params: {
        filters: 'category = 2'
      }
    }
  }
];

// Save the rules.
index.saveRules(rules).then(() => {
  // done
});

// Replace all the rules in the index by the provided ones.
index.saveRules(rules, { clearExistingRules: true }).then(() => {
  // done
});

// Save the rules, and forward them to all replicas of the index.
index.saveRules(rules, { forwardToReplicas: true }).then(() => {
  // done
});

1
2
3
4
5
6
7
8
9
let rules: [Rule] = [/* Your Query rules */]

index.saveRules(rules,
                forwardToReplicas: true,
                clearExistingRules: true) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
List<Rule> rules;
index.SaveRules(rules, forwardToReplicas: true, clearExistingRules: false);

// Asynchronous
await index.SaveRulesAsync(rules, forwardToReplicas: true, clearExistingRules: false);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
boolean forwardToReplicas = false;
boolean clearExistingRules = false;

index.saveRules(
  Arrays.asList(rule1, rule2),
  forwardToReplicas,
  clearExistingRules
);

index.saveRulesAsync(
  Arrays.asList(rule1, rule2),
  forwardToReplicas,
  clearExistingRules
);

1
2
3
4
5
6
7
8
rules := []search.Rule{rule1, rule2}

opts := []interface{}{
  opt.ForwardToReplicas(false),
  opt.ClearExistingRules(false),
}

res, err := index.SaveRules(rules, opts...)

Parameters

`rules`	type: list of Rule objects Required See Rule.
`clearExistingRules`	type: boolean default: false Optional Whether the batch will remove all existing Rules before adding/updating the Rules.
`forwardToReplicas`	type: boolean default: false Optional Whether to forward the operation to the replica indices.
`requestOptions`	type: key/value mapping default: No request options Optional A mapping of request options to send along with the request.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

Copy

          {
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}

        

`updatedAt`	string Date at which the batch Rules job has been created.
`taskID`	integer The taskID used with the waitTask method.