Package org.opensearch.client.opensearch.snapshot

Class GetRepositoryRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<GetRepositoryRequest.Builder>

org.opensearch.client.opensearch.snapshot.GetRepositoryRequest.Builder

All Implemented Interfaces:

CopyableBuilder<GetRepositoryRequest.Builder,GetRepositoryRequest>, MutableBuilder<GetRepositoryRequest.Builder,GetRepositoryRequest>, ObjectBuilder<GetRepositoryRequest>

Enclosing class:

GetRepositoryRequest

public static class GetRepositoryRequest.Builder
extends RequestBase.AbstractBuilder<GetRepositoryRequest.Builder>
implements CopyableBuilder<GetRepositoryRequest.Builder,GetRepositoryRequest>

Builder for GetRepositoryRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetRepositoryRequest	build()	Builds a GetRepositoryRequest.
final GetRepositoryRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response from the cluster manager node.
final GetRepositoryRequest.Builder	clusterManagerTimeout(Time value)	The amount of time to wait for a response from the cluster manager node.
GetRepositoryRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetRepositoryRequest.Builder	local(Boolean value)	Whether to get information from the local node.
final GetRepositoryRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final GetRepositoryRequest.Builder	masterTimeout(Time value)	Deprecated.
final GetRepositoryRequest.Builder	name(String value, String... values)	A comma-separated list of repository names.
final GetRepositoryRequest.Builder	name(List<String> list)	A comma-separated list of repository names.
protected GetRepositoryRequest.Builder	self()

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public GetRepositoryRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<GetRepositoryRequest.Builder,GetRepositoryRequest>

Returns:

a new builder instance.

self

@Nonnull
protected GetRepositoryRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetRepositoryRequest.Builder>

clusterManagerTimeout

@Nonnull
public final GetRepositoryRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

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

clusterManagerTimeout

@Nonnull
public final GetRepositoryRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

@Nonnull
public final GetRepositoryRequest.Builder local(@Nullable
 Boolean value)

Whether to get information from the local node.

API name: local

masterTimeout

@Deprecated
@Nonnull
public final GetRepositoryRequest.Builder masterTimeout(@Nullable
 Time value)

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

masterTimeout

@Deprecated
@Nonnull
public final GetRepositoryRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

name

@Nonnull
public final GetRepositoryRequest.Builder name(List<String> list)

A comma-separated list of repository names.

API name: repository

Adds all elements of list to name.

name

@Nonnull
public final GetRepositoryRequest.Builder name(String value,
 String... values)

A comma-separated list of repository names.

API name: repository

Adds one or more values to name.

build

@Nonnull
public GetRepositoryRequest build()

Builds a GetRepositoryRequest.

Specified by:

build in interface ObjectBuilder<GetRepositoryRequest>

Throws:

NullPointerException - if some of the required fields are null.