collectors

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

Overview

Name	collectors
Type	Resource
Id	sumologic.ingest_budgets.collectors

Fields

The following fields are returned by SELECT queries:

getAssignedCollectors

A paginated list of Collectors.

Name	Datatype	Description
id	string	Unique identifier for the Collector.
name	string	The name of the Collector.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getAssignedCollectors	select	id, region	limit, token	Get a list of Collectors assigned to an ingest budget. The response is paginated with a default limit of 100 Collectors per page.
removeCollectorFromBudget	delete	id, collectorId, region		Remove Collector from a budget.
assignCollectorToBudget	exec	id, collectorId, region		Assign a Collector to a budget.

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
collectorId	string	Identifier of the Collector to assign.
id	string	Identifier of the ingest budget to assign to the Collector.
region	string	SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2)
limit	integer (int32)	Limit the number of Collectors returned in the response. The number of Collectors returned may be less than the limit.
token	string	Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results.

SELECT examples

getAssignedCollectors

Get a list of Collectors assigned to an ingest budget. The response is paginated with a default limit of 100 Collectors per page.

SELECT
id,
name
FROM sumologic.ingest_budgets.collectors
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND token = '{{ token }}'
;

DELETE examples

removeCollectorFromBudget

Remove Collector from a budget.

DELETE FROM sumologic.ingest_budgets.collectors
WHERE id = '{{ id }}' --required
AND collectorId = '{{ collectorId }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

assignCollectorToBudget

Assign a Collector to a budget.

EXEC sumologic.ingest_budgets.collectors.assignCollectorToBudget 
@id='{{ id }}' --required, 
@collectorId='{{ collectorId }}' --required, 
@region='{{ region }}' --required
;