Documentation
¶
Index ¶
- Variables
- type APIKeyRoleDescriptor
- type Action
- type ActionAlertsFilter
- type ActionFrequency
- type Agent
- type AgentConfiguration
- type AgentToolsConfig
- type AlertingRule
- type AlertingRuleAction
- type AlertingRuleExecutionStatus
- type AlertingRuleFlapping
- type AlertingRuleSchedule
- type AlertsFilterTimeframe
- type Application
- type ComponentTemplate
- type ComponentTemplateResponse
- type CrossClusterAPIKeyAccess
- type CrossClusterAPIKeyAccessEntry
- type DataStreamLifecycle
- type DataStreamLifecycleResponse
- type DataStreamOptions
- type DataStreamSettings
- type Downsampling
- type EnrichPolicy
- type FailureStoreLifecycle
- type FailureStoreOptions
- type FieldSecurity
- type GetTransformResponse
- type Index
- type IndexAlias
- type IndexPerms
- type IndexTemplate
- type IngestPipeline
- type KibanaActionConnector
- type LifecycleSettings
- type LogstashPipeline
- type Phase
- type Policy
- type PutIndexParams
- type PutWatch
- type RemoteIndexPerms
- type Restriction
- type Slo
- type StringSliceOrCSV
- type Template
- type Tool
- type Transform
- type TransformAlias
- type TransformDestination
- type TransformRetentionPolicy
- type TransformRetentionPolicyTime
- type TransformSettings
- type TransformSource
- type TransformSync
- type TransformSyncTime
- type Watch
- type WatchBody
- type Workflow
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrInvalidStringSliceOrCSV = errors.New("expected array of strings, or a csv string")
Functions ¶
This section is empty.
Types ¶
type APIKeyRoleDescriptor ¶ added in v0.14.3
type APIKeyRoleDescriptor struct {
Name string `json:"-"`
Applications []Application `json:"applications,omitempty"`
Global map[string]any `json:"global,omitempty"`
Cluster []string `json:"cluster,omitempty"`
Indices []IndexPerms `json:"indices,omitempty"`
RemoteIndices []RemoteIndexPerms `json:"remote_indices,omitempty"`
Metadata map[string]any `json:"metadata,omitempty"`
RunAs []string `json:"run_as,omitempty"`
Restriction *Restriction `json:"restriction,omitempty"`
}
type ActionAlertsFilter ¶ added in v0.11.7
type ActionAlertsFilter struct {
Kql *string
Timeframe *AlertsFilterTimeframe
}
type ActionFrequency ¶ added in v0.11.7
type Agent ¶ added in v0.14.4
type Agent struct {
ID string `json:"id"`
Name string `json:"name"`
Description *string `json:"description,omitempty"`
AvatarColor *string `json:"avatar_color,omitempty"`
AvatarSymbol *string `json:"avatar_symbol,omitempty"`
Labels []string `json:"labels,omitempty"`
Configuration AgentConfiguration `json:"configuration"`
}
type AgentConfiguration ¶ added in v0.14.4
type AgentConfiguration struct {
Instructions *string `json:"instructions,omitempty"`
Tools []AgentToolsConfig `json:"tools,omitempty"`
}
type AgentToolsConfig ¶ added in v0.14.4
type AgentToolsConfig struct {
ToolIDs []string `json:"tool_ids"`
}
type AlertingRule ¶ added in v0.6.0
type AlertingRule struct {
RuleID string
SpaceID string
Name string
Consumer string
NotifyWhen *string
Params map[string]any
RuleTypeID string
Schedule AlertingRuleSchedule
Actions []AlertingRuleAction
Enabled *bool
Tags []string
Throttle *string
ScheduledTaskID *string
ExecutionStatus AlertingRuleExecutionStatus
AlertDelay *float32
Flapping *AlertingRuleFlapping
}
type AlertingRuleAction ¶ added in v0.6.0
type AlertingRuleAction struct {
Group string
ID string
Params map[string]any
Frequency *ActionFrequency
AlertsFilter *ActionAlertsFilter
}
type AlertingRuleExecutionStatus ¶ added in v0.6.0
type AlertingRuleFlapping ¶ added in v0.14.4
AlertingRuleFlapping is rule-level flapping detection settings (Kibana 8.16+).
type AlertingRuleSchedule ¶ added in v0.6.0
type AlertingRuleSchedule struct {
Interval string
}
type AlertsFilterTimeframe ¶ added in v0.11.7
type Application ¶
type ComponentTemplate ¶ added in v0.3.0
type ComponentTemplateResponse ¶ added in v0.3.0
type ComponentTemplateResponse struct {
Name string `json:"name"`
ComponentTemplate ComponentTemplate `json:"component_template"`
}
type CrossClusterAPIKeyAccess ¶ added in v0.14.3
type CrossClusterAPIKeyAccess struct {
Search []CrossClusterAPIKeyAccessEntry `json:"search,omitempty"`
Replication []CrossClusterAPIKeyAccessEntry `json:"replication,omitempty"`
}
type CrossClusterAPIKeyAccessEntry ¶ added in v0.14.3
type CrossClusterAPIKeyAccessEntry struct {
Names []string `json:"names"`
FieldSecurity *FieldSecurity `json:"field_security,omitempty"`
Query *string `json:"query,omitempty"`
AllowRestrictedIndices *bool `json:"allow_restricted_indices,omitempty"`
}
type DataStreamLifecycle ¶ added in v0.11.11
type DataStreamLifecycle struct {
Name string `json:"name"`
Lifecycle LifecycleSettings `json:"lifecycle"`
}
type DataStreamLifecycleResponse ¶ added in v0.15.0
type DataStreamLifecycleResponse struct {
DataStreams []DataStreamLifecycle `json:"data_streams"`
}
type DataStreamOptions ¶ added in v0.15.0
type DataStreamOptions struct {
FailureStore *FailureStoreOptions `json:"failure_store,omitempty"`
}
type DataStreamSettings ¶ added in v0.3.1
type Downsampling ¶ added in v0.11.11
type EnrichPolicy ¶ added in v0.6.0
type FailureStoreLifecycle ¶ added in v0.15.0
type FailureStoreLifecycle struct {
DataRetention string `json:"data_retention,omitempty"`
}
type FailureStoreOptions ¶ added in v0.15.0
type FailureStoreOptions struct {
Enabled bool `json:"enabled"`
Lifecycle *FailureStoreLifecycle `json:"lifecycle,omitempty"`
}
type FieldSecurity ¶
type GetTransformResponse ¶ added in v0.6.0
type IndexAlias ¶ added in v0.2.0
type IndexAlias struct {
Name string `json:"-"`
Filter map[string]any `json:"filter,omitempty"`
IndexRouting string `json:"index_routing,omitempty"`
IsHidden bool `json:"is_hidden,omitempty"`
IsWriteIndex bool `json:"is_write_index,omitempty"`
Routing string `json:"routing,omitempty"`
SearchRouting string `json:"search_routing,omitempty"`
}
type IndexPerms ¶
type IndexPerms struct {
FieldSecurity *FieldSecurity `json:"field_security,omitempty"`
Names []string `json:"names"`
Privileges []string `json:"privileges"`
Query *string `json:"query,omitempty"`
AllowRestrictedIndices *bool `json:"allow_restricted_indices,omitempty"`
}
type IndexTemplate ¶
type IndexTemplate struct {
Name string `json:"-"`
Create bool `json:"-"`
Timeout string `json:"-"`
ComposedOf []string `json:"composed_of"`
IgnoreMissingComponentTemplates []string `json:"ignore_missing_component_templates,omitempty"`
DataStream *DataStreamSettings `json:"data_stream,omitempty"`
IndexPatterns []string `json:"index_patterns"`
Meta map[string]any `json:"_meta,omitempty"`
Priority *int64 `json:"priority,omitempty"`
Template *Template `json:"template,omitempty"`
Version *int64 `json:"version,omitempty"`
}
type IngestPipeline ¶ added in v0.3.0
type KibanaActionConnector ¶ added in v0.6.0
type LifecycleSettings ¶ added in v0.11.7
type LifecycleSettings struct {
DataRetention string `json:"data_retention,omitempty"`
Enabled bool `json:"enabled,omitempty"`
Downsampling []Downsampling `json:"downsampling,omitempty"`
}
type LogstashPipeline ¶ added in v0.5.0
type LogstashPipeline struct {
PipelineID string `json:"-"`
Description string `json:"description,omitempty"`
LastModified string `json:"last_modified"`
Pipeline string `json:"pipeline"`
PipelineMetadata map[string]any `json:"pipeline_metadata"`
PipelineSettings map[string]any `json:"pipeline_settings"`
Username string `json:"username"`
}
type PutIndexParams ¶ added in v0.6.0
type RemoteIndexPerms ¶ added in v0.11.7
type RemoteIndexPerms struct {
IndexPerms
Clusters []string `json:"clusters"`
}
type Restriction ¶ added in v0.11.5
type Restriction struct {
Workflows []string `json:"workflows,omitempty"`
}
type Slo ¶ added in v0.7.0
type Slo struct {
SloID string
Name string
Description string
Indicator kbapi.SLOsSloWithSummaryResponse_Indicator
TimeWindow kbapi.SLOsTimeWindow
BudgetingMethod kbapi.SLOsBudgetingMethod
Objective kbapi.SLOsObjective
Settings *kbapi.SLOsSettings
SpaceID string
GroupBy []string
Tags []string
Enabled bool
Artifacts *kbapi.SLOsArtifacts
}
type StringSliceOrCSV ¶ added in v0.11.3
type StringSliceOrCSV []string
func (*StringSliceOrCSV) UnmarshalJSON ¶ added in v0.11.3
func (i *StringSliceOrCSV) UnmarshalJSON(data []byte) error
type Template ¶
type Template struct {
Aliases map[string]IndexAlias `json:"aliases,omitempty"`
Mappings map[string]any `json:"mappings,omitempty"`
Settings map[string]any `json:"settings,omitempty"`
Lifecycle *LifecycleSettings `json:"lifecycle,omitempty"`
DataStreamOptions *DataStreamOptions `json:"data_stream_options,omitempty"`
}
type Transform ¶ added in v0.6.0
type Transform struct {
ID string `json:"id,omitempty"`
Name string `json:"-"`
Description string `json:"description,omitempty"`
Source *TransformSource `json:"source"`
Destination *TransformDestination `json:"dest"`
Pivot any `json:"pivot,omitempty"`
Latest any `json:"latest,omitempty"`
Frequency string `json:"frequency,omitempty"`
RetentionPolicy *TransformRetentionPolicy `json:"retention_policy,omitempty"`
Sync *TransformSync `json:"sync,omitempty"`
Meta any `json:"_meta,omitempty"`
Settings *TransformSettings `json:"settings,omitempty"`
}
type TransformAlias ¶ added in v0.11.9
type TransformDestination ¶ added in v0.6.0
type TransformDestination struct {
Index string `json:"index"`
Aliases []TransformAlias `json:"aliases,omitempty"`
Pipeline string `json:"pipeline,omitempty"`
}
type TransformRetentionPolicy ¶ added in v0.6.0
type TransformRetentionPolicy struct {
Time TransformRetentionPolicyTime `json:"time"`
}
type TransformRetentionPolicyTime ¶ added in v0.6.0
type TransformSettings ¶ added in v0.6.0
type TransformSettings struct {
AlignCheckpoints *bool `json:"align_checkpoints,omitempty"`
DatesAsEpochMillis *bool `json:"dates_as_epoch_millis,omitempty"`
DeduceMappings *bool `json:"deduce_mappings,omitempty"`
DocsPerSecond *float64 `json:"docs_per_second,omitempty"`
MaxPageSearchSize *int `json:"max_page_search_size,omitempty"`
NumFailureRetries *int `json:"num_failure_retries,omitempty"`
Unattended *bool `json:"unattended,omitempty"`
}
type TransformSource ¶ added in v0.6.0
type TransformSync ¶ added in v0.6.0
type TransformSync struct {
Time TransformSyncTime `json:"time"`
}
type TransformSyncTime ¶ added in v0.6.0
type WatchBody ¶ added in v0.6.0
type WatchBody struct {
Trigger map[string]any `json:"trigger"`
Input map[string]any `json:"input"`
Condition map[string]any `json:"condition"`
Actions map[string]any `json:"actions"`
Metadata map[string]any `json:"metadata"`
Transform map[string]any `json:"transform,omitempty"`
ThrottlePeriodInMillis int `json:"throttle_period_in_millis,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.