estimated_usage

Creates, updates, deletes, gets or lists an estimated_usage resource.

Overview

Name	estimated_usage
Type	Resource
Id	sumologic.log_searches.estimated_usage

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
estimate	exec	region, queryString, timeRange, timezone		Gets the estimated volume of data that would be scanned for a given log search in the Infrequent data tier.<br />
estimate_by_tier	exec	region, queryString, timeRange, timezone		Gets the estimated volume of data that would be scanned for a given log search per data tier.<br />
estimate_by_metering_type	exec	region, queryString, timeRange, timezone		Gets the estimated volume of data, per metering type, that would be scanned for running a given log search for a given timerange.<br />
estimate_by_view	exec	region, queryString, timeRange, timezone		Gets the estimated volume of data, per view, that would be scanned for running a given log search for a given timerange.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT)

Lifecycle Methods

EXEC variables use wire (API) names.

estimate

Gets the estimated volume of data that would be scanned for a given log search in the Infrequent data tier.<br />

EXEC sumologic.log_searches.estimated_usage.estimate 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set 
@@json=
'{
"queryString": "{{ queryString }}", 
"timeRange": "{{ timeRange }}", 
"runByReceiptTime": {{ runByReceiptTime }}, 
"queryParameters": "{{ queryParameters }}", 
"intervalTimeType": "{{ intervalTimeType }}", 
"parsingMode": "{{ parsingMode }}", 
"timezone": "{{ timezone }}"
}'
;

estimate_by_tier

Gets the estimated volume of data that would be scanned for a given log search per data tier.<br />

EXEC sumologic.log_searches.estimated_usage.estimate_by_tier 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set 
@@json=
'{
"queryString": "{{ queryString }}", 
"timeRange": "{{ timeRange }}", 
"runByReceiptTime": {{ runByReceiptTime }}, 
"queryParameters": "{{ queryParameters }}", 
"intervalTimeType": "{{ intervalTimeType }}", 
"timezone": "{{ timezone }}"
}'
;

estimate_by_metering_type

Gets the estimated volume of data, per metering type, that would be scanned for running a given log search for a given timerange.<br />

EXEC sumologic.log_searches.estimated_usage.estimate_by_metering_type 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set 
@@json=
'{
"queryString": "{{ queryString }}", 
"timeRange": "{{ timeRange }}", 
"queryParameters": "{{ queryParameters }}", 
"intervalTimeType": "{{ intervalTimeType }}", 
"runByReceiptTime": {{ runByReceiptTime }}, 
"timezone": "{{ timezone }}", 
"emulateSearchContext": "{{ emulateSearchContext }}"
}'
;

estimate_by_view

Gets the estimated volume of data, per view, that would be scanned for running a given log search for a given timerange.<br />

EXEC sumologic.log_searches.estimated_usage.estimate_by_view 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set 
@@json=
'{
"queryString": "{{ queryString }}", 
"timeRange": "{{ timeRange }}", 
"queryParameters": "{{ queryParameters }}", 
"intervalTimeType": "{{ intervalTimeType }}", 
"runByReceiptTime": {{ runByReceiptTime }}, 
"timezone": "{{ timezone }}", 
"emulateSearchContext": "{{ emulateSearchContext }}"
}'
;