aws-sdk-cloudsearchdomain 1.30.0 → 1.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +46 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudsearchdomain/client.rb +70 -28
- data/lib/aws-sdk-cloudsearchdomain/types.rb +34 -74
- data/lib/aws-sdk-cloudsearchdomain.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6bff380e66673694fcfb3a773234563ac7f85068b351bd23ba95dcec63ac6274
|
4
|
+
data.tar.gz: 62e9cddcd2c295e641f6e80f57b416aed6c2b04d4529c3aca571da730833e7e0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e5bacd4849ae7352b510e762baa08bc84dc551b47d6566d77434cad6efc5cb22be454e2cfc5c5ed724795e1acb7e04d34375c8a36824d41b9b73f91cf995703e
|
7
|
+
data.tar.gz: 3ff692700a7029ee8d3469d92df38d08f2e8a577b25897f95b5bfd012b4bb033e1904b11e2c657a4a44b5519f02e60d5d7e7db8888a9c2646ad8205f69f9341e
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,51 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.38.0 (2023-09-27)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.37.0 (2023-07-06)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.36.0 (2023-06-28)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.35.0 (2023-05-31)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
24
|
+
1.34.1 (2023-01-18)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Issue - Replace runtime endpoint resolution approach with generated ruby code.
|
28
|
+
|
29
|
+
1.34.0 (2022-10-25)
|
30
|
+
------------------
|
31
|
+
|
32
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
33
|
+
|
34
|
+
1.33.0 (2022-02-24)
|
35
|
+
------------------
|
36
|
+
|
37
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
38
|
+
|
39
|
+
1.32.0 (2022-02-03)
|
40
|
+
------------------
|
41
|
+
|
42
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
43
|
+
|
44
|
+
1.31.0 (2021-12-21)
|
45
|
+
------------------
|
46
|
+
|
47
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
48
|
+
|
4
49
|
1.30.0 (2021-11-30)
|
5
50
|
------------------
|
6
51
|
|
@@ -223,4 +268,4 @@ Unreleased Changes
|
|
223
268
|
1.0.0.rc1 (2016-12-05)
|
224
269
|
------------------
|
225
270
|
|
226
|
-
* Feature - Initial preview release of the `aws-sdk-cloudsearchdomain` gem.
|
271
|
+
* Feature - Initial preview release of the `aws-sdk-cloudsearchdomain` gem.
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.38.0
|
@@ -24,6 +24,10 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
26
26
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
28
|
+
require 'aws-sdk-core/plugins/request_compression.rb'
|
29
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
30
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
27
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
32
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
33
|
require 'aws-sdk-cloudsearchdomain/plugins/conditional_signing.rb'
|
@@ -69,6 +73,10 @@ module Aws::CloudSearchDomain
|
|
69
73
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
70
74
|
add_plugin(Aws::Plugins::TransferEncoding)
|
71
75
|
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
77
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
72
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
81
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
74
82
|
add_plugin(Aws::CloudSearchDomain::Plugins::ConditionalSigning)
|
@@ -157,6 +165,14 @@ module Aws::CloudSearchDomain
|
|
157
165
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
158
166
|
# a clock skew correction and retry requests with skewed client clocks.
|
159
167
|
#
|
168
|
+
# @option options [String] :defaults_mode ("legacy")
|
169
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
170
|
+
# accepted modes and the configuration defaults that are included.
|
171
|
+
#
|
172
|
+
# @option options [Boolean] :disable_request_compression (false)
|
173
|
+
# When set to 'true' the request body will not be compressed
|
174
|
+
# for supported operations.
|
175
|
+
#
|
160
176
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
161
177
|
# The log formatter.
|
162
178
|
#
|
@@ -177,6 +193,11 @@ module Aws::CloudSearchDomain
|
|
177
193
|
# Used when loading credentials from the shared credentials file
|
178
194
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
179
195
|
#
|
196
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
197
|
+
# The minimum size in bytes that triggers compression for request
|
198
|
+
# bodies. The value must be non-negative integer value between 0
|
199
|
+
# and 10485780 bytes inclusive.
|
200
|
+
#
|
180
201
|
# @option options [Proc] :retry_backoff
|
181
202
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
182
203
|
# This option is only used in the `legacy` retry mode.
|
@@ -222,6 +243,11 @@ module Aws::CloudSearchDomain
|
|
222
243
|
# in the future.
|
223
244
|
#
|
224
245
|
#
|
246
|
+
# @option options [String] :sdk_ua_app_id
|
247
|
+
# A unique and opaque application ID that is appended to the
|
248
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
249
|
+
# maximum length of 50.
|
250
|
+
#
|
225
251
|
# @option options [String] :secret_access_key
|
226
252
|
#
|
227
253
|
# @option options [String] :session_token
|
@@ -239,6 +265,19 @@ module Aws::CloudSearchDomain
|
|
239
265
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
240
266
|
# requests are made, and retries are disabled.
|
241
267
|
#
|
268
|
+
# @option options [Aws::TokenProvider] :token_provider
|
269
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
270
|
+
# following classes:
|
271
|
+
#
|
272
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
273
|
+
# tokens.
|
274
|
+
#
|
275
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
276
|
+
# access token generated from `aws login`.
|
277
|
+
#
|
278
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
279
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
280
|
+
#
|
242
281
|
# @option options [Boolean] :validate_params (true)
|
243
282
|
# When `true`, request parameters are validated before
|
244
283
|
# sending the request.
|
@@ -250,7 +289,7 @@ module Aws::CloudSearchDomain
|
|
250
289
|
# seconds to wait when opening a HTTP session before raising a
|
251
290
|
# `Timeout::Error`.
|
252
291
|
#
|
253
|
-
# @option options [
|
292
|
+
# @option options [Float] :http_read_timeout (60) The default
|
254
293
|
# number of seconds to wait for response data. This value can
|
255
294
|
# safely be set per-request on the session.
|
256
295
|
#
|
@@ -266,6 +305,9 @@ module Aws::CloudSearchDomain
|
|
266
305
|
# disables this behaviour. This value can safely be set per
|
267
306
|
# request on the session.
|
268
307
|
#
|
308
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
309
|
+
# in seconds.
|
310
|
+
#
|
269
311
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
270
312
|
# HTTP debug output will be sent to the `:logger`.
|
271
313
|
#
|
@@ -295,16 +337,16 @@ module Aws::CloudSearchDomain
|
|
295
337
|
# criteria. How you specify the search criteria depends on which query
|
296
338
|
# parser you use. Amazon CloudSearch supports four query parsers:
|
297
339
|
#
|
298
|
-
# * `simple
|
340
|
+
# * `simple`: search all `text` and `text-array` fields for the
|
299
341
|
# specified string. Search for phrases, individual terms, and
|
300
342
|
# prefixes.
|
301
|
-
# * `structured
|
343
|
+
# * `structured`: search specific fields, construct compound queries
|
302
344
|
# using Boolean operators, and use advanced features such as term
|
303
345
|
# boosting and proximity searching.
|
304
|
-
# * `lucene
|
346
|
+
# * `lucene`: specify search criteria using the Apache Lucene query
|
305
347
|
# parser syntax.
|
306
|
-
# * `dismax
|
307
|
-
#
|
348
|
+
# * `dismax`: specify search criteria using the simplified subset of the
|
349
|
+
# Apache Lucene query parser syntax defined by the DisMax query
|
308
350
|
# parser.
|
309
351
|
#
|
310
352
|
# For more information, see [Searching Your Data][1] in the *Amazon
|
@@ -445,16 +487,16 @@ module Aws::CloudSearchDomain
|
|
445
487
|
#
|
446
488
|
# You can specify the following highlight options:
|
447
489
|
#
|
448
|
-
# * `format
|
449
|
-
#
|
450
|
-
#
|
451
|
-
# * `max_phrases
|
490
|
+
# * `format`: specifies the format of the data in the text field: `text`
|
491
|
+
# or `html`. When data is returned as HTML, all non-alphanumeric
|
492
|
+
# characters are encoded. The default is `html`.
|
493
|
+
# * `max_phrases`: specifies the maximum number of occurrences of the
|
452
494
|
# search term(s) you want to highlight. By default, the first
|
453
495
|
# occurrence is highlighted.
|
454
|
-
# * `pre_tag
|
496
|
+
# * `pre_tag`: specifies the string to prepend to an occurrence of a
|
455
497
|
# search term. The default for HTML highlights is `<em>`. The
|
456
498
|
# default for text highlights is `*`.
|
457
|
-
# * `post_tag
|
499
|
+
# * `post_tag`: specifies the string to append to an occurrence of a
|
458
500
|
# search term. The default for HTML highlights is `</em>`. The
|
459
501
|
# default for text highlights is `*`.
|
460
502
|
#
|
@@ -504,7 +546,7 @@ module Aws::CloudSearchDomain
|
|
504
546
|
#
|
505
547
|
# The options you can configure vary according to which parser you use:
|
506
548
|
#
|
507
|
-
# * `defaultOperator
|
549
|
+
# * `defaultOperator`: The default operator used to combine individual
|
508
550
|
# terms in the search string. For example: `defaultOperator: 'or'`.
|
509
551
|
# For the `dismax` parser, you specify a percentage that represents
|
510
552
|
# the percentage of terms in the search string (rounded down) that
|
@@ -516,7 +558,7 @@ module Aws::CloudSearchDomain
|
|
516
558
|
# (`dismax`). Default: `and` (`simple`, `structured`, `lucene`) or
|
517
559
|
# `100` (`dismax`). Valid for: `simple`, `structured`, `lucene`, and
|
518
560
|
# `dismax`.
|
519
|
-
# * `fields
|
561
|
+
# * `fields`: An array of the fields to search when no fields are
|
520
562
|
# specified in a search. If no fields are specified in a search and
|
521
563
|
# this option is not specified, all text and text-array fields are
|
522
564
|
# searched. You can specify a weight for each field to control the
|
@@ -528,7 +570,7 @@ module Aws::CloudSearchDomain
|
|
528
570
|
# The name of any configured field and an optional numeric value
|
529
571
|
# greater than zero. Default: All `text` and `text-array` fields.
|
530
572
|
# Valid for: `simple`, `structured`, `lucene`, and `dismax`.
|
531
|
-
# * `operators
|
573
|
+
# * `operators`: An array of the operators or special characters you
|
532
574
|
# want to disable for the simple query parser. If you disable the
|
533
575
|
# `and`, `or`, or `not` operators, the corresponding operators (`+`,
|
534
576
|
# `|`, `-`) have no special meaning and are dropped from the search
|
@@ -550,7 +592,7 @@ module Aws::CloudSearchDomain
|
|
550
592
|
# `escape`, `fuzzy`, `near`, `not`, `or`, `phrase`, `precedence`,
|
551
593
|
# `prefix`, `whitespace`. Default: All operators and special
|
552
594
|
# characters are enabled. Valid for: `simple`.
|
553
|
-
# * `phraseFields
|
595
|
+
# * `phraseFields`: An array of the `text` or `text-array` fields you
|
554
596
|
# want to use for phrase searches. When the terms in the search string
|
555
597
|
# appear in close proximity within a field, the field scores higher.
|
556
598
|
# You can specify a weight for each field to boost that score. The
|
@@ -564,20 +606,20 @@ module Aws::CloudSearchDomain
|
|
564
606
|
# If you don't specify any fields with `phraseFields`, proximity
|
565
607
|
# scoring is disabled even if `phraseSlop` is specified. Valid for:
|
566
608
|
# `dismax`.
|
567
|
-
# * `phraseSlop
|
609
|
+
# * `phraseSlop`: An integer value that specifies how much matches can
|
568
610
|
# deviate from the search phrase and still be boosted according to the
|
569
611
|
# weights specified in the `phraseFields` option; for example,
|
570
612
|
# `phraseSlop: 2`. You must also specify `phraseFields` to enable
|
571
613
|
# proximity scoring. Valid values: positive integers. Default: 0.
|
572
614
|
# Valid for: `dismax`.
|
573
|
-
# * `explicitPhraseSlop
|
615
|
+
# * `explicitPhraseSlop`: An integer value that specifies how much a
|
574
616
|
# match can deviate from the search phrase when the phrase is enclosed
|
575
617
|
# in double quotes in the search string. (Phrases that exceed this
|
576
618
|
# proximity distance are not considered a match.) For example, to
|
577
619
|
# specify a slop of three for dismax phrase queries, you would specify
|
578
620
|
# `"explicitPhraseSlop":3`. Valid values: positive integers. Default:
|
579
621
|
# 0. Valid for: `dismax`.
|
580
|
-
# * `tieBreaker
|
622
|
+
# * `tieBreaker`: When a term in the search string is found in a
|
581
623
|
# document's field, a score is calculated for that field based on how
|
582
624
|
# common the word is in that field compared to other documents. If the
|
583
625
|
# term occurs in multiple fields within a document, by default only
|
@@ -601,11 +643,11 @@ module Aws::CloudSearchDomain
|
|
601
643
|
#
|
602
644
|
# Amazon CloudSearch supports four query parsers:
|
603
645
|
#
|
604
|
-
# * `simple
|
605
|
-
#
|
606
|
-
#
|
607
|
-
#
|
608
|
-
#
|
646
|
+
# * `simple`: perform simple searches of `text` and `text-array` fields.
|
647
|
+
# By default, the `simple` query parser searches all `text` and
|
648
|
+
# `text-array` fields. You can specify which fields to search by with
|
649
|
+
# the `queryOptions` parameter. If you prefix a search term with a
|
650
|
+
# plus sign (+) documents must contain the term to be considered a
|
609
651
|
# match. (This is the default, unless you configure the default
|
610
652
|
# operator with the `queryOptions` parameter.) You can use the `-`
|
611
653
|
# (NOT), `|` (OR), and `*` (wildcard) operators to exclude particular
|
@@ -613,15 +655,15 @@ module Aws::CloudSearchDomain
|
|
613
655
|
# for a prefix. To search for a phrase rather than individual terms,
|
614
656
|
# enclose the phrase in double quotes. For more information, see
|
615
657
|
# [Searching for Text][1] in the *Amazon CloudSearch Developer Guide*.
|
616
|
-
# * `structured
|
658
|
+
# * `structured`: perform advanced searches by combining multiple
|
617
659
|
# expressions to define the search criteria. You can also search
|
618
660
|
# within particular fields, search for values and ranges of values,
|
619
661
|
# and use advanced options such as term boosting, `matchall`, and
|
620
662
|
# `near`. For more information, see [Constructing Compound Queries][2]
|
621
663
|
# in the *Amazon CloudSearch Developer Guide*.
|
622
|
-
# * `lucene
|
664
|
+
# * `lucene`: search using the Apache Lucene query parser syntax. For
|
623
665
|
# more information, see [Apache Lucene Query Parser Syntax][3].
|
624
|
-
# * `dismax
|
666
|
+
# * `dismax`: search using the simplified subset of the Apache Lucene
|
625
667
|
# query parser syntax defined by the DisMax query parser. For more
|
626
668
|
# information, see [DisMax Query Parser Syntax][4].
|
627
669
|
#
|
@@ -890,7 +932,7 @@ module Aws::CloudSearchDomain
|
|
890
932
|
params: params,
|
891
933
|
config: config)
|
892
934
|
context[:gem_name] = 'aws-sdk-cloudsearchdomain'
|
893
|
-
context[:gem_version] = '1.
|
935
|
+
context[:gem_version] = '1.38.0'
|
894
936
|
Seahorse::Client::Request.new(handlers, context)
|
895
937
|
end
|
896
938
|
|
@@ -81,8 +81,7 @@ module Aws::CloudSearchDomain
|
|
81
81
|
# `double-array`), `min` is the string representation of a
|
82
82
|
# double-precision 64-bit floating point value. If the field is `date`
|
83
83
|
# or `date-array`, `min` is the string representation of a date with
|
84
|
-
# the format specified in [IETF RFC3339][1]
|
85
|
-
# yyyy-mm-ddTHH:mm:ss.SSSZ.
|
84
|
+
# the format specified in [IETF RFC3339][1]: yyyy-mm-ddTHH:mm:ss.SSSZ.
|
86
85
|
#
|
87
86
|
#
|
88
87
|
#
|
@@ -96,8 +95,7 @@ module Aws::CloudSearchDomain
|
|
96
95
|
# `double-array`), `max` is the string representation of a
|
97
96
|
# double-precision 64-bit floating point value. If the field is `date`
|
98
97
|
# or `date-array`, `max` is the string representation of a date with
|
99
|
-
# the format specified in [IETF RFC3339][1]
|
100
|
-
# yyyy-mm-ddTHH:mm:ss.SSSZ.
|
98
|
+
# the format specified in [IETF RFC3339][1]: yyyy-mm-ddTHH:mm:ss.SSSZ.
|
101
99
|
#
|
102
100
|
#
|
103
101
|
#
|
@@ -131,8 +129,7 @@ module Aws::CloudSearchDomain
|
|
131
129
|
# `double-array`), `mean` is the string representation of a
|
132
130
|
# double-precision 64-bit floating point value. If the field is `date`
|
133
131
|
# or `date-array`, `mean` is the string representation of a date with
|
134
|
-
# the format specified in [IETF RFC3339][1]
|
135
|
-
# yyyy-mm-ddTHH:mm:ss.SSSZ.
|
132
|
+
# the format specified in [IETF RFC3339][1]: yyyy-mm-ddTHH:mm:ss.SSSZ.
|
136
133
|
#
|
137
134
|
#
|
138
135
|
#
|
@@ -229,26 +226,6 @@ module Aws::CloudSearchDomain
|
|
229
226
|
|
230
227
|
# Container for the parameters to the `Search` request.
|
231
228
|
#
|
232
|
-
# @note When making an API call, you may pass SearchRequest
|
233
|
-
# data as a hash:
|
234
|
-
#
|
235
|
-
# {
|
236
|
-
# cursor: "Cursor",
|
237
|
-
# expr: "Expr",
|
238
|
-
# facet: "Facet",
|
239
|
-
# filter_query: "FilterQuery",
|
240
|
-
# highlight: "Highlight",
|
241
|
-
# partial: false,
|
242
|
-
# query: "Query", # required
|
243
|
-
# query_options: "QueryOptions",
|
244
|
-
# query_parser: "simple", # accepts simple, structured, lucene, dismax
|
245
|
-
# return: "Return",
|
246
|
-
# size: 1,
|
247
|
-
# sort: "Sort",
|
248
|
-
# start: 1,
|
249
|
-
# stats: "Stat",
|
250
|
-
# }
|
251
|
-
#
|
252
229
|
# @!attribute [rw] cursor
|
253
230
|
# Retrieves a cursor value you can use to page through large result
|
254
231
|
# sets. Use the `size` parameter to control the number of hits to
|
@@ -377,16 +354,16 @@ module Aws::CloudSearchDomain
|
|
377
354
|
#
|
378
355
|
# You can specify the following highlight options:
|
379
356
|
#
|
380
|
-
# * `format
|
357
|
+
# * `format`: specifies the format of the data in the text field:
|
381
358
|
# `text` or `html`. When data is returned as HTML, all
|
382
359
|
# non-alphanumeric characters are encoded. The default is `html`.
|
383
|
-
# * `max_phrases
|
360
|
+
# * `max_phrases`: specifies the maximum number of occurrences of the
|
384
361
|
# search term(s) you want to highlight. By default, the first
|
385
362
|
# occurrence is highlighted.
|
386
|
-
# * `pre_tag
|
363
|
+
# * `pre_tag`: specifies the string to prepend to an occurrence of a
|
387
364
|
# search term. The default for HTML highlights is `<em>`. The
|
388
365
|
# default for text highlights is `*`.
|
389
|
-
# * `post_tag
|
366
|
+
# * `post_tag`: specifies the string to append to an occurrence of a
|
390
367
|
# search term. The default for HTML highlights is `</em>`. The
|
391
368
|
# default for text highlights is `*`.
|
392
369
|
#
|
@@ -442,19 +419,19 @@ module Aws::CloudSearchDomain
|
|
442
419
|
# The options you can configure vary according to which parser you
|
443
420
|
# use:
|
444
421
|
#
|
445
|
-
# * `defaultOperator
|
446
|
-
#
|
447
|
-
#
|
448
|
-
#
|
449
|
-
#
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
# `
|
457
|
-
# * `fields
|
422
|
+
# * `defaultOperator`: The default operator used to combine individual
|
423
|
+
# terms in the search string. For example: `defaultOperator: 'or'`.
|
424
|
+
# For the `dismax` parser, you specify a percentage that represents
|
425
|
+
# the percentage of terms in the search string (rounded down) that
|
426
|
+
# must match, rather than a default operator. A value of `0%` is the
|
427
|
+
# equivalent to OR, and a value of `100%` is equivalent to AND. The
|
428
|
+
# percentage must be specified as a value in the range 0-100
|
429
|
+
# followed by the percent (%) symbol. For example, `defaultOperator:
|
430
|
+
# 50%`. Valid values: `and`, `or`, a percentage in the range 0%-100%
|
431
|
+
# (`dismax`). Default: `and` (`simple`, `structured`, `lucene`) or
|
432
|
+
# `100` (`dismax`). Valid for: `simple`, `structured`, `lucene`, and
|
433
|
+
# `dismax`.
|
434
|
+
# * `fields`: An array of the fields to search when no fields are
|
458
435
|
# specified in a search. If no fields are specified in a search and
|
459
436
|
# this option is not specified, all text and text-array fields are
|
460
437
|
# searched. You can specify a weight for each field to control the
|
@@ -467,7 +444,7 @@ module Aws::CloudSearchDomain
|
|
467
444
|
# any configured field and an optional numeric value greater than
|
468
445
|
# zero. Default: All `text` and `text-array` fields. Valid for:
|
469
446
|
# `simple`, `structured`, `lucene`, and `dismax`.
|
470
|
-
# * `operators
|
447
|
+
# * `operators`: An array of the operators or special characters you
|
471
448
|
# want to disable for the simple query parser. If you disable the
|
472
449
|
# `and`, `or`, or `not` operators, the corresponding operators (`+`,
|
473
450
|
# `|`, `-`) have no special meaning and are dropped from the search
|
@@ -489,7 +466,7 @@ module Aws::CloudSearchDomain
|
|
489
466
|
# values: `and`, `escape`, `fuzzy`, `near`, `not`, `or`, `phrase`,
|
490
467
|
# `precedence`, `prefix`, `whitespace`. Default: All operators and
|
491
468
|
# special characters are enabled. Valid for: `simple`.
|
492
|
-
# * `phraseFields
|
469
|
+
# * `phraseFields`: An array of the `text` or `text-array` fields you
|
493
470
|
# want to use for phrase searches. When the terms in the search
|
494
471
|
# string appear in close proximity within a field, the field scores
|
495
472
|
# higher. You can specify a weight for each field to boost that
|
@@ -503,20 +480,20 @@ module Aws::CloudSearchDomain
|
|
503
480
|
# than zero. Default: No fields. If you don't specify any fields
|
504
481
|
# with `phraseFields`, proximity scoring is disabled even if
|
505
482
|
# `phraseSlop` is specified. Valid for: `dismax`.
|
506
|
-
# * `phraseSlop
|
507
|
-
#
|
508
|
-
#
|
509
|
-
#
|
510
|
-
#
|
511
|
-
#
|
512
|
-
# * `explicitPhraseSlop
|
483
|
+
# * `phraseSlop`: An integer value that specifies how much matches can
|
484
|
+
# deviate from the search phrase and still be boosted according to
|
485
|
+
# the weights specified in the `phraseFields` option; for example,
|
486
|
+
# `phraseSlop: 2`. You must also specify `phraseFields` to enable
|
487
|
+
# proximity scoring. Valid values: positive integers. Default: 0.
|
488
|
+
# Valid for: `dismax`.
|
489
|
+
# * `explicitPhraseSlop`: An integer value that specifies how much a
|
513
490
|
# match can deviate from the search phrase when the phrase is
|
514
491
|
# enclosed in double quotes in the search string. (Phrases that
|
515
492
|
# exceed this proximity distance are not considered a match.) For
|
516
493
|
# example, to specify a slop of three for dismax phrase queries, you
|
517
494
|
# would specify `"explicitPhraseSlop":3`. Valid values: positive
|
518
495
|
# integers. Default: 0. Valid for: `dismax`.
|
519
|
-
# * `tieBreaker
|
496
|
+
# * `tieBreaker`: When a term in the search string is found in a
|
520
497
|
# document's field, a score is calculated for that field based on
|
521
498
|
# how common the word is in that field compared to other documents.
|
522
499
|
# If the term occurs in multiple fields within a document, by
|
@@ -541,7 +518,7 @@ module Aws::CloudSearchDomain
|
|
541
518
|
#
|
542
519
|
# Amazon CloudSearch supports four query parsers:
|
543
520
|
#
|
544
|
-
# * `simple
|
521
|
+
# * `simple`: perform simple searches of `text` and `text-array`
|
545
522
|
# fields. By default, the `simple` query parser searches all `text`
|
546
523
|
# and `text-array` fields. You can specify which fields to search by
|
547
524
|
# with the `queryOptions` parameter. If you prefix a search term
|
@@ -554,15 +531,15 @@ module Aws::CloudSearchDomain
|
|
554
531
|
# individual terms, enclose the phrase in double quotes. For more
|
555
532
|
# information, see [Searching for Text][1] in the *Amazon
|
556
533
|
# CloudSearch Developer Guide*.
|
557
|
-
# * `structured
|
534
|
+
# * `structured`: perform advanced searches by combining multiple
|
558
535
|
# expressions to define the search criteria. You can also search
|
559
536
|
# within particular fields, search for values and ranges of values,
|
560
537
|
# and use advanced options such as term boosting, `matchall`, and
|
561
538
|
# `near`. For more information, see [Constructing Compound
|
562
539
|
# Queries][2] in the *Amazon CloudSearch Developer Guide*.
|
563
|
-
# * `lucene
|
540
|
+
# * `lucene`: search using the Apache Lucene query parser syntax. For
|
564
541
|
# more information, see [Apache Lucene Query Parser Syntax][3].
|
565
|
-
# * `dismax
|
542
|
+
# * `dismax`: search using the simplified subset of the Apache Lucene
|
566
543
|
# query parser syntax defined by the DisMax query parser. For more
|
567
544
|
# information, see [DisMax Query Parser Syntax][4].
|
568
545
|
#
|
@@ -721,15 +698,6 @@ module Aws::CloudSearchDomain
|
|
721
698
|
|
722
699
|
# Container for the parameters to the `Suggest` request.
|
723
700
|
#
|
724
|
-
# @note When making an API call, you may pass SuggestRequest
|
725
|
-
# data as a hash:
|
726
|
-
#
|
727
|
-
# {
|
728
|
-
# query: "Query", # required
|
729
|
-
# suggester: "Suggester", # required
|
730
|
-
# size: 1,
|
731
|
-
# }
|
732
|
-
#
|
733
701
|
# @!attribute [rw] query
|
734
702
|
# Specifies the string for which you want to get suggestions.
|
735
703
|
# @return [String]
|
@@ -813,14 +781,6 @@ module Aws::CloudSearchDomain
|
|
813
781
|
|
814
782
|
# Container for the parameters to the `UploadDocuments` request.
|
815
783
|
#
|
816
|
-
# @note When making an API call, you may pass UploadDocumentsRequest
|
817
|
-
# data as a hash:
|
818
|
-
#
|
819
|
-
# {
|
820
|
-
# documents: "data", # required
|
821
|
-
# content_type: "application/json", # required, accepts application/json, application/xml
|
822
|
-
# }
|
823
|
-
#
|
824
784
|
# @!attribute [rw] documents
|
825
785
|
# A batch of documents formatted in JSON or HTML.
|
826
786
|
# @return [IO]
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-cloudsearchdomain
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.38.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2023-09-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.184.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.184.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|