Generates bulk JSON upload data to get documents into Amazon CloudSearch.
- Namespace
- Statiq
.Web .Aws - Interfaces
- Base Types
-
- object
- Module
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, IModuleRemarks
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 |
|---|---|
| Generate |
Generates Amazon CloudSearch JSON data. |
Methods
| Name | Return Value | Summary |
|---|---|---|
| AddField |
Generate |
Adds a field value.
|
| AfterExecution |
void |
Called after each module execution.
Inherited from Module
|
| AfterExecutionAsync |
Task |
Called after each module execution.
Inherited from Module
|
| BeforeExecution |
void |
Called before each module execution.
Inherited from Module
|
| BeforeExecutionAsync |
Task |
Called before each module execution.
Inherited from Module
|
| ExecuteAsync |
Task |
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 |
Task |
Executes the module once for all input documents.
|
| ExecuteInputAsync |
Task |
Executes the module.
Inherited from Module
|
| Finally |
void |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| MapMetaField |
Generate |
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.
|