elasticstack.getElasticsearchIngestProcessorCircle

Explore with Pulumi AI

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";

const circle = elasticstack.getElasticsearchIngestProcessorCircle({
    field: "circle",
    errorDistance: 28.1,
    shapeType: "geo_shape",
});
const myIngestPipeline = new elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", {processors: [circle.then(circle => circle.json)]});

import pulumi
import pulumi_elasticstack as elasticstack

circle = elasticstack.get_elasticsearch_ingest_processor_circle(field="circle",
    error_distance=28.1,
    shape_type="geo_shape")
my_ingest_pipeline = elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", processors=[circle.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 {
		circle, err := elasticstack.GetElasticsearchIngestProcessorCircle(ctx, &elasticstack.GetElasticsearchIngestProcessorCircleArgs{
			Field:         "circle",
			ErrorDistance: 28.1,
			ShapeType:     "geo_shape",
		}, nil)
		if err != nil {
			return err
		}
		_, err = elasticstack.NewElasticsearchIngestPipeline(ctx, "myIngestPipeline", &elasticstack.ElasticsearchIngestPipelineArgs{
			Processors: pulumi.StringArray{
				pulumi.String(circle.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 circle = Elasticstack.GetElasticsearchIngestProcessorCircle.Invoke(new()
    {
        Field = "circle",
        ErrorDistance = 28.1,
        ShapeType = "geo_shape",
    });

    var myIngestPipeline = new Elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", new()
    {
        Processors = new[]
        {
            circle.Apply(getElasticsearchIngestProcessorCircleResult => getElasticsearchIngestProcessorCircleResult.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.GetElasticsearchIngestProcessorCircleArgs;
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 circle = ElasticstackFunctions.getElasticsearchIngestProcessorCircle(GetElasticsearchIngestProcessorCircleArgs.builder()
            .field("circle")
            .errorDistance(28.1)
            .shapeType("geo_shape")
            .build());

        var myIngestPipeline = new ElasticsearchIngestPipeline("myIngestPipeline", ElasticsearchIngestPipelineArgs.builder()
            .processors(circle.applyValue(getElasticsearchIngestProcessorCircleResult -> getElasticsearchIngestProcessorCircleResult.json()))
            .build());

    }
}

resources:
  myIngestPipeline:
    type: elasticstack:ElasticsearchIngestPipeline
    properties:
      processors:
        - ${circle.json}
variables:
  circle:
    fn::invoke:
      function: elasticstack:getElasticsearchIngestProcessorCircle
      arguments:
        field: circle
        errorDistance: 28.1
        shapeType: geo_shape

Using getElasticsearchIngestProcessorCircle

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 getElasticsearchIngestProcessorCircle(args: GetElasticsearchIngestProcessorCircleArgs, opts?: InvokeOptions): Promise<GetElasticsearchIngestProcessorCircleResult>
function getElasticsearchIngestProcessorCircleOutput(args: GetElasticsearchIngestProcessorCircleOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIngestProcessorCircleResult>

def get_elasticsearch_ingest_processor_circle(description: Optional[str] = None,
                                              error_distance: Optional[float] = 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,
                                              shape_type: Optional[str] = None,
                                              tag: Optional[str] = None,
                                              target_field: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetElasticsearchIngestProcessorCircleResult
def get_elasticsearch_ingest_processor_circle_output(description: Optional[pulumi.Input[str]] = None,
                                              error_distance: Optional[pulumi.Input[float]] = 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,
                                              shape_type: Optional[pulumi.Input[str]] = None,
                                              tag: Optional[pulumi.Input[str]] = None,
                                              target_field: Optional[pulumi.Input[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchIngestProcessorCircleResult]

func GetElasticsearchIngestProcessorCircle(ctx *Context, args *GetElasticsearchIngestProcessorCircleArgs, opts ...InvokeOption) (*GetElasticsearchIngestProcessorCircleResult, error)
func GetElasticsearchIngestProcessorCircleOutput(ctx *Context, args *GetElasticsearchIngestProcessorCircleOutputArgs, opts ...InvokeOption) GetElasticsearchIngestProcessorCircleResultOutput

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

public static class GetElasticsearchIngestProcessorCircle 
{
    public static Task<GetElasticsearchIngestProcessorCircleResult> InvokeAsync(GetElasticsearchIngestProcessorCircleArgs args, InvokeOptions? opts = null)
    public static Output<GetElasticsearchIngestProcessorCircleResult> Invoke(GetElasticsearchIngestProcessorCircleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetElasticsearchIngestProcessorCircleResult> getElasticsearchIngestProcessorCircle(GetElasticsearchIngestProcessorCircleArgs args, InvokeOptions options)
public static Output<GetElasticsearchIngestProcessorCircleResult> getElasticsearchIngestProcessorCircle(GetElasticsearchIngestProcessorCircleArgs args, InvokeOptions options)

fn::invoke:
  function: elasticstack:index/getElasticsearchIngestProcessorCircle:getElasticsearchIngestProcessorCircle
  arguments:
    # arguments dictionary

The following arguments are supported:

ErrorDistance double: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape)
Field string: The string-valued field to trim whitespace from.
ShapeType string: Which field mapping type is to be used when processing the circle.
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

ErrorDistance float64: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape)
Field string: The string-valued field to trim whitespace from.
ShapeType string: Which field mapping type is to be used when processing the circle.
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

errorDistance Double: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape)
field String: The string-valued field to trim whitespace from.
shapeType String: Which field mapping type is to be used when processing the circle.
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

errorDistance number: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape)
field string: The string-valued field to trim whitespace from.
shapeType string: Which field mapping type is to be used when processing the circle.
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

error_distance float: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape)
field str: The string-valued field to trim whitespace from.
shape_type str: Which field mapping type is to be used when processing the circle.
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

errorDistance Number: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape)
field String: The string-valued field to trim whitespace from.
shapeType String: Which field mapping type is to be used when processing the circle.
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

getElasticsearchIngestProcessorCircle Result

The following output properties are available:

ErrorDistance double: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape)
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.
ShapeType string: Which field mapping type is to be used when processing the circle.
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

ErrorDistance float64: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape)
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.
ShapeType string: Which field mapping type is to be used when processing the circle.
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

errorDistance Double: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape)
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.
shapeType String: Which field mapping type is to be used when processing the circle.
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

errorDistance number: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape)
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.
shapeType string: Which field mapping type is to be used when processing the circle.
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

error_distance float: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape)
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.
shape_type str: Which field mapping type is to be used when processing the circle.
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

errorDistance Number: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape)
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.
shapeType String: Which field mapping type is to be used when processing the circle.
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 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

elastic/terraform-provider-elasticstack

elasticstack.getElasticsearchIngestProcessorCircle

On this page

On this page

Example Usage

Using getElasticsearchIngestProcessorCircle

getElasticsearchIngestProcessorCircle Result

Package Details

On this page

On this page