import * as pulumi from "@pulumi/pulumi"; /** * The enrich processor can enrich documents with data from another index. See enrich data section for more information about how to set this up. * * See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-enriching-data.html and https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-processor.html * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as elasticstack from "@pulumi/elasticstack"; * * const enrich = elasticstack.ElasticsearchIngestProcessorEnrich({ * policyName: "users-policy", * field: "email", * targetField: "user", * maxMatches: 1, * }); * const myIngestPipeline = new elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", {processors: [enrich.then(enrich => enrich.json)]}); * ``` */ export declare function elasticsearchIngestProcessorEnrich(args: ElasticsearchIngestProcessorEnrichArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking ElasticsearchIngestProcessorEnrich. */ export interface ElasticsearchIngestProcessorEnrichArgs { /** * Description of the processor. */ description?: string; /** * The field in the input document that matches the policies matchField used to retrieve the enrichment data. */ field: string; /** * Conditionally execute the processor */ if?: string; /** * Ignore failures for the processor. */ ignoreFailure?: boolean; /** * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. */ ignoreMissing?: boolean; /** * The maximum number of matched documents to include under the configured target field. */ maxMatches?: number; /** * Handle failures for the processor. */ onFailures?: string[]; /** * If processor will update fields with pre-existing non-null-valued field. */ override?: boolean; /** * The name of the enrich policy to use. */ policyName: string; /** * A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. */ shapeRelation?: string; /** * Identifier for the processor. */ tag?: string; /** * Field added to incoming documents to contain enrich data. */ targetField: string; } /** * A collection of values returned by ElasticsearchIngestProcessorEnrich. */ export interface ElasticsearchIngestProcessorEnrichResult { /** * Description of the processor. */ readonly description?: string; /** * The field in the input document that matches the policies matchField used to retrieve the enrichment data. */ readonly field: string; /** * Internal identifier of the resource */ readonly id: string; /** * Conditionally execute the processor */ readonly if?: string; /** * Ignore failures for the processor. */ readonly ignoreFailure?: boolean; /** * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. */ readonly ignoreMissing?: boolean; /** * JSON representation of this data source. */ readonly json: string; /** * The maximum number of matched documents to include under the configured target field. */ readonly maxMatches?: number; /** * Handle failures for the processor. */ readonly onFailures?: string[]; /** * If processor will update fields with pre-existing non-null-valued field. */ readonly override?: boolean; /** * The name of the enrich policy to use. */ readonly policyName: string; /** * A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. */ readonly shapeRelation?: string; /** * Identifier for the processor. */ readonly tag?: string; /** * Field added to incoming documents to contain enrich data. */ readonly targetField: string; } export declare function elasticsearchIngestProcessorEnrichOutput(args: ElasticsearchIngestProcessorEnrichOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output; /** * A collection of arguments for invoking ElasticsearchIngestProcessorEnrich. */ export interface ElasticsearchIngestProcessorEnrichOutputArgs { /** * Description of the processor. */ description?: pulumi.Input; /** * The field in the input document that matches the policies matchField used to retrieve the enrichment data. */ field: pulumi.Input; /** * Conditionally execute the processor */ if?: pulumi.Input; /** * Ignore failures for the processor. */ ignoreFailure?: pulumi.Input; /** * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. */ ignoreMissing?: pulumi.Input; /** * The maximum number of matched documents to include under the configured target field. */ maxMatches?: pulumi.Input; /** * Handle failures for the processor. */ onFailures?: pulumi.Input[]>; /** * If processor will update fields with pre-existing non-null-valued field. */ override?: pulumi.Input; /** * The name of the enrich policy to use. */ policyName: pulumi.Input; /** * A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. */ shapeRelation?: pulumi.Input; /** * Identifier for the processor. */ tag?: pulumi.Input; /** * Field added to incoming documents to contain enrich data. */ targetField: pulumi.Input; }