Class AddIndexBlockDescriptor

A request to the indices add block API

Inheritance
object
RequestBase<AddIndexBlockRequestParameters>
RequestDescriptorBase<AddIndexBlockDescriptor, AddIndexBlockRequestParameters, IAddIndexBlockRequest>
AddIndexBlockDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class AddIndexBlockDescriptor : RequestDescriptorBase<AddIndexBlockDescriptor, AddIndexBlockRequestParameters, IAddIndexBlockRequest>, IDescriptor, IAddIndexBlockRequest, IRequest<AddIndexBlockRequestParameters>, IRequest

Constructors

| Edit this page View Source

AddIndexBlockDescriptor()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected AddIndexBlockDescriptor()
| Edit this page View Source

AddIndexBlockDescriptor(Indices, IndexBlock)

/{index}/_block/{block}

Declaration
public AddIndexBlockDescriptor(Indices index, IndexBlock block)
Parameters
Type Name Description
Indices index

this parameter is required
IndexBlock block

this parameter is required

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public AddIndexBlockDescriptor AllIndices()
Returns
Type Description
AddIndexBlockDescriptor
| Edit this page View Source

AllowNoIndices(bool?)

Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all string or when no indexes have been specified).

Declaration
public AddIndexBlockDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
AddIndexBlockDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public AddIndexBlockDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
AddIndexBlockDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

ExpandWildcards(ExpandWildcards?)

Whether to expand wildcard expression to concrete indexes that are open, closed or both.

Declaration
public AddIndexBlockDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
AddIndexBlockDescriptor
| Edit this page View Source

IgnoreUnavailable(bool?)

Whether specified concrete indexes should be ignored when unavailable (missing or closed).

Declaration
public AddIndexBlockDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
AddIndexBlockDescriptor
| Edit this page View Source

Index(Indices)

A comma separated list of indexes to add a block to.

Declaration
public AddIndexBlockDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
AddIndexBlockDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public AddIndexBlockDescriptor Index<TOther>() where TOther : class
Returns
Type Description
AddIndexBlockDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

MasterTimeout(Time)

Specify timeout for connection to cluster manager.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public AddIndexBlockDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
AddIndexBlockDescriptor
| Edit this page View Source

Timeout(Time)

Explicit operation timeout.

Declaration
public AddIndexBlockDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
AddIndexBlockDescriptor

Implements

Extension Methods