Search Results for

    Show / Hide Table of Contents

    Class TypeExistsDescriptor

    Descriptor for TypeExists

    https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/

    Inheritance
    object
    RequestBase<TypeExistsRequestParameters>
    RequestDescriptorBase<TypeExistsDescriptor, TypeExistsRequestParameters, ITypeExistsRequest>
    TypeExistsDescriptor
    Implements
    IDescriptor
    ITypeExistsRequest
    IRequest<TypeExistsRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<TypeExistsDescriptor, TypeExistsRequestParameters, ITypeExistsRequest>.Self
    RequestDescriptorBase<TypeExistsDescriptor, TypeExistsRequestParameters, ITypeExistsRequest>.Assign<TValue>(TValue, Action<ITypeExistsRequest, TValue>)
    RequestDescriptorBase<TypeExistsDescriptor, TypeExistsRequestParameters, ITypeExistsRequest>.Qs(string, object)
    RequestDescriptorBase<TypeExistsDescriptor, TypeExistsRequestParameters, ITypeExistsRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<TypeExistsDescriptor, TypeExistsRequestParameters, ITypeExistsRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<TypeExistsDescriptor, TypeExistsRequestParameters, ITypeExistsRequest>.FilterPath(params string[])
    RequestDescriptorBase<TypeExistsDescriptor, TypeExistsRequestParameters, ITypeExistsRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<TypeExistsDescriptor, TypeExistsRequestParameters, ITypeExistsRequest>.Human(bool?)
    RequestDescriptorBase<TypeExistsDescriptor, TypeExistsRequestParameters, ITypeExistsRequest>.Pretty(bool?)
    RequestDescriptorBase<TypeExistsDescriptor, TypeExistsRequestParameters, ITypeExistsRequest>.SourceQueryString(string)
    RequestBase<TypeExistsRequestParameters>.HttpMethod
    RequestBase<TypeExistsRequestParameters>.RequestState
    RequestBase<TypeExistsRequestParameters>.ContentType
    RequestBase<TypeExistsRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<TypeExistsRequestParameters>.RequestDefaults(TypeExistsRequestParameters)
    RequestBase<TypeExistsRequestParameters>.Q<TOut>(string)
    RequestBase<TypeExistsRequestParameters>.Q(string, object)
    RequestBase<TypeExistsRequestParameters>.SetAcceptHeader(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class TypeExistsDescriptor : RequestDescriptorBase<TypeExistsDescriptor, TypeExistsRequestParameters, ITypeExistsRequest>, IDescriptor, ITypeExistsRequest, IRequest<TypeExistsRequestParameters>, IRequest
    Remarks

    Deprecated as of OpenSearch 2.0

    Constructors

    | Edit this page View Source

    TypeExistsDescriptor()

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

    Declaration
    protected TypeExistsDescriptor()
    | Edit this page View Source

    TypeExistsDescriptor(Indices, Names)

    /{index}/_mapping/{type}

    Declaration
    public TypeExistsDescriptor(Indices index, Names type)
    Parameters
    Type Name Description
    Indices index

    this parameter is required

    Names type

    this parameter is required

    Methods

    | Edit this page View Source

    AllIndices()

    A shortcut into calling Index(Indices.All)

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

    AllowNoIndices(bool?)

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

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

    ExpandWildcards(ExpandWildcards?)

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

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

    IgnoreUnavailable(bool?)

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

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

    Index(Indices)

    A comma-separated list of index names; use _all to check the types across all indices

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

    Index<TOther>()

    a shortcut into calling Index(typeof(TOther))

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

    Local(bool?)

    Return local information, do not retrieve the state from cluster_manager node (default: false)

    Declaration
    public TypeExistsDescriptor Local(bool? local = true)
    Parameters
    Type Name Description
    bool? local
    Returns
    Type Description
    TypeExistsDescriptor

    Implements

    IDescriptor
    ITypeExistsRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • TypeExistsDescriptor()
      • TypeExistsDescriptor(Indices, Names)
    • Methods
      • AllIndices()
      • AllowNoIndices(bool?)
      • ExpandWildcards(ExpandWildcards?)
      • IgnoreUnavailable(bool?)
      • Index(Indices)
      • Index<TOther>()
      • Local(bool?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX