Documentation
¶
Index ¶
- Constants
- Variables
- type Action
- type AggregateAlert
- type Alert
- type CreateAggregateAlert
- type CreateAlert
- type CreateFilterAlert
- type CreateParserInputV2
- type CreateScheduledSearch
- type FieldHasValue
- type FieldHasValueInput
- type FilterAlert
- type Long
- type Parser
- type ParserTestCase
- type ParserTestCaseAssertionsForOutput
- type ParserTestCaseAssertionsForOutputInput
- type ParserTestCaseInput
- type ParserTestCaseOutputAssertions
- type ParserTestCaseOutputAssertionsInput
- type ParserTestEvent
- type ParserTestEventInput
- type QueryOwnership
- type QueryOwnershipType
- type QueryOwnershipTypeName
- type QueryTimestampType
- type RepoOrViewName
- type S3ArchivingFormat
- type S3Configuration
- type ScheduledSearch
- type TriggerMode
- type UpdateAggregateAlert
- type UpdateAlert
- type UpdateFilterAlert
- type UpdateParserScriptInput
- type UpdateScheduledSearch
- type User
Constants ¶
View Source
const DefaultS3ArchivingFormat = S3ArchivingFormat("NDSON")
Variables ¶
View Source
var ValidS3ArchivingFormats = []S3ArchivingFormat{"NDJSON", "RAW"}
Functions ¶
This section is empty.
Types ¶
type AggregateAlert ¶ added in v0.36.0
type AggregateAlert struct {
ID graphql.String `graphql:"id"`
Name graphql.String `graphql:"name"`
Description graphql.String `graphql:"description"`
QueryString graphql.String `graphql:"queryString"`
SearchIntervalSeconds Long `graphql:"searchIntervalSeconds"`
ThrottleTimeSeconds Long `graphql:"throttleTimeSeconds"`
ThrottleField graphql.String `graphql:"throttleField"`
Actions []Action `graphql:"actions"`
Labels []graphql.String `graphql:"labels"`
Enabled graphql.Boolean `graphql:"enabled"`
QueryOwnership QueryOwnership `graphql:"queryOwnership"`
TriggerMode TriggerMode `graphql:"triggerMode"`
QueryTimestampType QueryTimestampType `graphql:"queryTimestampType"`
}
type Alert ¶
type Alert struct {
ID graphql.String `graphql:"id"`
Name graphql.String `graphql:"name"`
QueryString graphql.String `graphql:"queryString"`
QueryStart graphql.String `graphql:"queryStart"`
ThrottleField graphql.String `graphql:"throttleField"`
TimeOfLastTrigger Long `graphql:"timeOfLastTrigger"`
IsStarred graphql.Boolean `graphql:"isStarred"`
Description graphql.String `graphql:"description"`
ThrottleTimeMillis Long `graphql:"throttleTimeMillis"`
Enabled graphql.Boolean `graphql:"enabled"`
Actions []graphql.String `graphql:"actions"`
Labels []graphql.String `graphql:"labels"`
LastError graphql.String `graphql:"lastError"`
QueryOwnership QueryOwnership `graphql:"queryOwnership"`
RunAsUser User `graphql:"runAsUser"`
}
type CreateAggregateAlert ¶ added in v0.36.0
type CreateAggregateAlert struct {
ViewName RepoOrViewName `json:"viewName"`
Name graphql.String `json:"name"`
Description graphql.String `json:"description,omitempty"`
QueryString graphql.String `json:"queryString"`
SearchIntervalSeconds Long `json:"searchIntervalSeconds"`
ThrottleTimeSeconds Long `json:"throttleTimeSeconds"`
ThrottleField graphql.String `json:"throttleField,omitempty"`
ActionIdsOrNames []graphql.String `json:"actionIdsOrNames"`
Labels []graphql.String `json:"labels"`
Enabled graphql.Boolean `json:"enabled"`
RunAsUserID graphql.String `json:"runAsUserId,omitempty"`
QueryOwnershipType QueryOwnershipType `json:"queryOwnershipType"`
TriggerMode TriggerMode `json:"triggerMode,omitempty"`
QueryTimestampType QueryTimestampType `json:"queryTimestampType"`
}
type CreateAlert ¶
type CreateAlert struct {
ViewName graphql.String `json:"viewName"`
Name graphql.String `json:"name"`
Description graphql.String `json:"description,omitempty"`
QueryString graphql.String `json:"queryString"`
QueryStart graphql.String `json:"queryStart"`
ThrottleTimeMillis Long `json:"throttleTimeMillis"`
ThrottleField graphql.String `json:"throttleField,omitempty"`
RunAsUserID graphql.String `json:"runAsUserId,omitempty"`
Enabled graphql.Boolean `json:"enabled"`
Actions []graphql.String `json:"actions"`
Labels []graphql.String `json:"labels"`
QueryOwnershipType QueryOwnershipType `json:"queryOwnershipType,omitempty"`
}
type CreateFilterAlert ¶ added in v0.34.0
type CreateFilterAlert struct {
ViewName RepoOrViewName `json:"viewName"`
Name graphql.String `json:"name"`
Description graphql.String `json:"description,omitempty"`
QueryString graphql.String `json:"queryString"`
ActionIdsOrNames []graphql.String `json:"actionIdsOrNames"`
Labels []graphql.String `json:"labels"`
Enabled graphql.Boolean `json:"enabled"`
ThrottleTimeSeconds Long `json:"throttleTimeSeconds,omitempty"`
ThrottleField graphql.String `json:"throttleField,omitempty"`
RunAsUserID graphql.String `json:"runAsUserId,omitempty"`
QueryOwnershipType QueryOwnershipType `json:"queryOwnershipType"`
}
type CreateParserInputV2 ¶ added in v0.35.0
type CreateParserInputV2 struct {
Name graphql.String `json:"name"`
Script graphql.String `json:"script""`
TestCases []ParserTestCaseInput `json:"testCases"`
RepositoryName RepoOrViewName `json:"repositoryName"`
FieldsToTag []graphql.String `json:"fieldsToTag"`
FieldsToBeRemovedBeforeParsing []graphql.String `json:"fieldsToBeRemovedBeforeParsing"`
AllowOverwritingExistingParser graphql.Boolean `json:"allowOverwritingExistingParser"`
}
type CreateScheduledSearch ¶ added in v0.35.0
type CreateScheduledSearch struct {
ViewName graphql.String `json:"viewName"`
Name graphql.String `json:"name"`
Description graphql.String `json:"description,omitempty"`
QueryString graphql.String `json:"queryString"`
QueryStart graphql.String `json:"queryStart"`
QueryEnd graphql.String `json:"queryEnd"`
Schedule graphql.String `json:"schedule"`
TimeZone graphql.String `json:"timeZone"`
BackfillLimit graphql.Int `json:"backfillLimit"`
Enabled graphql.Boolean `json:"enabled"`
ActionsIdsOrNames []graphql.String `json:"actions"`
Labels []graphql.String `json:"labels,omitempty"`
RunAsUserID graphql.String `json:"runAsUserId,omitempty"`
QueryOwnership QueryOwnershipType `json:"queryOwnershipType,omitempty"`
}
type FieldHasValue ¶ added in v0.35.0
type FieldHasValueInput ¶ added in v0.35.0
type FilterAlert ¶ added in v0.34.0
type FilterAlert struct {
ID graphql.String `graphql:"id"`
Name graphql.String `graphql:"name"`
Description graphql.String `graphql:"description"`
QueryString graphql.String `graphql:"queryString"`
Actions []Action `graphql:"actions"`
Labels []graphql.String `graphql:"labels"`
Enabled graphql.Boolean `graphql:"enabled"`
ThrottleTimeSeconds Long `graphql:"throttleTimeSeconds"`
ThrottleField graphql.String `graphql:"throttleField"`
QueryOwnership QueryOwnership `graphql:"queryOwnership"`
}
type Parser ¶ added in v0.35.0
type Parser struct {
ID graphql.String `graphql:"id"`
Name graphql.String `graphql:"name"`
DisplayName graphql.String `graphql:"displayName"`
Description graphql.String `graphql:"description""`
IsBuiltIn graphql.Boolean `graphql:"isBuiltIn"`
Script graphql.String `graphql:"script"`
FieldsToTag []graphql.String `graphql:"fieldsToTag"`
FieldsToBeRemovedBeforeParsing []graphql.String `graphql:"fieldsToBeRemovedBeforeParsing"`
TestCases []ParserTestCase `graphql:"testCases"`
}
type ParserTestCase ¶ added in v0.35.0
type ParserTestCase struct {
Event ParserTestEvent `graphql:"event"`
OutputAssertions []ParserTestCaseAssertionsForOutput `graphql:"outputAssertions"`
}
type ParserTestCaseAssertionsForOutput ¶ added in v0.35.0
type ParserTestCaseAssertionsForOutput struct {
OutputEventIndex graphql.Int `graphql:"outputEventIndex"`
Assertions ParserTestCaseOutputAssertions `graphql:"assertions"`
}
type ParserTestCaseAssertionsForOutputInput ¶ added in v0.35.0
type ParserTestCaseAssertionsForOutputInput struct {
OutputEventIndex graphql.Int `json:"outputEventIndex"`
Assertions ParserTestCaseOutputAssertionsInput `json:"assertions"`
}
type ParserTestCaseInput ¶ added in v0.35.0
type ParserTestCaseInput struct {
Event ParserTestEventInput `json:"event"`
OutputAssertions []ParserTestCaseAssertionsForOutputInput `json:"outputAssertions"`
}
type ParserTestCaseOutputAssertions ¶ added in v0.35.0
type ParserTestCaseOutputAssertions struct {
FieldsNotPresent []string `graphql:"fieldsNotPresent"`
FieldsHaveValues []FieldHasValue `graphql:"fieldsHaveValues"`
}
type ParserTestCaseOutputAssertionsInput ¶ added in v0.35.0
type ParserTestCaseOutputAssertionsInput struct {
FieldsNotPresent []graphql.String `json:"fieldsNotPresent"`
FieldsHaveValues []FieldHasValueInput `json:"fieldsHaveValues"`
}
type ParserTestEvent ¶ added in v0.35.0
type ParserTestEventInput ¶ added in v0.35.0
type QueryOwnership ¶
type QueryOwnership struct {
ID graphql.String `graphql:"id"`
QueryOwnershipTypeName QueryOwnershipTypeName `graphql:"__typename"`
}
type QueryOwnershipType ¶
type QueryOwnershipType string
const ( QueryOwnershipTypeUser QueryOwnershipType = "User" QueryOwnershipTypeOrganization QueryOwnershipType = "Organization" )
type QueryOwnershipTypeName ¶
type QueryOwnershipTypeName string
const ( QueryOwnershipTypeNameOrganization QueryOwnershipTypeName = "OrganizationOwnership" QueryOwnershipTypeNameUser QueryOwnershipTypeName = "UserOwnership" )
type QueryTimestampType ¶ added in v0.36.0
type QueryTimestampType string
const ( QueryTimestampTypeIngestTimestamp QueryTimestampType = "IngestTimestamp" QueryTimestampTypeEventTimestamp QueryTimestampType = "EventTimestamp" )
type RepoOrViewName ¶ added in v0.34.0
type RepoOrViewName string
type S3ArchivingFormat ¶ added in v0.34.0
type S3ArchivingFormat string
S3ArchivingFormat - the format in which to store the archived data on S3, either RAW or NDJSON
func NewS3ArchivingFormat ¶ added in v0.34.0
func NewS3ArchivingFormat(format string) (S3ArchivingFormat, error)
NewS3ArchivingFormat - creates a S3ArchivingFormat and ensures the value is uppercase
func (*S3ArchivingFormat) Validate ¶ added in v0.34.0
func (f *S3ArchivingFormat) Validate() error
type S3Configuration ¶ added in v0.34.0
type S3Configuration struct {
Bucket string `graphql:"bucket"`
Region string `graphql:"region"`
Disabled bool `graphql:"disabled"`
Format S3ArchivingFormat `graphql:"format"`
}
func (*S3Configuration) IsConfigured ¶ added in v0.34.0
func (s *S3Configuration) IsConfigured() bool
func (*S3Configuration) IsEnabled ¶ added in v0.34.0
func (s *S3Configuration) IsEnabled() bool
IsEnabled - determine if S3Configuration is enabled based on values and the Disabled field to avoid a bool defaulting to false
type ScheduledSearch ¶ added in v0.35.0
type ScheduledSearch struct {
ID graphql.String `graphql:"id"`
Name graphql.String `graphql:"name"`
Description graphql.String `graphql:"description"`
QueryString graphql.String `graphql:"queryString"`
Start graphql.String `graphql:"start"`
End graphql.String `graphql:"end"`
TimeZone graphql.String `graphql:"timeZone"`
Schedule graphql.String `graphql:"schedule"`
BackfillLimit graphql.Int `graphql:"backfillLimit"`
Enabled graphql.Boolean `graphql:"enabled"`
ActionsV2 []Action `graphql:"actionsV2"`
RunAsUser User `graphql:"runAsUser"`
Labels []graphql.String `graphql:"labels"`
QueryOwnership QueryOwnership `graphql:"queryOwnership"`
}
type TriggerMode ¶ added in v0.36.0
type TriggerMode string
const ( TriggerModeCompleteMode TriggerMode = "CompleteMode" TriggerModeImmediateMode TriggerMode = "ImmediateMode" )
type UpdateAggregateAlert ¶ added in v0.36.0
type UpdateAggregateAlert struct {
ViewName RepoOrViewName `json:"viewName"`
ID graphql.String `json:"id"`
Name graphql.String `json:"name"`
Description graphql.String `json:"description,omitempty"`
QueryString graphql.String `json:"queryString"`
SearchIntervalSeconds Long `json:"searchIntervalSeconds"`
ThrottleTimeSeconds Long `json:"throttleTimeSeconds"`
ThrottleField graphql.String `json:"throttleField,omitempty"`
ActionIdsOrNames []graphql.String `json:"actionIdsOrNames"`
Labels []graphql.String `json:"labels"`
Enabled graphql.Boolean `json:"enabled"`
RunAsUserID graphql.String `json:"runAsUserId,omitempty"`
QueryOwnershipType QueryOwnershipType `json:"queryOwnershipType"`
TriggerMode TriggerMode `json:"triggerMode"`
QueryTimestampType QueryTimestampType `json:"queryTimestampType"`
}
type UpdateAlert ¶
type UpdateAlert struct {
ViewName graphql.String `json:"viewName"`
ID graphql.String `json:"id"`
Name graphql.String `json:"name"`
Description graphql.String `json:"description,omitempty"`
QueryString graphql.String `json:"queryString"`
QueryStart graphql.String `json:"queryStart"`
ThrottleTimeMillis Long `json:"throttleTimeMillis"`
ThrottleField graphql.String `json:"throttleField,omitempty"`
RunAsUserID graphql.String `json:"runAsUserId,omitempty"`
Enabled graphql.Boolean `json:"enabled"`
Actions []graphql.String `json:"actions"`
Labels []graphql.String `json:"labels"`
QueryOwnershipType QueryOwnershipType `json:"queryOwnershipType,omitempty"`
}
type UpdateFilterAlert ¶ added in v0.34.0
type UpdateFilterAlert struct {
ViewName RepoOrViewName `json:"viewName"`
ID graphql.String `json:"id"`
Name graphql.String `json:"name"`
Description graphql.String `json:"description,omitempty"`
QueryString graphql.String `json:"queryString"`
ActionIdsOrNames []graphql.String `json:"actionIdsOrNames"`
Labels []graphql.String `json:"labels"`
Enabled graphql.Boolean `json:"enabled"`
ThrottleTimeSeconds Long `json:"throttleTimeSeconds,omitempty"`
ThrottleField graphql.String `json:"throttleField,omitempty"`
RunAsUserID graphql.String `json:"runAsUserId,omitempty"`
QueryOwnershipType QueryOwnershipType `json:"queryOwnershipType"`
}
type UpdateParserScriptInput ¶ added in v0.35.0
type UpdateScheduledSearch ¶ added in v0.35.0
type UpdateScheduledSearch struct {
ViewName graphql.String `json:"viewName"`
ID graphql.String `json:"id"`
Name graphql.String `json:"name"`
Description graphql.String `json:"description,omitempty"`
QueryString graphql.String `json:"queryString"`
QueryStart graphql.String `json:"queryStart"`
QueryEnd graphql.String `json:"queryEnd"`
Schedule graphql.String `json:"schedule"`
TimeZone graphql.String `json:"timeZone"`
BackfillLimit graphql.Int `json:"backfillLimit"`
Enabled graphql.Boolean `json:"enabled"`
ActionsIdsOrNames []graphql.String `json:"actions"`
Labels []graphql.String `json:"labels"`
RunAsUserID graphql.String `json:"runAsUserId,omitempty"`
QueryOwnership QueryOwnershipType `json:"queryOwnershipType"`
}
Click to show internal directories.
Click to hide internal directories.