Documentation
¶
Index ¶
- func Bool(b bool) *bool
- func Float32(f float32) *float32
- func Float64(f float64) *float64
- func Int(i int) *int
- func Int64(i int64) *int64
- func Pointer[T any](v T) *T
- func String(s string) *string
- type ACL
- type Auth
- type Branches
- type Captures
- type Collectors
- func (s *Collectors) Create(ctx context.Context, request components.SavedJob, opts ...operations.Option) (*operations.CreateSavedJobResponse, error)
- func (s *Collectors) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DeleteSavedJobByIDResponse, error)
- func (s *Collectors) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetSavedJobByIDResponse, error)
- func (s *Collectors) List(ctx context.Context, collectorType *components.CollectorType, offset *int64, ...) (*operations.GetSavedJobResponse, error)
- func (s *Collectors) Update(ctx context.Context, id string, savedJob components.SavedJob, ...) (*operations.UpdateSavedJobByIDResponse, error)
- type Commits
- func (s *Commits) Create(ctx context.Context, request components.GitCommitBody, ...) (*operations.CreateVersionCommitResponse, error)
- func (s *Commits) Diff(ctx context.Context, commit *string, filename *string, diffLineLimit *int64, ...) (*operations.GetVersionDiffResponse, error)
- func (s *Commits) Get(ctx context.Context, commit *string, filename *string, diffLineLimit *int64, ...) (*operations.GetVersionShowResponse, error)
- func (s *Commits) List(ctx context.Context, count *int64, offset *int64, limit *int64, ...) (*operations.GetVersionResponse, error)
- func (s *Commits) Push(ctx context.Context, opts ...operations.Option) (*operations.CreateVersionPushResponse, error)
- func (s *Commits) Revert(ctx context.Context, request components.GitRevertParams, ...) (*operations.CreateVersionRevertResponse, error)
- func (s *Commits) Undo(ctx context.Context, opts ...operations.Option) (*operations.CreateVersionUndoResponse, error)
- type ConfigsVersions
- type Cribl
- type CriblControlPlane
- type DatabaseConnections
- func (s *DatabaseConnections) Create(ctx context.Context, request components.DatabaseConnectionConfig, ...) (*operations.CreateDatabaseConnectionConfigResponse, error)
- func (s *DatabaseConnections) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DeleteDatabaseConnectionConfigByIDResponse, error)
- func (s *DatabaseConnections) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetDatabaseConnectionConfigByIDResponse, error)
- func (s *DatabaseConnections) List(ctx context.Context, databaseType *components.DatabaseConnectionType, ...) (*operations.GetDatabaseConnectionConfigResponse, error)
- func (s *DatabaseConnections) Update(ctx context.Context, id string, ...) (*operations.UpdateDatabaseConnectionConfigByIDResponse, error)
- type Datasets
- func (s *Datasets) Create(ctx context.Context, lakeID string, ...) (*operations.CreateCriblLakeDatasetByLakeIDResponse, error)
- func (s *Datasets) Delete(ctx context.Context, lakeID string, id string, opts ...operations.Option) (*operations.DeleteCriblLakeDatasetByLakeIDAndIDResponse, error)
- func (s *Datasets) Get(ctx context.Context, lakeID string, id string, includeMetrics *bool, ...) (*operations.GetCriblLakeDatasetByLakeIDAndIDResponse, error)
- func (s *Datasets) List(ctx context.Context, request operations.GetCriblLakeDatasetByLakeIDRequest, ...) (*operations.GetCriblLakeDatasetByLakeIDResponse, error)
- func (s *Datasets) Update(ctx context.Context, lakeID string, id string, ...) (*operations.UpdateCriblLakeDatasetByLakeIDAndIDResponse, error)
- type Destinations
- func (s *Destinations) Create(ctx context.Context, request operations.CreateOutputRequest, ...) (*operations.CreateOutputResponse, error)
- func (s *Destinations) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DeleteOutputByIDResponse, error)
- func (s *Destinations) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetOutputByIDResponse, error)
- func (s *Destinations) List(ctx context.Context, type_ *components.DestinationType, offset *int64, ...) (*operations.ListOutputResponse, error)
- func (s *Destinations) Update(ctx context.Context, id string, output components.Output, ...) (*operations.UpdateOutputByIDResponse, error)
- type DestinationsPq
- type DestinationsStatuses
- func (s *DestinationsStatuses) Get(ctx context.Context, id string, metrics *bool, type_ *bool, ...) (*operations.GetOutputStatusByIDResponse, error)
- func (s *DestinationsStatuses) List(ctx context.Context, metrics *bool, type_ *bool, offset *int64, limit *int64, ...) (*operations.GetOutputStatusResponse, error)
- type Files
- type Functions
- type Groups
- func (s *Groups) Create(ctx context.Context, product components.ProductsCore, ...) (*operations.CreateProductsGroupsByProductResponse, error)
- func (s *Groups) Delete(ctx context.Context, product components.ProductsCore, id string, ...) (*operations.DeleteProductsGroupsByProductAndIDResponse, error)
- func (s *Groups) Deploy(ctx context.Context, product components.ProductsCore, id string, ...) (*operations.UpdateProductsGroupsDeployByProductAndIDResponse, error)
- func (s *Groups) Get(ctx context.Context, product components.ProductsCore, id string, ...) (*operations.GetProductsGroupsByProductAndIDResponse, error)
- func (s *Groups) List(ctx context.Context, product components.ProductsCore, fields *string, ...) (*operations.GetProductsGroupsByProductResponse, error)
- func (s *Groups) Update(ctx context.Context, product components.ProductsCore, id string, ...) (*operations.UpdateProductsGroupsByProductAndIDResponse, error)
- type GroupsConfigs
- type HTTPClient
- type Health
- type HecTokens
- type Lakes
- type Nodes
- func (s *Nodes) Count(ctx context.Context, product components.ProductsCore, filterExp *string, ...) (*operations.GetProductsSummaryWorkersByProductResponse, error)
- func (s *Nodes) Get(ctx context.Context, product components.ProductsCore, id string, ...) (*operations.GetProductsWorkersByProductAndIDResponse, error)
- func (s *Nodes) List(ctx context.Context, request operations.GetProductsWorkersByProductRequest, ...) (*operations.GetProductsWorkersByProductResponse, error)
- func (s *Nodes) Restart(ctx context.Context, product components.ProductsCore, ...) (*operations.UpdateProductsWorkersRestartByProductResponse, error)
- type Packs
- func (s *Packs) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DeletePacksByIDResponse, error)
- func (s *Packs) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetPacksByIDResponse, error)
- func (s *Packs) Install(ctx context.Context, request components.PackRequestBodyUnion, ...) (*operations.CreatePacksResponse, error)
- func (s *Packs) List(ctx context.Context, with *string, offset *int64, limit *int64, ...) (*operations.GetPacksResponse, error)
- func (s *Packs) Update(ctx context.Context, id string, ...) (*operations.UpdatePacksByIDResponse, error)
- func (s *Packs) Upload(ctx context.Context, filename string, requestBody any, ...) (*operations.UpdatePacksResponse, error)
- type PacksDestinations
- func (s *PacksDestinations) Create(ctx context.Context, pack string, ...) (*operations.CreateOutputSystemByPackResponse, error)
- func (s *PacksDestinations) Delete(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.DeleteOutputSystemByPackAndIDResponse, error)
- func (s *PacksDestinations) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetOutputSystemByPackAndIDResponse, error)
- func (s *PacksDestinations) List(ctx context.Context, pack string, type_ *components.DestinationType, ...) (*operations.GetOutputSystemByPackResponse, error)
- func (s *PacksDestinations) Update(ctx context.Context, id string, pack string, output components.Output, ...) (*operations.UpdateOutputSystemByPackAndIDResponse, error)
- type PacksDestinationsPq
- func (s *PacksDestinationsPq) Clear(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.DeleteOutputSystemPqByPackAndIDResponse, error)
- func (s *PacksDestinationsPq) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetOutputSystemPqByPackAndIDResponse, error)
- type PacksDestinationsStatuses
- func (s *PacksDestinationsStatuses) Get(ctx context.Context, id string, pack string, metrics *bool, type_ *bool, ...) (*operations.GetOutputStatusSystemOutputsByPackAndIDResponse, error)
- func (s *PacksDestinationsStatuses) List(ctx context.Context, ...) (*operations.GetOutputStatusSystemOutputsByPackResponse, error)
- type PacksHecTokens
- func (s *PacksHecTokens) Create(ctx context.Context, id string, pack string, ...) (*operations.CreateInputSystemHecTokenByPackAndIDResponse, error)
- func (s *PacksHecTokens) Update(ctx context.Context, id string, token string, pack string, ...) (*operations.UpdateInputSystemHecTokenByPackAndIDAndTokenResponse, error)
- type PacksPipelines
- func (s *PacksPipelines) Create(ctx context.Context, pack string, pipeline components.PipelineInput, ...) (*operations.CreatePipelinesByPackResponse, error)
- func (s *PacksPipelines) Delete(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.DeletePipelinesByPackAndIDResponse, error)
- func (s *PacksPipelines) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetPipelinesByPackAndIDResponse, error)
- func (s *PacksPipelines) List(ctx context.Context, pack string, offset *int64, limit *int64, ...) (*operations.GetPipelinesByPackResponse, error)
- func (s *PacksPipelines) Update(ctx context.Context, id string, pack string, pipeline components.PipelineInput, ...) (*operations.UpdatePipelinesByPackAndIDResponse, error)
- type PacksRoutes
- func (s *PacksRoutes) Append(ctx context.Context, id string, pack string, ...) (*operations.CreateRoutesAppendByPackAndIDResponse, error)
- func (s *PacksRoutes) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetRoutesByPackAndIDResponse, error)
- func (s *PacksRoutes) List(ctx context.Context, pack string, opts ...operations.Option) (*operations.GetRoutesByPackResponse, error)
- func (s *PacksRoutes) Update(ctx context.Context, id string, pack string, ...) (*operations.UpdateRoutesByPackAndIDResponse, error)
- type PacksSamples
- func (s *PacksSamples) Create(ctx context.Context, id string, pack string, ...) (*operations.CreateOutputSystemTestByPackAndIDResponse, error)
- func (s *PacksSamples) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetOutputSystemSamplesByPackAndIDResponse, error)
- type PacksSources
- func (s *PacksSources) Create(ctx context.Context, pack string, ...) (*operations.CreateInputSystemByPackResponse, error)
- func (s *PacksSources) Delete(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.DeleteInputSystemByPackAndIDResponse, error)
- func (s *PacksSources) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetInputSystemByPackAndIDResponse, error)
- func (s *PacksSources) List(ctx context.Context, pack string, type_ []string, offset *int64, limit *int64, ...) (*operations.GetInputSystemByPackResponse, error)
- func (s *PacksSources) Update(ctx context.Context, id string, pack string, input components.Input, ...) (*operations.UpdateInputSystemByPackAndIDResponse, error)
- type PacksSourcesPq
- func (s *PacksSourcesPq) Clear(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.DeleteInputSystemPqByPackAndIDResponse, error)
- func (s *PacksSourcesPq) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetInputSystemPqByPackAndIDResponse, error)
- type PacksSourcesStatuses
- func (s *PacksSourcesStatuses) Get(ctx context.Context, id string, pack string, metrics *bool, type_ *bool, ...) (*operations.GetInputStatusSystemInputsByPackAndIDResponse, error)
- func (s *PacksSourcesStatuses) List(ctx context.Context, ...) (*operations.GetInputStatusSystemInputsByPackResponse, error)
- type Pipelines
- func (s *Pipelines) Create(ctx context.Context, request components.PipelineInput, ...) (*operations.CreatePipelinesResponse, error)
- func (s *Pipelines) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DeletePipelinesByIDResponse, error)
- func (s *Pipelines) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetPipelinesByIDResponse, error)
- func (s *Pipelines) List(ctx context.Context, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetPipelinesResponse, error)
- func (s *Pipelines) Update(ctx context.Context, id string, pipeline components.PipelineInput, ...) (*operations.UpdatePipelinesByIDResponse, error)
- type Routes
- func (s *Routes) Append(ctx context.Context, id string, requestBody []components.RouteConfInput, ...) (*operations.CreateRoutesAppendByIDResponse, error)
- func (s *Routes) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetRoutesByIDResponse, error)
- func (s *Routes) List(ctx context.Context, opts ...operations.Option) (*operations.GetRoutesResponse, error)
- func (s *Routes) Update(ctx context.Context, id string, routesInput components.RoutesInput, ...) (*operations.UpdateRoutesByIDResponse, error)
- type SDKOption
- func WithClient(client HTTPClient) SDKOption
- func WithRetryConfig(retryConfig retry.Config) SDKOption
- func WithSecurity(security components.Security) SDKOption
- func WithSecuritySource(security func(context.Context) (components.Security, error)) SDKOption
- func WithServerURL(serverURL string) SDKOption
- func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption
- func WithTimeout(timeout time.Duration) SDKOption
- type Samples
- type Settings
- type Sources
- func (s *Sources) Create(ctx context.Context, request operations.CreateInputRequest, ...) (*operations.CreateInputResponse, error)
- func (s *Sources) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DeleteInputByIDResponse, error)
- func (s *Sources) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetInputByIDResponse, error)
- func (s *Sources) List(ctx context.Context, type_ []string, offset *int64, limit *int64, ...) (*operations.ListInputResponse, error)
- func (s *Sources) Update(ctx context.Context, id string, input components.Input, ...) (*operations.UpdateInputByIDResponse, error)
- type SourcesPq
- type SourcesStatuses
- func (s *SourcesStatuses) Get(ctx context.Context, id string, metrics *bool, type_ *bool, ...) (*operations.GetInputStatusByIDResponse, error)
- func (s *SourcesStatuses) List(ctx context.Context, metrics *bool, type_ *bool, offset *int64, limit *int64, ...) (*operations.GetInputStatusResponse, error)
- type Summaries
- type System
- type Teams
- type Tokens
- type Versions
- type VersionsConfigs
- type VersionsStatuses
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ACL ¶
type ACL struct {
Teams *Teams
// contains filtered or unexported fields
}
func (*ACL) Get ¶
func (s *ACL) Get(ctx context.Context, product components.ProductsCore, id string, type_ *components.RbacResource, opts ...operations.Option) (*operations.GetProductsGroupsACLByProductAndIDResponse, error)
Get the Access Control List for a Worker Group, Outpost Group, or Edge Fleet Get the Access Control List (ACL) for the specified Worker Group, Outpost Group, or Edge Fleet.
type Branches ¶
type Branches struct {
// contains filtered or unexported fields
}
func (*Branches) Get ¶
func (s *Branches) Get(ctx context.Context, opts ...operations.Option) (*operations.GetVersionCurrentBranchResponse, error)
Get the name of the Git branch that the Cribl configuration is checked out to Get the name of the Git branch that the Cribl configuration is checked out to. Useful for verifying the active configuration branch.
func (*Branches) List ¶
func (s *Branches) List(ctx context.Context, opts ...operations.Option) (*operations.GetVersionBranchResponse, error)
List all branches in the Git repository used for Cribl configuration Get a list of all branches in the Git repository used for Cribl configuration.
type Captures ¶
type Captures struct {
// contains filtered or unexported fields
}
func (*Captures) Create ¶
func (s *Captures) Create(ctx context.Context, request components.CaptureParamsReq, opts ...operations.Option) (*operations.CreateSystemCaptureResponse, error)
Create - Capture live data Initiate a live data capture from Cribl Workers. Returns a stream of captured events in NDJSON format that match the parameters specified in the request body.
type Collectors ¶
type Collectors struct {
// contains filtered or unexported fields
}
Collectors - Actions related to Collectors
func (*Collectors) Create ¶
func (s *Collectors) Create(ctx context.Context, request components.SavedJob, opts ...operations.Option) (*operations.CreateSavedJobResponse, error)
Create a Collector Create a new Collector.
func (*Collectors) Delete ¶
func (s *Collectors) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DeleteSavedJobByIDResponse, error)
Delete a Collector Delete the specified Collector.
func (*Collectors) Get ¶
func (s *Collectors) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetSavedJobByIDResponse, error)
Get a Collector Get the specified Collector.
func (*Collectors) List ¶
func (s *Collectors) List(ctx context.Context, collectorType *components.CollectorType, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetSavedJobResponse, error)
List all Collectors Get a list of all Collectors.
func (*Collectors) Update ¶
func (s *Collectors) Update(ctx context.Context, id string, savedJob components.SavedJob, opts ...operations.Option) (*operations.UpdateSavedJobByIDResponse, error)
Update a Collector Update the specified Collector.<br/><br/>Provide a complete representation of the Collector that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Collector.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Collector might not function as expected.
type Commits ¶
type Commits struct {
Files *Files
// contains filtered or unexported fields
}
func (*Commits) Create ¶
func (s *Commits) Create(ctx context.Context, request components.GitCommitBody, opts ...operations.Option) (*operations.CreateVersionCommitResponse, error)
Create a new commit for pending changes to the Cribl configuration Create a new commit for pending changes to the Cribl configuration. Any merge conflicts indicated in the response must be resolved using Git.<br/><br/>To commit only a subset of configuration changes, specify the files to include in the commit in the <code>files</code> array.
func (*Commits) Diff ¶
func (s *Commits) Diff(ctx context.Context, commit *string, filename *string, diffLineLimit *int64, opts ...operations.Option) (*operations.GetVersionDiffResponse, error)
Diff - Get the diff for a commit Get the diff for a commit. Default is the latest commit (HEAD).
func (*Commits) Get ¶
func (s *Commits) Get(ctx context.Context, commit *string, filename *string, diffLineLimit *int64, opts ...operations.Option) (*operations.GetVersionShowResponse, error)
Get the diff and log message for a commit Get the diff and log message for a commit. Default is the latest commit (HEAD).
func (*Commits) List ¶
func (s *Commits) List(ctx context.Context, count *int64, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetVersionResponse, error)
List the commit history List the commit history.<br/><br/>Analogous to <code>git log</code> for the Cribl configuration, allowing you to audit and review changes over time.
func (*Commits) Push ¶
func (s *Commits) Push(ctx context.Context, opts ...operations.Option) (*operations.CreateVersionPushResponse, error)
Push local commits to the remote repository Push all local commits from the local repository to the remote repository.<br/><br/>Requires at least one local commit that has not been pushed. Returns an error if the remote repository cannot be reached or the push is rejected.
func (*Commits) Revert ¶
func (s *Commits) Revert(ctx context.Context, request components.GitRevertParams, opts ...operations.Option) (*operations.CreateVersionRevertResponse, error)
Revert a commit in the local repository Revert a commit in the local repository by creating a new commit that undoes the changes introduced by the specified commit.<br/><br/>Use the <code>force</code> field to proceed even when the working directory is not clean.
func (*Commits) Undo ¶
func (s *Commits) Undo(ctx context.Context, opts ...operations.Option) (*operations.CreateVersionUndoResponse, error)
Undo - Discard uncommitted (staged) changes Discard all uncommitted (staged) configuration changes, resetting the working directory to the last committed state. Use only if you are certain that you do not need to preserve your local changes.<br/><br/>When applied globally (no group), triggers a Cribl restart to reload the reverted configuration. Returns <code>false</code> if the working directory is already clean.
type ConfigsVersions ¶
type ConfigsVersions struct {
// contains filtered or unexported fields
}
func (*ConfigsVersions) Get ¶
func (s *ConfigsVersions) Get(ctx context.Context, product components.ProductsCore, id string, opts ...operations.Option) (*operations.GetProductsGroupsConfigVersionByProductAndIDResponse, error)
Get the configuration version for a Worker Group, Outpost Group, or Edge Fleet Get the configuration version for the specified Worker Group, Outpost Group, or Edge Fleet.
type Cribl ¶
type Cribl struct {
// contains filtered or unexported fields
}
func (*Cribl) List ¶
func (s *Cribl) List(ctx context.Context, opts ...operations.Option) (*operations.GetSystemSettingsConfResponse, error)
List - Get system settings Get the current Cribl system settings.
func (*Cribl) Update ¶
func (s *Cribl) Update(ctx context.Context, request components.SystemSettingsConfUpdate, opts ...operations.Option) (*operations.UpdateSystemSettingsConfResponse, error)
Update system settings Update the specified Cribl system settings.<br/><br/>This endpoint supports partial updates — provide only the top-level sections (<code>api</code>, <code>workers</code>, <code>tls</code>, <code>proxy</code>, etc.) that you want to change. Omitted top-level sections are preserved unchanged.<br/><br/><b>Important:</b> while top-level sections are optional, nested objects within a section must be complete. For example, if you include <code>api</code>, you must provide its required fields (<code>host</code> and <code>port</code>).
type CriblControlPlane ¶
type CriblControlPlane struct {
SDKVersion string
Auth *Auth
// Actions related to functions
Functions *Functions
// Actions related to REST server health
Health *Health
// Actions related to DatabaseConnections
DatabaseConnections *DatabaseConnections
// Actions related to Collectors
Collectors *Collectors
// Actions related to Packs
Packs *Packs
// Actions related to Pipelines
Pipelines *Pipelines
// Actions related to Groups
Groups *Groups
Nodes *Nodes
Lakes *Lakes
// Actions related to Routes
Routes *Routes
System *System
// Actions related to Sources
Sources *Sources
// Actions related to Destinations
Destinations *Destinations
Versions *Versions
// contains filtered or unexported fields
}
CriblControlPlane - Cribl API Reference: This API Reference lists available REST endpoints, along with their supported operations for accessing, creating, updating, or deleting resources. Base URL contexts for reference: - Leader context: /api/v1 - Worker Group or Edge Fleet context: /api/v1/m/{groupName} - Host (Worker or Edge Node) context: /api/v1/w/{nodeId} - Search context: /api/v1/m/default_search
https://docs.cribl.io - See our complementary product documentation
func New ¶
func New(serverURL string, opts ...SDKOption) *CriblControlPlane
New creates a new instance of the SDK with the provided serverURL and options
type DatabaseConnections ¶
type DatabaseConnections struct {
// contains filtered or unexported fields
}
DatabaseConnections - Actions related to DatabaseConnections
func (*DatabaseConnections) Create ¶
func (s *DatabaseConnections) Create(ctx context.Context, request components.DatabaseConnectionConfig, opts ...operations.Option) (*operations.CreateDatabaseConnectionConfigResponse, error)
Create a Database Connection Create a new Database Connection.
func (*DatabaseConnections) Delete ¶
func (s *DatabaseConnections) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DeleteDatabaseConnectionConfigByIDResponse, error)
Delete a Database Connection Delete the specified Database Connection.
func (*DatabaseConnections) Get ¶
func (s *DatabaseConnections) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetDatabaseConnectionConfigByIDResponse, error)
Get a Database Connection Get the specified Database Connection.
func (*DatabaseConnections) List ¶
func (s *DatabaseConnections) List(ctx context.Context, databaseType *components.DatabaseConnectionType, limit *int64, offset *int64, opts ...operations.Option) (*operations.GetDatabaseConnectionConfigResponse, error)
List all Database Connections Get a list of all Database Connections.
func (*DatabaseConnections) Update ¶
func (s *DatabaseConnections) Update(ctx context.Context, id string, databaseConnectionConfig components.DatabaseConnectionConfig, opts ...operations.Option) (*operations.UpdateDatabaseConnectionConfigByIDResponse, error)
Update a Database Connection Update the specified Database Connection.<br/><br/>Provide a complete representation of the Database Connection that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Database Connection.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Database Connection might not function as expected.
type Datasets ¶
type Datasets struct {
// contains filtered or unexported fields
}
func (*Datasets) Create ¶
func (s *Datasets) Create(ctx context.Context, lakeID string, criblLakeDataset components.CriblLakeDataset, opts ...operations.Option) (*operations.CreateCriblLakeDatasetByLakeIDResponse, error)
Create a Lake Dataset (Cribl.Cloud only) Create a new Lake Dataset in the specified Lake (Cribl.Cloud only).
func (*Datasets) Delete ¶
func (s *Datasets) Delete(ctx context.Context, lakeID string, id string, opts ...operations.Option) (*operations.DeleteCriblLakeDatasetByLakeIDAndIDResponse, error)
Delete a Lake Dataset (Cribl.Cloud only) Delete the specified Lake Dataset in the specified Lake (Cribl.Cloud only).
func (*Datasets) Get ¶
func (s *Datasets) Get(ctx context.Context, lakeID string, id string, includeMetrics *bool, opts ...operations.Option) (*operations.GetCriblLakeDatasetByLakeIDAndIDResponse, error)
Get a Lake Dataset (Cribl.Cloud only) Get the specified Lake Dataset in the specified Lake (Cribl.Cloud only).
func (*Datasets) List ¶
func (s *Datasets) List(ctx context.Context, request operations.GetCriblLakeDatasetByLakeIDRequest, opts ...operations.Option) (*operations.GetCriblLakeDatasetByLakeIDResponse, error)
List all Lake Datasets (Cribl.Cloud only) Get a list of all Lake Datasets in the specified Lake (Cribl.Cloud only).
func (*Datasets) Update ¶
func (s *Datasets) Update(ctx context.Context, lakeID string, id string, criblLakeDatasetUpdate components.CriblLakeDatasetUpdate, opts ...operations.Option) (*operations.UpdateCriblLakeDatasetByLakeIDAndIDResponse, error)
Update a Lake Dataset (Cribl.Cloud only) Update the specified Lake Dataset in the specified Lake (Cribl.Cloud only).
type Destinations ¶
type Destinations struct {
Pq *DestinationsPq
Samples *Samples
Statuses *DestinationsStatuses
// contains filtered or unexported fields
}
Destinations - Actions related to Destinations
func (*Destinations) Create ¶
func (s *Destinations) Create(ctx context.Context, request operations.CreateOutputRequest, opts ...operations.Option) (*operations.CreateOutputResponse, error)
Create a Destination Create a new Destination.
func (*Destinations) Delete ¶
func (s *Destinations) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DeleteOutputByIDResponse, error)
Delete a Destination Delete the specified Destination.
func (*Destinations) Get ¶
func (s *Destinations) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetOutputByIDResponse, error)
Get a Destination Get the specified Destination.
func (*Destinations) List ¶
func (s *Destinations) List(ctx context.Context, type_ *components.DestinationType, offset *int64, limit *int64, opts ...operations.Option) (*operations.ListOutputResponse, error)
List all Destinations Get a list of all Destinations.
func (*Destinations) Update ¶
func (s *Destinations) Update(ctx context.Context, id string, output components.Output, opts ...operations.Option) (*operations.UpdateOutputByIDResponse, error)
Update a Destination Update the specified Destination.<br/><br/>Provide a complete representation of the Destination that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Destination.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Destination might not function as expected.
type DestinationsPq ¶
type DestinationsPq struct {
// contains filtered or unexported fields
}
func (*DestinationsPq) Clear ¶
func (s *DestinationsPq) Clear(ctx context.Context, id string, opts ...operations.Option) (*operations.DeleteOutputPqByIDResponse, error)
Clear the persistent queue for a Destination Clear the persistent queue (PQ) for the specified Destination.
func (*DestinationsPq) Get ¶
func (s *DestinationsPq) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetOutputPqByIDResponse, error)
Get information about the latest job to clear the persistent queue for a Destination Get information about the latest job to clear the persistent queue (PQ) for the specified Destination.
type DestinationsStatuses ¶
type DestinationsStatuses struct {
// contains filtered or unexported fields
}
func (*DestinationsStatuses) Get ¶
func (s *DestinationsStatuses) Get(ctx context.Context, id string, metrics *bool, type_ *bool, opts ...operations.Option) (*operations.GetOutputStatusByIDResponse, error)
Get the status of a Destination Get the status and optional metrics for the specified Destination.
func (*DestinationsStatuses) List ¶
func (s *DestinationsStatuses) List(ctx context.Context, metrics *bool, type_ *bool, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetOutputStatusResponse, error)
List the status of all Destinations List status information and optional metrics for all configured Destinations in the Worker Group or Edge Fleet.
type Files ¶
type Files struct {
// contains filtered or unexported fields
}
func (*Files) Count ¶
func (s *Files) Count(ctx context.Context, commit *string, opts ...operations.Option) (*operations.GetVersionCountResponse, error)
Count - Get a count of files that changed since a commit Get a count of the files that changed since a commit. Default is the latest commit (HEAD).
func (*Files) List ¶
func (s *Files) List(ctx context.Context, commit *string, opts ...operations.Option) (*operations.GetVersionFilesResponse, error)
List - Get the names and statuses of files that changed since a commit Get the names and statuses of files that changed since a commit. Default is the latest commit (HEAD).
type Functions ¶
type Functions struct {
// contains filtered or unexported fields
}
Functions - Actions related to functions
func (*Functions) Get ¶
func (s *Functions) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetFunctionsByIDResponse, error)
Get a Function Get the specified Function.
func (*Functions) List ¶
func (s *Functions) List(ctx context.Context, showHidden *bool, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetFunctionsResponse, error)
List all Functions Get a list of all Functions.
type Groups ¶
type Groups struct {
ACL *ACL
Configs *GroupsConfigs
// contains filtered or unexported fields
}
Groups - Actions related to Groups
func (*Groups) Create ¶
func (s *Groups) Create(ctx context.Context, product components.ProductsCore, groupCreateRequest components.GroupCreateRequest, opts ...operations.Option) (*operations.CreateProductsGroupsByProductResponse, error)
Create a Worker Group, Outpost Group, or Edge Fleet Create a new Worker Group, Outpost Group, or Edge Fleet for the specified Cribl product.
func (*Groups) Delete ¶
func (s *Groups) Delete(ctx context.Context, product components.ProductsCore, id string, opts ...operations.Option) (*operations.DeleteProductsGroupsByProductAndIDResponse, error)
Delete a Worker Group, Outpost Group, or Edge Fleet Delete the specified Worker Group, Outpost Group, or Edge Fleet.
func (*Groups) Deploy ¶
func (s *Groups) Deploy(ctx context.Context, product components.ProductsCore, id string, deployRequest components.DeployRequest, opts ...operations.Option) (*operations.UpdateProductsGroupsDeployByProductAndIDResponse, error)
Deploy commits to a Worker Group, Outpost Group, or Edge Fleet Deploy commits to the specified Worker Group, Outpost Group, or Edge Fleet.
func (*Groups) Get ¶
func (s *Groups) Get(ctx context.Context, product components.ProductsCore, id string, fields *string, opts ...operations.Option) (*operations.GetProductsGroupsByProductAndIDResponse, error)
Get a Worker Group, Outpost Group, or Edge Fleet Get the specified Worker Group, Outpost Group, or Edge Fleet.
func (*Groups) List ¶
func (s *Groups) List(ctx context.Context, product components.ProductsCore, fields *string, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetProductsGroupsByProductResponse, error)
List all Worker Groups, Outpost Groups, or Edge Fleets Get a list of all Worker Groups, Outpost Groups, or Edge Fleets for the specified Cribl product.
func (*Groups) Update ¶
func (s *Groups) Update(ctx context.Context, product components.ProductsCore, id string, configGroup components.ConfigGroup, opts ...operations.Option) (*operations.UpdateProductsGroupsByProductAndIDResponse, error)
Update a Worker Group, Outpost Group, or Edge Fleet Update the specified Worker Group, Outpost Group, or Edge Fleet.<br/><br/>Provide a complete representation of the Group or Fleet that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Group or Fleet.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Group or Fleet might not function as expected.<br/><br/>**Warning**: Do not change the values for the following parameters in the body of PATCH requests. The request body must include the values as they appear in the <code>GET /products/{product}/groups/{id}</code> response.<br/> - <code>configVersion</code><br/> - <code>deployingWorkerCount</code><br/> - <code>incompatibleWorkerCount</code><br/> - <code>workerCount</code><br/> - <code>lookupDeployments</code>.
type GroupsConfigs ¶
type GroupsConfigs struct {
Versions *ConfigsVersions
// contains filtered or unexported fields
}
type HTTPClient ¶
HTTPClient provides an interface for supplying the SDK with a custom HTTP client
type Health ¶
type Health struct {
// contains filtered or unexported fields
}
Health - Actions related to REST server health
func (*Health) Get ¶
func (s *Health) Get(ctx context.Context, opts ...operations.Option) (*operations.GetHealthResponse, error)
Get the health status of the server Get the current health status of the server (Leader or Worker Node). In Distributed deployments, requests routed to a Worker or Edge node using the [host context](https://docs.cribl.io/cribl-as-code/api#base-url-group-fleet-host) require a Bearer token for [authentication](https://docs.cribl.io/cribl-as-code/api-auth/).
type HecTokens ¶
type HecTokens struct {
// contains filtered or unexported fields
}
func (*HecTokens) Create ¶
func (s *HecTokens) Create(ctx context.Context, id string, addHecTokenRequest components.AddHecTokenRequest, opts ...operations.Option) (*operations.CreateInputHecTokenByIDResponse, error)
Create - Add an HEC token and optional metadata to a Splunk HEC Source Add an HEC token and optional metadata to the specified Splunk HEC Source.
func (*HecTokens) Update ¶
func (s *HecTokens) Update(ctx context.Context, id string, token string, updateHecTokenRequest components.UpdateHecTokenRequest, opts ...operations.Option) (*operations.UpdateInputHecTokenByIDAndTokenResponse, error)
Update metadata for an HEC token for a Splunk HEC Source Update the metadata for the specified HEC token for the specified Splunk HEC Source.
type Nodes ¶
type Nodes struct {
Summaries *Summaries
// contains filtered or unexported fields
}
func (*Nodes) Count ¶
func (s *Nodes) Count(ctx context.Context, product components.ProductsCore, filterExp *string, opts ...operations.Option) (*operations.GetProductsSummaryWorkersByProductResponse, error)
Count - Get a count of Worker, Edge, or Outpost Nodes Get a count of all Worker, Edge, or Outpost Nodes for the specified Cribl product.
func (*Nodes) Get ¶
func (s *Nodes) Get(ctx context.Context, product components.ProductsCore, id string, opts ...operations.Option) (*operations.GetProductsWorkersByProductAndIDResponse, error)
Get detailed metadata for a Worker, Edge, or Outpost Node Get detailed metadata for the specified Worker, Edge, or Outpost Node for the specified Cribl product.
func (*Nodes) List ¶
func (s *Nodes) List(ctx context.Context, request operations.GetProductsWorkersByProductRequest, opts ...operations.Option) (*operations.GetProductsWorkersByProductResponse, error)
List - Get detailed metadata for Worker, Edge, or Outpost Nodes Get detailed metadata for Worker, Edge, or Outpost Nodes for the specified Cribl product.
func (*Nodes) Restart ¶
func (s *Nodes) Restart(ctx context.Context, product components.ProductsCore, restartRequest components.RestartRequest, opts ...operations.Option) (*operations.UpdateProductsWorkersRestartByProductResponse, error)
Restart Worker, Edge, or Outpost Nodes Restart all Worker, Edge, or Outpost Nodes for the specified Cribl product.
type Packs ¶
type Packs struct {
Pipelines *PacksPipelines
Routes *PacksRoutes
Sources *PacksSources
Destinations *PacksDestinations
// contains filtered or unexported fields
}
Packs - Actions related to Packs
func (*Packs) Delete ¶
func (s *Packs) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DeletePacksByIDResponse, error)
Delete - Uninstall a Pack Uninstall the specified Pack.
func (*Packs) Get ¶
func (s *Packs) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetPacksByIDResponse, error)
Get a Pack Get the specified Pack.
func (*Packs) Install ¶
func (s *Packs) Install(ctx context.Context, request components.PackRequestBodyUnion, opts ...operations.Option) (*operations.CreatePacksResponse, error)
Install a Pack Install a Pack.<br/><br/>To install an uploaded Pack, provide the <code>source</code> value from the <code>PUT /packs</code> response as the <code>source</code> parameter in the request body.<br/><br/>To install a Pack by importing from a URL, provide the direct URL location of the <code>.crbl</code> file for the Pack as the <code>source</code> parameter in the request body.<br/><br/>To install a Pack by importing from a Git repository, provide <code>git+<repo-url></code> as the <code>source</code> parameter in the request body.<br/><br/>If you do not include the <code>source</code> parameter in the request body, an empty Pack is created.
func (*Packs) List ¶
func (s *Packs) List(ctx context.Context, with *string, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetPacksResponse, error)
List all Packs Get a list of all Packs.
func (*Packs) Update ¶
func (s *Packs) Update(ctx context.Context, id string, packUpgradeRequest components.PackUpgradeRequest, opts ...operations.Option) (*operations.UpdatePacksByIDResponse, error)
Update - Upgrade a Pack Upgrade the specified Pack.<br/><br/>If the Pack includes any user-modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.<br/><br/>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
func (*Packs) Upload ¶
func (s *Packs) Upload(ctx context.Context, filename string, requestBody any, opts ...operations.Option) (*operations.UpdatePacksResponse, error)
Upload a Pack file Upload a Pack file. Returns the <code>source</code> ID needed to install the Pack with <code>POST /packs</code>, which you must call separately.
type PacksDestinations ¶
type PacksDestinations struct {
Pq *PacksDestinationsPq
Samples *PacksSamples
Statuses *PacksDestinationsStatuses
// contains filtered or unexported fields
}
func (*PacksDestinations) Create ¶
func (s *PacksDestinations) Create(ctx context.Context, pack string, requestBody operations.CreateOutputSystemByPackRequestBody, opts ...operations.Option) (*operations.CreateOutputSystemByPackResponse, error)
Create a Destination within a Pack Create a new Destination within the specified Pack.
func (*PacksDestinations) Delete ¶
func (s *PacksDestinations) Delete(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.DeleteOutputSystemByPackAndIDResponse, error)
Delete a Destination within a Pack Delete the specified Destination within the specified Pack.
func (*PacksDestinations) Get ¶
func (s *PacksDestinations) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetOutputSystemByPackAndIDResponse, error)
Get a Destination within a Pack Get the specified Destination within the specified Pack.
func (*PacksDestinations) List ¶
func (s *PacksDestinations) List(ctx context.Context, pack string, type_ *components.DestinationType, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetOutputSystemByPackResponse, error)
List all Destinations within a Pack Get a list of all Destinations within the specified Pack.
func (*PacksDestinations) Update ¶
func (s *PacksDestinations) Update(ctx context.Context, id string, pack string, output components.Output, opts ...operations.Option) (*operations.UpdateOutputSystemByPackAndIDResponse, error)
Update a Destination within a Pack Update the specified Destination.<br/><br/>Provide a complete representation of the Destination that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Destination.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Destination might not function as expected within the specified Pack.
type PacksDestinationsPq ¶
type PacksDestinationsPq struct {
// contains filtered or unexported fields
}
func (*PacksDestinationsPq) Clear ¶
func (s *PacksDestinationsPq) Clear(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.DeleteOutputSystemPqByPackAndIDResponse, error)
Clear the persistent queue for a Destination within a Pack Clear the persistent queue (PQ) for the specified Destination within the specified Pack.
func (*PacksDestinationsPq) Get ¶
func (s *PacksDestinationsPq) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetOutputSystemPqByPackAndIDResponse, error)
Get information about the latest job to clear the persistent queue for a Destination within a Pack Get information about the latest job to clear the persistent queue (PQ) for the specified Destination within the specified Pack.
type PacksDestinationsStatuses ¶
type PacksDestinationsStatuses struct {
// contains filtered or unexported fields
}
func (*PacksDestinationsStatuses) Get ¶
func (s *PacksDestinationsStatuses) Get(ctx context.Context, id string, pack string, metrics *bool, type_ *bool, opts ...operations.Option) (*operations.GetOutputStatusSystemOutputsByPackAndIDResponse, error)
Get the status of a Destination within a Pack Get the status and optional metrics for the specified Destination within the specified Pack.
func (*PacksDestinationsStatuses) List ¶
func (s *PacksDestinationsStatuses) List(ctx context.Context, request operations.GetOutputStatusSystemOutputsByPackRequest, opts ...operations.Option) (*operations.GetOutputStatusSystemOutputsByPackResponse, error)
List the status of all Destinations within a Pack List status information and optional metrics for all configured Destinations in the Worker Group or Edge Fleet within the specified Pack.
type PacksHecTokens ¶
type PacksHecTokens struct {
// contains filtered or unexported fields
}
func (*PacksHecTokens) Create ¶
func (s *PacksHecTokens) Create(ctx context.Context, id string, pack string, addHecTokenRequest components.AddHecTokenRequest, opts ...operations.Option) (*operations.CreateInputSystemHecTokenByPackAndIDResponse, error)
Create - Add an HEC token and optional metadata to a Splunk HEC Source within a Pack Add an HEC token and optional metadata to the specified Splunk HEC Source within the specified Pack.
func (*PacksHecTokens) Update ¶
func (s *PacksHecTokens) Update(ctx context.Context, id string, token string, pack string, updateHecTokenRequest components.UpdateHecTokenRequest, opts ...operations.Option) (*operations.UpdateInputSystemHecTokenByPackAndIDAndTokenResponse, error)
Update metadata for an HEC token for a Splunk HEC Source within a Pack Update the metadata for the specified HEC token for the specified Splunk HEC Source within the specified Pack.
type PacksPipelines ¶
type PacksPipelines struct {
// contains filtered or unexported fields
}
func (*PacksPipelines) Create ¶
func (s *PacksPipelines) Create(ctx context.Context, pack string, pipeline components.PipelineInput, opts ...operations.Option) (*operations.CreatePipelinesByPackResponse, error)
Create a Pipeline within a Pack Create a new Pipeline within the specified Pack.
func (*PacksPipelines) Delete ¶
func (s *PacksPipelines) Delete(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.DeletePipelinesByPackAndIDResponse, error)
Delete a Pipeline within a Pack Delete the specified Pipeline within the specified Pack.
func (*PacksPipelines) Get ¶
func (s *PacksPipelines) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetPipelinesByPackAndIDResponse, error)
Get a Pipeline within a Pack Get the specified Pipeline within the specified Pack.
func (*PacksPipelines) List ¶
func (s *PacksPipelines) List(ctx context.Context, pack string, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetPipelinesByPackResponse, error)
List all Pipelines within a Pack Get a list of all Pipelines within the specified Pack.
func (*PacksPipelines) Update ¶
func (s *PacksPipelines) Update(ctx context.Context, id string, pack string, pipeline components.PipelineInput, opts ...operations.Option) (*operations.UpdatePipelinesByPackAndIDResponse, error)
Update a Pipeline within a Pack Update the specified Pipeline within the specified Pack.<br/><br/>Provide a complete representation of the Pipeline that you want to update in the request body.<br/><br/>This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Pipeline.<br/><br/>Confirm that the configuration in your request body is correct before sending the request.<br/><br/>If the configuration is incorrect, the updated Pipeline might not function as expected.
type PacksRoutes ¶
type PacksRoutes struct {
// contains filtered or unexported fields
}
func (*PacksRoutes) Append ¶
func (s *PacksRoutes) Append(ctx context.Context, id string, pack string, requestBody []components.RouteConfInput, opts ...operations.Option) (*operations.CreateRoutesAppendByPackAndIDResponse, error)
Append - Add a Route to the end of the Routing table within a Pack Add a Route to the end of the specified Routing table within the specified Pack.
func (*PacksRoutes) Get ¶
func (s *PacksRoutes) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetRoutesByPackAndIDResponse, error)
Get a Routing table within a Pack Get the specified Routing table within the specified Pack.
func (*PacksRoutes) List ¶
func (s *PacksRoutes) List(ctx context.Context, pack string, opts ...operations.Option) (*operations.GetRoutesByPackResponse, error)
List all Routes within a Pack Get a list of all Routes within the specified Pack.
func (*PacksRoutes) Update ¶
func (s *PacksRoutes) Update(ctx context.Context, id string, pack string, routesInput components.RoutesInput, opts ...operations.Option) (*operations.UpdateRoutesByPackAndIDResponse, error)
Update a Routing table within a Pack Update the specified Routing table within the specified Pack.<br/><br/>Provide a complete representation of the Routing table that you want to update in the request body.<br/><br/>This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Routing table.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Routing table might not function as expected.<br/><br/>Cribl also removes any omitted Routes when updating the Routing table.
type PacksSamples ¶
type PacksSamples struct {
// contains filtered or unexported fields
}
func (*PacksSamples) Create ¶
func (s *PacksSamples) Create(ctx context.Context, id string, pack string, outputTestRequest components.OutputTestRequest, opts ...operations.Option) (*operations.CreateOutputSystemTestByPackAndIDResponse, error)
Create - Send sample event data to a Destination within a Pack Send sample event data to the specified Destination to validate the configuration or test connectivity within the specified Pack.
func (*PacksSamples) Get ¶
func (s *PacksSamples) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetOutputSystemSamplesByPackAndIDResponse, error)
Get sample event data for a Destination within a Pack Get sample event data for the specified Destination to validate the configuration or test connectivity within the specified Pack.
type PacksSources ¶
type PacksSources struct {
HecTokens *PacksHecTokens
Pq *PacksSourcesPq
Statuses *PacksSourcesStatuses
// contains filtered or unexported fields
}
func (*PacksSources) Create ¶
func (s *PacksSources) Create(ctx context.Context, pack string, requestBody operations.CreateInputSystemByPackRequestBody, opts ...operations.Option) (*operations.CreateInputSystemByPackResponse, error)
Create a Source within a Pack Create a new Source. The system-managed provenance field (JSON <code>criblSourceProvenance</code>) must be omitted from the request body within the specified Pack.
func (*PacksSources) Delete ¶
func (s *PacksSources) Delete(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.DeleteInputSystemByPackAndIDResponse, error)
Delete a Source within a Pack Delete the specified Source within the specified Pack.
func (*PacksSources) Get ¶
func (s *PacksSources) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetInputSystemByPackAndIDResponse, error)
Get a Source within a Pack Get the specified Source within the specified Pack.
func (*PacksSources) List ¶
func (s *PacksSources) List(ctx context.Context, pack string, type_ []string, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetInputSystemByPackResponse, error)
List all Sources within a Pack Get a list of all Sources within the specified Pack.
func (*PacksSources) Update ¶
func (s *PacksSources) Update(ctx context.Context, id string, pack string, input components.Input, opts ...operations.Option) (*operations.UpdateInputSystemByPackAndIDResponse, error)
Update a Source within a Pack Update the specified Source.<br/><br/>Provide a complete representation of the Source that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Source.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Source might not function as expected.<br/><br/>Cribl preserves <code>criblSourceProvenance</code> when you omit it from the request body, and you cannot overwrite it through this endpoint within the specified Pack.
type PacksSourcesPq ¶
type PacksSourcesPq struct {
// contains filtered or unexported fields
}
func (*PacksSourcesPq) Clear ¶
func (s *PacksSourcesPq) Clear(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.DeleteInputSystemPqByPackAndIDResponse, error)
Clear the persistent queue for a Source within a Pack Clear the persistent queue (PQ) for the specified Source within the specified Pack.
func (*PacksSourcesPq) Get ¶
func (s *PacksSourcesPq) Get(ctx context.Context, id string, pack string, opts ...operations.Option) (*operations.GetInputSystemPqByPackAndIDResponse, error)
Get information about the latest job to clear the persistent queue for a Source within a Pack Get information about the latest job to clear the persistent queue (PQ) for the specified Source within the specified Pack.
type PacksSourcesStatuses ¶
type PacksSourcesStatuses struct {
// contains filtered or unexported fields
}
func (*PacksSourcesStatuses) Get ¶
func (s *PacksSourcesStatuses) Get(ctx context.Context, id string, pack string, metrics *bool, type_ *bool, opts ...operations.Option) (*operations.GetInputStatusSystemInputsByPackAndIDResponse, error)
Get the status of a Source within a Pack Get the status and optional metrics for the specified Source within the specified Pack.
func (*PacksSourcesStatuses) List ¶
func (s *PacksSourcesStatuses) List(ctx context.Context, request operations.GetInputStatusSystemInputsByPackRequest, opts ...operations.Option) (*operations.GetInputStatusSystemInputsByPackResponse, error)
List the status of all Sources within a Pack List status information and optional metrics for all configured Sources in the Worker Group or Edge Fleet within the specified Pack.
type Pipelines ¶
type Pipelines struct {
// contains filtered or unexported fields
}
Pipelines - Actions related to Pipelines
func (*Pipelines) Create ¶
func (s *Pipelines) Create(ctx context.Context, request components.PipelineInput, opts ...operations.Option) (*operations.CreatePipelinesResponse, error)
Create a Pipeline Create a new Pipeline.
func (*Pipelines) Delete ¶
func (s *Pipelines) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DeletePipelinesByIDResponse, error)
Delete a Pipeline Delete the specified Pipeline.
func (*Pipelines) Get ¶
func (s *Pipelines) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetPipelinesByIDResponse, error)
Get a Pipeline Get the specified Pipeline.
func (*Pipelines) List ¶
func (s *Pipelines) List(ctx context.Context, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetPipelinesResponse, error)
List all Pipelines Get a list of all Pipelines.
func (*Pipelines) Update ¶
func (s *Pipelines) Update(ctx context.Context, id string, pipeline components.PipelineInput, opts ...operations.Option) (*operations.UpdatePipelinesByIDResponse, error)
Update a Pipeline Update the specified Pipeline.<br/><br/>Provide a complete representation of the Pipeline that you want to update in the request body.<br/><br/>This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Pipeline.<br/><br/>Confirm that the configuration in your request body is correct before sending the request.<br/><br/>If the configuration is incorrect, the updated Pipeline might not function as expected.
type Routes ¶
type Routes struct {
// contains filtered or unexported fields
}
Routes - Actions related to Routes
func (*Routes) Append ¶
func (s *Routes) Append(ctx context.Context, id string, requestBody []components.RouteConfInput, opts ...operations.Option) (*operations.CreateRoutesAppendByIDResponse, error)
Append - Add a Route to the end of the Routing table Add a Route to the end of the specified Routing table.
func (*Routes) Get ¶
func (s *Routes) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetRoutesByIDResponse, error)
Get a Routing table Get the specified Routing table.
func (*Routes) List ¶
func (s *Routes) List(ctx context.Context, opts ...operations.Option) (*operations.GetRoutesResponse, error)
List all Routes Get a list of all Routes.
func (*Routes) Update ¶
func (s *Routes) Update(ctx context.Context, id string, routesInput components.RoutesInput, opts ...operations.Option) (*operations.UpdateRoutesByIDResponse, error)
Update a Routing table Update the specified Routing table.<br/><br/>Provide a complete representation of the Routing table that you want to update in the request body.<br/><br/>This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Routing table.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Routing table might not function as expected.<br/><br/>Cribl also removes any omitted Routes when updating the Routing table.
type SDKOption ¶
type SDKOption func(*CriblControlPlane)
func WithClient ¶
func WithClient(client HTTPClient) SDKOption
WithClient allows the overriding of the default HTTP client used by the SDK
func WithRetryConfig ¶
func WithSecurity ¶
func WithSecurity(security components.Security) SDKOption
WithSecurity configures the SDK to use the provided security details
func WithSecuritySource ¶
WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication
func WithServerURL ¶
WithServerURL allows providing an alternative server URL
func WithTemplatedServerURL ¶
WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters
func WithTimeout ¶
WithTimeout Optional request timeout applied to each operation
type Samples ¶
type Samples struct {
// contains filtered or unexported fields
}
func (*Samples) Create ¶
func (s *Samples) Create(ctx context.Context, id string, outputTestRequest components.OutputTestRequest, opts ...operations.Option) (*operations.CreateOutputTestByIDResponse, error)
Create - Send sample event data to a Destination Send sample event data to the specified Destination to validate the configuration or test connectivity.
func (*Samples) Get ¶
func (s *Samples) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetOutputSamplesByIDResponse, error)
Get sample event data for a Destination Get sample event data for the specified Destination to validate the configuration or test connectivity.
type Settings ¶
type Settings struct {
Cribl *Cribl
// contains filtered or unexported fields
}
func (*Settings) Restart ¶
func (s *Settings) Restart(ctx context.Context, opts ...operations.Option) (*operations.CreateSystemSettingsRestartResponse, error)
Restart the Cribl server Restart the Cribl server.<br/><br/>This operation requires <code>system.restart</code> to be set to <code>api</code> in <code>cribl.yml</code>. If this setting is not configured, the request returns a <code>403</code> error.<br/><br/>Restarting the server causes a brief period of downtime while the process stops and restarts. All in-flight events are drained before the process exits. Use <code>POST /system/settings/reload</code> to apply configuration changes without a full restart.
type Sources ¶
type Sources struct {
HecTokens *HecTokens
Pq *SourcesPq
Statuses *SourcesStatuses
// contains filtered or unexported fields
}
Sources - Actions related to Sources
func (*Sources) Create ¶
func (s *Sources) Create(ctx context.Context, request operations.CreateInputRequest, opts ...operations.Option) (*operations.CreateInputResponse, error)
Create a Source Create a new Source. The system-managed provenance field (JSON <code>criblSourceProvenance</code>) must be omitted from the request body.
func (*Sources) Delete ¶
func (s *Sources) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DeleteInputByIDResponse, error)
Delete a Source Delete the specified Source.
func (*Sources) Get ¶
func (s *Sources) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetInputByIDResponse, error)
Get a Source Get the specified Source.
func (*Sources) List ¶
func (s *Sources) List(ctx context.Context, type_ []string, offset *int64, limit *int64, opts ...operations.Option) (*operations.ListInputResponse, error)
List all Sources Get a list of all Sources.
func (*Sources) Update ¶
func (s *Sources) Update(ctx context.Context, id string, input components.Input, opts ...operations.Option) (*operations.UpdateInputByIDResponse, error)
Update a Source Update the specified Source.<br/><br/>Provide a complete representation of the Source that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Source.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Source might not function as expected.<br/><br/>Cribl preserves <code>criblSourceProvenance</code> when you omit it from the request body, and you cannot overwrite it through this endpoint.
type SourcesPq ¶
type SourcesPq struct {
// contains filtered or unexported fields
}
func (*SourcesPq) Clear ¶
func (s *SourcesPq) Clear(ctx context.Context, id string, opts ...operations.Option) (*operations.DeleteInputPqByIDResponse, error)
Clear the persistent queue for a Source Clear the persistent queue (PQ) for the specified Source.
func (*SourcesPq) Get ¶
func (s *SourcesPq) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.GetInputPqByIDResponse, error)
Get information about the latest job to clear the persistent queue for a Source Get information about the latest job to clear the persistent queue (PQ) for the specified Source.
type SourcesStatuses ¶
type SourcesStatuses struct {
// contains filtered or unexported fields
}
func (*SourcesStatuses) Get ¶
func (s *SourcesStatuses) Get(ctx context.Context, id string, metrics *bool, type_ *bool, opts ...operations.Option) (*operations.GetInputStatusByIDResponse, error)
Get the status of a Source Get the status and optional metrics for the specified Source.
func (*SourcesStatuses) List ¶
func (s *SourcesStatuses) List(ctx context.Context, metrics *bool, type_ *bool, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetInputStatusResponse, error)
List the status of all Sources List status information and optional metrics for all configured Sources in the Worker Group or Edge Fleet.
type Summaries ¶
type Summaries struct {
// contains filtered or unexported fields
}
func (*Summaries) Get ¶
func (s *Summaries) Get(ctx context.Context, product components.ProductsBase, offset *int64, limit *int64, opts ...operations.Option) (*operations.GetProductsSummaryByProductResponse, error)
Get a summary of the deployment for a Cribl product Get a summary of the deployment for the specified Cribl product (Stream or Edge).<br/><br/>The summary includes a count of Worker Groups or Edge Fleets and resources such as Pipelines, Routes, Sources, and Destinations. For Distributed deployments, the summary also includes a count and statistics for Worker or Edge Nodes.
type Teams ¶
type Teams struct {
// contains filtered or unexported fields
}
func (*Teams) Get ¶
func (s *Teams) Get(ctx context.Context, product components.ProductsCore, id string, type_ *components.RbacResource, opts ...operations.Option) (*operations.GetProductsGroupsACLTeamsByProductAndIDResponse, error)
Get the Access Control List for teams with permissions on a Worker Group, Outpost Group, or Edge Fleet for the specified Cribl product Get the Access Control List (ACL) for teams that have permissions on a Worker Group, Outpost Group, or Edge Fleet for the specified Cribl product.
type Tokens ¶
type Tokens struct {
// contains filtered or unexported fields
}
func (*Tokens) Get ¶
func (s *Tokens) Get(ctx context.Context, request components.LoginInfo, opts ...operations.Option) (*operations.CreateAuthLoginResponse, error)
Get - Log in and fetch an authentication token This endpoint is unavailable on Cribl.Cloud. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
type Versions ¶
type Versions struct {
Commits *Commits
Branches *Branches
Configs *VersionsConfigs
Statuses *VersionsStatuses
// contains filtered or unexported fields
}
type VersionsConfigs ¶
type VersionsConfigs struct {
// contains filtered or unexported fields
}
func (*VersionsConfigs) Get ¶
func (s *VersionsConfigs) Get(ctx context.Context, opts ...operations.Option) (*operations.GetVersionInfoResponse, error)
Get the configuration and status for the Git integration Get the configuration and versioning status for the Git integration for the Cribl configuration.
type VersionsStatuses ¶
type VersionsStatuses struct {
// contains filtered or unexported fields
}
func (*VersionsStatuses) Get ¶
func (s *VersionsStatuses) Get(ctx context.Context, opts ...operations.Option) (*operations.GetVersionStatusResponse, error)
Get the status of the current working tree Get the status of the current working tree of the Git repository used for Cribl configuration. The response includes details about modified, staged, untracked, and conflicted files, as well as branch and remote tracking information.
Source Files
¶
- acl.go
- auth.go
- branches.go
- captures.go
- collectors.go
- commits.go
- configsversions.go
- cribl.go
- criblcontrolplane.go
- databaseconnections.go
- datasets.go
- destinations.go
- destinationspq.go
- destinationsstatuses.go
- files.go
- functions.go
- groups.go
- groupsconfigs.go
- health.go
- hectokens.go
- lakes.go
- nodes.go
- packs.go
- packsdestinations.go
- packsdestinationspq.go
- packsdestinationsstatuses.go
- packshectokens.go
- packspipelines.go
- packsroutes.go
- packssamples.go
- packssources.go
- packssourcespq.go
- packssourcesstatuses.go
- pipelines.go
- routes.go
- samples.go
- settings.go
- sources.go
- sourcespq.go
- sourcesstatuses.go
- summaries.go
- system.go
- teams.go
- tokens.go
- versions.go
- versionsconfigs.go
- versionsstatuses.go