api

Mar 1, 2024

Changes in this version

+ const QueryOwnershipTypeOrganization

+ const QueryOwnershipTypeUser

type Alert

+ QueryOwnershipType string

+ RunAsUserID string

type ViewListItem

+ Typename string

Sep 20, 2023

Changes in this version

type Users

+ func (u *Users) RotateToken(userID string) (string, error)

May 15, 2023

Changes in this version

type Client

+ func (c *Client) Roles() *Roles

type Role

+ Color string

+ Description string

+ DisplayName string

+ ID string

+ OrgPermissions []string

+ SystemPermissions []string

+ ViewPermissions []string

+ type Roles struct

+ func (r *Roles) Create(role *Role) error

+ func (r *Roles) Get(rolename string) (*Role, error)

+ func (r *Roles) GetRoleID(rolename string) (string, error)

+ func (r *Roles) List() ([]Role, error)

+ func (r *Roles) RemoveRole(rolename string) error

+ func (r *Roles) Update(rolename string, newRole *Role) error

Aug 18, 2022

Changes in this version

type View

+ Description string

type ViewQueryData

+ Description string

Feb 16, 2022

Changes in this version

+ const ActionTypeEmail

+ const ActionTypeHumioRepo

+ const ActionTypeOpsGenie

+ const ActionTypePagerDuty

+ const ActionTypeSlack

+ const ActionTypeSlackPostMessage

+ const ActionTypeVictorOps

+ const ActionTypeWebhook

+ func ActionNotFound(name string) error

+ func AlertNotFound(name string) error

+ func ParserNotFound(name string) error

+ type Action struct

+ EmailAction EmailAction

+ HumioRepoAction HumioRepoAction

+ ID string

+ Name string

+ OpsGenieAction OpsGenieAction

+ PagerDutyAction PagerDutyAction

+ SlackAction SlackAction

+ SlackPostMessageAction SlackPostMessageAction

+ Type string

+ VictorOpsAction VictorOpsAction

+ WebhookAction WebhookAction

+ type Actions struct

+ func (n *Actions) Add(viewName string, newAction *Action) (*Action, error)

+ func (n *Actions) Delete(viewName, actionName string) error

+ func (n *Actions) Get(viewName, actionName string) (*Action, error)

+ func (n *Actions) GetByID(viewName, actionID string) (*Action, error)

+ func (n *Actions) List(viewName string) ([]Action, error)

+ func (n *Actions) Update(viewName string, newAction *Action) (*Action, error)

type Alert

+ Actions []string

+ Enabled bool

+ IsStarred bool

+ LastError string

+ QueryStart string

+ QueryString string

+ ThrottleField string

+ TimeOfLastTrigger int

type Client

+ func (c *Client) Actions() *Actions

+ func (c *Client) FeatureFlags() *FeatureFlags

+ type EmailAction struct

+ BodyTemplate string

+ Recipients []string

+ SubjectTemplate string

+ UseProxy bool

+ type EntityNotFound struct

+ func (e EntityNotFound) EntityType() EntityType

+ func (e EntityNotFound) Error() string

+ func (e EntityNotFound) Key() string

+ type EntityType string

+ const EntityTypeAction

+ const EntityTypeAlert

+ const EntityTypeParser

+ func (e EntityType) String() string

+ type FeatureFlag string

+ type FeatureFlags struct

+ func (f *FeatureFlags) DisableForOrganization(organizationID string, flag FeatureFlag) error

+ func (f *FeatureFlags) DisableForUser(userID string, flag FeatureFlag) error

+ func (f *FeatureFlags) DisableGlobally(flag FeatureFlag) error

+ func (f *FeatureFlags) EnableForOrganization(organizationID string, flag FeatureFlag) error

+ func (f *FeatureFlags) EnableForUser(userID string, flag FeatureFlag) error

+ func (f *FeatureFlags) EnableGlobally(flag FeatureFlag) error

+ func (f *FeatureFlags) SupportedFlags() ([]FeatureFlag, error)

+ type HttpHeaderEntryInput struct

+ Header string

+ Value string

+ type HumioRepoAction struct

+ IngestToken string

+ type Long int64

+ type OpsGenieAction struct

+ ApiUrl string

+ GenieKey string

+ UseProxy bool

+ type PagerDutyAction struct

+ RoutingKey string

+ Severity string

+ UseProxy bool

type Parser

+ ID string

type ParserListItem

+ ID string

+ type SlackAction struct

+ Fields []SlackFieldEntryInput

+ Url string

+ UseProxy bool

+ type SlackFieldEntryInput struct

+ FieldName string

+ Value string

+ type SlackPostMessageAction struct

+ ApiToken string

+ Channels []string

+ Fields []SlackFieldEntryInput

+ UseProxy bool

+ type VictorOpsAction struct

+ MessageType string

+ NotifyUrl string

+ UseProxy bool

+ type WebhookAction struct

+ BodyTemplate string

+ Headers []HttpHeaderEntryInput

+ IgnoreSSL bool

+ Method string

+ Url string

+ UseProxy bool

Oct 14, 2021

Changes in this version

+ type InstallationErrors struct

+ InstallationErrors []string

+ ParseErrors []string

+ ResponseType string

Sep 24, 2021

Changes in this version

+ func NewHttpTransport(config Config) *http.Transport

type Client

+ func NewClientWithTransport(config Config, httpTransport *http.Transport) *Client

Jun 28, 2021

Changes in this version

type Config

+ UserAgent string

Jan 11, 2021

Changes in this version

type Client

+ func (c *Client) Files() *Files

+ type File struct

+ ContentHash string

+ ID string

+ Name string

+ type Files struct

+ func (f *Files) Delete(viewName string, fileName string) error

+ func (f *Files) Download(viewName string, fileName string) (io.Reader, error)

+ func (f *Files) List(viewName string) ([]File, error)

+ func (f *Files) Upload(viewName string, fileName string, reader io.Reader) error

type RepoListItem

+ ID string

Nov 6, 2020

Changes in this version

+ const NotifierTypeHumioRepo

+ const NotifierTypeSlackPostMessage

+ var ErrManagedGroupDoesNotExist = errors.New("managed export group does not exist")

+ var ErrUserNotFound = errors.New("user not found")

+ type AddTransferJobResponse struct

+ ID string

type Client

+ func (c *Client) Config() Config

+ func (c *Client) Groups() *Groups

+ func (c *Client) Organizations() *Organizations

+ func (c *Client) Transfer() *Transfer

type Clusters

+ func (c *Clusters) SuggestedIngestPartitions() ([]IngestPartitionInput, error)

+ func (c *Clusters) SuggestedStoragePartitions() ([]StoragePartitionInput, error)

type Config

+ DialContext func(ctx context.Context, network, addr string) (net.Conn, error)

+ type Group struct

+ DisplayName string

+ ID string

+ type Groups struct

+ func (g *Groups) AddUserToGroup(groupID string, userID string) error

+ func (g *Groups) List() ([]Group, error)

+ func (g *Groups) RemoveUserFromGroup(groupID string, userID string) error

+ type Organization struct

+ Description *string

+ ID string

+ Name string

+ type Organizations struct

+ func (o *Organizations) CreateOrganization(name string) (Organization, error)

type Repository

+ ID string

+ type Transfer struct

+ func (t *Transfer) AddTransferJob(sourceClusterURL string, sourceClusterToken string, ...) (AddTransferJobResponse, error)

+ func (t *Transfer) CancelTransferJob(transferJobID string) (TransferJob, error)

+ func (t *Transfer) CreateManagedExportGroup() (string, error)

+ func (t *Transfer) GetManagedExportGroup() (string, error)

+ func (t *Transfer) GetTransferJobStatus(transferJobID string) (TransferJobStatus, error)

+ func (t *Transfer) ListTransferJobs() ([]TransferJob, error)

+ func (t *Transfer) RemoveManagedExportGroup() error

+ type TransferJob struct

+ CancelledAt *time.Time

+ CompletedAt *time.Time

+ Dataspaces []string

+ ID string

+ MaximumParallelDownloads int

+ SourceClusterURL string

+ type TransferJobStatus struct

+ Error string

+ Running bool

+ Status string

+ StatusLine string

+ TotalSegments int

+ TransferredSegments int

type User

+ ID string

type Users

+ func (u *Users) RotateUserApiTokenAndGet(userID string) (string, error)

+ type ViewConnectionInput struct

+ Filter graphql.String

+ RepositoryName graphql.String

type Views

+ func (c *Views) Create(name, description string, connections map[string]string) error

+ func (c *Views) Delete(name, reason string) error

+ func (c *Views) UpdateConnections(name string, connections map[string]string) error

+ func (c *Views) UpdateDescription(name string, description string) error

Oct 29, 2020

Changes in this version

+ const ZIPContentType

type ClusterNode

+ Zone string

type Config

+ CACertificatePEM string

+ ProxyOrganization string

+ type InstalledPackage struct

+ AvailableUpdate string

+ ID string

+ InstalledBy ...

+ Source string

+ UpdatedBy ...

type Packages

+ func (p *Packages) ListInstalled(viewName string) ([]InstalledPackage, error)

+ type UnversionedPackageSpecifier string

Sep 24, 2020

Changes in this version

+ const JSONContentType

type Client

+ func (c *Client) Packages() *Packages

+ type DefaultGroupEnum string

+ const DefaultGroupEnumAdmin

+ const DefaultGroupEnumEliminator

+ const DefaultGroupEnumMember

+ func (e *DefaultGroupEnum) ParseString(s string) bool

+ func (e DefaultGroupEnum) String() string

+ type Packages struct

+ func (p *Packages) CreateArchive(packageDirPath string, targetFileName string) error

+ func (p *Packages) InstallArchive(repoOrViewName string, pathToZip string) (*ValidationResponse, error)

+ func (p *Packages) InstallFromDirectory(packageDirPath string, targetRepoOrView string) (*ValidationResponse, error)

+ func (p *Packages) UninstallPackage(repoOrViewName string, packageID string) error

+ func (p *Packages) Validate(repoOrViewName string, absDiretoryPath string) (*ValidationResponse, error)

type Parsers

+ func (p *Parsers) Export(reposistoryName string, parserName string) (string, error)

type Repositories

+ func (r *Repositories) UpdateUserGroup(name, username string, groups ...DefaultGroupEnum) error

+ type ValidationResponse struct

+ InstallationErrors []string

+ ParseErrors []string

+ func (resp *ValidationResponse) IsValid() bool

+ type VersionedPackageSpecifier string

Jul 31, 2020

Changes in this version

+ func CloneHeader(in http.Header) http.Header

+ func CloneRequest(req *http.Request) *http.Request

type Client

+ func (c *Client) CACertificate() []byte

+ func (c *Client) Insecure() bool

type Config

+ CACertificate []byte

+ Insecure bool

type Repositories

+ func (r *Repositories) Delete(name, reason string, allowDataDeletion bool) error

+ func (r *Repositories) UpdateDescription(name, description string) error

+ func (r *Repositories) UpdateIngestBasedRetention(name string, ingestInGB float64, allowDataDeletion bool) error

+ func (r *Repositories) UpdateStorageBasedRetention(name string, storageInGB float64, allowDataDeletion bool) error

+ func (r *Repositories) UpdateTimeBasedRetention(name string, retentionInDays float64, allowDataDeletion bool) error

type Repository

+ Description string

+ IngestRetentionSizeGB float64

+ StorageRetentionSizeGB float64

May 11, 2020

Changes in this version

+ const NotifierTypeEmail

+ const NotifierTypeOpsGenie

+ const NotifierTypePagerDuty

+ const NotifierTypeSlack

+ const NotifierTypeVictorOps

+ const NotifierTypeWebHook

+ type Alert struct

+ Description string

+ ID string

+ Labels []string

+ LinkURL string

+ Name string

+ Notifiers []string

+ Query HumioQuery

+ Silenced bool

+ ThrottleTimeMillis int

+ type Alerts struct

+ func (a *Alerts) Add(viewName string, alert *Alert, updateExisting bool) (*Alert, error)

+ func (a *Alerts) Delete(viewName, alertName string) error

+ func (a *Alerts) Get(viewName, alertName string) (*Alert, error)

+ func (a *Alerts) List(viewName string) ([]Alert, error)

+ func (a *Alerts) Update(viewName string, alert *Alert) (*Alert, error)

type Client

+ func (c *Client) Alerts() *Alerts

+ func (c *Client) ClusterNodes() *ClusterNodes

+ func (c *Client) Clusters() *Clusters

+ func (c *Client) HTTPRequest(httpMethod string, path string, body *bytes.Buffer) (*http.Response, error)

+ func (c *Client) HTTPRequestContext(ctx context.Context, httpMethod string, path string, body *bytes.Buffer) (*http.Response, error)

+ func (c *Client) Health() (Health, error)

+ func (c *Client) HealthString() (string, error)

+ func (c *Client) Notifiers() *Notifiers

+ func (c *Client) QueryJobs() *QueryJobs

+ type Cluster struct

+ ClusterInfoAgeSeconds float64

+ IngestPartitions []IngestPartition

+ MissingSegmentSize float64

+ Nodes []ClusterNode

+ OverReplicatedSegmentSize float64

+ ProperlyReplicatedSegmentSize float64

+ StoragePartitions []StoragePartition

+ TargetMissingSegmentSize float64

+ TargetOverReplicatedSegmentSize float64

+ TargetProperlyReplicatedSegmentSize float64

+ TargetUnderReplicatedSegmentSize float64

+ UnderReplicatedSegmentSize float64

+ type ClusterNode struct

+ CanBeSafelyUnregistered bool

+ ClusterInfoAgeSeconds float64

+ CurrentSize float64

+ FreeOnPrimary float64

+ FreeOnSecondary float64

+ Id int

+ InboundSegmentSize float64

+ IsAvailable bool

+ LastHeartbeat string

+ Name string

+ OutboundSegmentSize float64

+ PrimarySize float64

+ Reapply_targetSize float64

+ SecondarySize float64

+ SolitarySegmentSize float64

+ StorageDivergence float64

+ TargetSize float64

+ TotalSizeOfPrimary float64

+ TotalSizeOfSecondary float64

+ Uri string

+ Uuid string

+ WipSize float64

+ type ClusterNodes struct

+ func (n *ClusterNodes) Get(nodeID int) (ClusterNode, error)

+ func (n *ClusterNodes) List() ([]ClusterNode, error)

+ func (n *ClusterNodes) Unregister(nodeID int64, force bool) error

+ type Clusters struct

+ func (c *Clusters) ClusterMoveIngestRoutesAwayFromNode(nodeID int) error

+ func (c *Clusters) ClusterMoveStorageRouteAwayFromNode(nodeID int) error

+ func (c *Clusters) Get() (Cluster, error)

+ func (c *Clusters) StartDataRedistribution() error

+ func (c *Clusters) UpdateIngestPartitionScheme(desired []IngestPartitionInput) error

+ func (c *Clusters) UpdateStoragePartitionScheme(desired []StoragePartitionInput) error

+ type Health struct

+ Down []HealthCheck

+ OK []HealthCheck

+ Status StatusValue

+ StatusMessage string

+ Uptime string

+ Version string

+ Warn []HealthCheck

+ func (h *Health) ChecksMap() map[string]HealthCheck

+ func (h *Health) Json() []byte

+ type HealthCheck struct

+ Fields map[string]interface{}

+ Name string

+ Status StatusValue

+ StatusMessage string

+ type HumioQuery struct

+ End string

+ IsLive bool

+ QueryString string

+ Start string

+ type IngestPartition struct

+ Id int

+ NodeIds []int

+ type IngestPartitionInput struct

+ ID graphql.Int

+ NodeIDs []graphql.Int

type IngestTokens

+ func (i *IngestTokens) Get(repoName, tokenName string) (*IngestToken, error)

+ func (i *IngestTokens) Update(repositoryName string, tokenName string, parserName string) (*IngestToken, error)

+ type Notifier struct

+ Entity string

+ ID string

+ Name string

+ Properties map[string]interface{}

+ type Notifiers struct

+ func (n *Notifiers) Add(viewName string, notifier *Notifier, force bool) (*Notifier, error)

+ func (n *Notifiers) Delete(viewName, notifierName string) error

+ func (n *Notifiers) Get(viewName, notifierName string) (*Notifier, error)

+ func (n *Notifiers) GetByID(viewName, notifierID string) (*Notifier, error)

+ func (n *Notifiers) List(viewName string) ([]Notifier, error)

+ func (n *Notifiers) Update(viewName string, notifier *Notifier) (*Notifier, error)

+ type Query struct

+ Arguments map[string]string

+ End string

+ Live bool

+ QueryString string

+ ShowQueryEventDistribution bool

+ Start string

+ TimezoneOffset *int

+ type QueryError struct

+ func (e QueryError) Error() string

+ type QueryJobs struct

+ func (q *QueryJobs) Delete(repository string, id string) error

+ func (q *QueryJobs) Poll(repository string, id string) (QueryResult, error)

+ func (q *QueryJobs) PollContext(ctx context.Context, repository string, id string) (QueryResult, error)

+ func (q QueryJobs) Create(repository string, query Query) (string, error)

+ type QueryResult struct

+ Cancelled bool

+ Done bool

+ Events []map[string]interface{}

+ Metadata QueryResultMetadata

+ type QueryResultMetadata struct

+ EventCount uint64

+ ExtraData map[string]interface{}

+ FieldOrder []string

+ IsAggregate bool

+ PollAfter int

+ ProcessedBytes uint64

+ ProcessedEvents uint64

+ QueryEnd uint64

+ QueryStart uint64

+ ResultBufferSize uint64

+ TimeMillis uint64

+ TotalWork uint64

+ WorkDone uint64

type StatusResponse

+ func (s StatusResponse) IsDown() bool

+ type StatusValue string

+ const StatusDown

+ const StatusOK

+ const StatusWarn

+ type StoragePartition struct

+ Id int

+ NodeIds []int

+ type StoragePartitionInput struct

+ ID graphql.Int

+ NodeIDs []graphql.Int

type Viewer

+ func (c *Viewer) ApiToken() (string, error)

Jun 13, 2019

Changes in this version

type Repositories

+ func (c *Repositories) Create(name string) error

Dec 2, 2018

Changes in this version

type View

+ Connections []ViewConnection

+ type ViewConnection struct

+ Filter string

+ RepoName string

+ type ViewQueryData struct

+ Name string

+ Roles []RolePermission

+ ViewInfo struct{ ... }

Dec 2, 2018

Changes in this version

type Client

+ func (c *Client) Repositories() *Repositories

+ type RepoListItem struct

+ Name string

+ SpaceUsed int64

+ type Repositories struct

+ func (c *Repositories) Get(name string) (Repository, error)

+ func (c *Repositories) List() ([]RepoListItem, error)

+ type Repository struct

+ Name string

+ RetentionDays int64

+ RetentionSizeGB int64

+ SpaceUsed int64

Dec 1, 2018

Changes in this version

type Client

+ func (c *Client) Licenses() *Licenses

type License

+ ExpiresAt func() string

+ IssuedAt func() string

+ LicenseType func() string

+ type Licenses struct

+ func (c *Licenses) Get() (License, error)

+ func (p *Licenses) Install(license string) error

+ type OnPremLicense struct

+ ExpiresAtVal string

+ Fingerprint string

+ ID string

+ IssuedAtVal string

+ IssuedTo string

+ NumberOfSeats int

+ func (l OnPremLicense) ExpiresAt() string

+ func (l OnPremLicense) IssuedAt() string

+ func (l OnPremLicense) LicenseType() string

+ type TrialLicense struct

+ ExpiresAtVal string

+ IssuedAtVal string

+ func (l TrialLicense) ExpiresAt() string

+ func (l TrialLicense) IssuedAt() string

+ func (l TrialLicense) LicenseType() string

Nov 30, 2018

Changes in this version

+ type ViewListItem struct

+ Name string

type Views

+ func (c *Views) List() ([]ViewListItem, error)

Nov 29, 2018

Changes in this version

type Client

+ func (c *Client) License() *License

+ type License struct

+ func (c *License) Get() (LicenseData, error)

+ func (p *License) Install(license string) error

+ type LicenseData struct

+ ExpiresAt string

+ IssuedAt string

Nov 28, 2018

Changes in this version

type Client

+ func (c *Client) Views() *Views

+ type Role struct

+ Name string

+ type RolePermission struct

+ QueryPrefix string

+ Role struct{ ... }

+ View struct{ ... }

type User

+ Company string

+ CountryCode string

+ Email string

+ Picture string

+ Roles []Role

type Users

+ func (c *Users) Add(username string, changeset UserChangeSet) (User, error)

+ type View struct

+ Name string

+ Roles []RolePermission

+ type Views struct

+ func (c *Views) Get(name string) (View, error)

Nov 27, 2018

Changes in this version

+ type AppConfigProperties map[string]string

+ func ReadPropertiesFile(filename string) (AppConfigProperties, error)

type Client

+ func (c *Client) Status() (*StatusResponse, error)

+ func (c *Client) Viewer() *Viewer

+ type StatusResponse struct

+ Status string

+ Version string

type UserChangeSet

+ Company *string

+ CountryCode *string

+ Email *string

+ FullName *string

+ Picture *string

+ type Viewer struct

+ func (c *Viewer) Username() (string, error)

Nov 23, 2018

Changes in this version

+ type Client struct

+ func NewClient(config Config) (*Client, error)

+ func (c *Client) Address() string

+ func (c *Client) HttpPOST(path string, jsonStr *bytes.Buffer) (*http.Response, error)

+ func (c *Client) IngestTokens() *IngestTokens

+ func (c *Client) Mutate(mutation interface{}, variables map[string]interface{}) error

+ func (c *Client) Parsers() *Parsers

+ func (c *Client) Query(query interface{}, variables map[string]interface{}) error

+ func (c *Client) Token() string

+ func (c *Client) Users() *Users

+ type Config struct

+ Address string

+ Token string

+ func DefaultConfig() Config

+ type IngestToken struct

+ AssignedParser string

+ Name string

+ Token string

+ type IngestTokens struct

+ func (p *IngestTokens) Add(repo string, name string, parserName *string) (*IngestToken, error)

+ func (p *IngestTokens) List(repo string) ([]IngestToken, error)

+ func (p *IngestTokens) Remove(repo string, tokenName string) error

+ type Parser struct

+ Description string

+ Example string

+ Name string

+ Script string

+ TagFields []string

+ Tests []ParserTestCase

+ type ParserListItem struct

+ IsBuiltIn bool

+ Name string

+ type ParserTestCase struct

+ Input string

+ Output map[string]string

+ type Parsers struct

+ func (p *Parsers) Add(reposistoryName string, parser *Parser, force bool) error

+ func (p *Parsers) Get(reposistoryName string, parserName string) (*Parser, error)

+ func (p *Parsers) List(reposistoryName string) ([]ParserListItem, error)

+ func (p *Parsers) Remove(reposistoryName string, parserName string) error

+ type User struct

+ CreatedAt string

+ FullName string

+ IsRoot bool

+ Username string

+ type UserChangeSet struct

+ IsRoot *bool

+ type Users struct

+ func (c *Users) Get(username string) (User, error)

+ func (c *Users) List() ([]User, error)

+ func (c *Users) Remove(username string, changeset UserChangeSet) error

+ func (c *Users) Update(username string, changeset UserChangeSet) (User, error)