Package org.opensearch.client.opensearch.cat

Class CountRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder<CountRequest.Builder>

org.opensearch.client.opensearch.cat.CountRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

CountRequest

public static class CountRequest.Builder
extends CatRequestBase.AbstractBuilder<CountRequest.Builder>
implements CopyableBuilder<CountRequest.Builder,CountRequest>

Builder for CountRequest.

Field Summary

Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, sort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CountRequest	build()	Builds a CountRequest.
CountRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CountRequest.Builder	index(String value, String... values)	Comma-separated list of data streams, indexes, and aliases used to limit the request.
final CountRequest.Builder	index(List<String> list)	Comma-separated list of data streams, indexes, and aliases used to limit the request.
protected CountRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, headers, sort, sort

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 CountRequest.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<CountRequest.Builder,CountRequest>

Returns:

a new builder instance.

self

@Nonnull
protected CountRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CountRequest.Builder>

index

@Nonnull
public final CountRequest.Builder index(List<String> list)

Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

Adds all elements of list to index.

index

@Nonnull
public final CountRequest.Builder index(String value,
 String... values)

Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

Adds one or more values to index.

build

@Nonnull
public CountRequest build()

Builds a CountRequest.

Specified by:

build in interface ObjectBuilder<CountRequest>

Throws:

NullPointerException - if some of the required fields are null.