Class AddIndexBlockRequest

A request to the indices add block API

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

Constructors

| Edit this page View Source

AddIndexBlockRequest()

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

Declaration
protected AddIndexBlockRequest()
| Edit this page View Source

AddIndexBlockRequest(Indices, IndexBlock)

/{index}/_block/{block}

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

this parameter is required
IndexBlock block

this parameter is required

Properties

| Edit this page View Source

AllowNoIndices

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 bool? AllowNoIndices { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type Description
Time
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

ExpandWildcards

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

Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type Description
ExpandWildcards?
| Edit this page View Source

IgnoreUnavailable

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

Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

MasterTimeout

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 Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Self

Declaration
protected IAddIndexBlockRequest Self { get; }
Property Value
Type Description
IAddIndexBlockRequest
| Edit this page View Source

Timeout

Explicit operation timeout.

Declaration
public Time Timeout { get; set; }
Property Value
Type Description
Time

Implements

Extension Methods