Skip to content

Commit a3fa752

Browse files
johnny94johnny94
committed
fix typo in documentation; Add 'context' parameter for RequestConvertests its test.
1 parent f9da579 commit a3fa752

File tree

7 files changed

+63
-21
lines changed

7 files changed

+63
-21
lines changed

‎client/rest-high-level/src/main/java/org/elasticsearch/client/IndicesClient.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -701,9 +701,9 @@ public void getTemplateAsync(GetIndexTemplatesRequest getIndexTemplatesRequest,
701701
* @return the response
702702
* @throws IOException in case there is a problem sending the request or parsing back the response
703703
*/
704-
public PutStoredScriptResponse putStoredScript(PutStoredScriptRequest putStoredScriptRequest,
705-
RequestOptions options) throws IOException {
706-
return restHighLevelClient.performRequestAndParseEntity(putStoredScriptRequest, RequestConverters::putStoredScript, options,
704+
public PutStoredScriptResponse putScript(PutStoredScriptRequest putStoredScriptRequest,
705+
RequestOptions options) throws IOException {
706+
return restHighLevelClient.performRequestAndParseEntity(putStoredScriptRequest, RequestConverters::putScript, options,
707707
PutStoredScriptResponse::fromXContent, emptySet());
708708
}
709709

@@ -715,9 +715,9 @@ public PutStoredScriptResponse putStoredScript(PutStoredScriptRequest putStoredS
715715
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
716716
* @param listener the listener to be notified upon request completion
717717
*/
718-
public void putStoredScriptAsync(PutStoredScriptRequest putStoredScriptRequest, RequestOptions options,
719-
ActionListener<PutStoredScriptResponse> listener) {
720-
restHighLevelClient.performRequestAsyncAndParseEntity(putStoredScriptRequest, RequestConverters::putStoredScript, options,
718+
public void putScriptAsync(PutStoredScriptRequest putStoredScriptRequest, RequestOptions options,
719+
ActionListener<PutStoredScriptResponse> listener) {
720+
restHighLevelClient.performRequestAsyncAndParseEntity(putStoredScriptRequest, RequestConverters::putScript, options,
721721
PutStoredScriptResponse::fromXContent, listener, emptySet());
722722
}
723723
}

‎client/rest-high-level/src/main/java/org/elasticsearch/client/RequestConverters.java‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -878,12 +878,15 @@ static Request getTemplates(GetIndexTemplatesRequest getIndexTemplatesRequest) t
878878
return request;
879879
}
880880

881-
static Request putStoredScript(PutStoredScriptRequest putStoredScriptRequest) throws IOException {
881+
static Request putScript(PutStoredScriptRequest putStoredScriptRequest) throws IOException {
882882
String endpoint = new EndpointBuilder().addPathPartAsIs("_scripts").addPathPart(putStoredScriptRequest.id()).build();
883883
Request request = new Request(HttpPost.METHOD_NAME, endpoint);
884884
Params params = new Params(request);
885885
params.withTimeout(putStoredScriptRequest.timeout());
886886
params.withMasterTimeout(putStoredScriptRequest.masterNodeTimeout());
887+
if(Strings.hasText(putStoredScriptRequest.context())){
888+
params.putParam("context", putStoredScriptRequest.context());
889+
}
887890
request.setEntity(createEntity(putStoredScriptRequest, REQUEST_BODY_CONTENT_TYPE));
888891
return request;
889892
}

‎client/rest-high-level/src/test/java/org/elasticsearch/client/IndicesClientIT.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1206,7 +1206,7 @@ public void testGetIndexTemplate() throws Exception {
12061206
assertThat(notFound.status(), equalTo(RestStatus.NOT_FOUND));
12071207
}
12081208

1209-
public void testPutStoredScript() throws Exception {
1209+
public void testPutScript() throws Exception {
12101210
RestHighLevelClient client = highLevelClient();
12111211
XContentType xContentType = randomFrom(XContentType.values());
12121212
PutStoredScriptRequest request = new PutStoredScriptRequest()
@@ -1223,7 +1223,7 @@ public void testPutStoredScript() throws Exception {
12231223
}
12241224

12251225
PutStoredScriptResponse response = execute(request,
1226-
client.indices()::putStoredScript, client.indices()::putStoredScriptAsync);
1226+
client.indices()::putScript, client.indices()::putScriptAsync);
12271227
assertThat(response.isAcknowledged(), equalTo(true));
12281228

12291229
Map<String, Object> script = getAsMap("/_scripts/script1");

‎client/rest-high-level/src/test/java/org/elasticsearch/client/RequestConvertersTests.java‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1935,7 +1935,14 @@ public void testPutStoredScript() throws Exception {
19351935
Map<String, String> expectedParams = new HashMap<>();
19361936
setRandomMasterTimeout(putStoredScriptRequest, expectedParams);
19371937
setRandomTimeout(putStoredScriptRequest::timeout, AcknowledgedRequest.DEFAULT_ACK_TIMEOUT, expectedParams);
1938-
Request request = RequestConverters.putStoredScript(putStoredScriptRequest);
1938+
1939+
if(randomBoolean()) {
1940+
String context = randomAlphaOfLengthBetween(5, 10);
1941+
putStoredScriptRequest.context(context);
1942+
expectedParams.put("context", context);
1943+
}
1944+
1945+
Request request = RequestConverters.putScript(putStoredScriptRequest);
19391946

19401947
assertThat(request.getEndpoint(), equalTo("/_scripts/" + id));
19411948
assertThat(request.getParameters(), equalTo(expectedParams));

‎client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/IndicesClientDocumentationIT.java‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2134,7 +2134,7 @@ public void onFailure(Exception e) {
21342134
assertTrue(latch.await(30L, TimeUnit.SECONDS));
21352135
}
21362136

2137-
public void testPutStoredScript() throws Exception {
2137+
public void testPutScript() throws Exception {
21382138
RestHighLevelClient client = highLevelClient();
21392139

21402140
{
@@ -2154,6 +2154,20 @@ public void testPutStoredScript() throws Exception {
21542154
"}\n"
21552155
), XContentType.JSON); // <2>
21562156
// end::put-stored-script-request
2157+
2158+
// tag::put-stored-script-context
2159+
request.context("context"); // <1>
2160+
// end::put-stored-script-context
2161+
2162+
// tag::put-stored-script-timeout
2163+
request.timeout(TimeValue.timeValueMinutes(2)); // <1>
2164+
request.timeout("2m"); // <2>
2165+
// end::put-stored-script-timeout
2166+
2167+
// tag::put-stored-script-masterTimeout
2168+
request.masterNodeTimeout(TimeValue.timeValueMinutes(1)); // <1>
2169+
request.masterNodeTimeout("1m"); // <2>
2170+
// end::put-stored-script-masterTimeout
21572171
}
21582172

21592173
{
@@ -2177,7 +2191,7 @@ public void testPutStoredScript() throws Exception {
21772191

21782192

21792193
// tag::put-stored-script-execute
2180-
PutStoredScriptResponse putStoredScriptResponse = client.indices().putStoredScript(request, RequestOptions.DEFAULT);
2194+
PutStoredScriptResponse putStoredScriptResponse = client.indices().putScript(request, RequestOptions.DEFAULT);
21812195
// end::put-stored-script-execute
21822196

21832197
// tag::put-stored-script-response
@@ -2206,7 +2220,7 @@ public void onFailure(Exception e) {
22062220
listener = new LatchedActionListener<>(listener, latch);
22072221

22082222
// tag::put-stored-script-execute-async
2209-
client.indices().putStoredScriptAsync(request, RequestOptions.DEFAULT, listener); // <1>
2223+
client.indices().putScriptAsync(request, RequestOptions.DEFAULT, listener); // <1>
22102224
// end::put-stored-script-execute-async
22112225

22122226
assertTrue(latch.await(30L, TimeUnit.SECONDS));
@@ -2231,12 +2245,11 @@ public void onFailure(Exception e) {
22312245
request.content(BytesReference.bytes(builder), XContentType.JSON); // <1>
22322246
// end::put-stored-script-content-mustache
22332247

2234-
client.indices().putStoredScript(request, RequestOptions.DEFAULT);
2248+
client.indices().putScript(request, RequestOptions.DEFAULT);
22352249

22362250
Map<String, Object> script = getAsMap("/_scripts/id");
22372251
assertThat(extractValue("script.lang", script), equalTo("mustache"));
22382252
assertThat(extractValue("script.source", script), equalTo("{\"query\":{\"match\":{\"title\":\"{{query_string}}\"}}}"));
22392253
}
2240-
22412254
}
22422255
}

‎docs/java-rest/high-level/indices/put_storedscript.asciidoc‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,37 @@ different ways:
2323
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-stored-script-content-painless]
2424
--------------------------------------------------
2525
<1> Specify a painless script and provided as `XContentBuilder` object.
26-
Note that the builder need to be passed as a `BytesReference` object
26+
Note that the builder needs to be passed as a `BytesReference` object
2727

2828
["source","java",subs="attributes,callouts,macros"]
2929
--------------------------------------------------
3030
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-stored-script-content-mustache]
3131
--------------------------------------------------
3232
<1> Specify a mustache script and provided as `XContentBuilder` object.
33-
Note that value of source can be direvtly provided as a JSON string
33+
Note that value of source can be directly provided as a JSON string
34+
35+
==== Optional arguments
36+
The following arguments can optionally be provided:
37+
38+
["source","java",subs="attributes,callouts,macros"]
39+
--------------------------------------------------
40+
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-stored-script-context]
41+
--------------------------------------------------
42+
<1> The context the script should be executed in.
43+
44+
["source","java",subs="attributes,callouts,macros"]
45+
--------------------------------------------------
46+
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-stored-script-timeout]
47+
--------------------------------------------------
48+
<1> Timeout to wait for the all the nodes to acknowledge the script creation as a `TimeValue`
49+
<2> Timeout to wait for the all the nodes to acknowledge the script creation as a `String`
50+
51+
["source","java",subs="attributes,callouts,macros"]
52+
--------------------------------------------------
53+
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-stored-script-masterTimeout]
54+
--------------------------------------------------
55+
<1> Timeout to connect to the master node as a `TimeValue`
56+
<2> Timeout to connect to the master node as a `String`
3457

3558
[[java-rest-high-put-stored-script-sync]]
3659
==== Synchronous Execution

‎server/src/main/java/org/elasticsearch/action/admin/cluster/storedscripts/PutStoredScriptRequest.java‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,10 +171,6 @@ public String toString() {
171171

172172
@Override
173173
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
174-
if (source == null) {
175-
source = StoredScriptSource.parse(content, xContentType);
176-
}
177-
178174
builder.field("script");
179175
source.toXContent(builder, params);
180176

0 commit comments

Comments
 (0)