GenerateCloudSearchData Class
Generates bulk JSON upload data to get documents into Amazon CloudSearch.
Namespace
Statiq.Web.Aws
Interfaces
Base Types
graph BT Type-->Base0["Module"] click Base0 "/api/Statiq.Common/Module" Base0-->Base1["object"] Type-.->Interface0["IModule"] click Interface0 "/api/Statiq.Common/IModule" Type["GenerateCloudSearchData"] class Type type-node

Syntax

public class GenerateCloudSearchData : Module, IModule

Remarks

This module creates a single document from a pipeline with JSON data containing the correctly formatted commands for Amazon CloudSearch. Note that this just creates the document. Once that document is written to the file system, you will still need to upload the document to a correctly configured CloudSearch instance using the API or Amazon CLI.

Constructors

Name Summary
GenerateCloudSearchData(string, string) Generates Amazon CloudSearch JSON data.

Methods

Name Return Value Summary
AddField(Config<string>, Config<object>) GenerateCloudSearchData
Adds a field value.
AfterExecution(IExecutionContext, ExecutionOutputs) void
Called after each module execution.
Inherited from Module
AfterExecutionAsync(IExecutionContext, ExecutionOutputs) Task
Called after each module execution.
Inherited from Module
BeforeExecution(IExecutionContext) void
Called before each module execution.
Inherited from Module
BeforeExecutionAsync(IExecutionContext) Task
Called before each module execution.
Inherited from Module
ExecuteAsync(IExecutionContext) Task<IEnumerable<IDocument>>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
ExecuteContextAsync(IExecutionContext) Task<IEnumerable<IDocument>>
Executes the module once for all input documents.
ExecuteInputAsync(IDocument, IExecutionContext) Task<IEnumerable<IDocument>>
Executes the module.
Inherited from Module
Finally(IExecutionContext) void
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
FinallyAsync(IExecutionContext) Task
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
MapMetaField(Config<string>, Config<string>, Func<object, object>) GenerateCloudSearchData
Adds a mapping from meta key to CloudSearch field. When provided, the contents of the meta key will be written to the provided field name.

Extension Methods