1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. getElasticsearchIngestProcessorBytes
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

elasticstack.getElasticsearchIngestProcessorBytes

Explore with Pulumi AI

elasticstack logo
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

    Helper data source to which can be used to create a processor to convert a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). If the field is an array of strings, all members of the array will be converted.

    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.

    See: https://www.elastic.co/guide/en/elasticsearch/reference/current/bytes-processor.html

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as elasticstack from "@pulumi/elasticstack";
    
    const bytes = elasticstack.getElasticsearchIngestProcessorBytes({
        field: "file.size",
    });
    const myIngestPipeline = new elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", {processors: [bytes.then(bytes => bytes.json)]});
    
    import pulumi
    import pulumi_elasticstack as elasticstack
    
    bytes = elasticstack.get_elasticsearch_ingest_processor_bytes(field="file.size")
    my_ingest_pipeline = elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", processors=[bytes.json])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		bytes, err := elasticstack.GetElasticsearchIngestProcessorBytes(ctx, &elasticstack.GetElasticsearchIngestProcessorBytesArgs{
    			Field: "file.size",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = elasticstack.NewElasticsearchIngestPipeline(ctx, "myIngestPipeline", &elasticstack.ElasticsearchIngestPipelineArgs{
    			Processors: pulumi.StringArray{
    				pulumi.String(bytes.Json),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Elasticstack = Pulumi.Elasticstack;
    
    return await Deployment.RunAsync(() => 
    {
        var bytes = Elasticstack.GetElasticsearchIngestProcessorBytes.Invoke(new()
        {
            Field = "file.size",
        });
    
        var myIngestPipeline = new Elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", new()
        {
            Processors = new[]
            {
                bytes.Apply(getElasticsearchIngestProcessorBytesResult => getElasticsearchIngestProcessorBytesResult.Json),
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.elasticstack.ElasticstackFunctions;
    import com.pulumi.elasticstack.inputs.GetElasticsearchIngestProcessorBytesArgs;
    import com.pulumi.elasticstack.ElasticsearchIngestPipeline;
    import com.pulumi.elasticstack.ElasticsearchIngestPipelineArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var bytes = ElasticstackFunctions.getElasticsearchIngestProcessorBytes(GetElasticsearchIngestProcessorBytesArgs.builder()
                .field("file.size")
                .build());
    
            var myIngestPipeline = new ElasticsearchIngestPipeline("myIngestPipeline", ElasticsearchIngestPipelineArgs.builder()
                .processors(bytes.applyValue(getElasticsearchIngestProcessorBytesResult -> getElasticsearchIngestProcessorBytesResult.json()))
                .build());
    
        }
    }
    
    resources:
      myIngestPipeline:
        type: elasticstack:ElasticsearchIngestPipeline
        properties:
          processors:
            - ${bytes.json}
    variables:
      bytes:
        fn::invoke:
          function: elasticstack:getElasticsearchIngestProcessorBytes
          arguments:
            field: file.size
    

    Using getElasticsearchIngestProcessorBytes

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getElasticsearchIngestProcessorBytes(args: GetElasticsearchIngestProcessorBytesArgs, opts?: InvokeOptions): Promise<GetElasticsearchIngestProcessorBytesResult>
    function getElasticsearchIngestProcessorBytesOutput(args: GetElasticsearchIngestProcessorBytesOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIngestProcessorBytesResult>
    def get_elasticsearch_ingest_processor_bytes(description: Optional[str] = None,
                                                 field: Optional[str] = None,
                                                 if_: Optional[str] = None,
                                                 ignore_failure: Optional[bool] = None,
                                                 ignore_missing: Optional[bool] = None,
                                                 on_failures: Optional[Sequence[str]] = None,
                                                 tag: Optional[str] = None,
                                                 target_field: Optional[str] = None,
                                                 opts: Optional[InvokeOptions] = None) -> GetElasticsearchIngestProcessorBytesResult
    def get_elasticsearch_ingest_processor_bytes_output(description: Optional[pulumi.Input[str]] = None,
                                                 field: Optional[pulumi.Input[str]] = None,
                                                 if_: Optional[pulumi.Input[str]] = None,
                                                 ignore_failure: Optional[pulumi.Input[bool]] = None,
                                                 ignore_missing: Optional[pulumi.Input[bool]] = None,
                                                 on_failures: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                                 tag: Optional[pulumi.Input[str]] = None,
                                                 target_field: Optional[pulumi.Input[str]] = None,
                                                 opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchIngestProcessorBytesResult]
    func GetElasticsearchIngestProcessorBytes(ctx *Context, args *GetElasticsearchIngestProcessorBytesArgs, opts ...InvokeOption) (*GetElasticsearchIngestProcessorBytesResult, error)
    func GetElasticsearchIngestProcessorBytesOutput(ctx *Context, args *GetElasticsearchIngestProcessorBytesOutputArgs, opts ...InvokeOption) GetElasticsearchIngestProcessorBytesResultOutput

    > Note: This function is named GetElasticsearchIngestProcessorBytes in the Go SDK.

    public static class GetElasticsearchIngestProcessorBytes 
    {
        public static Task<GetElasticsearchIngestProcessorBytesResult> InvokeAsync(GetElasticsearchIngestProcessorBytesArgs args, InvokeOptions? opts = null)
        public static Output<GetElasticsearchIngestProcessorBytesResult> Invoke(GetElasticsearchIngestProcessorBytesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetElasticsearchIngestProcessorBytesResult> getElasticsearchIngestProcessorBytes(GetElasticsearchIngestProcessorBytesArgs args, InvokeOptions options)
    public static Output<GetElasticsearchIngestProcessorBytesResult> getElasticsearchIngestProcessorBytes(GetElasticsearchIngestProcessorBytesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: elasticstack:index/getElasticsearchIngestProcessorBytes:getElasticsearchIngestProcessorBytes
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Field string
    The field to convert
    Description string
    Description of the processor.
    If string
    Conditionally execute the processor
    IgnoreFailure bool
    Ignore failures for the processor.
    IgnoreMissing bool
    If true and field does not exist or is null, the processor quietly exits without modifying the document.
    OnFailures List<string>
    Handle failures for the processor.
    Tag string
    Identifier for the processor.
    TargetField string
    The field to assign the converted value to, by default field is updated in-place
    Field string
    The field to convert
    Description string
    Description of the processor.
    If string
    Conditionally execute the processor
    IgnoreFailure bool
    Ignore failures for the processor.
    IgnoreMissing bool
    If true and field does not exist or is null, the processor quietly exits without modifying the document.
    OnFailures []string
    Handle failures for the processor.
    Tag string
    Identifier for the processor.
    TargetField string
    The field to assign the converted value to, by default field is updated in-place
    field String
    The field to convert
    description String
    Description of the processor.
    if_ String
    Conditionally execute the processor
    ignoreFailure Boolean
    Ignore failures for the processor.
    ignoreMissing Boolean
    If true and field does not exist or is null, the processor quietly exits without modifying the document.
    onFailures List<String>
    Handle failures for the processor.
    tag String
    Identifier for the processor.
    targetField String
    The field to assign the converted value to, by default field is updated in-place
    field string
    The field to convert
    description string
    Description of the processor.
    if string
    Conditionally execute the processor
    ignoreFailure boolean
    Ignore failures for the processor.
    ignoreMissing boolean
    If true and field does not exist or is null, the processor quietly exits without modifying the document.
    onFailures string[]
    Handle failures for the processor.
    tag string
    Identifier for the processor.
    targetField string
    The field to assign the converted value to, by default field is updated in-place
    field str
    The field to convert
    description str
    Description of the processor.
    if_ str
    Conditionally execute the processor
    ignore_failure bool
    Ignore failures for the processor.
    ignore_missing bool
    If true and field does not exist or is null, the processor quietly exits without modifying the document.
    on_failures Sequence[str]
    Handle failures for the processor.
    tag str
    Identifier for the processor.
    target_field str
    The field to assign the converted value to, by default field is updated in-place
    field String
    The field to convert
    description String
    Description of the processor.
    if String
    Conditionally execute the processor
    ignoreFailure Boolean
    Ignore failures for the processor.
    ignoreMissing Boolean
    If true and field does not exist or is null, the processor quietly exits without modifying the document.
    onFailures List<String>
    Handle failures for the processor.
    tag String
    Identifier for the processor.
    targetField String
    The field to assign the converted value to, by default field is updated in-place

    getElasticsearchIngestProcessorBytes Result

    The following output properties are available:

    Field string
    The field to convert
    Id string
    Internal identifier of the resource
    Json string
    JSON representation of this data source.
    Description string
    Description of the processor.
    If string
    Conditionally execute the processor
    IgnoreFailure bool
    Ignore failures for the processor.
    IgnoreMissing bool
    If true and field does not exist or is null, the processor quietly exits without modifying the document.
    OnFailures List<string>
    Handle failures for the processor.
    Tag string
    Identifier for the processor.
    TargetField string
    The field to assign the converted value to, by default field is updated in-place
    Field string
    The field to convert
    Id string
    Internal identifier of the resource
    Json string
    JSON representation of this data source.
    Description string
    Description of the processor.
    If string
    Conditionally execute the processor
    IgnoreFailure bool
    Ignore failures for the processor.
    IgnoreMissing bool
    If true and field does not exist or is null, the processor quietly exits without modifying the document.
    OnFailures []string
    Handle failures for the processor.
    Tag string
    Identifier for the processor.
    TargetField string
    The field to assign the converted value to, by default field is updated in-place
    field String
    The field to convert
    id String
    Internal identifier of the resource
    json String
    JSON representation of this data source.
    description String
    Description of the processor.
    if_ String
    Conditionally execute the processor
    ignoreFailure Boolean
    Ignore failures for the processor.
    ignoreMissing Boolean
    If true and field does not exist or is null, the processor quietly exits without modifying the document.
    onFailures List<String>
    Handle failures for the processor.
    tag String
    Identifier for the processor.
    targetField String
    The field to assign the converted value to, by default field is updated in-place
    field string
    The field to convert
    id string
    Internal identifier of the resource
    json string
    JSON representation of this data source.
    description string
    Description of the processor.
    if string
    Conditionally execute the processor
    ignoreFailure boolean
    Ignore failures for the processor.
    ignoreMissing boolean
    If true and field does not exist or is null, the processor quietly exits without modifying the document.
    onFailures string[]
    Handle failures for the processor.
    tag string
    Identifier for the processor.
    targetField string
    The field to assign the converted value to, by default field is updated in-place
    field str
    The field to convert
    id str
    Internal identifier of the resource
    json str
    JSON representation of this data source.
    description str
    Description of the processor.
    if_ str
    Conditionally execute the processor
    ignore_failure bool
    Ignore failures for the processor.
    ignore_missing bool
    If true and field does not exist or is null, the processor quietly exits without modifying the document.
    on_failures Sequence[str]
    Handle failures for the processor.
    tag str
    Identifier for the processor.
    target_field str
    The field to assign the converted value to, by default field is updated in-place
    field String
    The field to convert
    id String
    Internal identifier of the resource
    json String
    JSON representation of this data source.
    description String
    Description of the processor.
    if String
    Conditionally execute the processor
    ignoreFailure Boolean
    Ignore failures for the processor.
    ignoreMissing Boolean
    If true and field does not exist or is null, the processor quietly exits without modifying the document.
    onFailures List<String>
    Handle failures for the processor.
    tag String
    Identifier for the processor.
    targetField String
    The field to assign the converted value to, by default field is updated in-place

    Package Details

    Repository
    elasticstack elastic/terraform-provider-elasticstack
    License
    Notes
    This Pulumi package is based on the elasticstack Terraform Provider.
    elasticstack logo
    elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic