Documentation
¶
Overview ¶
Package search -- generated by scloudgen !! DO NOT EDIT !!
Index ¶
- func CreateFederatedConnection(cmd *cobra.Command, args []string) error
- func CreateJob(cmd *cobra.Command, args []string) error
- func DeleteFederatedConnection(cmd *cobra.Command, args []string) error
- func DeleteJob(cmd *cobra.Command, args []string) error
- func ExportResults(cmd *cobra.Command, args []string) error
- func GetFederatedConnectionByName(cmd *cobra.Command, args []string) error
- func GetJob(cmd *cobra.Command, args []string) error
- func ListEventsSummary(cmd *cobra.Command, args []string) error
- func ListFieldsSummary(cmd *cobra.Command, args []string) error
- func ListJobs(cmd *cobra.Command, args []string) error
- func ListPreviewResults(cmd *cobra.Command, args []string) error
- func ListResults(cmd *cobra.Command, args []string) error
- func ListTimeBuckets(cmd *cobra.Command, args []string) error
- func PutFederatedConnectionByName(cmd *cobra.Command, args []string) error
- func RefreshFederatedConnection(cmd *cobra.Command, args []string) error
- func TestFederatedConnection(cmd *cobra.Command, args []string) error
- func UpdateJob(cmd *cobra.Command, args []string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateFederatedConnection ¶
CreateFederatedConnection Creates a new federated connection with information about how to connect to a remote index.
func DeleteFederatedConnection ¶
DeleteFederatedConnection Deletes a federated connection with the specified name (connectionName)
func DeleteJob ¶ added in v1.6.0
DeleteJob Creates a search job that deletes events from an index. The events are deleted from the index in the specified module, based on the search criteria as specified by the predicate.
func ExportResults ¶
ExportResults Exports the search results for the job with the specified search ID (SID). Export the results as a CSV file or JSON file.
func GetFederatedConnectionByName ¶
GetFederatedConnectionByName Returns the federated connection with the specified name (connectionName).
func ListEventsSummary ¶
ListEventsSummary Returns an events summary for search ID (SID) search.
func ListFieldsSummary ¶
ListFieldsSummary Returns a fields stats summary of the events to-date, for search ID (SID) search.
func ListPreviewResults ¶
ListPreviewResults Returns the preview search results for the job with the specified search ID (SID). Can be used when a job is running to return interim results.
func ListResults ¶
ListResults Returns the search results for the job with the specified search ID (SID).
func ListTimeBuckets ¶
ListTimeBuckets Returns the event distribution over time of the untransformed events read to-date, for search ID(SID) search.
func PutFederatedConnectionByName ¶
PutFederatedConnectionByName Creates or updates a federated connection with a specified name (connectionName).
func RefreshFederatedConnection ¶
RefreshFederatedConnection Refresh a federated connection to fetch new remote indexes and add/delete corresponding federated datasets.
func TestFederatedConnection ¶
TestFederatedConnection Test connection with remote EC instance using federated connection parameters.
Types ¶
This section is empty.