Package co.elastic.clients.elasticsearch.transform

Class ElasticsearchTransformClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchTransformClient>

co.elastic.clients.elasticsearch.transform.ElasticsearchTransformClient

public class ElasticsearchTransformClient
extends ApiClient<ElasticsearchTransport,ElasticsearchTransformClient>

Client for the transform namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchTransformClient(ElasticsearchTransport transport)
ElasticsearchTransformClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
DeleteTransformResponse	deleteTransform(DeleteTransformRequest request)	Deletes an existing transform.
final DeleteTransformResponse	deleteTransform(Function<DeleteTransformRequest.Builder,ObjectBuilder<DeleteTransformRequest>> fn)	Deletes an existing transform.
GetTransformResponse	getTransform()	Retrieves configuration information for transforms.
GetTransformResponse	getTransform(GetTransformRequest request)	Retrieves configuration information for transforms.
final GetTransformResponse	getTransform(Function<GetTransformRequest.Builder,ObjectBuilder<GetTransformRequest>> fn)	Retrieves configuration information for transforms.
GetTransformStatsResponse	getTransformStats(GetTransformStatsRequest request)	Retrieves usage information for transforms.
final GetTransformStatsResponse	getTransformStats(Function<GetTransformStatsRequest.Builder,ObjectBuilder<GetTransformStatsRequest>> fn)	Retrieves usage information for transforms.
<TTransform> PreviewTransformResponse<TTransform>	previewTransform(PreviewTransformRequest request, Class<TTransform> tTransformClass)	Previews a transform.
<TTransform> PreviewTransformResponse<TTransform>	previewTransform(PreviewTransformRequest request, Type tTransformType)	Previews a transform.
final <TTransform> PreviewTransformResponse<TTransform>	previewTransform(Function<PreviewTransformRequest.Builder,ObjectBuilder<PreviewTransformRequest>> fn, Class<TTransform> tTransformClass)	Previews a transform.
final <TTransform> PreviewTransformResponse<TTransform>	previewTransform(Function<PreviewTransformRequest.Builder,ObjectBuilder<PreviewTransformRequest>> fn, Type tTransformType)	Previews a transform.
PutTransformResponse	putTransform(PutTransformRequest request)	Instantiates a transform.
final PutTransformResponse	putTransform(Function<PutTransformRequest.Builder,ObjectBuilder<PutTransformRequest>> fn)	Instantiates a transform.
ResetTransformResponse	resetTransform(ResetTransformRequest request)	Resets an existing transform.
final ResetTransformResponse	resetTransform(Function<ResetTransformRequest.Builder,ObjectBuilder<ResetTransformRequest>> fn)	Resets an existing transform.
StartTransformResponse	startTransform(StartTransformRequest request)	Starts one or more transforms.
final StartTransformResponse	startTransform(Function<StartTransformRequest.Builder,ObjectBuilder<StartTransformRequest>> fn)	Starts one or more transforms.
StopTransformResponse	stopTransform(StopTransformRequest request)	Stops one or more transforms.
final StopTransformResponse	stopTransform(Function<StopTransformRequest.Builder,ObjectBuilder<StopTransformRequest>> fn)	Stops one or more transforms.
UpdateTransformResponse	updateTransform(UpdateTransformRequest request)	Updates certain properties of a transform.
final UpdateTransformResponse	updateTransform(Function<UpdateTransformRequest.Builder,ObjectBuilder<UpdateTransformRequest>> fn)	Updates certain properties of a transform.
UpgradeTransformsResponse	upgradeTransforms()	Upgrades all transforms.
UpgradeTransformsResponse	upgradeTransforms(UpgradeTransformsRequest request)	Upgrades all transforms.
final UpgradeTransformsResponse	upgradeTransforms(Function<UpgradeTransformsRequest.Builder,ObjectBuilder<UpgradeTransformsRequest>> fn)	Upgrades all transforms.
ElasticsearchTransformClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ElasticsearchTransformClient

public ElasticsearchTransformClient(ElasticsearchTransport transport)

ElasticsearchTransformClient

public ElasticsearchTransformClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchTransformClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchTransformClient>

deleteTransform

public DeleteTransformResponse deleteTransform(DeleteTransformRequest request)
                                        throws IOException,
ElasticsearchException

Deletes an existing transform.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteTransform

public final DeleteTransformResponse deleteTransform(Function<DeleteTransformRequest.Builder,ObjectBuilder<DeleteTransformRequest>> fn)
                                              throws IOException,
ElasticsearchException

Deletes an existing transform.

Parameters:

fn - a function that initializes a builder to create the DeleteTransformRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTransform

public GetTransformResponse getTransform(GetTransformRequest request)
                                  throws IOException,
ElasticsearchException

Retrieves configuration information for transforms.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTransform

public final GetTransformResponse getTransform(Function<GetTransformRequest.Builder,ObjectBuilder<GetTransformRequest>> fn)
                                        throws IOException,
ElasticsearchException

Retrieves configuration information for transforms.

Parameters:

fn - a function that initializes a builder to create the GetTransformRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTransform

public GetTransformResponse getTransform()
                                  throws IOException,
ElasticsearchException

Retrieves configuration information for transforms.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTransformStats

public GetTransformStatsResponse getTransformStats(GetTransformStatsRequest request)
                                            throws IOException,
ElasticsearchException

Retrieves usage information for transforms.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTransformStats

public final GetTransformStatsResponse getTransformStats(Function<GetTransformStatsRequest.Builder,ObjectBuilder<GetTransformStatsRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Retrieves usage information for transforms.

Parameters:

fn - a function that initializes a builder to create the GetTransformStatsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

previewTransform

public <TTransform>
PreviewTransformResponse<TTransform> previewTransform(PreviewTransformRequest request,
 Class<TTransform> tTransformClass)
                                               throws IOException,
ElasticsearchException

Previews a transform.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

previewTransform

public final <TTransform>
PreviewTransformResponse<TTransform> previewTransform(Function<PreviewTransformRequest.Builder,ObjectBuilder<PreviewTransformRequest>> fn,
 Class<TTransform> tTransformClass)
                                               throws IOException,
ElasticsearchException

Previews a transform.

Parameters:

fn - a function that initializes a builder to create the PreviewTransformRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

previewTransform

public <TTransform>
PreviewTransformResponse<TTransform> previewTransform(PreviewTransformRequest request,
 Type tTransformType)
                                               throws IOException,
ElasticsearchException

Previews a transform.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

previewTransform

public final <TTransform>
PreviewTransformResponse<TTransform> previewTransform(Function<PreviewTransformRequest.Builder,ObjectBuilder<PreviewTransformRequest>> fn,
 Type tTransformType)
                                               throws IOException,
ElasticsearchException

Previews a transform.

Parameters:

fn - a function that initializes a builder to create the PreviewTransformRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTransform

public PutTransformResponse putTransform(PutTransformRequest request)
                                  throws IOException,
ElasticsearchException

Instantiates a transform.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTransform

public final PutTransformResponse putTransform(Function<PutTransformRequest.Builder,ObjectBuilder<PutTransformRequest>> fn)
                                        throws IOException,
ElasticsearchException

Instantiates a transform.

Parameters:

fn - a function that initializes a builder to create the PutTransformRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resetTransform

public ResetTransformResponse resetTransform(ResetTransformRequest request)
                                      throws IOException,
ElasticsearchException

Resets an existing transform.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resetTransform

public final ResetTransformResponse resetTransform(Function<ResetTransformRequest.Builder,ObjectBuilder<ResetTransformRequest>> fn)
                                            throws IOException,
ElasticsearchException

Resets an existing transform.

Parameters:

fn - a function that initializes a builder to create the ResetTransformRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

startTransform

public StartTransformResponse startTransform(StartTransformRequest request)
                                      throws IOException,
ElasticsearchException

Starts one or more transforms.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

startTransform

public final StartTransformResponse startTransform(Function<StartTransformRequest.Builder,ObjectBuilder<StartTransformRequest>> fn)
                                            throws IOException,
ElasticsearchException

Starts one or more transforms.

Parameters:

fn - a function that initializes a builder to create the StartTransformRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stopTransform

public StopTransformResponse stopTransform(StopTransformRequest request)
                                    throws IOException,
ElasticsearchException

Stops one or more transforms.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stopTransform

public final StopTransformResponse stopTransform(Function<StopTransformRequest.Builder,ObjectBuilder<StopTransformRequest>> fn)
                                          throws IOException,
ElasticsearchException

Stops one or more transforms.

Parameters:

fn - a function that initializes a builder to create the StopTransformRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateTransform

public UpdateTransformResponse updateTransform(UpdateTransformRequest request)
                                        throws IOException,
ElasticsearchException

Updates certain properties of a transform.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateTransform

public final UpdateTransformResponse updateTransform(Function<UpdateTransformRequest.Builder,ObjectBuilder<UpdateTransformRequest>> fn)
                                              throws IOException,
ElasticsearchException

Updates certain properties of a transform.

Parameters:

fn - a function that initializes a builder to create the UpdateTransformRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

upgradeTransforms

public UpgradeTransformsResponse upgradeTransforms(UpgradeTransformsRequest request)
                                            throws IOException,
ElasticsearchException

Upgrades all transforms.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

upgradeTransforms

public final UpgradeTransformsResponse upgradeTransforms(Function<UpgradeTransformsRequest.Builder,ObjectBuilder<UpgradeTransformsRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Upgrades all transforms.

Parameters:

fn - a function that initializes a builder to create the UpgradeTransformsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

upgradeTransforms

public UpgradeTransformsResponse upgradeTransforms()
                                            throws IOException,
ElasticsearchException

Upgrades all transforms.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co