Documentation
¶
Overview ¶
Package entry provides types that manage remote content via the Splunk REST API.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Index ¶
type Index struct {
ID client.ID `selective:"create" service:"data/indexes"`
Content IndexContent `json:"content" values:",anonymize"`
}
Index is a Splunk Index.
type IndexContent ¶
type IndexContent struct {
BlockSignSize attributes.Explicit[int] `json:"blockSignSize" values:"blockSignSize,omitzero"`
BucketRebuildMemoryHint attributes.Explicit[int] `json:"bucketRebuildMemoryHint" values:"bucketRebuildMemoryHint,omitzero"`
ColdPath attributes.Explicit[string] `json:"coldPath" values:"coldPath,omitzero" selective:"create"`
ColdToFrozenDir attributes.Explicit[string] `json:"coldToFrozenDir" values:"coldToFrozenDir,omitzero"`
ColdToFrozenScript attributes.Explicit[string] `json:"coldToFrozenScript" values:"coldToFrozenScript,omitzero"`
CompressRawdata attributes.Explicit[bool] `json:"compressRawdata" values:"compressRawdata,omitzero"`
DataType attributes.Explicit[string] `json:"datatype" values:"datatype,omitzero" selective:"create"`
Disabled attributes.Explicit[bool] `json:"disabled" values:"disabled,omitzero" selective:"read"`
EnableOnlineBucketRepair attributes.Explicit[bool] `json:"enableOnlineBucketRepair" values:"enableOnlineBucketRepair,omitzero"`
FrozenTimePeriodInSecs attributes.Explicit[int] `json:"frozenTimePeriodInSecs" values:"frozenTimePeriodInSecs,omitzero"`
HomePath attributes.Explicit[string] `json:"homePath" values:"homePath,omitzero" selective:"create"`
MaxBloomBackfillBucketAge attributes.Explicit[string] `json:"maxBloomBackfillBucketAge" values:"maxBloomBackfillBucketAge,omitzero"`
MaxConcurrentOptimizes attributes.Explicit[int] `json:"maxConcurrentOptimizes" values:"maxConcurrentOptimizes,omitzero"`
MaxDataSize attributes.Explicit[string] `json:"maxDataSize" values:"maxDataSize,omitzero"`
MaxHotBuckets attributes.Explicit[string] `json:"maxHotBuckets" values:"maxHotBuckets,omitzero"`
MaxHotIdleSecs attributes.Explicit[int] `json:"maxHotIdleSecs" values:"maxHotIdleSecs,omitzero"`
MaxHotSpanSecs attributes.Explicit[int] `json:"maxHotSpanSecs" values:"maxHotSpanSecs,omitzero"`
MaxMemMB attributes.Explicit[int] `json:"maxMemMB" values:"maxMemMB,omitzero"`
MaxMetaEntries attributes.Explicit[int] `json:"maxMetaEntries" values:"maxMetaEntries,omitzero"`
MaxTimeUnreplicatedNoAcks attributes.Explicit[int] `json:"maxTimeUnreplicatedNoAcks" values:"maxTimeUnreplicatedNoAcks,omitzero"`
MaxTimeUnreplicatedWithAcks attributes.Explicit[int] `json:"maxTimeUnreplicatedWithAcks" values:"maxTimeUnreplicatedWithAcks,omitzero"`
MaxTotalDataSizeMB attributes.Explicit[int] `json:"maxTotalDataSizeMB" values:"maxTotalDataSizeMB,omitzero"`
MaxWarmDBCount attributes.Explicit[int] `json:"maxWarmDBCount" values:"maxWarmDBCount,omitzero"`
MinRawFileSyncSecs attributes.Explicit[string] `json:"minRawFileSyncSecs" values:"minRawFileSyncSecs,omitzero"`
MinStreamGroupQueueSize attributes.Explicit[int] `json:"minStreamGroupQueueSize" values:"minStreamGroupQueueSize,omitzero"`
PartialServiceMetaPeriod attributes.Explicit[int] `json:"partialServiceMetaPeriod" values:"partialServiceMetaPeriod,omitzero"`
ProcessTrackerServiceInterval attributes.Explicit[int] `json:"processTrackerServiceInterval" values:"processTrackerServiceInterval,omitzero"`
QuarantineFutureSecs attributes.Explicit[int] `json:"quarantineFutureSecs" values:"quarantineFutureSecs,omitzero"`
QuarantinePastSecs attributes.Explicit[int] `json:"quarantinePastSecs" values:"quarantinePastSecs,omitzero"`
RawChunkSizeBytes attributes.Explicit[int] `json:"rawChunkSizeBytes" values:"rawChunkSizeBytes,omitzero"`
RepFactor attributes.Explicit[int] `json:"repFactor" values:"repFactor,omitzero"`
RotatePeriodInSecs attributes.Explicit[int] `json:"rotatePeriodInSecs" values:"rotatePeriodInSecs,omitzero"`
ServiceMetaPeriod attributes.Explicit[int] `json:"serviceMetaPeriod" values:"serviceMetaPeriod,omitzero"`
SyncMeta attributes.Explicit[bool] `json:"syncMeta" values:"syncMeta,omitzero"`
ThawedPath attributes.Explicit[string] `json:"thawedPath" values:"thawedPath,omitzero" selective:"create"`
ThrottleCheckPeriod attributes.Explicit[int] `json:"throttleCheckPeriod" values:"throttleCheckPeriod,omitzero"`
TstatsHomePath attributes.Explicit[string] `json:"tstatsHomePath" values:"tstatsHomePath,omitzero" selective:"create"`
WarmToColdScript attributes.Explicit[string] `json:"warmToColdScript" values:"warmToColdScript,omitzero"`
}
IndexContent is the content for an Index.
type Role ¶
type Role struct {
ID client.ID `selective:"create" service:"authorization/roles"`
Content RoleContent `json:"content" values:",anonymize"`
}
Role defines a Splunk role.
type RoleContent ¶
type RoleContent struct {
Capabilities []string `json:"capabilities" values:"capabilities,omitzero,fillempty"`
CumulativeRTSrchJobsQuota attributes.Explicit[int] `json:"cumulativeRTSrchJobsQuota" values:"cumulativeRTSrchJobsQuota,omitzero"`
CumulativeSrchJobsQuota attributes.Explicit[int] `json:"cumulativeSrchJobsQuota" values:"cumulativeSrchJobsQuota,omitzero"`
DefaultApp attributes.Explicit[string] `json:"defaultApp" values:"defaultApp,omitzero"`
RtSrchJobsQuota attributes.Explicit[int] `json:"rtSrchJobsQuota" values:"rtSrchJobsQuota,omitzero"`
SrchDiskQuota attributes.Explicit[int] `json:"srchDiskQuota" values:"srchDiskQuota,omitzero"`
SrchFilter attributes.Explicit[string] `json:"srchFilter" values:"srchFilter,omitzero"`
SrchIndexesAllowed []string `json:"srchIndexesAllowed" values:"srchIndexesAllowed,omitzero,fillempty"`
SrchIndexesDefault []string `json:"srchIndexesDefault" values:"srchIndexesDefault,omitzero,fillempty"`
SrchJobsQuota attributes.Explicit[int] `json:"srchJobsQuota" values:"srchJobsQuota,omitzero"`
SrchTimeWin attributes.Explicit[int] `json:"srchTimeWin" values:"srchTimeWin,omitzero"`
// Read-only fields are populated by results returned by the Splunk API, but
// are not settable by Create or Update operations.
ImportedCapabilities []string `json:"imported_capabilities" values:"-"`
ImportedRoles []string `json:"imported_roles" values:"-"`
ImportedRtSrchJobsQuota attributes.Explicit[int] `json:"imported_rtSrchJobsQuota" values:"-"`
ImportedRtSrchJObsQuota attributes.Explicit[int] `json:"imported_rtSrchJObsQuota" values:"-"`
ImportedSrchDiskQuota attributes.Explicit[int] `json:"imported_srchDiskQuota" values:"-"`
ImportedSrchFilter attributes.Explicit[string] `json:"imported_srchFilter" values:"-"`
ImportedSrchIndexesAllowed []string `json:"imported_srchIndexesAllowed" values:"-"`
ImportedSrchIndexesDefault []string `json:"imported_srchIndexesDefault" values:"-"`
ImportedSrchJobsQuota attributes.Explicit[int] `json:"imported_srchJobsQuota" values:"-"`
ImportedSrchTimeWin attributes.Explicit[int] `json:"imported_srchTimeWin" values:"-"`
}
RoleContent defines the Content for a Role.
type SAMLGroup ¶
type SAMLGroup struct {
ID client.ID `selective:"create" service:"admin/SAML-groups"`
Content SAMLGroupContent `json:"content" values:",anonymize"`
// contains filtered or unexported fields
}
SAMLGroup defines a SAML group mapping.
type SAMLGroupContent ¶
type SAMLGroupContent struct {
Roles []string `json:"roles" values:"roles,omitzero,fillempty"`
}
SAMLGroupContent defines the content for a SAMLGroup.
type SavedSearch ¶
type SavedSearch struct {
ID client.ID `service:"saved/searches" selective:"create"`
Content SavedSearchContent `json:"content" values:",anonymize"`
}
SavedSearch defines a Splunk savedsearch.
type SavedSearchContent ¶
type SavedSearchContent struct {
Actions attributes.NamedParametersCollection `` /* 137-byte string literal not displayed */
AlertDigestMode attributes.Explicit[bool] `json:"alert.digest_mode" values:"alert.digest_mode,omitzero"`
AlertExpires attributes.Explicit[string] `json:"alert.expires" values:"alert.expires,omitzero"`
AlertSeverity attributes.Explicit[string] `json:"alert.severity" values:"alert.severity,omitzero"`
AlertSuppress attributes.Explicit[bool] `json:"alert.suppress" values:"alert.suppress,omitzero"`
AlertSuppressFields attributes.Explicit[string] `json:"alert.suppress.fields" values:"alert.suppress.fields,omitzero"`
AlertSuppressGroupName attributes.Explicit[string] `json:"alert.suppress.group_name" values:"alert.suppress.group_name,omitzero"`
AlertSuppressPeriod attributes.Explicit[int] `json:"alert.suppress.period" values:"alert.suppress.period,omitzero"`
AlertTrack attributes.Explicit[string] `json:"alert.track" values:"alert.track,omitzero"`
AlertComparator attributes.Explicit[string] `json:"alert_comparator" values:"alert_comparator,omitzero"`
AlertCondition attributes.Explicit[string] `json:"alert_condition" values:"alert_condition,omitzero"`
AlertThreshold attributes.Explicit[int] `json:"alert_threshold" values:"alert_threshold,omitzero"`
AlertType attributes.Explicit[string] `json:"alert_type" values:"alert_type,omitzero"`
AllowSkew attributes.Explicit[string] `json:"allow_skew" values:"allow_skew,omitzero"`
AutoSummarize attributes.Explicit[bool] `json:"auto_summarize" values:"auto_summarize,omitzero"`
AutoSummarizeCommand attributes.Explicit[string] `json:"auto_summarize.command" values:"auto_summarize.command,omitzero"`
AutoSummarizeCronSchedule attributes.Explicit[string] `json:"auto_summarize.cron_schedule" values:"auto_summarize.cron_schedule,omitzero"`
AutoSummarizeDispatchEarliestTime attributes.Explicit[string] `json:"auto_summarize.dispatch.earliest_time" values:"auto_summarize.dispatch.earliest_time,omitzero"`
AutoSummarizeDispatchLatestTime attributes.Explicit[string] `json:"auto_summarize.dispatch.latest_time" values:"auto_summarize.dispatch.latest_time,omitzero"`
AutoSummarizeDispatchTimeFormat attributes.Explicit[string] `json:"auto_summarize.dispatch.time_format" values:"auto_summarize.dispatch.time_format,omitzero"`
AutoSummarizeDispatchTtl attributes.Explicit[string] `json:"auto_summarize.dispatch.ttl" values:"auto_summarize.dispatch.ttl,omitzero"`
AutoSummarizeMaxConcurrent attributes.Explicit[int] `json:"auto_summarize.max_concurrent" values:"auto_summarize.max_concurrent,omitzero"`
AutoSummarizeMaxDisabledBuckets attributes.Explicit[int] `json:"auto_summarize.max_disabled_buckets" values:"auto_summarize.max_disabled_buckets,omitzero"`
AutoSummarizeMaxSummaryRatio attributes.Explicit[int] `json:"auto_summarize.max_summary_ratio" values:"auto_summarize.max_summary_ratio,omitzero"`
AutoSummarizeMaxSummarySize attributes.Explicit[int] `json:"auto_summarize.max_summary_size" values:"auto_summarize.max_summary_size,omitzero"`
AutoSummarizeMaxTime attributes.Explicit[int] `json:"auto_summarize.max_time" values:"auto_summarize.max_time,omitzero"`
AutoSummarizeSuspendPeriod attributes.Explicit[string] `json:"auto_summarize.suspend_period" values:"auto_summarize.suspend_period,omitzero"`
AutoSummarizeTimespan attributes.Explicit[string] `json:"auto_summarize.timespan" values:"auto_summarize.timespan,omitzero"`
CronSchedule attributes.Explicit[string] `json:"cron_schedule" values:"cron_schedule,omitzero"`
Description attributes.Explicit[string] `json:"description" values:"description,omitzero"`
Disabled attributes.Explicit[bool] `json:"disabled" values:"disabled,omitzero"`
Dispatch attributes.NamedParametersCollection `` /* 140-byte string literal not displayed */
DispatchAs attributes.Explicit[string] `json:"dispatchAs" values:"dispatchAs,omitzero"`
Displayview attributes.Explicit[string] `json:"displayview" values:"displayview,omitzero"`
DurableBackfillType attributes.Explicit[string] `json:"durable.backfill_type" values:"durable.backfill_type,omitzero"`
DurableLagTime attributes.Explicit[int] `json:"durable.lag_time" values:"durable.lag_time,omitzero"`
DurableMaxBackfillIntervals attributes.Explicit[int] `json:"durable.max_backfill_intervals" values:"durable.max_backfill_intervals,omitzero"`
DurableTrackTimeType attributes.Explicit[string] `json:"durable.track_time_type" values:"durable.track_time_type,omitzero"`
IsScheduled attributes.Explicit[bool] `json:"is_scheduled" values:"is_scheduled,omitzero"`
IsVisible attributes.Explicit[bool] `json:"is_visible" values:"is_visible,omitzero"`
MaxConcurrent attributes.Explicit[int] `json:"max_concurrent" values:"max_concurrent,omitzero"`
Name attributes.Explicit[string] `json:"name" values:"name,omitzero"`
NextScheduledTime attributes.Explicit[string] `json:"next_scheduled_time" values:"next_scheduled_time,omitzero"`
QualifiedSearch attributes.Explicit[string] `json:"qualifiedSearch" values:"qualifiedSearch,omitzero"`
RealtimeSchedule attributes.Explicit[bool] `json:"realtime_schedule" values:"realtime_schedule,omitzero"`
RequestUiDispatchApp attributes.Explicit[string] `json:"request.ui_dispatch_app" values:"request.ui_dispatch_app,omitzero"`
RequestUiDispatchView attributes.Explicit[string] `json:"request.ui_dispatch_view" values:"request.ui_dispatch_view,omitzero"`
RestartOnSearchpeerAdd attributes.Explicit[bool] `json:"restart_on_searchpeer_add" values:"restart_on_searchpeer_add,omitzero"`
RunNTimes attributes.Explicit[int] `json:"run_n_times" values:"run_n_times,omitzero"`
RunOnStartup attributes.Explicit[bool] `json:"run_on_startup" values:"run_on_startup,omitzero"`
SchedulePriority attributes.Explicit[string] `json:"schedule_priority" values:"schedule_priority,omitzero"`
ScheduleWindow attributes.Explicit[string] `json:"schedule_window" values:"schedule_window,omitzero"`
Search attributes.Explicit[string] `json:"search" values:"search,omitzero"`
Vsid attributes.Explicit[string] `json:"vsid" values:"vsid"`
WorkloadPool attributes.Explicit[string] `json:"workload_pool" values:"workload_pool"`
}
SavedSearchContent defines the content of a Savedsearch object.
func (SavedSearchContent) AddURLValues ¶
func (content SavedSearchContent) AddURLValues(key string, v *url.Values) error
AddURLValues implements custom additional encoding to url.Values.
func (*SavedSearchContent) UnmarshalJSON ¶
func (content *SavedSearchContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements custom JSON unmarshaling.
type Stanza ¶
type Stanza struct {
ID client.ConfID `selective:"create" service:"configs"`
Content StanzaContent `json:"content" values:",anonymize"`
}
Stanza is a Splunk configs/conf-<file> stanza.
type StanzaContent ¶
type StanzaContent struct {
Disabled attributes.Explicit[bool] `json:"disabled" values:"disabled,omitzero"`
Values map[string]string `json:"-" values:",anonymize"`
}
StanzaContent defines the content for a Stanza.
func (*StanzaContent) UnmarshalJSON ¶
func (content *StanzaContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements custom JSON unmarshaling.
type User ¶
type User struct {
ID client.ID `selective:"create" service:"authentication/users"`
Content UserContent `json:"content" values:",anonymize"`
}
User defines a Splunk user.
type UserContent ¶
type UserContent struct {
// Read/Write
DefaultApp attributes.Explicit[string] `values:"defaultApp,omitzero"`
Email attributes.Explicit[string] `values:"email,omitzero"`
ForceChangePass attributes.Explicit[bool] `values:"force-change-pass,omitzero"`
Password attributes.Explicit[string] `values:"password,omitzero"`
RealName attributes.Explicit[string] `values:"realname,omitzero"`
RestartBackgroundJobs attributes.Explicit[bool] `values:"restart_background_jobs,omitzero"`
Roles []string `values:"roles,omitzero,fillempty"`
TZ attributes.Explicit[string] `values:"tz,omitzero"`
// Read-only fields are populated by results returned by the Splunk API, but
// are not settable by Create or Update operations.
Capabilities []string `values:"-"`
Type attributes.Explicit[string] `values:"-"`
}
UserContent defines the content of a User object.