Search Results for

    Show / Hide Table of Contents

    Class BytesProcessorDescriptor<T>

    Converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63.

    Inheritance
    object
    DescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>
    ProcessorDescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>
    BytesProcessorDescriptor<T>
    Implements
    IDescriptor
    IBytesProcessor
    IProcessor
    Inherited Members
    ProcessorDescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>.Name
    ProcessorDescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>.Description(string)
    ProcessorDescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>.OnFailure(IEnumerable<IProcessor>)
    ProcessorDescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>.OnFailure(Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>>)
    ProcessorDescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>.If(string)
    ProcessorDescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>.Tag(string)
    ProcessorDescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>.IgnoreFailure(bool?)
    DescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>.Self
    DescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>.Assign<TValue>(TValue, Action<IBytesProcessor, TValue>)
    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 BytesProcessorDescriptor<T> : ProcessorDescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>, IDescriptor, IBytesProcessor, IProcessor where T : class
    Type Parameters
    Name Description
    T

    Properties

    | Edit this page View Source

    Name

    Declaration
    protected override string Name { get; }
    Property Value
    Type Description
    string
    Overrides
    ProcessorDescriptorBase<BytesProcessorDescriptor<T>, IBytesProcessor>.Name

    Methods

    | Edit this page View Source

    Field(Field)

    The field to convert bytes from

    Declaration
    public BytesProcessorDescriptor<T> Field(Field field)
    Parameters
    Type Name Description
    Field field
    Returns
    Type Description
    BytesProcessorDescriptor<T>
    | Edit this page View Source

    Field<TValue>(Expression<Func<T, TValue>>)

    The field to convert bytes from

    Declaration
    public BytesProcessorDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> objectPath)
    Parameters
    Type Name Description
    Expression<Func<T, TValue>> objectPath
    Returns
    Type Description
    BytesProcessorDescriptor<T>
    Type Parameters
    Name Description
    TValue
    | Edit this page View Source

    IgnoreMissing(bool?)

    If true and Field does not exist or is null, the processor quietly exits without modifying the document. Default is false

    Declaration
    public BytesProcessorDescriptor<T> IgnoreMissing(bool? ignoreMissing = true)
    Parameters
    Type Name Description
    bool? ignoreMissing
    Returns
    Type Description
    BytesProcessorDescriptor<T>
    | Edit this page View Source

    TargetField(Field)

    The field to assign the converted value to, by default Field is updated in-place

    Declaration
    public BytesProcessorDescriptor<T> TargetField(Field field)
    Parameters
    Type Name Description
    Field field
    Returns
    Type Description
    BytesProcessorDescriptor<T>
    | Edit this page View Source

    TargetField<TValue>(Expression<Func<T, TValue>>)

    The field to assign the converted value to, by default Field is updated in-place

    Declaration
    public BytesProcessorDescriptor<T> TargetField<TValue>(Expression<Func<T, TValue>> objectPath)
    Parameters
    Type Name Description
    Expression<Func<T, TValue>> objectPath
    Returns
    Type Description
    BytesProcessorDescriptor<T>
    Type Parameters
    Name Description
    TValue

    Implements

    IDescriptor
    IBytesProcessor
    IProcessor

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Name
    • Methods
      • Field(Field)
      • Field<TValue>(Expression<Func<T, TValue>>)
      • IgnoreMissing(bool?)
      • TargetField(Field)
      • TargetField<TValue>(Expression<Func<T, TValue>>)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX