Package co.elastic.clients.elasticsearch.snapshot

Class GetRepositoryRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.snapshot.GetRepositoryRequest

public class GetRepositoryRequest
extends RequestBase

Get snapshot repository information.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetRepositoryRequest.Builder	Builder for GetRepositoryRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetRepositoryRequest,GetRepositoryResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.get_repository".

Method Summary

Modifier and Type	Method	Description
final Boolean	local()	If true, the request gets information from the local node only.
final Time	masterTimeout()	The period to wait for the master node.
final List<String>	name()	A comma-separated list of snapshot repository names used to limit the request.
static GetRepositoryRequest	of(Function<GetRepositoryRequest.Builder,ObjectBuilder<GetRepositoryRequest>> fn)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<GetRepositoryRequest,GetRepositoryResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.get_repository".

Method Details

of

public static GetRepositoryRequest of(Function<GetRepositoryRequest.Builder,ObjectBuilder<GetRepositoryRequest>> fn)

local

@Nullable
public final Boolean local()

If true, the request gets information from the local node only. If false, the request gets information from the master node.

API name: local

masterTimeout

@Nullable
public final Time masterTimeout()

The period to wait for 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 List<String> name()

A comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported including combining wildcards with exclude patterns starting with -.

To get information about all snapshot repositories registered in the cluster, omit this parameter or use * or _all.

API name: repository