You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb
+5-9Lines changed: 5 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -66,18 +66,16 @@ module Actions
66
66
#
67
67
# @option arguments [String] :index Default index for items which don't provide one
68
68
# @option arguments [String] :type Default document type for items which don't provide one
69
-
# @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*). Note that this cannot be empty.
70
-
# @option arguments [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
69
+
# @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*)
71
70
# @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
72
71
# @option arguments [String] :refresh If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
73
72
# @option arguments [String] :routing Specific routing value
# @option arguments [String] :type Default document type for items which don't provide one
76
-
# @option arguments [List] :fields Default comma-separated list of fields to return in the response for updates, can be overridden on each sub-request
77
75
# @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
78
-
# @option arguments [List] :_source_exclude Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
79
-
# @option arguments [List] :_source_include Default list of fields to extract and return from the _source field, can be overridden on each sub-request
80
-
# @option arguments [String] :pipeline The pipeline ID to preprocess incoming documents with
76
+
# @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
77
+
# @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request
78
+
# @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
# @option arguments [List] :index A comma-separated list of indices to restrict the results
37
38
# @option arguments [List] :type A comma-separated list of types to restrict the results
38
39
# @option arguments [Hash] :body A query to restrict the results specified with the Query DSL (optional)
39
-
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
40
-
# unavailable (missing or closed)
41
-
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves
42
-
# into no concrete indices.
43
-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices
44
-
# that are open, closed or both.
45
-
# (options: open, closed, none, all)
40
+
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
41
+
# @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
42
+
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
43
+
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
46
44
# @option arguments [Number] :min_score Include only documents with a specific `_score` value in the result
47
-
# @option arguments [String] :preference Specify the node or shard the operation should be performed on
48
-
# (default: random)
49
-
# @option arguments [String] :routing Specific routing value
45
+
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
46
+
# @option arguments [List] :routing A comma-separated list of specific routing values
50
47
# @option arguments [String] :q Query in the Lucene query string syntax
51
48
# @option arguments [String] :analyzer The analyzer to use for the query string
52
-
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be
53
-
# analyzed (default: false)
54
-
# @option arguments [String] :default_operator The default operator for query string query (AND or OR)
55
-
# (options: AND, OR)
56
-
# @option arguments [String] :df The field to use as default where no field prefix is given in the query
57
-
# string
58
-
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text
59
-
# to a numeric field) should be ignored
60
-
# @option arguments [Boolean] :lowercase_expanded_terms Specify whether query terms should be lowercased
61
-
#
62
-
# @option arguments [Boolean] :terminate_after Specify the maximum count for each shard, upon reaching
63
-
# which the query execution will terminate early.
49
+
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
50
+
# @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
51
+
# @option arguments [String] :df The field to use as default where no field prefix is given in the query string
52
+
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
53
+
# @option arguments [Number] :terminate_after The maximum count for each shard, upon reaching which the query execution will terminate early
# @option arguments [String] :id The document ID (*Required*)
33
-
# @option arguments [Number,List] :ignore The list of HTTP errors to ignore; only `404` supported at the moment
34
33
# @option arguments [String] :index The name of the index (*Required*)
35
-
# @option arguments [String] :type The type of the document (*Required*)
36
-
# @option arguments [String] :consistency Specific write consistency setting for the operation
37
-
# (options: one, quorum, all)
38
-
# @option arguments [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
34
+
# @option arguments [String] :type The type of the document
35
+
# @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
39
36
# @option arguments [String] :parent ID of parent document
40
-
# @option arguments [Boolean] :refresh Refresh the index after performing the operation
41
-
# @option arguments [String] :replication Specific replication type (options: sync, async)
37
+
# @option arguments [String] :refresh If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
42
38
# @option arguments [String] :routing Specific routing value
# @option arguments [Number] :if_seq_no only perform the delete operation if the last operation that has changed the document has the specified sequence number
41
+
# @option arguments [Number] :if_primary_term only perform the delete operation if the last operation that has changed the document has the specified primary term
44
42
# @option arguments [Number] :version Explicit version number for concurrency control
45
43
# @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
0 commit comments