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

elasticstack.getElasticsearchIngestProcessorDotExpander

Explore with Pulumi AI

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

    Expands a field with dots into an object field. This processor allows fields with dots in the name to be accessible by other processors in the pipeline. Otherwise these fields can’t be accessed by any processor.

    See: elastic.co/guide/en/elasticsearch/reference/current/dot-expand-processor.html

    Example Usage

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

    Using getElasticsearchIngestProcessorDotExpander

    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 getElasticsearchIngestProcessorDotExpander(args: GetElasticsearchIngestProcessorDotExpanderArgs, opts?: InvokeOptions): Promise<GetElasticsearchIngestProcessorDotExpanderResult>
    function getElasticsearchIngestProcessorDotExpanderOutput(args: GetElasticsearchIngestProcessorDotExpanderOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIngestProcessorDotExpanderResult>
    def get_elasticsearch_ingest_processor_dot_expander(description: Optional[str] = None,
                                                        field: Optional[str] = None,
                                                        if_: Optional[str] = None,
                                                        ignore_failure: Optional[bool] = None,
                                                        on_failures: Optional[Sequence[str]] = None,
                                                        override: Optional[bool] = None,
                                                        path: Optional[str] = None,
                                                        tag: Optional[str] = None,
                                                        opts: Optional[InvokeOptions] = None) -> GetElasticsearchIngestProcessorDotExpanderResult
    def get_elasticsearch_ingest_processor_dot_expander_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,
                                                        on_failures: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                                        override: Optional[pulumi.Input[bool]] = None,
                                                        path: Optional[pulumi.Input[str]] = None,
                                                        tag: Optional[pulumi.Input[str]] = None,
                                                        opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchIngestProcessorDotExpanderResult]
    func GetElasticsearchIngestProcessorDotExpander(ctx *Context, args *GetElasticsearchIngestProcessorDotExpanderArgs, opts ...InvokeOption) (*GetElasticsearchIngestProcessorDotExpanderResult, error)
    func GetElasticsearchIngestProcessorDotExpanderOutput(ctx *Context, args *GetElasticsearchIngestProcessorDotExpanderOutputArgs, opts ...InvokeOption) GetElasticsearchIngestProcessorDotExpanderResultOutput

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

    public static class GetElasticsearchIngestProcessorDotExpander 
    {
        public static Task<GetElasticsearchIngestProcessorDotExpanderResult> InvokeAsync(GetElasticsearchIngestProcessorDotExpanderArgs args, InvokeOptions? opts = null)
        public static Output<GetElasticsearchIngestProcessorDotExpanderResult> Invoke(GetElasticsearchIngestProcessorDotExpanderInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetElasticsearchIngestProcessorDotExpanderResult> getElasticsearchIngestProcessorDotExpander(GetElasticsearchIngestProcessorDotExpanderArgs args, InvokeOptions options)
    public static Output<GetElasticsearchIngestProcessorDotExpanderResult> getElasticsearchIngestProcessorDotExpander(GetElasticsearchIngestProcessorDotExpanderArgs args, InvokeOptions options)
    
    fn::invoke:
      function: elasticstack:index/getElasticsearchIngestProcessorDotExpander:getElasticsearchIngestProcessorDotExpander
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Field string
    The field to expand into an object field. If set to *, all top-level fields will be expanded.
    Description string
    Description of the processor.
    If string
    Conditionally execute the processor
    IgnoreFailure bool
    Ignore failures for the processor.
    OnFailures List<string>
    Handle failures for the processor.
    Override bool
    Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
    Path string
    The field that contains the field to expand.
    Tag string
    Identifier for the processor.
    Field string
    The field to expand into an object field. If set to *, all top-level fields will be expanded.
    Description string
    Description of the processor.
    If string
    Conditionally execute the processor
    IgnoreFailure bool
    Ignore failures for the processor.
    OnFailures []string
    Handle failures for the processor.
    Override bool
    Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
    Path string
    The field that contains the field to expand.
    Tag string
    Identifier for the processor.
    field String
    The field to expand into an object field. If set to *, all top-level fields will be expanded.
    description String
    Description of the processor.
    if_ String
    Conditionally execute the processor
    ignoreFailure Boolean
    Ignore failures for the processor.
    onFailures List<String>
    Handle failures for the processor.
    override Boolean
    Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
    path String
    The field that contains the field to expand.
    tag String
    Identifier for the processor.
    field string
    The field to expand into an object field. If set to *, all top-level fields will be expanded.
    description string
    Description of the processor.
    if string
    Conditionally execute the processor
    ignoreFailure boolean
    Ignore failures for the processor.
    onFailures string[]
    Handle failures for the processor.
    override boolean
    Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
    path string
    The field that contains the field to expand.
    tag string
    Identifier for the processor.
    field str
    The field to expand into an object field. If set to *, all top-level fields will be expanded.
    description str
    Description of the processor.
    if_ str
    Conditionally execute the processor
    ignore_failure bool
    Ignore failures for the processor.
    on_failures Sequence[str]
    Handle failures for the processor.
    override bool
    Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
    path str
    The field that contains the field to expand.
    tag str
    Identifier for the processor.
    field String
    The field to expand into an object field. If set to *, all top-level fields will be expanded.
    description String
    Description of the processor.
    if String
    Conditionally execute the processor
    ignoreFailure Boolean
    Ignore failures for the processor.
    onFailures List<String>
    Handle failures for the processor.
    override Boolean
    Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
    path String
    The field that contains the field to expand.
    tag String
    Identifier for the processor.

    getElasticsearchIngestProcessorDotExpander Result

    The following output properties are available:

    Field string
    The field to expand into an object field. If set to *, all top-level fields will be expanded.
    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.
    OnFailures List<string>
    Handle failures for the processor.
    Override bool
    Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
    Path string
    The field that contains the field to expand.
    Tag string
    Identifier for the processor.
    Field string
    The field to expand into an object field. If set to *, all top-level fields will be expanded.
    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.
    OnFailures []string
    Handle failures for the processor.
    Override bool
    Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
    Path string
    The field that contains the field to expand.
    Tag string
    Identifier for the processor.
    field String
    The field to expand into an object field. If set to *, all top-level fields will be expanded.
    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.
    onFailures List<String>
    Handle failures for the processor.
    override Boolean
    Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
    path String
    The field that contains the field to expand.
    tag String
    Identifier for the processor.
    field string
    The field to expand into an object field. If set to *, all top-level fields will be expanded.
    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.
    onFailures string[]
    Handle failures for the processor.
    override boolean
    Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
    path string
    The field that contains the field to expand.
    tag string
    Identifier for the processor.
    field str
    The field to expand into an object field. If set to *, all top-level fields will be expanded.
    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.
    on_failures Sequence[str]
    Handle failures for the processor.
    override bool
    Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
    path str
    The field that contains the field to expand.
    tag str
    Identifier for the processor.
    field String
    The field to expand into an object field. If set to *, all top-level fields will be expanded.
    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.
    onFailures List<String>
    Handle failures for the processor.
    override Boolean
    Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
    path String
    The field that contains the field to expand.
    tag String
    Identifier for the processor.

    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