Package co.elastic.clients.elasticsearch.snapshot

Class CleanupRepositoryRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<CleanupRepositoryRequest.Builder>

co.elastic.clients.elasticsearch.snapshot.CleanupRepositoryRequest.Builder

All Implemented Interfaces:

WithJson<CleanupRepositoryRequest.Builder>, ObjectBuilder<CleanupRepositoryRequest>

Enclosing class:

CleanupRepositoryRequest

public static class CleanupRepositoryRequest.Builder
extends RequestBase.AbstractBuilder<CleanupRepositoryRequest.Builder>
implements ObjectBuilder<CleanupRepositoryRequest>

Builder for CleanupRepositoryRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CleanupRepositoryRequest	build()	Builds a CleanupRepositoryRequest.
final CleanupRepositoryRequest.Builder	masterTimeout(Time value)	The period to wait for a connection to the master node.
final CleanupRepositoryRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for a connection to the master node.
final CleanupRepositoryRequest.Builder	name(String value)	Required - The name of the snapshot repository to clean up.
protected CleanupRepositoryRequest.Builder	self()
final CleanupRepositoryRequest.Builder	timeout(Time value)	The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
final CleanupRepositoryRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

masterTimeout

public final CleanupRepositoryRequest.Builder masterTimeout(@Nullable
 Time value)

The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1

API name: master_timeout

masterTimeout

public final CleanupRepositoryRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1

API name: master_timeout

name

public final CleanupRepositoryRequest.Builder name(String value)

Required - The name of the snapshot repository to clean up.

API name: repository

timeout

public final CleanupRepositoryRequest.Builder timeout(@Nullable
 Time value)

The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to -1.

API name: timeout

timeout

public final CleanupRepositoryRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to -1.

API name: timeout

self

protected CleanupRepositoryRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CleanupRepositoryRequest.Builder>

build

public CleanupRepositoryRequest build()

Builds a CleanupRepositoryRequest.

Specified by:

build in interface ObjectBuilder<CleanupRepositoryRequest>

Throws:

NullPointerException - if some of the required fields are null.