Documentation ¶
Index ¶
- Constants
- Variables
- func ActionNotFound(name string) error
- func AlertNotFound(name string) error
- func CloneHeader(in http.Header) http.Header
- func CloneRequest(req *http.Request) *http.Request
- func NewHttpTransport(config Config) *http.Transport
- func ParserNotFound(name string) error
- type Action
- type Actions
- 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
- type Alerts
- func (a *Alerts) Add(viewName string, newAlert *Alert) (*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, newAlert *Alert) (*Alert, error)
- type Client
- func (c *Client) Actions() *Actions
- func (c *Client) Address() *url.URL
- func (c *Client) Alerts() *Alerts
- func (c *Client) CACertificate() string
- func (c *Client) ClusterNodes() *ClusterNodes
- func (c *Client) Clusters() *Clusters
- func (c *Client) Config() Config
- func (c *Client) FeatureFlags() *FeatureFlags
- func (c *Client) Files() *Files
- func (c *Client) Groups() *Groups
- func (c *Client) HTTPRequest(httpMethod string, path string, body io.Reader) (*http.Response, error)
- func (c *Client) HTTPRequestContext(ctx context.Context, httpMethod string, path string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) Health() (Health, error)
- func (c *Client) HealthString() (string, error)
- func (c *Client) IngestTokens() *IngestTokens
- func (c *Client) Insecure() bool
- func (c *Client) Licenses() *Licenses
- func (c *Client) Mutate(mutation interface{}, variables map[string]interface{}) error
- func (c *Client) Organizations() *Organizations
- func (c *Client) Packages() *Packages
- func (c *Client) Parsers() *Parsers
- func (c *Client) Query(query interface{}, variables map[string]interface{}) error
- func (c *Client) QueryJobs() *QueryJobs
- func (c *Client) Repositories() *Repositories
- func (c *Client) Roles() *Roles
- func (c *Client) Status() (*StatusResponse, error)
- func (c *Client) Token() string
- func (c *Client) Users() *Users
- func (c *Client) Viewer() *Viewer
- func (c *Client) Views() *Views
- type Cluster
- type ClusterNode
- type ClusterNodes
- type Clusters
- func (c *Clusters) ClusterMoveIngestRoutesAwayFromNode(nodeID int) errordeprecated
- func (c *Clusters) ClusterMoveStorageRouteAwayFromNode(nodeID int) errordeprecated
- func (c *Clusters) Get() (Cluster, error)
- func (c *Clusters) StartDataRedistribution() errordeprecated
- func (c *Clusters) SuggestedIngestPartitions() ([]IngestPartitionInput, error)deprecated
- func (c *Clusters) SuggestedStoragePartitions() ([]StoragePartitionInput, error)deprecated
- func (c *Clusters) UpdateIngestPartitionScheme(desired []IngestPartitionInput) errordeprecated
- func (c *Clusters) UpdateStoragePartitionScheme(desired []StoragePartitionInput) errordeprecated
- type Config
- type DefaultGroupEnum
- type EmailAction
- type EntityNotFound
- type EntityType
- type FeatureFlag
- type FeatureFlags
- 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 File
- type Files
- type Group
- type Groups
- type Health
- type HealthCheck
- type HttpHeaderEntryInput
- type HumioRepoAction
- type IngestPartition
- type IngestPartitionInput
- type IngestToken
- type IngestTokens
- func (i *IngestTokens) Add(repositoryName string, tokenName string, parser string) (*IngestToken, error)
- func (i *IngestTokens) Get(repoName, tokenName string) (*IngestToken, error)
- func (i *IngestTokens) List(repo string) ([]IngestToken, error)
- func (i *IngestTokens) Remove(repositoryName string, tokenName string) error
- func (i *IngestTokens) Update(repositoryName string, tokenName string, parser string) (*IngestToken, error)
- type InstallationErrors
- type InstalledPackage
- type License
- type Licenses
- type OnPremLicense
- type OpsGenieAction
- type Organization
- type Organizations
- type Packages
- func (p *Packages) CreateArchive(packageDirPath string, targetFileName string) error
- func (p *Packages) InstallArchive(viewName string, pathToZip string) (*ValidationResponse, error)
- func (p *Packages) InstallFromDirectory(packageDirPath string, targetRepoOrView string) (*ValidationResponse, error)
- func (p *Packages) ListInstalled(viewName string) ([]InstalledPackage, error)
- func (p *Packages) UninstallPackage(viewName string, packageID string) error
- func (p *Packages) Validate(viewName string, absPath string) (*ValidationResponse, error)
- type PagerDutyAction
- type Parser
- type ParserListItem
- type ParserTestCase
- type Parsers
- func (p *Parsers) Add(repositoryName string, parser *Parser, force bool) error
- func (p *Parsers) Export(repositoryName string, parserName string) (string, error)
- func (p *Parsers) Get(repositoryName string, parserName string) (*Parser, error)
- func (p *Parsers) List(repositoryName string) ([]ParserListItem, error)
- func (p *Parsers) Remove(repositoryName string, parserName string) error
- type Query
- type QueryError
- type QueryJobs
- func (q QueryJobs) Create(repository string, query Query) (string, error)
- 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)
- type QueryResult
- type QueryResultMetadata
- type RepoListItem
- type Repositories
- func (r *Repositories) Create(name string) error
- func (r *Repositories) Delete(name, reason string, allowDataDeletion bool) error
- func (r *Repositories) Get(name string) (Repository, error)
- func (r *Repositories) List() ([]RepoListItem, 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
- func (r *Repositories) UpdateUserGroup(name, username string, groups ...DefaultGroupEnum) error
- type Repository
- type Role
- type Roles
- 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
- type SlackAction
- type SlackFieldEntryInput
- type SlackPostMessageAction
- type StatusResponse
- type StatusValue
- type StoragePartition
- type StoragePartitionInput
- type UnversionedPackageSpecifier
- type User
- type UserChangeSet
- type Users
- func (u *Users) Add(username string, changeset UserChangeSet) (User, error)
- func (u *Users) Get(username string) (User, error)
- func (u *Users) List() ([]User, error)
- func (u *Users) Remove(username string) (User, error)
- func (u *Users) RotateToken(userID string) (string, error)
- func (u *Users) Update(username string, changeset UserChangeSet) (User, error)
- type ValidationResponse
- type VersionedPackageSpecifier
- type VictorOpsAction
- type View
- type ViewConnection
- type ViewConnectionInput
- type ViewListItem
- type ViewQueryData
- type Viewer
- type Views
- func (c *Views) Create(name, description string, connections []ViewConnectionInput) error
- func (c *Views) Delete(name, reason string) error
- func (c *Views) Get(name string) (*View, error)
- func (c *Views) List() ([]ViewListItem, error)
- func (c *Views) UpdateConnections(name string, connections []ViewConnectionInput) error
- func (c *Views) UpdateDescription(name string, description string) error
- type WebhookAction
Constants ¶
const ( ActionTypeEmail string = "EmailAction" ActionTypeHumioRepo string = "HumioRepoAction" ActionTypeOpsGenie string = "OpsGenieAction" ActionTypePagerDuty string = "PagerDutyAction" ActionTypeSlack string = "SlackAction" ActionTypeSlackPostMessage string = "SlackPostMessageAction" ActionTypeVictorOps string = "VictorOpsAction" ActionTypeWebhook string = "WebhookAction" )
const ( QueryOwnershipTypeUser string = "User" QueryOwnershipTypeOrganization string = "Organization" )
const JSONContentType string = "application/json"
JSONContentType is "application/json"
const ZIPContentType string = "application/zip"
Variables ¶
var ErrUserNotFound = errors.New("user not found")
Functions ¶
func ActionNotFound ¶ added in v0.29.0
func AlertNotFound ¶ added in v0.29.0
func CloneHeader ¶ added in v0.26.0
CloneHeader creates a deep copy of an http.Header.
func CloneRequest ¶ added in v0.26.0
CloneRequest creates a shallow copy of the request along with a deep copy of the Headers.
func NewHttpTransport ¶ added in v0.28.7
func ParserNotFound ¶ added in v0.29.0
Types ¶
type Action ¶ added in v0.29.0
type Action struct { Type string `graphql:"__typename" yaml:"type" json:"type"` ID string `graphql:"id" yaml:"-" json:"id"` Name string `graphql:"name" yaml:"name" json:"name"` EmailAction EmailAction `graphql:"... on EmailAction" yaml:"emailAction,omitempty" json:"emailAction,omitempty"` HumioRepoAction HumioRepoAction `graphql:"... on HumioRepoAction" yaml:"humioRepoAction,omitempty" json:"humioRepoAction,omitempty"` OpsGenieAction OpsGenieAction `graphql:"... on OpsGenieAction" yaml:"opsGenieAction,omitempty" json:"opsGenieAction,omitempty"` PagerDutyAction PagerDutyAction `graphql:"... on PagerDutyAction" yaml:"pagerDutyAction,omitempty" json:"pagerDutyAction,omitempty"` SlackAction SlackAction `graphql:"... on SlackAction" yaml:"slackAction,omitempty" json:"slackAction,omitempty"` SlackPostMessageAction SlackPostMessageAction `graphql:"... on SlackPostMessageAction" yaml:"slackPostMessageAction,omitempty" json:"slackPostMessageAction,omitempty"` VictorOpsAction VictorOpsAction `graphql:"... on VictorOpsAction" yaml:"victorOpsAction,omitempty" json:"victorOpsAction,omitempty"` WebhookAction WebhookAction `graphql:"... on WebhookAction" yaml:"webhookAction,omitempty" json:"webhookAction,omitempty"` }
type Actions ¶ added in v0.29.0
type Actions struct {
// contains filtered or unexported fields
}
type Alert ¶ added in v0.25.0
type Alert struct { ID string `graphql:"id" yaml:"-" json:"id"` Name string `graphql:"name" yaml:"name" json:"name"` QueryString string `graphql:"queryString" yaml:"queryString" json:"queryString"` QueryStart string `graphql:"queryStart" yaml:"queryStart" json:"queryStart"` ThrottleField string `graphql:"throttleField" yaml:"throttleField" json:"throttleField"` TimeOfLastTrigger int `graphql:"timeOfLastTrigger" yaml:"timeOfLastTrigger" json:"timeOfLastTrigger"` IsStarred bool `graphql:"isStarred" yaml:"isStarred" json:"isStarred"` Description string `graphql:"description" yaml:"description,omitempty" json:"description"` ThrottleTimeMillis int `graphql:"throttleTimeMillis" yaml:"throttleTimeMillis" json:"throttleTimeMillis"` Enabled bool `graphql:"enabled" yaml:"enabled" json:"enabled"` Actions []string `graphql:"actions" yaml:"actions" json:"actions"` Labels []string `graphql:"labels" yaml:"labels,omitempty" json:"labels,omitempty"` LastError string `graphql:"lastError" yaml:"lastError" json:"lastError"` RunAsUserID string `graphql:"runAsUserId" yaml:"runAsUserId,omitempty" json:"runAsUserID,omitempty"` QueryOwnershipType string `graphql:"queryOwnershipType" yaml:"queryOwnershipType,omitempty" json:"queryOwnershipType,omitempty"` }
type Alerts ¶ added in v0.25.0
type Alerts struct {
// contains filtered or unexported fields
}
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func NewClientWithTransport ¶ added in v0.28.7
func (*Client) CACertificate ¶ added in v0.26.0
func (*Client) ClusterNodes ¶ added in v0.25.0
func (c *Client) ClusterNodes() *ClusterNodes
func (*Client) FeatureFlags ¶ added in v0.29.0
func (c *Client) FeatureFlags() *FeatureFlags
func (*Client) HTTPRequest ¶ added in v0.25.0
func (*Client) HTTPRequestContext ¶ added in v0.25.0
func (*Client) HealthString ¶ added in v0.25.0
func (*Client) IngestTokens ¶
func (c *Client) IngestTokens() *IngestTokens
func (*Client) Organizations ¶ added in v0.28.1
func (c *Client) Organizations() *Organizations
func (*Client) Repositories ¶ added in v0.13.0
func (c *Client) Repositories() *Repositories
func (*Client) Status ¶ added in v0.4.0
func (c *Client) Status() (*StatusResponse, error)
type Cluster ¶ added in v0.25.0
type Cluster struct { Nodes []ClusterNode ClusterInfoAgeSeconds float64 UnderReplicatedSegmentSize float64 OverReplicatedSegmentSize float64 MissingSegmentSize float64 ProperlyReplicatedSegmentSize float64 TargetUnderReplicatedSegmentSize float64 TargetOverReplicatedSegmentSize float64 TargetMissingSegmentSize float64 TargetProperlyReplicatedSegmentSize float64 IngestPartitions []IngestPartition StoragePartitions []StoragePartition // Deprecated: returns dummy data as of LogScale 1.88 }
type ClusterNode ¶ added in v0.25.0
type ClusterNode struct { Id int Name string Uri string Uuid string ClusterInfoAgeSeconds float64 InboundSegmentSize float64 OutboundSegmentSize float64 CanBeSafelyUnregistered bool CurrentSize float64 PrimarySize float64 SecondarySize float64 TotalSizeOfPrimary float64 TotalSizeOfSecondary float64 FreeOnPrimary float64 FreeOnSecondary float64 WipSize float64 TargetSize float64 SolitarySegmentSize float64 IsAvailable bool LastHeartbeat string // Zone holds the availability zone as configured in the `ZONE` configuration of the Humio server. Zone string }
type ClusterNodes ¶ added in v0.25.0
type ClusterNodes struct {
// contains filtered or unexported fields
}
func (*ClusterNodes) Get ¶ added in v0.25.0
func (n *ClusterNodes) Get(nodeID int) (ClusterNode, error)
func (*ClusterNodes) List ¶ added in v0.25.0
func (n *ClusterNodes) List() ([]ClusterNode, error)
func (*ClusterNodes) Unregister ¶ added in v0.25.0
func (n *ClusterNodes) Unregister(nodeID int, force bool) error
type Clusters ¶ added in v0.25.0
type Clusters struct {
// contains filtered or unexported fields
}
func (*Clusters) ClusterMoveIngestRoutesAwayFromNode
deprecated
added in
v0.25.0
func (*Clusters) ClusterMoveStorageRouteAwayFromNode
deprecated
added in
v0.25.0
func (*Clusters) StartDataRedistribution
deprecated
added in
v0.25.0
func (*Clusters) SuggestedIngestPartitions
deprecated
added in
v0.28.1
func (c *Clusters) SuggestedIngestPartitions() ([]IngestPartitionInput, error)
Deprecated: returns dummy data as of LogScale 1.80
func (*Clusters) SuggestedStoragePartitions
deprecated
added in
v0.28.1
func (c *Clusters) SuggestedStoragePartitions() ([]StoragePartitionInput, error)
Deprecated: returns dummy data as of LogScale 1.88
func (*Clusters) UpdateIngestPartitionScheme
deprecated
added in
v0.25.0
func (c *Clusters) UpdateIngestPartitionScheme(desired []IngestPartitionInput) error
Deprecated: returns dummy data as of LogScale 1.80
func (*Clusters) UpdateStoragePartitionScheme
deprecated
added in
v0.25.0
func (c *Clusters) UpdateStoragePartitionScheme(desired []StoragePartitionInput) error
Deprecated: returns dummy data as of LogScale 1.88
type Config ¶
type Config struct { Address *url.URL UserAgent string Token string CACertificatePEM string Insecure bool ProxyOrganization string DialContext func(ctx context.Context, network, addr string) (net.Conn, error) }
func DefaultConfig ¶
func DefaultConfig() Config
type DefaultGroupEnum ¶ added in v0.27.0
type DefaultGroupEnum string
const ( DefaultGroupEnumMember DefaultGroupEnum = "Member" DefaultGroupEnumAdmin DefaultGroupEnum = "Admin" DefaultGroupEnumEliminator DefaultGroupEnum = "Eliminator" )
func (*DefaultGroupEnum) ParseString ¶ added in v0.27.0
func (e *DefaultGroupEnum) ParseString(s string) bool
func (DefaultGroupEnum) String ¶ added in v0.27.0
func (e DefaultGroupEnum) String() string
type EmailAction ¶ added in v0.29.0
type EmailAction struct { Recipients []string `graphql:"emailRecipients: recipients" yaml:"recipients,omitempty" json:"recipients,omitempty"` SubjectTemplate string `graphql:"emailSubjectTemplate: subjectTemplate" yaml:"subjectTemplate,omitempty" json:"subjectTemplate,omitempty"` BodyTemplate string `graphql:"emailBodyTemplate: bodyTemplate" yaml:"bodyTemplate,omitempty" json:"bodyTemplate,omitempty"` UseProxy bool `graphql:"emailUseProxy: useProxy" yaml:"useProxy,omitempty" json:"useProxy,omitempty"` }
type EntityNotFound ¶ added in v0.29.0
type EntityNotFound struct {
// contains filtered or unexported fields
}
func (EntityNotFound) EntityType ¶ added in v0.29.0
func (e EntityNotFound) EntityType() EntityType
func (EntityNotFound) Error ¶ added in v0.29.0
func (e EntityNotFound) Error() string
func (EntityNotFound) Key ¶ added in v0.29.0
func (e EntityNotFound) Key() string
type EntityType ¶ added in v0.29.0
type EntityType string
const ( EntityTypeParser EntityType = "parser" EntityTypeAction EntityType = "action" EntityTypeAlert EntityType = "alert" )
func (EntityType) String ¶ added in v0.29.0
func (e EntityType) String() string
type FeatureFlag ¶ added in v0.29.0
type FeatureFlag string
type FeatureFlags ¶ added in v0.29.0
type FeatureFlags struct {
// contains filtered or unexported fields
}
func (*FeatureFlags) DisableForOrganization ¶ added in v0.29.0
func (f *FeatureFlags) DisableForOrganization(organizationID string, flag FeatureFlag) error
func (*FeatureFlags) DisableForUser ¶ added in v0.29.0
func (f *FeatureFlags) DisableForUser(userID string, flag FeatureFlag) error
func (*FeatureFlags) DisableGlobally ¶ added in v0.29.0
func (f *FeatureFlags) DisableGlobally(flag FeatureFlag) error
func (*FeatureFlags) EnableForOrganization ¶ added in v0.29.0
func (f *FeatureFlags) EnableForOrganization(organizationID string, flag FeatureFlag) error
func (*FeatureFlags) EnableForUser ¶ added in v0.29.0
func (f *FeatureFlags) EnableForUser(userID string, flag FeatureFlag) error
func (*FeatureFlags) EnableGlobally ¶ added in v0.29.0
func (f *FeatureFlags) EnableGlobally(flag FeatureFlag) error
func (*FeatureFlags) SupportedFlags ¶ added in v0.29.0
func (f *FeatureFlags) SupportedFlags() ([]FeatureFlag, error)
type Files ¶ added in v0.28.2
type Files struct {
// contains filtered or unexported fields
}
type Groups ¶ added in v0.28.1
type Groups struct {
// contains filtered or unexported fields
}
func (*Groups) AddUserToGroup ¶ added in v0.28.1
type Health ¶ added in v0.25.0
type Health struct { Status StatusValue `json:"status"` StatusMessage string `json:"statusMessage"` Uptime string `json:"uptime"` Version string `json:"version"` OK []HealthCheck `json:"oks"` Warn []HealthCheck `json:"warnings"` Down []HealthCheck `json:"down"` // contains filtered or unexported fields }
func (*Health) ChecksMap ¶ added in v0.25.0
func (h *Health) ChecksMap() map[string]HealthCheck
type HealthCheck ¶ added in v0.25.0
type HealthCheck struct { Name string `json:"name"` Status StatusValue `json:"status"` StatusMessage string `json:"statusMessage"` Fields map[string]interface{} `json:"fields"` }
type HttpHeaderEntryInput ¶ added in v0.29.0
type HumioRepoAction ¶ added in v0.29.0
type HumioRepoAction struct {
IngestToken string `graphql:"humioRepoIngestToken: ingestToken" yaml:"ingestToken,omitempty" json:"ingestToken,omitempty"`
}
type IngestPartition ¶ added in v0.25.0
type IngestPartitionInput ¶ added in v0.25.0
type IngestToken ¶
type IngestTokens ¶
type IngestTokens struct {
// contains filtered or unexported fields
}
func (*IngestTokens) Add ¶
func (i *IngestTokens) Add(repositoryName string, tokenName string, parser string) (*IngestToken, error)
func (*IngestTokens) Get ¶ added in v0.25.0
func (i *IngestTokens) Get(repoName, tokenName string) (*IngestToken, error)
func (*IngestTokens) List ¶
func (i *IngestTokens) List(repo string) ([]IngestToken, error)
func (*IngestTokens) Remove ¶
func (i *IngestTokens) Remove(repositoryName string, tokenName string) error
func (*IngestTokens) Update ¶ added in v0.25.0
func (i *IngestTokens) Update(repositoryName string, tokenName string, parser string) (*IngestToken, error)
type InstallationErrors ¶ added in v0.28.10
type InstalledPackage ¶ added in v0.28.0
type InstalledPackage struct { ID string InstalledBy *struct { Username string Timestamp string } UpdatedBy *struct { Username string Timestamp string } Source string AvailableUpdate string }
InstalledPackage contain the details of an installed package
type OnPremLicense ¶ added in v0.12.0
type OnPremLicense struct { ID string ExpiresAtVal string IssuedAtVal string IssuedTo string NumberOfSeats int }
func (OnPremLicense) ExpiresAt ¶ added in v0.12.0
func (l OnPremLicense) ExpiresAt() string
func (OnPremLicense) IssuedAt ¶ added in v0.12.0
func (l OnPremLicense) IssuedAt() string
type OpsGenieAction ¶ added in v0.29.0
type OpsGenieAction struct { ApiUrl string `graphql:"opsGenieApiUrl: apiUrl" yaml:"apiUrl,omitempty" json:"apiUrl,omitempty"` GenieKey string `graphql:"opsGenieGenieKey: genieKey" yaml:"genieKey,omitempty" json:"genieKey,omitempty"` UseProxy bool `graphql:"opsGenieUseProxy: useProxy" yaml:"useProxy,omitempty" json:"useProxy,omitempty"` }
type Organization ¶ added in v0.28.1
type Organizations ¶ added in v0.28.1
type Organizations struct {
// contains filtered or unexported fields
}
func (*Organizations) CreateOrganization ¶ added in v0.28.1
func (o *Organizations) CreateOrganization(name string) (Organization, error)
type Packages ¶ added in v0.27.0
type Packages struct {
// contains filtered or unexported fields
}
Packages is a API client for working with Humio packages.
func (*Packages) CreateArchive ¶ added in v0.27.0
CreateArchive creates a archive by bundling the files in packageDirPath in a zip file.
func (*Packages) InstallArchive ¶ added in v0.27.0
func (p *Packages) InstallArchive(viewName string, pathToZip string) (*ValidationResponse, error)
InstallArchive installs a local package (zip file).
func (*Packages) InstallFromDirectory ¶ added in v0.27.0
func (p *Packages) InstallFromDirectory(packageDirPath string, targetRepoOrView string) (*ValidationResponse, error)
InstallFromDirectory installs a package from a directory containing the package files.
func (*Packages) ListInstalled ¶ added in v0.28.0
func (p *Packages) ListInstalled(viewName string) ([]InstalledPackage, error)
ListInstalled returns a list of installed packages
func (*Packages) UninstallPackage ¶ added in v0.27.0
UninstallPackage uninstalls a package by name.
type PagerDutyAction ¶ added in v0.29.0
type PagerDutyAction struct { Severity string `graphql:"pagerDutySeverity: severity" yaml:"severity,omitempty" json:"severity,omitempty"` RoutingKey string `graphql:"pagerDutyRoutingKey: routingKey" yaml:"routingKey,omitempty" json:"routingKey,omitempty"` UseProxy bool `graphql:"pagerDutyUseProxy: useProxy" yaml:"useProxy,omitempty" json:"useProxy,omitempty"` }
type ParserListItem ¶
type ParserTestCase ¶
type Parsers ¶
type Parsers struct {
// contains filtered or unexported fields
}
type Query ¶ added in v0.25.0
type Query struct { QueryString string `json:"queryString"` Start string `json:"start,omitempty"` End string `json:"end,omitempty"` Live bool `json:"isLive,omitempty"` TimezoneOffset *int `json:"timeZoneOffsetMinutes,omitempty"` Arguments map[string]string `json:"arguments,omitempty"` ShowQueryEventDistribution bool `json:"showQueryEventDistribution,omitempty"` }
type QueryError ¶ added in v0.25.0
type QueryError struct {
// contains filtered or unexported fields
}
func (QueryError) Error ¶ added in v0.25.0
func (e QueryError) Error() string
type QueryJobs ¶ added in v0.25.0
type QueryJobs struct {
// contains filtered or unexported fields
}
func (*QueryJobs) Poll ¶ added in v0.25.0
func (q *QueryJobs) Poll(repository string, id string) (QueryResult, error)
func (*QueryJobs) PollContext ¶ added in v0.25.0
type QueryResult ¶ added in v0.25.0
type QueryResult struct { Cancelled bool `json:"cancelled"` Done bool `json:"done"` Events []map[string]interface{} `json:"events"` Metadata QueryResultMetadata `json:"metaData"` }
type QueryResultMetadata ¶ added in v0.25.0
type QueryResultMetadata struct { EventCount uint64 `json:"eventCount"` ExtraData map[string]interface{} `json:"extraData"` FieldOrder []string `json:"fieldOrder"` IsAggregate bool `json:"isAggregate"` PollAfter int `json:"pollAfter"` ProcessedBytes uint64 `json:"processedBytes"` ProcessedEvents uint64 `json:"processedEvents"` QueryStart uint64 `json:"queryStart"` QueryEnd uint64 `json:"queryEnd"` ResultBufferSize uint64 `json:"resultBufferSize"` TimeMillis uint64 `json:"timeMillis"` TotalWork uint64 `json:"totalWork"` WorkDone uint64 `json:"workDone"` }
type RepoListItem ¶ added in v0.13.0
type Repositories ¶ added in v0.13.0
type Repositories struct {
// contains filtered or unexported fields
}
func (*Repositories) Create ¶ added in v0.24.0
func (r *Repositories) Create(name string) error
func (*Repositories) Delete ¶ added in v0.26.0
func (r *Repositories) Delete(name, reason string, allowDataDeletion bool) error
func (*Repositories) Get ¶ added in v0.13.0
func (r *Repositories) Get(name string) (Repository, error)
func (*Repositories) List ¶ added in v0.13.0
func (r *Repositories) List() ([]RepoListItem, error)
func (*Repositories) UpdateDescription ¶ added in v0.26.0
func (r *Repositories) UpdateDescription(name, description string) error
func (*Repositories) UpdateIngestBasedRetention ¶ added in v0.26.0
func (r *Repositories) UpdateIngestBasedRetention(name string, ingestInGB float64, allowDataDeletion bool) error
func (*Repositories) UpdateStorageBasedRetention ¶ added in v0.26.0
func (r *Repositories) UpdateStorageBasedRetention(name string, storageInGB float64, allowDataDeletion bool) error
func (*Repositories) UpdateTimeBasedRetention ¶ added in v0.26.0
func (r *Repositories) UpdateTimeBasedRetention(name string, retentionInDays float64, allowDataDeletion bool) error
func (*Repositories) UpdateUserGroup ¶ added in v0.27.0
func (r *Repositories) UpdateUserGroup(name, username string, groups ...DefaultGroupEnum) error
type Repository ¶ added in v0.13.0
type Repository struct { ID string Name string Description string RetentionDays float64 `graphql:"timeBasedRetention"` IngestRetentionSizeGB float64 `graphql:"ingestSizeBasedRetention"` StorageRetentionSizeGB float64 `graphql:"storageSizeBasedRetention"` SpaceUsed int64 `graphql:"compressedByteSize"` }
type Role ¶ added in v0.5.0
type Role struct { ID string `graphql:"id"` DisplayName string `graphql:"displayName"` Color string `graphql:"color"` Description string `graphql:"description"` ViewPermissions []string `graphql:"viewPermissions"` SystemPermissions []string `graphql:"systemPermissions"` OrgPermissions []string `graphql:"organizationPermissions"` }
type Roles ¶ added in v0.31.0
type Roles struct {
// contains filtered or unexported fields
}
func (*Roles) RemoveRole ¶ added in v0.31.0
type SlackAction ¶ added in v0.29.0
type SlackAction struct { Url string `graphql:"slackUrl: url" yaml:"url,omitempty" json:"url,omitempty"` Fields []SlackFieldEntryInput `graphql:"slackFields: fields" yaml:"fields,omitempty" json:"fields,omitempty"` UseProxy bool `graphql:"slackUseProxy: useProxy" yaml:"useProxy,omitempty" json:"useProxy,omitempty"` }
type SlackFieldEntryInput ¶ added in v0.29.0
type SlackPostMessageAction ¶ added in v0.29.0
type SlackPostMessageAction struct { ApiToken string `graphql:"slackPostMessageApiToken: apiToken" yaml:"apiToken,omitempty" json:"apiToken,omitempty"` Channels []string `graphql:"slackPostMessageChannels: channels" yaml:"channels,omitempty" json:"channels,omitempty"` Fields []SlackFieldEntryInput `graphql:"slackPostMessageFields: fields" yaml:"fields,omitempty" json:"fields,omitempty"` UseProxy bool `graphql:"slackPostMessageUseProxy: useProxy" yaml:"useProxy,omitempty" json:"useProxy,omitempty"` }
type StatusResponse ¶ added in v0.4.0
func (StatusResponse) IsDown ¶ added in v0.25.0
func (s StatusResponse) IsDown() bool
type StatusValue ¶ added in v0.25.0
type StatusValue string
const ( StatusOK StatusValue = "OK" StatusWarn StatusValue = "WARN" StatusDown StatusValue = "DOWN" )
type StoragePartition ¶ added in v0.25.0
type StoragePartitionInput ¶ added in v0.25.0
type UnversionedPackageSpecifier ¶ added in v0.28.0
type UnversionedPackageSpecifier string
UnversionedPackageSpecifier is the ID of a package, e.g foo/bar
type UserChangeSet ¶
type Users ¶
type Users struct {
// contains filtered or unexported fields
}
func (*Users) Add ¶ added in v0.5.0
func (u *Users) Add(username string, changeset UserChangeSet) (User, error)
func (*Users) RotateToken ¶ added in v0.32.1
type ValidationResponse ¶ added in v0.27.0
type ValidationResponse struct { InstallationErrors []string `json:"installationErrors"` ParseErrors []string `json:"parseErrors"` }
ValidationResponse contain the results of a package validation.
func (*ValidationResponse) IsValid ¶ added in v0.27.0
func (resp *ValidationResponse) IsValid() bool
IsValid returns true if there are no errors in the package
type VersionedPackageSpecifier ¶ added in v0.27.0
type VersionedPackageSpecifier string
VersionedPackageSpecifier is the ID and version of a package, e.g foo/[email protected]
type VictorOpsAction ¶ added in v0.29.0
type VictorOpsAction struct { MessageType string `graphql:"victorOpsMessageType: messageType" yaml:"messageType,omitempty" json:"messageType,omitempty"` NotifyUrl string `graphql:"victorOpsNotifyUrl: notifyUrl" yaml:"notifyUrl,omitempty" json:"notifyUrl,omitempty"` UseProxy bool `graphql:"victorOpsUseProxy: useProxy" yaml:"useProxy,omitempty" json:"useProxy,omitempty"` }
type View ¶ added in v0.5.0
type View struct { Name string Description string Connections []ViewConnection }
type ViewConnection ¶ added in v0.15.0
type ViewConnectionInput ¶ added in v0.28.1
type ViewListItem ¶ added in v0.11.0
type ViewQueryData ¶ added in v0.15.0
type Viewer ¶ added in v0.4.0
type Viewer struct {
// contains filtered or unexported fields
}
type Views ¶ added in v0.5.0
type Views struct {
// contains filtered or unexported fields
}
func (*Views) Create ¶ added in v0.28.1
func (c *Views) Create(name, description string, connections []ViewConnectionInput) error
func (*Views) List ¶ added in v0.11.0
func (c *Views) List() ([]ViewListItem, error)
func (*Views) UpdateConnections ¶ added in v0.28.1
func (c *Views) UpdateConnections(name string, connections []ViewConnectionInput) error
type WebhookAction ¶ added in v0.29.0
type WebhookAction struct { Method string `graphql:"webhookMethod: method" yaml:"method,omitempty" json:"method,omitempty"` Url string `graphql:"webhookUrl: url" yaml:"url,omitempty" json:"url,omitempty"` Headers []HttpHeaderEntryInput `graphql:"webhookHeaders: headers" yaml:"headers,omitempty" json:"headers,omitempty"` BodyTemplate string `graphql:"webhookBodyTemplate: bodyTemplate" yaml:"bodyTemplate,omitempty" json:"bodyTemplate,omitempty"` IgnoreSSL bool `graphql:"webhookIgnoreSSL: ignoreSSL" yaml:"ignoreSSL,omitempty" json:"ignoreSSL,omitempty"` UseProxy bool `graphql:"webhookUseProxy: useProxy" yaml:"useProxy,omitempty" json:"useProxy,omitempty"` }