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

elasticstack.getElasticsearchIngestProcessorTrim

Explore with Pulumi AI

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

    Trims whitespace from field. If the field is an array of strings, all members of the array will be trimmed.

    NOTE: This only works on leading and trailing whitespace.

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as elasticstack from "@pulumi/elasticstack";
    
    const trim = elasticstack.getElasticsearchIngestProcessorTrim({
        field: "foo",
    });
    const myIngestPipeline = new elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", {processors: [trim.then(trim => trim.json)]});
    
    import pulumi
    import pulumi_elasticstack as elasticstack
    
    trim = elasticstack.get_elasticsearch_ingest_processor_trim(field="foo")
    my_ingest_pipeline = elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", processors=[trim.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 {
    		trim, err := elasticstack.GetElasticsearchIngestProcessorTrim(ctx, &elasticstack.GetElasticsearchIngestProcessorTrimArgs{
    			Field: "foo",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = elasticstack.NewElasticsearchIngestPipeline(ctx, "myIngestPipeline", &elasticstack.ElasticsearchIngestPipelineArgs{
    			Processors: pulumi.StringArray{
    				pulumi.String(trim.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 trim = Elasticstack.GetElasticsearchIngestProcessorTrim.Invoke(new()
        {
            Field = "foo",
        });
    
        var myIngestPipeline = new Elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", new()
        {
            Processors = new[]
            {
                trim.Apply(getElasticsearchIngestProcessorTrimResult => getElasticsearchIngestProcessorTrimResult.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.GetElasticsearchIngestProcessorTrimArgs;
    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 trim = ElasticstackFunctions.getElasticsearchIngestProcessorTrim(GetElasticsearchIngestProcessorTrimArgs.builder()
                .field("foo")
                .build());
    
            var myIngestPipeline = new ElasticsearchIngestPipeline("myIngestPipeline", ElasticsearchIngestPipelineArgs.builder()
                .processors(trim.applyValue(getElasticsearchIngestProcessorTrimResult -> getElasticsearchIngestProcessorTrimResult.json()))
                .build());
    
        }
    }
    
    resources:
      myIngestPipeline:
        type: elasticstack:ElasticsearchIngestPipeline
        properties:
          processors:
            - ${trim.json}
    variables:
      trim:
        fn::invoke:
          function: elasticstack:getElasticsearchIngestProcessorTrim
          arguments:
            field: foo
    

    Using getElasticsearchIngestProcessorTrim

    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 getElasticsearchIngestProcessorTrim(args: GetElasticsearchIngestProcessorTrimArgs, opts?: InvokeOptions): Promise<GetElasticsearchIngestProcessorTrimResult>
    function getElasticsearchIngestProcessorTrimOutput(args: GetElasticsearchIngestProcessorTrimOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIngestProcessorTrimResult>
    def get_elasticsearch_ingest_processor_trim(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) -> GetElasticsearchIngestProcessorTrimResult
    def get_elasticsearch_ingest_processor_trim_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[GetElasticsearchIngestProcessorTrimResult]
    func GetElasticsearchIngestProcessorTrim(ctx *Context, args *GetElasticsearchIngestProcessorTrimArgs, opts ...InvokeOption) (*GetElasticsearchIngestProcessorTrimResult, error)
    func GetElasticsearchIngestProcessorTrimOutput(ctx *Context, args *GetElasticsearchIngestProcessorTrimOutputArgs, opts ...InvokeOption) GetElasticsearchIngestProcessorTrimResultOutput

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

    public static class GetElasticsearchIngestProcessorTrim 
    {
        public static Task<GetElasticsearchIngestProcessorTrimResult> InvokeAsync(GetElasticsearchIngestProcessorTrimArgs args, InvokeOptions? opts = null)
        public static Output<GetElasticsearchIngestProcessorTrimResult> Invoke(GetElasticsearchIngestProcessorTrimInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetElasticsearchIngestProcessorTrimResult> getElasticsearchIngestProcessorTrim(GetElasticsearchIngestProcessorTrimArgs args, InvokeOptions options)
    public static Output<GetElasticsearchIngestProcessorTrimResult> getElasticsearchIngestProcessorTrim(GetElasticsearchIngestProcessorTrimArgs args, InvokeOptions options)
    
    fn::invoke:
      function: elasticstack:index/getElasticsearchIngestProcessorTrim:getElasticsearchIngestProcessorTrim
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Field string
    The string-valued field to trim whitespace from.
    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 trimmed value to, by default field is updated in-place.
    Field string
    The string-valued field to trim whitespace from.
    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 trimmed value to, by default field is updated in-place.
    field String
    The string-valued field to trim whitespace from.
    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 trimmed value to, by default field is updated in-place.
    field string
    The string-valued field to trim whitespace from.
    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 trimmed value to, by default field is updated in-place.
    field str
    The string-valued field to trim whitespace from.
    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 trimmed value to, by default field is updated in-place.
    field String
    The string-valued field to trim whitespace from.
    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 trimmed value to, by default field is updated in-place.

    getElasticsearchIngestProcessorTrim Result

    The following output properties are available:

    Field string
    The string-valued field to trim whitespace from.
    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 trimmed value to, by default field is updated in-place.
    Field string
    The string-valued field to trim whitespace from.
    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 trimmed value to, by default field is updated in-place.
    field String
    The string-valued field to trim whitespace from.
    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 trimmed value to, by default field is updated in-place.
    field string
    The string-valued field to trim whitespace from.
    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 trimmed value to, by default field is updated in-place.
    field str
    The string-valued field to trim whitespace from.
    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 trimmed value to, by default field is updated in-place.
    field String
    The string-valued field to trim whitespace from.
    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 trimmed 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