diff --git a/README.md b/README.md index c3e1d9f..1eee381 100644 --- a/README.md +++ b/README.md @@ -57,18 +57,16 @@ Load data into opensearch compatible instance
Type:scope
Root object:DocumentRequest
Properties
bulk_upload_list (list[reference[BulkUploadObject]]) -
Name:bulk upload list
Description:The list of objects for the bulk upload operation.
Required:Yes
Type:list[reference[BulkUploadObject]]
+
Name:bulk upload list
Description:The list of objects for the bulk upload operation.
Required:Yes
Type:list[reference[BulkUploadObject]]
List items
Type:reference[BulkUploadObject]
Referenced object:BulkUploadObject
default_index (string) -
Name:index
Description:Name of the default index that will receive the data.
Required:Yes
Type:string
Minimum length:1
-
metadata (map[string, - any]) -
Name:metadata
Description:Optional global metadata object that will be added to every document.
Required:No
Type:map[string, - any]
+
Name:index
Description:Name of the default index that will receive the data.
Required:Yes
Type:string
Minimum length:1
+
metadata (map[string,any]) +
Name:metadata
Description:Optional global metadata object that will be added to every document.
Required:No
Type:map[string,any]
Key type
Type:string
@@ -77,25 +75,22 @@ Load data into opensearch compatible instance
Value type -
Type: - any
+
Type:any
password (string) -
Name:password
Description:The password for the given user.
Required:No
Type:string
+
Name:password
Description:The password for the given user.
Required:No
Type:string
tls_verify (bool) -
Name:TLS verify
Description:For development and testing purposes, this can be set to False to disable TLS verification for connections to Opensearch-compatible services.
Required:No
Default (JSON encoded):
true
Type:bool
+
Name:TLS verify
Description:For development and testing purposes, this can be set to False to disable TLS verification for connections to Opensearch-compatible services.
Required:No
Default (JSON encoded):
true
Type:bool
url (string) -
Name:url
Description:The URL for the Opensearch-compatible instance.
Required:Yes
Type:string
+
Name:url
Description:The URL for the Opensearch-compatible instance.
Required:Yes
Type:string
username (string) -
Name:username
Description:A username for an authorized user for the given Opensearch-compatible instance.
Required:No
Type:string
Minimum length:1
+
Name:username
Description:A username for an authorized user for the given Opensearch-compatible instance.
Required:No
Type:string
Minimum length:1
Objects
BulkUploadObject (object) -
Type:object
Properties
data (map[string, - any]) -
Name:data
Description:The JSON data document to upload to your index.
Required:Yes
Type:map[string, - any]
+
Type:object
Properties
data (map[string,any]) +
Name:data
Description:The JSON data document to upload to your index.
Required:Yes
Type:map[string,any]
Key type
Type:string
@@ -104,13 +99,12 @@ Load data into opensearch compatible instance
Value type -
Type: - any
+
Type:any
-
operation (map[string, reference[OperationMeta]]) -
Name:operation
Description:The operation type and associated operation metadata.
Required:Yes
Type:map[string, reference[OperationMeta]]
+
operation (map[string,reference[OperationMeta]]) +
Name:operation
Description:The operation type and associated operation metadata.
Required:Yes
Type:map[string,reference[OperationMeta]]
Key type
Type:string
@@ -127,18 +121,16 @@ Load data into opensearch compatible instance
DocumentRequest (object)
Type:object
Properties
bulk_upload_list (list[reference[BulkUploadObject]]) - @@ -229,18 +220,15 @@ Process list input into a bulk_upload_list
Name:bulk upload list
Description:The list of objects for the bulk upload operation.
Required:Yes
Type:list[reference[BulkUploadObject]]
+
Name:bulk upload list
Description:The list of objects for the bulk upload operation.
Required:Yes
Type:list[reference[BulkUploadObject]]
List items
Type:reference[BulkUploadObject]
Referenced object:BulkUploadObject
default_index (string) -
Name:index
Description:Name of the default index that will receive the data.
Required:Yes
Type:string
Minimum length:1
-
metadata (map[string, - any]) -
Name:metadata
Description:Optional global metadata object that will be added to every document.
Required:No
Type:map[string, - any]
+
Name:index
Description:Name of the default index that will receive the data.
Required:Yes
Type:string
Minimum length:1
+
metadata (map[string,any]) +
Name:metadata
Description:Optional global metadata object that will be added to every document.
Required:No
Type:map[string,any]
Key type
Type:string
@@ -147,26 +139,25 @@ Load data into opensearch compatible instance
Value type -
Type: - any
+
Type:any
password (string) -
Name:password
Description:The password for the given user.
Required:No
Type:string
+
Name:password
Description:The password for the given user.
Required:No
Type:string
tls_verify (bool) -
Name:TLS verify
Description:For development and testing purposes, this can be set to False to disable TLS verification for connections to Opensearch-compatible services.
Required:No
Default (JSON encoded):
true
Type:bool
+
Name:TLS verify
Description:For development and testing purposes, this can be set to False to disable TLS verification for connections to Opensearch-compatible services.
Required:No
Default (JSON encoded):
true
Type:bool
url (string) -
Name:url
Description:The URL for the Opensearch-compatible instance.
Required:Yes
Type:string
+
Name:url
Description:The URL for the Opensearch-compatible instance.
Required:Yes
Type:string
username (string) -
Name:username
Description:A username for an authorized user for the given Opensearch-compatible instance.
Required:No
Type:string
Minimum length:1
+
Name:username
Description:A username for an authorized user for the given Opensearch-compatible instance.
Required:No
Type:string
Minimum length:1
OperationMeta (object)
Type:object
Properties
_id (string) -
Name:ID
Description:Optional ID for the data document.
Required:No
Type:string
+
Name:ID
Description:Optional ID for the data document.
Required:No
Type:string
_index (string) -
Name:index
Description:Optional name of the index that will receive the data. If none is provided, the default index will be used.
Required:No
Type:string
+
Name:index
Description:Optional name of the index that will receive the data. If none is provided, the default index will be used.
Required:No
Type:string
-
Type:scope
Root object:DataList
Properties
data_list (list[ - any]) -
Name:data list
Description:List of data object to process into the bulk_upload_list.
Required:Yes
Type:list[ - any]
+
Properties
data_list (list[any]) +
Name:data list
Description:List of data object to process into the bulk_upload_list.
Required:Yes
Type:list[any]
List items -
Type: - any
+
Type:any
-
operation (map[string, reference[OperationMeta]]) -
Name:operation
Description:The operation type and associated operation metadata.
Required:Yes
Type:map[string, reference[OperationMeta]]
+
operation (map[string,reference[OperationMeta]]) +
Name:operation
Description:The operation type and associated operation metadata.
Required:Yes
Type:map[string,reference[OperationMeta]]
Key type
Type:string
@@ -255,18 +243,15 @@ Process list input into a bulk_upload_list
Objects
DataList (object) -
Type:object
Properties
data_list (list[ - any]) -
Name:data list
Description:List of data object to process into the bulk_upload_list.
Required:Yes
Type:list[ - any]
+
Type:object
Properties
data_list (list[any]) +
Name:data list
Description:List of data object to process into the bulk_upload_list.
Required:Yes
Type:list[any]
List items -
Type: - any
+
Type:any
-
operation (map[string, reference[OperationMeta]]) - @@ -314,7 +299,7 @@ Process list input into a bulk_upload_list
Name:operation
Description:The operation type and associated operation metadata.
Required:Yes
Type:map[string, reference[OperationMeta]]
+
operation (map[string,reference[OperationMeta]]) +
Name:operation
Description:The operation type and associated operation metadata.
Required:Yes
Type:map[string,reference[OperationMeta]]
Key type
Type:string
@@ -283,9 +268,9 @@ Process list input into a bulk_upload_list
OperationMeta (object)
Type:object
Properties
_id (string) -
Name:ID
Description:Optional ID for the data document.
Required:No
Type:string
+
Name:ID
Description:Optional ID for the data document.
Required:No
Type:string
_index (string) -
Name:index
Description:Optional name of the index that will receive the data. If none is provided, the default index will be used.
Required:No
Type:string
+
Name:index
Description:Optional name of the index that will receive the data. If none is provided, the default index will be used.
Required:No
Type:string
Type:scope
Root object:BulkUploadList
Properties
bulk_upload_list (list[reference[BulkUploadObject]]) -
Name:bulk upload list
Description:The list of objects for the bulk upload operation.
Required:Yes
Type:list[reference[BulkUploadObject]]
+
Name:bulk upload list
Description:The list of objects for the bulk upload operation.
Required:Yes
Type:list[reference[BulkUploadObject]]
List items
Type:reference[BulkUploadObject]
Referenced object:BulkUploadObject
@@ -323,7 +308,7 @@ Process list input into a bulk_upload_list
Objects
BulkUploadList (object)
Type:object
Properties
bulk_upload_list (list[reference[BulkUploadObject]]) -
Name:bulk upload list
Description:The list of objects for the bulk upload operation.
Required:Yes
Type:list[reference[BulkUploadObject]]
+
Name:bulk upload list
Description:The list of objects for the bulk upload operation.
Required:Yes
Type:list[reference[BulkUploadObject]]
List items
Type:reference[BulkUploadObject]
Referenced object:BulkUploadObject
@@ -332,10 +317,8 @@ Process list input into a bulk_upload_list
BulkUploadObject (object) -
Type:object
Properties
data (map[string, - any]) -
Name:data
Description:The JSON data document to upload to your index.
Required:Yes
Type:map[string, - any]
+
Type:object
Properties
data (map[string,any]) +
Name:data
Description:The JSON data document to upload to your index.
Required:Yes
Type:map[string,any]
Key type
Type:string
@@ -344,13 +327,12 @@ Process list input into a bulk_upload_list
Value type -
Type: - any
+
Type:any
-
operation (map[string, reference[OperationMeta]]) -
Name:operation
Description:The operation type and associated operation metadata.
Required:Yes
Type:map[string, reference[OperationMeta]]
+
operation (map[string,reference[OperationMeta]]) +
Name:operation
Description:The operation type and associated operation metadata.
Required:Yes
Type:map[string,reference[OperationMeta]]
Key type
Type:string
@@ -367,9 +349,9 @@ Process list input into a bulk_upload_list
OperationMeta (object)
Type:object
Properties
_id (string) -
Name:ID
Description:Optional ID for the data document.
Required:No
Type:string
+
Name:ID
Description:Optional ID for the data document.
Required:No
Type:string
_index (string) -
Name:index
Description:Optional name of the index that will receive the data. If none is provided, the default index will be used.
Required:No
Type:string
+
Name:index
Description:Optional name of the index that will receive the data. If none is provided, the default index will be used.
Required:No
Type:string