models

type ActionType string

type Audit struct {
	JobName    string     `json:"job_name,omitempty" description:"JobName is name of the job created/updated."`
	ModifiedAt *time.Time `json:"modified_at,omitempty" description:"ModifiedAt time of the job modified at."`
	Version    int        `json:"version" description:"Version of the job."`
	ModifiedBy string     `json:"modified_by,omitempty" description:"ModifiedBy is username of the person modified the job"`
	Action     string     `json:"action" description:"Handle indicates if the job was created or edited."`
	ID         string     `json:"id" description:"ID of the audit log."`
	JobID      string     `json:"job_id" description:"JobID is id of the job."`
}

type AuditResponse struct {
	Resources []Audit `json:"resources" description:"Resources is the list of Audit Info from custom storage."`
	Meta      *Paging `json:"meta,omitempty" description:"Meta is the pagination information."`
}

type Config struct {
	Cloud                           falcon.CloudType
	JobsCollection                  string
	AuditLogsCollection             string
	RemoveSystemWorkflowTemplateID  string
	RemoveConditionNodeID           string
	InstallSystemWorkflowTemplateID string
	InstallConditionNodeID          string
	BuildQSystemWorkflowTemplateID  string
	ExecutionNotifierWorkflow       string
}

type Direction int

type Filter struct {
	// Field is the name of the field on which to filter.
	Field string
	// Value is the value of the filter query.
	Value string
	// Op is the comparison operator.
	Op Operator
}

type InstallSoftwareAction struct {
	InstallFilePath string `json:"install_file_path" description:""`
	CommandSwitch   string `json:"command_switch" description:"CommandSwitch command need to be run during installing the file."`
	FileName        string `json:"file_name" description:"FileName indicates the file to be installed on the sensor."`
}

type Job struct {
	UserID           string         `json:"user_id" description:"UserID is the ID of the user who submitted the request."`
	UserName         string         `json:"user_name" description:"UserName is the username or email of the user who submitted the request."`
	ID               string         `json:"id,omitempty" description:"ID identifies a job"`
	Name             string         `json:"name" description:"Name is the name of the job."`
	Description      string         `json:"description,omitempty" description:"Description is the description of the job."`
	Version          int            `json:"version" description:"Version of the job"`
	Draft            bool           `json:"draft" description:"Draft indicates if the the job provisioned or not."`
	Notifications    []string       `json:"notifications" description:"Notifications is a list of email addresses to notify regarding this job."`
	Tags             []string       `json:"tags" description:"Tags is a list of tags to assign to this job."`
	HostCount        int            `json:"host_count" description:"HostCount gives estimates number of host targeted for this job."`
	Action           *RTRAction     `json:"action" description:"Handle contains information about the RTR put file or command."`
	Schedule         *Schedule      `json:"schedule" description:"Schedule defines when this job should execute."`
	WSchedule        *Schedule      `json:"wschedule" description:"Schedule defines when this job should execute in workflow format."`
	Target           *TargetHost    `json:"target" description:"Target defines the systems against which the action should be performed."`
	Workflows        *WorkflowsInfo `json:"workflows" description:"Workflows created for this job"`
	RunNow           bool           `json:"run_now" description:"Indicates if we need to run the workflow now."`
	TotalRecurrences int            `json:"total_recurrences" description:"TotalRecurrences is number of times job needs to be run."`
	RunCount         int            `json:"run_count" description:"RunCount is number of time job has ran."`
	NextRun          *time.Time     `json:"next_run,omitempty" description:"NextRun indicates the next time the job will run."`
	LastRun          *time.Time     `json:"last_run,omitempty" description:"LastRun indicates the last time the job ran."`
	OutputFormat     []string       `json:"output_format" description:"OutputFormat determines the user expecting the output format to be in."`
	CreatedAt        *time.Time     `json:"created_at,omitempty" description:"CreatedAt indicates the time at which job was created."`
	UpdatedAt        *time.Time     `json:"updated_at,omitempty" description:"UpdatedAt indicates the time at which jon was updated last."`
	DeletedAt        *time.Time     `json:"deleted_at,omitempty" description:"DeletedAt indicates the time at which job was deleted"`
}

type JobResponse struct {
	Resource Job `json:"resource" description:"Resource indicates Job details."`
}

type JobsResponse struct {
	Resources []Job   `json:"resources" description:"resources is list of Jobs in the custom storage"`
	Meta      *Paging `json:"meta" description:"meta is the pagination info."`
}

type Operator string

type Paging struct {
	Next  string `json:"next,omitempty" description:"Next is the marker to the next page."`
	Prev  string `json:"prev,omitempty" description:"Prev is the marker to the previous page."`
	Total int    `json:"total,omitempty" description:"Total is the total number of records available."`
	Limit int    `json:"limit,omitempty" description:"Limit is the total number of records to be queried per page."`
	Count int    `json:"count,omitempty" description:"Count is the total of record in a given page."`
}

type RTRAction struct {
	Type ActionType `json:"type" description:"Type indicates the type of activity the job needs to run."`
	InstallSoftwareAction
	RemoveFileAction
}

type RemoveFileAction struct {
	RemoveFileName string `json:"remove_file_name" description:"RemoveFileName indicates the name file to be removed."`
	RemoveFilePath string `json:"remove_file_path" description:"RemoveFilePath indicates the path of the file to be removed."`
}

type Schedule struct {
	TimeCycle      string `` /* 134-byte string literal not displayed */
	Start          string `json:"start_date,omitempty" description:"Start date in mm-dd-yyyy format"`
	End            string `json:"end_date,omitempty" description:"End date in mm-dd-yyyy format"`
	Timezone       string `json:"-" description:"Timezone label from IANA timezone database, for example, America/Los_Angeles"`
	SkipConcurrent bool   `json:"skip_concurrent" description:"Flag indicating if concurrent execution of scheduled workflow should be skipped or not"`
}

type SearchObjectsRequest struct {
	// Collection is the name of the collection.
	Collection string
	// Filter is the FQL filter.
	Filter string
	// Limit is the maximum number of records to be returned.
	Limit int
	// Offset is the records offset.
	Offset int
	// Sort is the FQL sort string.
	Sort string
}

type SearchObjectsResponse struct {
	// ObjectKeys contains the keys of objects which match the search response.
	ObjectKeys []string
	// Offset is the next value to present to the API get back the next page of results.
	Offset int
	// Total is the total number of records which match the filter.
	Total int
}

type SearchType string

type TargetHost struct {
	HostGroups      []string `json:"host_groups" description:"HostGroups indicates the list of host groups."`
	Hosts           []string `json:"hosts" description:"Hosts indicates the list of host."`
	OfflineQueueing bool     `json:"offline_queueing" description:"OfflineQueueing indicates if need to target host which are offline."`
}

type UpsertJobRequest struct {
	Job
}

type UpsertJobResponse struct {
	Resource string `json:"resource" description:""`
}

type ValidationErrorCode int

type WorkflowsInfo struct {
	ScheduleWorkflow string `json:"scheduled_workflow" description:"ScheduleWorkflow is the main workflow which runs the activity on an sensor"`
	NotifierWorkflow string `` /* 141-byte string literal not displayed */
}