scheduled_views

Overview

Name	scheduled_views
Type	Resource
Id	sumologic.scheduled_views.scheduled_views

Fields

Name	Datatype	Description
id	string	Identifier for the scheduled view.
totalBytes	integer	Total storage consumed by the scheduled view.
parsingMode	string	Define the parsing mode to scan the JSON format log messages. Possible values are: 1. AutoParse 2. Manual In AutoParse mode, the system automatically figures out fields to parse based on the search query. While in the Manual mode, no fields are parsed out automatically. For more information see Dynamic Parsing.
error	string	Errors related to the scheduled view.
modifiedAt	string	Last modification timestamp in UTC in RFC3339 format.
indexName	string	Name of the index for the scheduled view.
modifiedBy	string	Identifier of the user who last modified the resource.
createdAt	string	Creation timestamp in UTC.
retentionEffectiveAt	string	When the newRetentionPeriod will become effective in UTC format.
newRetentionPeriod	integer	If the retention period is scheduled to be updated in the future (i.e., if retention period is previously reduced with value of reduceRetentionPeriodImmediately as false), this property gives the future value of retention period while retentionPeriod gives the current value. retentionPeriod will take up the value of newRetentionPeriod after the scheduled time.
filledRanges	array	List of the different units of filled ranges since the autoview has been created.
status	string	Status of the scheduled view.
startTime	string	Start timestamp in UTC in RFC3339 format.
createdBy	string	Identifier of the user who created the scheduled view.
query	string	The query that defines the data to be included in the scheduled view.
indexId	string	The id of the Index where the output from Scheduled view is stored.
totalMessageCount	integer	Total number of messages for the scheduled view.
createdByOptimizeIt	boolean	If the scheduled view is created by OptimizeIt.
retentionPeriod	integer	The number of days to retain data in the scheduled view, or -1 to use the default value for your account. Only relevant if your account has multi-retention enabled.
dataForwardingId	string	An optional ID of a data forwarding configuration to be used by the scheduled view.

Methods

Name	Accessible by	Required Params	Description
getScheduledView	SELECT	id, region	Get a scheduled view with the given identifier.
listScheduledViews	SELECT	region	Get a list of all scheduled views in the organization. The response is paginated with a default limit of 100 scheduled views per page.
createScheduledView	INSERT	data__indexName, data__query, data__startTime, region	Creates a new scheduled view in the organization.
updateScheduledView	EXEC	id, region	Update an existing scheduled view.