Java high-level REST client completeness for xpack APIs #29827

elasticmachine · 2017-11-02T17:37:40Z

Original comment by @javanna:

This is the xpack side of #27205 . This is a meta issue to track completeness of the Java REST high-level Client in terms of supported xpack API. The following list includes all the REST API that xpack exposes to date, and that are also exposed by the Transport Client. The ones marked as done are already supported by the high-level REST client, while the others need to be added. Every group is sorted based on an estimation around how important the API is, from more important to less important. Each API is also assigned a rank from 1 to 3 that expresses how difficult adding support for it is expected to be.

Please Note The existing actions are in x-pack/ which is governed by the Elastic License, not the Apache License. Engineers who take these should strive to pull the Actions into Apache License controlled territory, so the high level rest client does not use any Elastic License bits. These should live in x-pack/protocol, which is OSS.

Please also note The APIs themselves should follow the spec for how they are named. This means they should be in the XPackClient, not the HighLevelRestClient. This would mean you end up with hlRestClient.xpack().watcher() as an example

Please Please also also note Prepend your commit msgs with HLRC:

Watcher API

Machine Learning API

Machine Learning REST only API

delete expired data * @edsavage [HLRC][ML] Add delete expired data API #35906

Security API

Security REST only API

authenticate * (highest prio) HLRest: add security authenticate API #33552 @albertzaharovits

Miscellaneous API

xpack info * HLREST: Add x-pack-info API #31870 @nik9000
xpack usage ** HLRC: Add xpack usage api #31975 @rjernst

Graph API

graph explore *** GraphClient for the high level REST client and associated tests #32366 @markharwood

Licensing API

put license ** Rest HL client: Add put license action #32214 @imotov
get license ** @imotov
delete license * HLRC: Add Delete License API #32586 @ywelsch
post start trial * add start trial API to HLRC #33406 @andyb-elastic
get trial status * HLRC: add support for get license basic/trial status API #33176 @javanna
post start basic * HLRC: Add support for XPack Post Start Basic Licence API #33606 @vladimirdolzhenko
get basic status * HLRC: add support for get license basic/trial status API #33176 @javanna

Rollup

Create Job Add create rollup job api to high level rest client #33521 @tlrx
Delete Job Add delete rollup job support to HL REST Client #34066 @pcsanwald
Start Job Add start rollup job support to HL REST Client #34623 (@cbuescher)
Stop Job Add stop rollup job support to HL REST Client #34702 (@cbuescher)
Get Job * HLRC: Add get rollup job #33921 (@nik9000)
Get Rollup Capabilities Add GetRollupCaps API to high level rest client #32880 (@polyfractal)
Get Rollup Index Capabilities [HLRC] Add GetRollupIndexCaps API #35102 * (@polyfractal)
Rollup Search ** HLRC: Add rollup search #36334 (@nik9000)

Migration

get Migration Assistance * HLRC: migration get assistance API #32744 @javanna
upgrade Migration ** HLRC: migration api - upgrade #34898 @pgomulka
get Deprecation Info * HLRC: Get Deprecation Info API #36279 @hub-cap

Monitoring API

~~monitoring bulk~~

Index Lifecycle Management

See #33100

CCR

See #33824

The text was updated successfully, but these errors were encountered:

elasticmachine · 2017-11-02T17:43:39Z

Original comment by @pickypg:

The _xpack/monitoring/_bulk API is not intended to be supported by outside clients. Its use is only meant for Kibana, Beats, APM Server, and Logstash.

Ideally we will even be removing it once we get to Metricbeat-based monitoring data.

elasticmachine · 2017-11-02T17:47:29Z

Original comment by @javanna:

thanks for clarifying @pickypg !

elasticmachine · 2017-11-07T06:51:56Z

Original comment by @tvernum:

@javanna What does

Security Transport Client only API

mean - is that intending to say that there is no REST interface, in which case has privileges is handled by rest action RestHasPrivilegesAction

elasticmachine · 2017-11-07T08:01:12Z

Original comment by @javanna:

@tvernum I couldn't find the corresponding REST action for some reason. I am going to edit the description and move has privileges with the other API.

elasticmachine · 2017-11-07T13:51:08Z

Original comment by @javanna:

I updated the description of the issue by assigning each API a rank from 1 to 3 based on how difficult it should be to add support for it to the high-level REST client. Criterias were mainly how big the request is to serialize and how big the response is to parse back.

elasticmachine · 2017-12-07T04:54:13Z

Original comment by @tvernum:

@javanna Did you have a plan about how we'd ship an X-Pack enabled client?
From the javadocs on the existing OSS client, it seems like the best course of action is a single

public class RestXPackClient extends RestHighLevelClient {

But there's options to have separate clients per feature (I can't see a reason to do that) or to take the same approach as the current SecurityClient and wrap rather than extend the RestHighLevelClient.

elasticmachine · 2017-12-07T08:38:45Z

Original comment by @javanna:

@tvernum I envisioned extending like you mentioned above, wrapping is an option too though. I don't have a strong opinion, we should give it a try and see how things look.

The `:x-pack:protocol` project is an implementation detail shared by the xpack projects and the high level rest client and really doesn't deserve its own maven coordinants and published javadoc. This change bundles `:x-pack:protocol` into the high level rest client. Relates to elastic#29827

nik9000 · 2018-07-09T17:23:03Z

One down!

The `:x-pack:protocol` project is an implementation detail shared by the xpack projects and the high level rest client and really doesn't deserve its own maven coordinants and published javadoc. This change bundles `:x-pack:protocol` into the high level rest client. Relates to #29827

Relates elastic#29827

@hub-cap

Relates #29827 This implementation behaves like the current transport client, that you basically cannot configure a Watch POJO representation as an argument to the put watch API, but only a bytes reference. You can use the the `WatchSourceBuilder` from the `org.elasticsearch.plugin:x-pack-core` dependency to build watches. This commit also changes the license type to trial, so that watcher is available in high level rest client tests. /cc @hub-cap

Relates elastic#29827 This implementation behaves like the current transport client, that you basically cannot configure a Watch POJO representation as an argument to the put watch API, but only a bytes reference. You can use the the `WatchSourceBuilder` from the `org.elasticsearch.plugin:x-pack-core` dependency to build watches. This commit also changes the license type to trial, so that watcher is available in high level rest client tests.

Relates elastic#29827

Relates #29827 This implementation behaves like the current transport client, that you basically cannot configure a Watch POJO representation as an argument to the put watch API, but only a bytes reference. You can use the the `WatchSourceBuilder` from the `org.elasticsearch.plugin:x-pack-core` dependency to build watches. This commit also changes the license type to trial, so that watcher is available in high level rest client tests.

This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, the request and response classes were moved to the x-pack protocol project and licensed under the Apache 2 license. The PutUserRequest previously performed some validation of the username that really is more fitting for the server validation. This validation has been removed to reduce the amount of logic on the client side and also reduce the number of classes that would need to be moved to the protocol project. The removed validation now happens in the transport action. See elastic#29827

This commits adds support for the Get Application Privileges API to the HLRC Relates: #29827

Relates to elastic#29827

Relates to #29827

This commits adds support for the Get Roles API to the HLRC Relates: #29827

Relates to elastic#29827

Relates to #29827

* HLRC: Add delete user action It adds delete user action to the high level rest client. Relates #29827

This commit adds the Get Deprecation Info API and associated documentation. Relates elastic#29827

Relates to elastic#29827

This commit adds the Get Deprecation Info API and associated documentation. Relates #29827

This commit adds the Get Deprecation Info API and associated documentation. Note: This commit is different from master as it adds back the _xpack portion of the API. Relates #29827

Relates to #29827

elasticmachine added :Core/Java High Level REST Client Meta labels Apr 25, 2018

nik9000 changed the title ~~Java high-level REST client completeness~~ Java high-level REST client completeness for xpack APIs May 9, 2018

javanna mentioned this issue Jun 13, 2018

Java high-level REST client completeness #27205

Closed

80 tasks

hub-cap mentioned this issue Jul 3, 2018

Watcher: Remove cron eval CLI tool in favor of API endpoint #31685

Closed

nik9000 mentioned this issue Jul 9, 2018

HLREST: Bundle the x-pack protocol project #31904

Merged

spinscale added a commit to spinscale/elasticsearch that referenced this issue Jul 13, 2018

Rest HL client: Add put watch action

b23d5eb

Relates elastic#29827

spinscale mentioned this issue Jul 13, 2018

Rest HL client: Add put watch action #32026

Merged

spinscale mentioned this issue Jul 19, 2018

Rest HL client: Add put watch action (#32026) #32191

Merged

imotov added a commit to imotov/elasticsearch that referenced this issue Jul 19, 2018

Rest HL client: Add put license action

da77fc5

Relates elastic#29827

imotov mentioned this issue Jul 19, 2018

Rest HL client: Add put license action #32214

Merged

jkakavas added a commit that referenced this issue Nov 21, 2018

[HLRC] Add support for get application privileges API (#35556)

25f83ae

This commits adds support for the Get Application Privileges API to the HLRC Relates: #29827

jkakavas added a commit that referenced this issue Nov 21, 2018

[HLRC] Add support for get application privileges API (#35556)

cedd02b

This commits adds support for the Get Application Privileges API to the HLRC Relates: #29827

droberts195 added a commit to droberts195/elasticsearch that referenced this issue Nov 22, 2018

[HLRC][ML] Add ML find file structure API

b43d3a5

Relates to elastic#29827

droberts195 mentioned this issue Nov 22, 2018

[HLRC][ML] Add ML find file structure API #35833

Merged

droberts195 added a commit that referenced this issue Nov 23, 2018

[HLRC][ML] Add ML find file structure API (#35833)

3c059ee

Relates to #29827

droberts195 added a commit that referenced this issue Nov 23, 2018

[HLRC][ML] Add ML find file structure API (#35833)

c011a1f

Relates to #29827

original-brownbear pushed a commit that referenced this issue Nov 23, 2018

[HLRC][ML] Add ML find file structure API (#35833)

d0b5006

Relates to #29827

romseygeek mentioned this issue Nov 23, 2018

HLRC: execute watch API #35868

Merged

jkakavas added a commit that referenced this issue Nov 26, 2018

[HLRC] Add support for get roles API (#35787)

8daa854

This commits adds support for the Get Roles API to the HLRC Relates: #29827

jkakavas added a commit that referenced this issue Nov 26, 2018

[HLRC] Add support for get roles API (#35787)

fa04714

This commits adds support for the Get Roles API to the HLRC Relates: #29827

edsavage added a commit to edsavage/elasticsearch that referenced this issue Nov 26, 2018

[HLRC][ML] Add delete expired data API

3d71bf6

Relates to elastic#29827

edsavage mentioned this issue Nov 26, 2018

[HLRC][ML] Add delete expired data API #35906

Merged

edsavage added a commit that referenced this issue Nov 26, 2018

[HLRC][ML] Add delete expired data API (#35906)

13e1196

Relates to #29827

edsavage added a commit that referenced this issue Nov 26, 2018

[HLRC][ML] Add delete expired data API (#35906)

13c76ef

Relates to #29827

droberts195 pushed a commit that referenced this issue Nov 28, 2018

[HLRC] XPack ML info action (#35777)

f0c5f0c

Relates to #29827

droberts195 pushed a commit that referenced this issue Nov 28, 2018

[HLRC] XPack ML info action (#35777)

2a41c9f

Relates to #29827

iverase added a commit that referenced this issue Nov 29, 2018

HLRC: Add delete user action (#35294)

93ed8b7

* HLRC: Add delete user action It adds delete user action to the high level rest client. Relates #29827

iverase added a commit that referenced this issue Nov 29, 2018

HLRC: Add delete user action (#35294)

f57e429

* HLRC: Add delete user action It adds delete user action to the high level rest client. Relates #29827

albertzaharovits mentioned this issue Dec 4, 2018

[HLRC] Put Role #36209

Merged

hub-cap added a commit to hub-cap/elasticsearch that referenced this issue Dec 5, 2018

HLRC: Get Deprecation Info API

c12227c

This commit adds the Get Deprecation Info API and associated documentation. Relates elastic#29827

hub-cap mentioned this issue Dec 5, 2018

HLRC: Get Deprecation Info API #36279

Merged

nknize mentioned this issue Dec 6, 2018

HLRC: Add get users action #36332

Merged

nik9000 added a commit to nik9000/elasticsearch that referenced this issue Dec 6, 2018

HLRC: Add rollup search

fb6edda

Relates to elastic#29827

nik9000 mentioned this issue Dec 6, 2018

HLRC: Add rollup search #36334

Merged

hub-cap added a commit that referenced this issue Dec 7, 2018

HLRC: Get Deprecation Info API (#36279)

ca09936

This commit adds the Get Deprecation Info API and associated documentation. Relates #29827

hub-cap added a commit that referenced this issue Dec 7, 2018

HLRC: Get Deprecation Info API (#36279)

0a4f203

This commit adds the Get Deprecation Info API and associated documentation. Note: This commit is different from master as it adds back the _xpack portion of the API. Relates #29827

nik9000 added a commit that referenced this issue Dec 7, 2018

HLRC: Add rollup search (#36334)

ead2b9e

Relates to #29827

nik9000 added a commit that referenced this issue Dec 8, 2018

HLRC: Add rollup search (#36334)

51feb42

Relates to #29827

hub-cap closed this as completed Apr 15, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Java high-level REST client completeness for xpack APIs #29827

Java high-level REST client completeness for xpack APIs #29827

elasticmachine commented Nov 2, 2017 •

edited by nknize

Loading

elasticmachine commented Nov 2, 2017

elasticmachine commented Nov 2, 2017

elasticmachine commented Nov 7, 2017

elasticmachine commented Nov 7, 2017

elasticmachine commented Nov 7, 2017

elasticmachine commented Dec 7, 2017

elasticmachine commented Dec 7, 2017

nik9000 commented Jul 9, 2018

Java high-level REST client completeness for xpack APIs #29827

Java high-level REST client completeness for xpack APIs #29827

Comments

elasticmachine commented Nov 2, 2017 • edited by nknize Loading

Watcher API

Machine Learning API

Machine Learning REST only API

Security API

Security REST only API

Miscellaneous API

Graph API

Licensing API

Rollup

Migration

Monitoring API

Index Lifecycle Management

CCR

elasticmachine commented Nov 2, 2017

elasticmachine commented Nov 2, 2017

elasticmachine commented Nov 7, 2017

elasticmachine commented Nov 7, 2017

elasticmachine commented Nov 7, 2017

elasticmachine commented Dec 7, 2017

elasticmachine commented Dec 7, 2017

nik9000 commented Jul 9, 2018

elasticmachine commented Nov 2, 2017 •

edited by nknize

Loading