Click or drag to resize
SavedSearchAttributes Properties

The SavedSearchAttributes type exposes the following members.

Properties
  NameDescription
Public propertyActionEmailAuthPassword
Gets or sets a password for authenticating with the SMTP server for the e- mail action of a SavedSearch.
Public propertyActionEmailAuthUsername
Gets or sets a username for authenticating with the SMTP server for the e- mail action of a SavedSearch.
Public propertyActionEmailBcc
Gets or sets the e-mail addresses of the blind carbon copy (BCC) recipients for the e-mail action of a SavedSearch.
Public propertyActionEmailCC
Gets or sets the e-mail addresses of the carbon copy (CC) recipients for the e-mail action of a SavedSearch.
Public propertyActionEmailCommand
Gets or sets the search command which is responsible for executing the e- mail action for a SavedSearch.
Public propertyActionEmailFormat
Gets or sets the format of the e-mail action for a SavedSearch.
Public propertyActionEmailFrom
Gets or sets the e-mail address from which the e-mail action for a SavedSearch originates.
Public propertyActionEmailInline
Gets or sets a value indicating whether search results should be contained in the body of the action e-mail for a SavedSearch.
Public propertyActionEmailMailServer
Gets or sets the address of the MTA server to be used to send the action e-mail for a SavedSearch.
Public propertyActionEmailMaxResults
Gets or sets the global maximum number of search results to send when the e-mail for a SavedSearch is enabled.
Public propertyActionEmailMaxTime
Gets or sets the maximum period of time the e-mail action for a SavedSearch may execute before it is aborted.
Public propertyActionEmailReportCidFontList
Gets or sets the set and load order of CID fonts for handling Simplified Chinese (gb), Traditional Chinese (cns), Japanese (jp), and Korean (kor) in Integrated PDF Rendering.
Public propertyActionEmailReportIncludeSplunkLogo
Gets or sets a value indicating whether to include the Splunk logo with the report on an e-mail action for a SavedSearch.
Public propertyActionEmailReportPaperOrientation
Gets or sets the paper orientation for the report on an e-mail action for a SavedSearch.
Public propertyActionEmailReportPaperSize
Gets or sets the paper size for the report on an e-mail action for a SavedSearch.
Public propertyActionEmailReportServerEnabled
Gets or sets a value that indicates whether the PDF server is enabled on the e-mail action for a SavedSearch.
Public propertyActionEmailSendPdf
Gets or sets a value that indicates whether to create and send the results of the e-mail action for a SavedSearch as a PDF report.
Public propertyActionEmailSendResults
Gets or sets a value that indicates whether search results should be included in the action e-mail for a SavedSearch.
Public propertyActionEmailSubject
Gets or sets an alternate subject for the action e-mail on a SavedSearch.
Public propertyActionEmailTo
Gets or sets the e-mail addresses of the recipients for the e-mail action of a SavedSearch.
Public propertyActionEmailTrackAlert
Gets or sets a value that indicates whether the e-mail action of a SavedSearch signifies a trackable alert.
Public propertyActionEmailTtl
Gets or sets the minimum time-to-live for artifacts of the e-mail action for a SavedSearch.
Public propertyActionEmailUseSsl
Gets or sets a value indicating whether to use SSL when communicating with the SMTP server.
Public propertyActionEmailUseTls
Gets or sets a value indicating whether to use TLS when communicating with the SMTP server.
Public propertyActionEmailWidthSortColumns
Gets or sets a value indicating whether columns should be sorted from least wide to most wide, left to right.
Public propertyActionLogEventCommand
Gets or sets the search command which is responsible for executing the logevent action for a SavedSearch.
Public propertyActionLogEventDescription
Gets or sets the human-readable description of a logevent action SavedSearch.
Public propertyActionLogEventHostName
Gets or sets the hostname used in the web link (URI) that is sent in the logevent action of a SavedSearch.
Public propertyActionLogEventIconPath
Gets or sets the icon path used in the UI for the logevent action of a SavedSearch.
Public propertyActionLogEventIsCustom
Gets or sets a value indicating whether whether the alert action is based on the custom alert actions framework and is supposed to be listed in the search UI
Public propertyActionLogEventLabel
Gets or sets the label of the logevent action SavedSearch.
Public propertyActionLogEventMaxResults
Gets or sets the global maximum number of search results to send when the logevent action for a SavedSearch is enabled.
Public propertyActionLogEventMaxTime
Gets or sets the maximum period of time the logevent action for a SavedSearch may execute before it is aborted.
Public propertyActionLogEventParamHost
Gets or sets the host parameter that is used in the event of a logevent action of a SavedSearch.
Public propertyActionLogEventParamIndex
Gets or sets the index parameter that is used in the event of a logevent action of a SavedSearch.
Public propertyActionLogEventParamSource
Gets or sets the source parameter that is used in the event of a logevent action of a SavedSearch.
Public propertyActionLogEventParamSourcetype
Gets or sets the sourcetype parameter that is used in the event of a logevent action of a SavedSearch.
Public propertyActionLogEventPayloadFormat
Gets or sets the payload format that is used in the logevent action of a SavedSearch.
Public propertyActionLogEventTrackAlert
Gets or sets a value indicating whether the execution of this action signifies a trackable alert.
Public propertyActionLogEventTtl
Gets or sets the minimum time-to-live for artifacts of the logevent action for a SavedSearch.
Public propertyActionLookupAppend
Gets or sets a value indicating whether to append results to the lookup file defined for the filename attribute.
Public propertyActionLookupCommand
Gets or sets the search command which is responsible for executing the lookup action for a SavedSearch.
Public propertyActionLookupDescription
Gets or sets the human-readable description of a lookup action SavedSearch.
Public propertyActionLookupFileName
Gets or sets the file name, with no path, of the CSV lookup file.
Public propertyActionLookupHostName
Gets or sets the hostname used in the web link (URI) that is sent in the lookup action of a SavedSearch.
Public propertyActionLookupIconPath
Gets or sets the icon path used in the UI for the lookup action of a SavedSearch.
Public propertyActionLookupLabel
Gets or sets the label of the lookup action SavedSearch.
Public propertyActionLookupMaxResults
Gets or sets the global maximum number of search results to send when the lookup action for a SavedSearch is enabled.
Public propertyActionLookupMaxTime
Gets or sets the maximum period of time the lookup action for a SavedSearch may execute before it is aborted.
Public propertyActionLookupTrackAlert
Gets or sets a value that indicates whether the lookup action for a SavedSearch signifies a trackable alert.
Public propertyActionLookupTtl
Gets or sets the minimum time-to-live for artifacts of the lookup action for a SavedSearch.
Public propertyActionPopulateLookupCommand
Gets or sets the search command which is responsible for executing the populate lookup action for a SavedSearch.
Public propertyActionPopulateLookupDestination
Gets or sets the name of the lookup table or lookup path to fill in the lookup action of a SavedSearch.
Public propertyActionPopulateLookupHostName
Gets or sets the hostname used in the web link (URI) that is sent in the populate lookup action of a SavedSearch.
Public propertyActionPopulateLookupMaxResults
Gets or sets the global maximum number of search results to send when the populate lookup action for a SavedSearch is enabled.
Public propertyActionPopulateLookupMaxTime
Gets or sets the maximum period of time the populate lookup action for a SavedSearch may execute before it is aborted.
Public propertyActionPopulateLookupTrackAlert
Gets or sets a value that indicates whether the populate lookup action for a SavedSearch signifies a trackable alert.
Public propertyActionPopulateLookupTtl
Gets or sets the minimum time-to-live for artifacts of the populate lookup action for a SavedSearch.
Public propertyActionRssCommand
Gets or sets the search command which is responsible for executing the RSS action for a SavedSearch.
Public propertyActionRssMaxResults
Gets or sets the global maximum number of search results to send when the RSS action for a SavedSearch is enabled.
Public propertyActionRssMaxTime
Gets or sets the maximum period of time the RSS action for a SavedSearch may execute before it is aborted.
Public propertyActionRssTrackAlert
Gets or sets a value that indicates whether the RSS action of a SavedSearch signifies a trackable alert.
Public propertyActionRssTtl
Gets or sets the minimum time-to-live for artifacts of the RSS action for a SavedSearch.
Public propertyActions
Gets or sets a comma-separated list of actions to enable for a SavedSearch.
Public propertyActionScriptCommand
Gets or sets the search command which is responsible for executing the script action for a SavedSearch.
Public propertyActionScriptFileName
Gets or sets the file name of the script to invoke when the script action of a SavedSearch is enabled.
Public propertyActionScriptHostName
Gets or sets the hostname used in the web link (URI) that is sent in the script action for a SavedSearch.
Public propertyActionScriptMaxResults
Gets or sets the global maximum number of search results to send when the script action for a SavedSearch is enabled.
Public propertyActionScriptMaxTime
Gets or sets the maximum period of time the script action for a SavedSearch may execute before it is aborted.
Public propertyActionScriptTrackAlert
Gets or sets a value that indicates whether the script action of a SavedSearch signifies a trackable alert.
Public propertyActionScriptTtl
Gets or sets the minimum time-to-live for artifacts of the script action for a SavedSearch.
Public propertyActionSummaryIndexCommand
Gets or sets the search command which is responsible for executing the summary index action for a SavedSearch.
Public propertyActionSummaryIndexInline
Gets or sets a value indicating whether to execute the summary index action of a SavedSearch as part of the SavedSearch.
Public propertyActionSummaryIndexMaxResults
Gets or sets the maximum number of search results sent via alerts for the index action of a SavedSearch.
Public propertyActionSummaryIndexMaxTime
Gets or sets the maximum period of time the summary index action for a SavedSearch may execute before it is aborted.
Public propertyActionSummaryIndexName
Gets or sets the name of the summary index where the results of the SavedSearch are stored.
Public propertyActionSummaryIndexTrackAlert
Gets or sets a value that indicates whether the summary index action of a SavedSearch signifies a trackable alert.
Public propertyActionSummaryIndexTtl
Gets or sets the minimum time-to-live for artifacts of the summary index action for a SavedSearch.
Public propertyActionWebHookCommand
Gets or sets the search command which is responsible for executing the webhook action for a SavedSearch.
Public propertyActionWebHookDescription
Gets or sets the human-readable description of a webhook action SavedSearch.
Public propertyActionWebHookHostName
Gets or sets the hostname used in the web link (URI) that is sent in the webhook action of a SavedSearch.
Public propertyActionWebHookIconPath
Gets or sets the icon path used in the UI for the webhook action of a SavedSearch.
Public propertyActionWebHookIsCustom
Gets or sets a value indicating whether whether the alert action is based on the custom alert actions framework and is supposed to be listed in the search UI
Public propertyActionWebHookLabel
Gets or sets the label of the webhook action SavedSearch.
Public propertyActionWebHookMaxResults
Gets or sets the global maximum number of search results to send when the webhook for a SavedSearch is enabled.
Public propertyActionWebHookMaxTime
Gets or sets the maximum period of time the webhook action for a SavedSearch may execute before it is aborted.
Public propertyActionWebHookParamUserAgent
Gets or sets the value of the User-Agent header sent to the webhook receiver in a SavedSearch
Public propertyActionWebHookPayloadFormat
Gets or sets the payload format that is used in the webhook action of a SavedSearch.
Public propertyActionWebHookTrackAlert
Gets or sets a value that indicates whether the webhook action of a SavedSearch signifies a trackable alert.
Public propertyActionWebHookTtl
Gets or sets the minimum time-to-live for artifacts of the webhook action for a SavedSearch.
Public propertyAlertComparator
Gets or sets the comparator used with AlertThreshold to trigger alert actions.
Public propertyAlertCondition
Gets or sets a conditional search that is evaluated against the results of a saved search.
Public propertyAlertDigestMode
Gets or sets a value indicating whether Splunk applies the alert actions to the entire result set or on each individual result.
Public propertyAlertExpires
Gets or sets the period of time to show the alert in the dashboard.
Public propertyAlertSeverity
Gets or sets the alert severity level for a SavedSearch.
Public propertyAlertThreshold
Gets or sets a string that specifies an absolute or percentage value to compare using AlertComparator before triggering the alert actions for a SavedSearch.
Public propertyAlertTrack
Gets or sets a value indicating whether to track the actions triggered by a scheduled SavedSearch.
Public propertyAlertType
Gets or sets a value that specifies the basis of an alert.
Public propertyAutoSummarize
Gets or sets a value that indicates whether the scheduler should ensure that the data for a SavedSearch is automatically summarized.
Public propertyAutoSummarizeCommand
Gets or sets a search command template that constructs the auto summarization for a SavedSearch.
Public propertyAutoSummarizeCronSchedule
Gets or sets a Cron schedule for auto-summarization of a SavedSearch.
Public propertyAutoSummarizeDispatchEarliestTime
Gets or sets a time string that specifies the earliest time for summarizing a SavedSearch.
Public propertyAutoSummarizeDispatchLatestTime
Gets or sets a time string that specifies the latest time for summarizing a SavedSearch.
Public propertyAutoSummarizeDispatchTimeFormat
Gets or sets the time format that Splunk uses to parse the values of AutoSummarizeDispatchEarliestTime and AutoSummarizeDispatchLatestTime when they are specified as absolute times.
Public propertyAutoSummarizeDispatchTtl
Gets or sets a string that specifies the time to live in seconds or periods for the artifacts of the summarization of a scheduled SavedSearch.
Public propertyAutoSummarizeMaxDisabledBuckets
Gets or sets the maximum number of buckets with suspended summarization before a summarization search is completely stopped.
Public propertyAutoSummarizeMaxSummaryRatio
Gets or sets the ratio of summary_size/bucket_size which specifies when to stop summarization and deem it unhelpful for a bucket.
Public propertyAutoSummarizeMaxSummarySize
Gets or sets the minimum summary size, in bytes, before testing whether the summarization is helpful.
Public propertyAutoSummarizeMaxTime
Gets or sets the maximum time in seconds that a summary search is allowed to run.
Public propertyAutoSummarizeSuspendPeriod
Gets or sets a time specfier that tells Splunk when to suspend summarization of a SavedSearch, if the summarization is deemed unhelpful.
Public propertyCronSchedule
Gets or sets the Cron schedule to execute a SavedSearch.
Public propertyDescription
Gets or sets the human-readable description of a SavedSearch.
Public propertyDisabled
Gets or sets a value that indicates if a SavedSearch should be disabled.
Public propertyDispatchBuckets
Gets or sets the maximum number of timeline buckets for a SavedSearch.
Public propertyDispatchEarliestTime
Gets or sets a value specifying the earliest time to begin a SavedSearch.
Public propertyDispatchLatestTime
Gets or sets a value specifying the latest time to begin a SavedSearch.
Public propertyDispatchLookups
Gets or sets a value indicating whether lookups are enabled.
Public propertyDispatchMaxCount
Gets or sets the maximum number of results to produce before finalizing a SavedSearch.
Public propertyDispatchMaxTime
Gets or sets the maximum length of time to run before finalizing a SavedSearch.
Public propertyDispatchRealTimeBackfill
Gets or sets a value indicating whether to back fill the real-time window for a SavedSearch.
Public propertyDispatchReduceFrequency
Gets or sets a value specifying how frequently Splunk runs the map/reduce phase on accumulated map values.
Public propertyDispatchSpawnProcess
Gets or sets a value indicating whether a SavedSearch should run in its own process.
Public propertyDispatchTimeFormat
Gets or sets a value specifying the time format Splunk should use for the earliest and latest times of a search.
Public propertyDispatchTtl
Gets or sets the time to live (in seconds) for the artifacts of a SavedSearch, if no actions are triggered.
Public propertyIsScheduled
Gets or sets a value indicating whether a SavedSearch is to be run on a schedule.
Public propertyIsVisible
Gets or sets a value indicating whether a SavedSearch should appear in the list of saved searches on Splunk Web.
Public propertyMaxConcurrent
Gets or sets the maximum number of concurrent instances of a SavedSearch the scheduler is allowed to run.
Public propertyRealTimeSchedule
Gets or sets a value indicating whether a SavedSearch is to be run on a realtime schedule.
Public propertyRestartOnSearchPeerAdd
Gets or sets a value indicating whether to restart a realtime SavedSearch managed by the scheduler when a new search peer becomes available.
Public propertyRunOnStartup
Gets or sets a value indicating whether a SavedSearch runs when Splunk starts.
Top
See Also