builtin

Creates, updates, deletes, gets or lists a builtin resource.

Overview

Name	builtin
Type	Resource
Id	sumologic.fields.builtin

Fields

The following fields are returned by SELECT queries:

getBuiltInField

The details of the built-in field.

Name	Datatype	Description
dataType	string	Field type. Possible values are String, Long, Int, Double, and Boolean. (pattern: ^(String|Long|Int|Double|Boolean)$, example: String, x-pattern-message: Must be String, Long, Int, Double or Boolean)
fieldId	string	Identifier of the field. (example: 00000000031D02DA)
fieldName	string	Field name. (example: hostIP)
state	string	Indicates whether the field is enabled and its values are being accepted. Possible values are Enabled and Disabled. (pattern: ^(Enabled|Disabled)$, example: Enabled, x-pattern-message: Must be Enabled or Disabled)

listBuiltInFields

List of all built-in fields.

Name	Datatype	Description
data	array	List of built-in fields.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getBuiltInField	select	id, region		Get the details of a built-in field.
listBuiltInFields	select	region		Built-in fields are created automatically by Sumo Logic for standard configuration purposes. They include _sourceHost and _sourceCategory. Built-in fields can't be deleted or disabled.

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
id	string	Identifier of a built-in field. (example: 000000000000000A)
region	string	SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2)

SELECT examples

getBuiltInField

Get the details of a built-in field.

SELECT
dataType,
fieldId,
fieldName,
state
FROM sumologic.fields.builtin
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

listBuiltInFields

Built-in fields are created automatically by Sumo Logic for standard configuration purposes. They include _sourceHost and _sourceCategory. Built-in fields can't be deleted or disabled.

SELECT
data
FROM sumologic.fields.builtin
WHERE region = '{{ region }}' -- required
;