Package org.opensearch.client.opensearch.snapshot

Class GetRepositoryRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.snapshot.GetRepositoryRequest

All Implemented Interfaces:

ToCopyableBuilder<GetRepositoryRequest.Builder,GetRepositoryRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class GetRepositoryRequest
extends RequestBase
implements ToCopyableBuilder<GetRepositoryRequest.Builder,GetRepositoryRequest>

Returns information about a snapshot repository.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._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
protected void	applyQueryParameters(Map<String,String> params)
static GetRepositoryRequest.Builder	builder()
final Time	clusterManagerTimeout()	The amount of time to wait for a response from the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final Boolean	local()	Whether to get information from the local node.
final Time	masterTimeout()	Deprecated.
final List<String>	name()	A comma-separated list of repository names.
static GetRepositoryRequest	of(Function<GetRepositoryRequest.Builder,ObjectBuilder<GetRepositoryRequest>> fn)
GetRepositoryRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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)

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

local

@Nullable
public final Boolean local()

Whether to get information from the local node.

API name: local

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

name

@Nonnull
public final List<String> name()

A comma-separated list of repository names.

API name: repository

toBuilder

@Nonnull
public GetRepositoryRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetRepositoryRequest.Builder,GetRepositoryRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static GetRepositoryRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object