dash0

package module
v1.21.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 24, 2026 License: Apache-2.0 Imports: 22 Imported by: 1

README

Dash0 Go API Client GoDoc

A Go client library for the Dash0 API.

Requirements

Go 1.25 or later.

Installation

go get github.com/dash0hq/dash0-api-client-go

Usage

package main

import (
    "context"
    "fmt"
    "log"

    "github.com/dash0hq/dash0-api-client-go"
)

func main() {
    // Create a new client
    client, err := dash0.NewClient(
        dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
        dash0.WithAuthToken("auth_your-auth-token"),
    )
    if err != nil {
        log.Fatal(err)
    }
    defer client.Close(context.Background())

    // List dashboards in the "default" dataset
    dashboards, err := client.ListDashboards(context.Background(), dash0.String("default"))
    if err != nil {
        if dash0.IsUnauthorized(err) {
            log.Fatal("Invalid API token")
        }
        log.Fatal(err)
    }

    for _, d := range dashboards {
        fmt.Printf("Dashboard: %s (ID: %s)\n", d.Name, d.Id)
    }
}

Sending Telemetry Data (OTLP)

The client can push OpenTelemetry traces, metrics, and logs to an OTLP endpoint with otlp/json encoding. You can create a client with only an OTLP endpoint, only a REST API URL, or both:

// OTLP-only client (no REST API access)
client, err := dash0.NewClient(
    dash0.WithAuthToken("auth_your-auth-token"),
    dash0.WithOtlpEndpoint(dash0.OtlpEncodingJson, "https://otlp.eu-west-1.aws.dash0.com"),
)

// Combined client (REST API + OTLP)
client, err := dash0.NewClient(
    dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
    dash0.WithAuthToken("auth_your-auth-token"),
    dash0.WithOtlpEndpoint(dash0.OtlpEncodingJson, "https://otlp.eu-west-1.aws.dash0.com"),
)

The SendTraces, SendMetrics, and SendLogs methods accept pdata types (ptrace.Traces, pmetric.Metrics, plog.Logs). Signal-specific paths (/v1/traces, /v1/metrics, /v1/logs) are appended automatically to the base endpoint URL. Pass nil as the dataset to send data to the default dataset in Dash0.

// Send to the default dataset
err = client.SendTraces(ctx, traces, nil)
err = client.SendMetrics(ctx, metrics, nil)
err = client.SendLogs(ctx, logs, nil)

// Send to a specific dataset
err = client.SendTraces(ctx, traces, dash0.String("my-dataset"))
err = client.SendMetrics(ctx, metrics, dash0.String("my-dataset"))
err = client.SendLogs(ctx, logs, dash0.String("my-dataset"))

OTLP requests use the same HTTP client, retry logic, and rate limiting as the REST API calls. Call Close when the underlying HTTP client is no longer needed.

Configuration Options

Option Description Default
WithApiUrl(url) Dash0 API URL (required for REST API) -
WithAuthToken(token) Auth token for authentication (required) -
WithOtlpEndpoint(enc, url) OTLP/HTTP endpoint for telemetry push (required for OTLP) -
WithMaxConcurrentRequests(n) Maximum concurrent API requests (1-10) 3
WithTimeout(duration) HTTP request timeout 30s
WithHTTPClient(client) Custom HTTP client -
WithUserAgent(ua) Custom User-Agent header dash0-api-client-go/<version>
WithMaxRetries(n) Maximum retries for failed requests (0-5) 1
WithRetryWaitMin(duration) Minimum wait between retries 500ms
WithRetryWaitMax(duration) Maximum wait between retries 30s
WithRetryOnConflict() Retry requests that fail with 409 Conflict Off unless passed

NewClient requires WithAuthToken and at least one of WithApiUrl or WithOtlpEndpoint. REST API methods (dashboards, check rules, etc.) require WithApiUrl; OTLP methods (SendTraces, SendMetrics, SendLogs) require WithOtlpEndpoint. Calling a method whose endpoint was not configured returns an error.

Automatic Retries

The client automatically retries failed requests with exponential backoff:

  • Retried errors: 429 (rate limited) and 5xx (server errors)
  • Max retries: 1 (configurable up to 5 via WithMaxRetries)
  • Backoff: Exponential with jitter, starting at 500ms up to 30s
  • Retry-After: Respected when present in response headers

Only idempotent requests (GET, PUT, DELETE, HEAD, OPTIONS) and OTLP sends are retried automatically.

Retrying dataset version conflicts

A Dash0 dataset is guarded by an optimistic-concurrency dataset version. When two writes to the same dataset race, exactly one wins and the other returns a 409 that asks the caller to retry. This happens whenever writes to one dataset are issued concurrently, whether from goroutines in one process or from separate processes, such as a CI matrix that runs dash0 apply in parallel.

WithRetryOnConflict() retries those writes instead of failing them:

client, err := dash0.NewClient(
    dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
    dash0.WithAuthToken("auth_yourtoken"),
    dash0.WithRetryOnConflict(),
)
  • Retried status: 409 only, on every request including non-idempotent ones such as the Import* methods, which are POSTs. A 409 means the server rejected the write without applying it, so sending it again does not duplicate anything.
  • Max retries: the budget WithMaxRetries sets.
  • Backoff: full jitter, starting at 100ms and capped at 2s. This is deliberately shorter than the 429 and 5xx window, because the wait is on a writer that has already won rather than on an overloaded server.
  • Retry-After: still respected when the response carries it.

The Transport equivalent is WithTransportRetryOnConflict().

Pagination with Iterators

For endpoints that return paginated results, use iterators to automatically fetch all pages:

// Iterate over all spans in a time range
iter := client.GetSpansIter(ctx, &dash0.GetSpansRequest{
    TimeRange: dash0.TimeReferenceRange{
        From: "now-1h",
        To:   "now",
    },
})

for iter.Next() {
    resourceSpan := iter.Current()
    // process resourceSpan
}
if err := iter.Err(); err != nil {
    log.Fatal(err)
}

Error Handling

HTTP errors

Both REST API and OTLP methods return *dash0.APIError for non-2xx HTTP responses. The error includes the status code, message, and trace ID for support:

err := client.SendTraces(ctx, traces, nil)
if err != nil {
    if apiErr, ok := err.(*dash0.APIError); ok {
        fmt.Printf("API error: %s (status: %d, trace_id: %s)\n",
            apiErr.Message, apiErr.StatusCode, apiErr.TraceID)
    }
}

The same helper functions work for both REST API and OTLP errors:

if dash0.IsUnauthorized(err) {
    // Handle 401 - invalid or expired token
}
if dash0.IsRateLimited(err) {
    // Handle 429 - too many requests
}
if dash0.IsServerError(err) {
    // Handle 5xx - server errors
}
if dash0.IsNotFound(err) {
    // Handle 404
}
if dash0.IsForbidden(err) {
    // Handle 403 - insufficient permissions
}
if dash0.IsBadRequest(err) {
    // Handle 400 - invalid request
}
if dash0.IsConflict(err) {
    // Handle 409 - resource conflict
}
Not-configured errors

Calling a method whose endpoint was not configured returns a sentinel error that can be checked with errors.Is:

if errors.Is(err, dash0.ErrOTLPNotConfigured) {
    // SendTraces/SendMetrics/SendLogs called without WithOtlpEndpoint
}
if errors.Is(err, dash0.ErrAPINotConfigured) {
    // REST API method called without WithApiUrl
}

Testing

The dash0.Client is an interface, making it easy to mock in tests. Use dash0test.MockClient for a ready-to-use mock implementation:

package mypackage

import (
    "context"
    "testing"

    "github.com/dash0hq/dash0-api-client-go"
    "github.com/dash0hq/dash0-api-client-go/dash0test"
)

// MyService uses the Dash0 client
type MyService struct {
    client dash0.Client
}

func TestMyService(t *testing.T) {
    // Create a mock client with custom behavior
    mock := &dash0test.MockClient{
        ListDashboardsFunc: func(ctx context.Context, dataset *string) ([]*dash0.DashboardApiListItem, error) {
            return []*dash0.DashboardApiListItem{
                {Id: dash0.Ptr("dashboard-1"), Name: dash0.Ptr("My Dashboard")},
            }, nil
        },
    }

    // Inject the mock into your service
    svc := &MyService{client: mock}

    // Test your service...
    _ = svc
}

OAuth 2.0 authentication

The library provides a separate OAuthClient for the public OAuth endpoints (no API token required) and a profiles package that persists OAuth state to disk and transparently refreshes access tokens.

The CLI orchestration (PKCE code generation, browser redirect, callback server) lives in the Dash0 CLI repository; this library provides the API surface and state management it builds on.

End-to-end flow for a dash0 login-style command:

// 1. Generate PKCE parameters and CSRF state.
pair, _ := dash0.GeneratePKCEPair()
state, _ := dash0.GenerateOAuthState()

// 2. Discover or register a client (omitted), then build the authorize URL.
oauthClient, _ := dash0.NewOAuthClient(dash0.WithApiUrl(apiURL))
defer oauthClient.Close(context.Background())

authorizeURL, _ := oauthClient.AuthorizeURL(&dash0.AuthorizeURLParams{
    ClientID:      clientID,
    RedirectURI:   "http://localhost:8080/callback",
    State:         state,
    CodeChallenge: pair.Challenge,
    // ResponseType defaults to dash0.OAuthResponseTypeCode.
    // CodeChallengeMethod defaults to dash0.OAuthCodeChallengeMethodS256.
})

// 3. After the user consents and the callback delivers the authorization code:
resp, _ := oauthClient.ExchangeToken(context.Background(), &dash0.OAuthTokenRequest{
    GrantType:    dash0.OAuthGrantTypeAuthorizationCode,
    Code:         dash0.Ptr(authorizationCode),
    RedirectUri:  dash0.Ptr("http://localhost:8080/callback"),
    CodeVerifier: dash0.Ptr(pair.Verifier),
    ClientId:     dash0.Ptr(clientID),
})

// 4. Persist the OAuth state alongside the active access token.
store, _ := profiles.NewStore()
_ = store.AddProfile(profiles.Profile{
    Name: "production",
    Configuration: profiles.Configuration{
        ApiUrl:    apiURL,
        AuthToken: resp.AccessToken,
        OAuth: &profiles.OAuthState{
            ClientID:     clientID,
            RefreshToken: *resp.RefreshToken,
            ExpiresAt:    time.Now().Add(time.Duration(resp.ExpiresIn) * time.Second),
        },
    },
})

On subsequent invocations, Store.GetActiveConfigurationContext(ctx) returns the active configuration and transparently refreshes the access token when it is within 5 minutes of expiry. A token that the authorization server rejects (invalid_grant) is cleared from disk and surfaces as profiles.ErrReauthenticationRequired, so the caller can trigger a fresh interactive login without retrying the dead credential.

Files written under the config directory

The profiles package stores state in the directory resolved by WithConfigDir > DASH0_CONFIG_DIR > ~/.dash0/:

File Purpose Mode
profiles.json Named profiles, including OAuth refresh tokens. 0600
activeProfile Name of the currently active profile. 0600
oauth-clients.json Dynamic client registrations (RFC 7591) keyed by canonical API URL, including the RFC 7592 RegistrationAccessToken. 0600
.profile-lock Sentinel file used for cross-process advisory locking (see below). 0600

The directory itself is created with mode 0700. All file writes go through a temp-file + os.Rename to avoid leaving a half-written file if the process crashes mid-write.

Concurrency model

The profiles.Store serializes mutations of profiles.json and activeProfile at two layers:

  • In-process: an internal mutex guards every read-modify-write sequence (AddProfile, UpdateProfile, RemoveProfile, SetActiveProfile, and the transparent OAuth refresh inside GetActiveConfigurationContext).
  • Cross-process: an OS-level advisory lock on .profile-lock, backed by github.com/gofrs/flock, prevents two CLI invocations sharing a config directory from refreshing or mutating profiles concurrently.

Without the cross-process lock, two CLI invocations could both refresh the same profile in the 5-minute pre-expiry window, both rotate the server-side refresh-token family, and the loser would 401 on the next API call. The lock makes the rotation deterministic: the second invocation waits, re-reads the freshly persisted tokens, and uses them instead of refreshing again with a stale refresh token.

License

See LICENSE for details.

Documentation

Overview

Package dash0 provides a high-level client for the Dash0 API.

Package dash0 provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.

Index

Examples

Constants

View Source
const (
	AnnotationFolderPath = "dash0.com/folder-path"
	AnnotationSharing    = "dash0.com/sharing"
	AnnotationSource     = "dash0.com/source"
)

CRD annotation keys used by Dash0 assets in Kubernetes-style metadata.

View Source
const (
	// AuthTokenPrefixStatic marks a long-lived organization token, created in
	// the Dash0 settings UI.
	AuthTokenPrefixStatic = "auth_"
	// AuthTokenPrefixOAuth marks an access token issued by the Dash0
	// authorization server, which expires and has to be refreshed.
	AuthTokenPrefixOAuth = "dash0_at_"
)

Auth token prefixes. Every Dash0 credential carries one of these, and callers that validate a token before handing it over should compare against them rather than repeating the literals.

View Source
const (
	// DefaultMaxConcurrentRequests is the default maximum number of concurrent API requests.
	DefaultMaxConcurrentRequests = 3

	// MaxConcurrentRequests is the maximum allowed value for concurrent requests.
	MaxConcurrentRequests = 10

	// DefaultTimeout is the default HTTP request timeout.
	DefaultTimeout = 30 * time.Second

	// DefaultUserAgent is the default User-Agent header value.
	DefaultUserAgent = "dash0-api-client-go/" + Version

	// DefaultRetryWaitMin is the default minimum wait time between retries.
	DefaultRetryWaitMin = 500 * time.Millisecond

	// DefaultRetryWaitMax is the default maximum wait time between retries.
	DefaultRetryWaitMax = 30 * time.Second

	// MaxRetries is the maximum allowed number of retries.
	MaxRetries = 5
)
View Source
const (
	LabelID      = "dash0.com/id"
	LabelDataset = "dash0.com/dataset"
	LabelOrigin  = "dash0.com/origin"
)

CRD label keys used by Dash0 assets in Kubernetes-style metadata.

Adaptive is a deprecated alias for SamplingModeAdaptive.

Deprecated: since v1.21.0. Use SamplingModeAdaptive instead.

Dash0SpamFilter is a deprecated alias for SpamFilterDefinitionKindDash0SpamFilter.

Deprecated: since v1.12.1. Use SpamFilterDefinitionKindDash0SpamFilter instead.

View Source
const DashboardSourceApi = Api

DashboardSourceApi is a deprecated alias for Api.

Deprecated: since v1.12.0. Use Api instead.

View Source
const DashboardSourceOperator = Operator

DashboardSourceOperator is a deprecated alias for Operator.

Deprecated: since v1.12.0. Use Operator instead.

View Source
const DashboardSourceTerraform = Terraform

DashboardSourceTerraform is a deprecated alias for Terraform.

Deprecated: since v1.12.0. Use Terraform instead.

View Source
const DashboardSourceUi = Ui

DashboardSourceUi is a deprecated alias for Ui.

Deprecated: since v1.12.0. Use Ui instead.

Disabled is a deprecated alias for SamplingModeDisabled.

Deprecated: since v1.21.0. Use SamplingModeDisabled instead.

View Source
const HttpRequestBodyKindForm = Form

HttpRequestBodyKindForm is a deprecated alias for Form.

Deprecated: since v1.16.0. Use Form instead.

View Source
const HttpRequestBodyKindGraphql = Graphql

HttpRequestBodyKindGraphql is a deprecated alias for Graphql.

Deprecated: since v1.16.0. Use Graphql instead.

View Source
const HttpRequestBodyKindJson = Json

HttpRequestBodyKindJson is a deprecated alias for Json.

Deprecated: since v1.16.0. Use Json instead.

View Source
const HttpRequestBodyKindRaw = Raw

HttpRequestBodyKindRaw is a deprecated alias for Raw.

Deprecated: since v1.16.0. Use Raw instead.

View Source
const OAuthCodeChallengeMethodS256 = S256

OAuthCodeChallengeMethodS256 is the prefixed alias for the S256 PKCE code-challenge method (RFC 7636). Prefer this name in user code — the bare S256 survives only for the oapi-codegen-generated constant set.

View Source
const OAuthResponseTypeCode = Code

OAuthResponseTypeCode is the prefixed alias for the Code response type (RFC 6749 §4.1). Prefer this name in user code — the bare Code survives only for the oapi-codegen-generated constant set.

View Source
const SignalToMetricsSourceApi = Api

SignalToMetricsSourceApi is a deprecated alias for Api.

Deprecated: since v1.12.0. Use Api instead.

View Source
const SignalToMetricsSourceOperator = Operator

SignalToMetricsSourceOperator is a deprecated alias for Operator.

Deprecated: since v1.12.0. Use Operator instead.

View Source
const SignalToMetricsSourceTerraform = Terraform

SignalToMetricsSourceTerraform is a deprecated alias for Terraform.

Deprecated: since v1.12.0. Use Terraform instead.

View Source
const SignalToMetricsSourceUi = Ui

SignalToMetricsSourceUi is a deprecated alias for Ui.

Deprecated: since v1.12.0. Use Ui instead.

Deprecated: since v1.12.3. Use SpamFilterApiVersionV1alpha1 instead (the enum value on the wider SpamFilterApiVersion type generated by the current upstream spec).

View Source
const Version = "1.21.1"

Version is the version of the dash0-api-client-go library. Updated automatically by the release workflow.

View Source
const ViewTypeAwsLambda = AwsLambda

Deprecated: since v1.12.3. Use AwsLambda instead.

View Source
const ViewTypeFailedChecks = FailedChecks

Deprecated: since v1.12.3. Use FailedChecks instead.

View Source
const ViewTypeGcpCloudRunJobs = GcpCloudRunJobs

Deprecated: since v1.12.3. Use GcpCloudRunJobs instead.

View Source
const ViewTypeGcpCloudRunServices = GcpCloudRunServices

Deprecated: since v1.12.3. Use GcpCloudRunServices instead.

View Source
const ViewTypeGcpCloudStorage = GcpCloudStorage

Deprecated: since v1.12.3. Use GcpCloudStorage instead.

View Source
const ViewTypeGcpPubsub = GcpPubsub

Deprecated: since v1.12.3. Use GcpPubsub instead.

View Source
const ViewTypeLogs = Logs

Deprecated: since v1.12.3. Use Logs instead.

View Source
const ViewTypeMetrics = Metrics

Deprecated: since v1.12.3. Use Metrics instead.

View Source
const ViewTypeProfiles = Profiles

Deprecated: since v1.12.3. Use Profiles instead.

View Source
const ViewTypeResources = Resources

Deprecated: since v1.12.3. Use Resources instead.

View Source
const ViewTypeServices = Services

Deprecated: since v1.12.3. Use Services instead.

View Source
const ViewTypeSpans = Spans

Deprecated: since v1.12.3. Use Spans instead.

View Source
const ViewTypeSql = Sql

Deprecated: since v1.12.3. Use Sql instead.

View Source
const ViewTypeWebEvents = WebEvents

Deprecated: since v1.12.3. Use WebEvents instead.

Variables

View Source
var ErrAPINotConfigured = errors.New("dash0: API endpoint not configured (use WithApiUrl)")

ErrAPINotConfigured is returned when a REST API method is called on a client created without WithApiUrl.

View Source
var ErrOTLPNotConfigured = errors.New("dash0: OTLP endpoint not configured (use WithOtlpEndpoint)")

ErrOTLPNotConfigured is returned when SendTraces, SendMetrics, or SendLogs is called on a client created without WithOtlpEndpoint.

Functions

func AppBaseURL added in v1.13.0

func AppBaseURL(apiURL string) string

AppBaseURL derives the Dash0 web app base URL from an API URL.

It takes the registrable domain (the last two labels) of the API host and prefixes "app.". For example "https://api.us-west-2.aws.dash0.com" yields "https://app.dash0.com" and "https://api.dash0-dev.com" yields "https://app.dash0-dev.com". It returns an empty string if the API URL is empty or cannot be parsed into a host with at least two labels.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	fmt.Println(dash0.AppBaseURL("https://api.eu-west-1.aws.dash0.com"))
}
Output:
https://app.dash0.com

func Bool

func Bool(v bool) *bool

Bool returns a pointer to the given bool value.

func BoolValue

func BoolValue(p *bool) bool

BoolValue returns the value of a bool pointer, or false if nil.

func ClearCheckRuleID added in v1.6.0

func ClearCheckRuleID(rule *PrometheusAlertRule)

ClearCheckRuleID removes the ID from a check rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.PrometheusAlertRule{Id: dash0.Ptr("cr-42")}
	dash0.ClearCheckRuleID(rule)
	fmt.Println(rule.Id == nil)
}
Output:
true

func ClearDashboardID added in v1.6.0

func ClearDashboardID(dashboard *DashboardDefinition)

ClearDashboardID removes the ID from a dashboard definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	dashboard := &dash0.DashboardDefinition{
		Metadata: dash0.DashboardMetadata{
			Dash0Extensions: &dash0.DashboardMetadataExtensions{
				Id: dash0.Ptr("d-123"),
			},
		},
	}
	dash0.ClearDashboardID(dashboard)
	fmt.Println(dashboard.Metadata.Dash0Extensions.Id == nil)
}
Output:
true

func ClearNotificationChannelID added in v1.9.0

func ClearNotificationChannelID(channel *NotificationChannelDefinition)

ClearNotificationChannelID removes the ID from a notification channel definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	channel := &dash0.NotificationChannelDefinition{
		Metadata: dash0.NotificationChannelMetadata{Name: "Slack Alerts"},
	}
	dash0.SetNotificationChannelID(channel, "nc-123")
	dash0.ClearNotificationChannelID(channel)
	fmt.Println(channel.Metadata.Labels.Dash0Comid == nil)
}
Output:
true

func ClearPersesDashboardID added in v1.6.0

func ClearPersesDashboardID(perses *PersesDashboard)

ClearPersesDashboardID removes the dash0.com/id label from a PersesDashboard CRD.

func ClearPrometheusRuleID added in v1.6.0

func ClearPrometheusRuleID(rule *PrometheusRules)

ClearPrometheusRuleID removes the dash0.com/id label from a PrometheusRules CRD.

func ClearRecordingRuleID added in v1.10.0

func ClearRecordingRuleID(rule *RecordingRule)

ClearRecordingRuleID removes the ID from a recording rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	labels := map[string]string{"dash0.com/id": "rr-42"}
	rule := &dash0.RecordingRule{
		Metadata: dash0.PrometheusRuleMetadata{Labels: &labels},
	}
	dash0.ClearRecordingRuleID(rule)
	fmt.Println(dash0.GetRecordingRuleID(rule) == "")
}
Output:
true

func ClearSLOID added in v1.18.0

func ClearSLOID(slo *SloDefinition)

ClearSLOID removes the ID from an SLO definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	slo := &dash0.SloDefinition{
		Metadata: dash0.SloMetadata{
			Labels: &dash0.SloLabels{Dash0Comid: dash0.Ptr("slo_01k5vpx97efdnrkqan15b41k84")},
		},
	}
	dash0.ClearSLOID(slo)
	fmt.Println(slo.Metadata.Labels.Dash0Comid == nil)
}
Output:
true

func ClearSpamFilterID added in v1.12.0

func ClearSpamFilterID(filter *SpamFilter)

ClearSpamFilterID removes the ID from a spam filter definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	filter := &dash0.SpamFilter{
		Metadata: dash0.SpamFilterMetadata{
			Labels: &dash0.SpamFilterLabels{Dash0Comid: dash0.Ptr("sf-123")},
		},
	}
	dash0.ClearSpamFilterID(filter)
	fmt.Println(filter.Metadata.Labels.Dash0Comid == nil)
}
Output:
true

func ClearSyntheticCheckID added in v1.6.0

func ClearSyntheticCheckID(check *SyntheticCheckDefinition)

ClearSyntheticCheckID removes the ID from a synthetic check definition.

func ClearTeamID added in v1.17.0

func ClearTeamID(team *TeamDefinitionV1Alpha1)

ClearTeamID removes the dash0.com/id label from a team definition. No-op when the team is nil or has no labels.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	team := &dash0.TeamDefinitionV1Alpha1{
		Metadata: dash0.TeamMetadata{
			Labels: &dash0.TeamLabels{Dash0Comid: dash0.Ptr("00000000-0000-0000-0000-000000000001")},
		},
	}
	dash0.ClearTeamID(team)
	fmt.Println(team.Metadata.Labels.Dash0Comid == nil)
}
Output:
true

func ClearViewID added in v1.6.0

func ClearViewID(view *ViewDefinition)

ClearViewID removes the ID from a view definition.

func DatasetPtr added in v1.6.0

func DatasetPtr(dataset string) *string

DatasetPtr converts a dataset string to a pointer, returning nil for empty strings and for "default" (the API uses "default" implicitly when no dataset parameter is sent).

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	// Returns nil for "default" — the API treats absent dataset as "default".
	p := dash0.DatasetPtr("default")
	fmt.Println(p)
}
Output:
<nil>
Example (NonDefault)
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	p := dash0.DatasetPtr("production")
	fmt.Println(*p)
}
Output:
production

func DeeplinkURL added in v1.13.0

func DeeplinkURL(apiURL string, assetType DeeplinkAssetType, assetID string, dataset *string) string

DeeplinkURL constructs a Dash0 web app deep link for the given asset type and ID, derived from the API URL (see AppBaseURL).

When dataset is non-nil and non-empty, a `dataset=<dataset>` query parameter is appended so the web app opens the page scoped to that dataset. Org-level assets (team, member, notification channel) do not live in a dataset; pass nil for those.

It returns an empty string if the API URL cannot be parsed or the asset type is not supported. For views, prefer ViewDeeplinkURL, which selects the correct page based on the view type.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	fmt.Println(dash0.DeeplinkURL("https://api.us-west-2.aws.dash0.com", dash0.DeeplinkAssetTypeDashboard, "abc-123", dash0.Ptr("production")))
}
Output:
https://app.dash0.com/goto/dashboards?dashboard_id=abc-123&dataset=production

func FailedChecksExplorerURL added in v1.16.0

func FailedChecksExplorerURL(apiURL string, filters []DeeplinkFilter, from, to string, dataset *string) string

FailedChecksExplorerURL builds a deep link to the Dash0 alerting failed checks view. The URL includes optional filter criteria, time range, and optional dataset as query parameters. It returns an empty string if the API URL is empty or cannot be parsed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	filters := []dash0.DeeplinkFilter{{Key: "priority", Operator: "is", Value: "p1"}}
	fmt.Println(dash0.FailedChecksExplorerURL("https://api.us-west-2.aws.dash0.com", filters, "now-1h", "now", dash0.Ptr("production")))
}
Output:
https://app.dash0.com/goto/alerting/failed-checks?dataset=production&filter=%5B%7B%22key%22%3A%22priority%22%2C%22operator%22%3A%22is%22%2C%22value%22%3A%22p1%22%7D%5D&from=now-1h&to=now

func Float64

func Float64(v float64) *float64

Float64 returns a pointer to the given float64 value.

func Float64Value

func Float64Value(p *float64) float64

Float64Value returns the value of a float64 pointer, or 0 if nil.

func FormatDuration added in v1.6.0

func FormatDuration(d time.Duration) string

FormatDuration formats a time.Duration as a compact Prometheus-style duration string (e.g., "2m" instead of Go's "2m0s").

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	fmt.Println(dash0.FormatDuration(5 * 60e9))   // 5 minutes
	fmt.Println(dash0.FormatDuration(90e9))       // 1m30s
	fmt.Println(dash0.FormatDuration(2 * 3600e9)) // 2 hours
}
Output:
5m
1m30s
2h

func GenerateOAuthState added in v1.15.0

func GenerateOAuthState() (string, error)

GenerateOAuthState returns a fresh opaque value suitable for the OAuth `state` parameter (RFC 6749 §10.12). 43 base64url characters, no padding.

Example
package main

import (
	"fmt"
	"log"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	state, err := dash0.GenerateOAuthState()
	if err != nil {
		log.Fatal(err)
	}
	// base64url(32 random bytes) without padding — 43 chars.
	fmt.Println(len(state))
}
Output:
43

func GetCheckRuleDataset added in v1.6.0

func GetCheckRuleDataset(rule *PrometheusAlertRule) string

GetCheckRuleDataset extracts the dataset from a check rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.PrometheusAlertRule{Dataset: dash0.Ptr("production")}
	fmt.Println(dash0.GetCheckRuleDataset(rule))
}
Output:
production

func GetCheckRuleID added in v1.6.0

func GetCheckRuleID(rule *PrometheusAlertRule) string

GetCheckRuleID extracts the ID from a check rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.PrometheusAlertRule{Id: dash0.Ptr("cr-42")}
	fmt.Println(dash0.GetCheckRuleID(rule))
}
Output:
cr-42

func GetCheckRuleName added in v1.6.0

func GetCheckRuleName(rule *PrometheusAlertRule) string

GetCheckRuleName extracts the name from a check rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.PrometheusAlertRule{Name: "HighErrorRate"}
	fmt.Println(dash0.GetCheckRuleName(rule))
}
Output:
HighErrorRate

func GetDashboardDataset added in v1.6.0

func GetDashboardDataset(dashboard *DashboardDefinition) string

GetDashboardDataset extracts the dataset from a dashboard definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	dashboard := &dash0.DashboardDefinition{
		Metadata: dash0.DashboardMetadata{
			Dash0Extensions: &dash0.DashboardMetadataExtensions{
				Dataset: dash0.Ptr("production"),
			},
		},
	}
	fmt.Println(dash0.GetDashboardDataset(dashboard))
}
Output:
production

func GetDashboardFolderPath added in v1.6.0

func GetDashboardFolderPath(dashboard *DashboardDefinition) string

GetDashboardFolderPath extracts the folder path from a dashboard definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	dashboard := &dash0.DashboardDefinition{
		Metadata: dash0.DashboardMetadata{
			Annotations: &dash0.DashboardAnnotations{
				Dash0ComfolderPath: dash0.Ptr("/team/sre"),
			},
		},
	}
	fmt.Println(dash0.GetDashboardFolderPath(dashboard))
}
Output:
/team/sre

func GetDashboardID added in v1.6.0

func GetDashboardID(dashboard *DashboardDefinition) string

GetDashboardID extracts the ID from a dashboard definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	dashboard := &dash0.DashboardDefinition{
		Metadata: dash0.DashboardMetadata{
			Dash0Extensions: &dash0.DashboardMetadataExtensions{
				Id: dash0.Ptr("d-123"),
			},
		},
	}
	fmt.Println(dash0.GetDashboardID(dashboard))
}
Output:
d-123

func GetDashboardName added in v1.6.0

func GetDashboardName(dashboard *DashboardDefinition) string

GetDashboardName extracts the display name from a dashboard definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	dashboard := &dash0.DashboardDefinition{
		Spec: map[string]any{
			"display": map[string]any{"name": "API Latency"},
		},
	}
	fmt.Println(dash0.GetDashboardName(dashboard))
}
Output:
API Latency

func GetNotificationChannelID added in v1.9.0

func GetNotificationChannelID(channel *NotificationChannelDefinition) string

GetNotificationChannelID extracts the ID from a notification channel definition.

func GetNotificationChannelName added in v1.9.0

func GetNotificationChannelName(channel *NotificationChannelDefinition) string

GetNotificationChannelName extracts the display name from a notification channel definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	channel := &dash0.NotificationChannelDefinition{
		Metadata: dash0.NotificationChannelMetadata{Name: "Slack Alerts"},
	}
	fmt.Println(dash0.GetNotificationChannelName(channel))
}
Output:
Slack Alerts

func GetNotificationChannelOrigin added in v1.9.0

func GetNotificationChannelOrigin(channel *NotificationChannelDefinition) string

GetNotificationChannelOrigin extracts the origin from a notification channel definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	channel := &dash0.NotificationChannelDefinition{
		Metadata: dash0.NotificationChannelMetadata{
			Labels: &dash0.NotificationChannelLabels{Dash0Comorigin: dash0.Ptr("terraform")},
		},
	}
	fmt.Println(dash0.GetNotificationChannelOrigin(channel))
}
Output:
terraform

func GetPersesDashboardDataset added in v1.6.0

func GetPersesDashboardDataset(perses *PersesDashboard) string

GetPersesDashboardDataset returns the dash0.com/dataset label value if present.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	perses := &dash0.PersesDashboard{
		Metadata: dash0.PersesDashboardMetadata{
			Labels: map[string]string{"dash0.com/dataset": "production"},
		},
	}
	fmt.Println(dash0.GetPersesDashboardDataset(perses))
}
Output:
production

func GetPersesDashboardFolderPath added in v1.6.0

func GetPersesDashboardFolderPath(perses *PersesDashboard) string

GetPersesDashboardFolderPath returns the dash0.com/folder-path annotation value if present.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	perses := &dash0.PersesDashboard{
		Metadata: dash0.PersesDashboardMetadata{
			Annotations: map[string]string{dash0.AnnotationFolderPath: "/team/sre"},
		},
	}
	fmt.Println(dash0.GetPersesDashboardFolderPath(perses))
}
Output:
/team/sre

func GetPersesDashboardID added in v1.6.0

func GetPersesDashboardID(perses *PersesDashboard) string

GetPersesDashboardID returns the dash0.com/id label value if present.

func GetPersesDashboardName added in v1.6.0

func GetPersesDashboardName(perses *PersesDashboard) string

GetPersesDashboardName returns the display name from the Perses spec, falling back to metadata.name.

func GetPrometheusRuleDataset added in v1.6.0

func GetPrometheusRuleDataset(rule *PrometheusRules) string

GetPrometheusRuleDataset extracts the dataset from a PrometheusRules definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.PrometheusRules{
		Metadata: dash0.PrometheusRulesMetadata{
			Labels: map[string]string{"dash0.com/dataset": "production"},
		},
	}
	fmt.Println(dash0.GetPrometheusRuleDataset(rule))
}
Output:
production

func GetPrometheusRuleID added in v1.6.0

func GetPrometheusRuleID(rule *PrometheusRules) string

GetPrometheusRuleID extracts the ID from a PrometheusRules definition.

func GetPrometheusRuleName added in v1.6.0

func GetPrometheusRuleName(rule *PrometheusRules) string

GetPrometheusRuleName extracts the name from a PrometheusRules definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.PrometheusRules{
		Metadata: dash0.PrometheusRulesMetadata{Name: "my-rules"},
	}
	fmt.Println(dash0.GetPrometheusRuleName(rule))
}
Output:
my-rules

func GetRecordingRuleDataset added in v1.10.0

func GetRecordingRuleDataset(rule *RecordingRule) string

GetRecordingRuleDataset extracts the dataset from a recording rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	labels := map[string]string{"dash0.com/dataset": "production"}
	rule := &dash0.RecordingRule{
		Metadata: dash0.PrometheusRuleMetadata{Labels: &labels},
	}
	fmt.Println(dash0.GetRecordingRuleDataset(rule))
}
Output:
production

func GetRecordingRuleID added in v1.10.0

func GetRecordingRuleID(rule *RecordingRule) string

GetRecordingRuleID extracts the ID from a recording rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	labels := map[string]string{"dash0.com/id": "rr-42"}
	rule := &dash0.RecordingRule{
		Metadata: dash0.PrometheusRuleMetadata{Labels: &labels},
	}
	fmt.Println(dash0.GetRecordingRuleID(rule))
}
Output:
rr-42

func GetRecordingRuleName added in v1.10.0

func GetRecordingRuleName(rule *RecordingRule) string

GetRecordingRuleName extracts the name from a recording rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.RecordingRule{
		Metadata: dash0.PrometheusRuleMetadata{Name: "cpu-usage-rules"},
	}
	fmt.Println(dash0.GetRecordingRuleName(rule))
}
Output:
cpu-usage-rules

func GetSLODataset added in v1.18.0

func GetSLODataset(slo *SloDefinition) string

GetSLODataset extracts the dataset from an SLO definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	slo := &dash0.SloDefinition{
		Metadata: dash0.SloMetadata{
			Labels: &dash0.SloLabels{Dash0Comdataset: dash0.Ptr("default")},
		},
	}
	fmt.Println(dash0.GetSLODataset(slo))
}
Output:
default

func GetSLOID added in v1.18.0

func GetSLOID(slo *SloDefinition) string

GetSLOID extracts the ID from an SLO definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	slo := &dash0.SloDefinition{
		Metadata: dash0.SloMetadata{
			Labels: &dash0.SloLabels{Dash0Comid: dash0.Ptr("slo_01k5vpx97efdnrkqan15b41k84")},
		},
	}
	fmt.Println(dash0.GetSLOID(slo))
}
Output:
slo_01k5vpx97efdnrkqan15b41k84

func GetSLOName added in v1.18.0

func GetSLOName(slo *SloDefinition) string

GetSLOName extracts the display name from an SLO definition, reading the dash0.com/display-name annotation and falling back to metadata.name when it is not set.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	slo := &dash0.SloDefinition{
		Metadata: dash0.SloMetadata{
			Name: "checkout-availability",
			Annotations: &dash0.SloAnnotations{
				AdditionalProperties: map[string]string{"dash0.com/display-name": "Checkout availability"},
			},
		},
	}
	fmt.Println(dash0.GetSLOName(slo))
}
Output:
Checkout availability

func GetSLOOrigin added in v1.19.0

func GetSLOOrigin(slo *SloDefinition) string

GetSLOOrigin extracts the dash0.com/origin label from an SLO definition. Returns the empty string when the SLO is nil, has no labels, or the label is unset.

SLO ids are server-assigned, so origin is the only identifier a hand-authored document can pin, and it doubles as the upsert key.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	slo := &dash0.SloDefinition{
		Metadata: dash0.SloMetadata{
			Labels: &dash0.SloLabels{Dash0Comorigin: dash0.Ptr("tf_6f2a1c8e-3b47-4d90-a1e5-9c73b0d84f21")},
		},
	}
	fmt.Println(dash0.GetSLOOrigin(slo))
}
Output:
tf_6f2a1c8e-3b47-4d90-a1e5-9c73b0d84f21

func GetSpamFilterDataset added in v1.12.0

func GetSpamFilterDataset(filter *SpamFilter) string

GetSpamFilterDataset extracts the dataset label from a spam filter definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	filter := &dash0.SpamFilter{
		Metadata: dash0.SpamFilterMetadata{
			Labels: &dash0.SpamFilterLabels{Dash0Comdataset: dash0.Ptr("production")},
		},
	}
	fmt.Println(dash0.GetSpamFilterDataset(filter))
}
Output:
production

func GetSpamFilterID added in v1.12.0

func GetSpamFilterID(filter *SpamFilter) string

GetSpamFilterID extracts the ID from a spam filter definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	filter := &dash0.SpamFilter{
		Metadata: dash0.SpamFilterMetadata{
			Labels: &dash0.SpamFilterLabels{Dash0Comid: dash0.Ptr("sf-123")},
		},
	}
	fmt.Println(dash0.GetSpamFilterID(filter))
}
Output:
sf-123

func GetSpamFilterName added in v1.12.0

func GetSpamFilterName(filter *SpamFilter) string

GetSpamFilterName extracts the display name from a spam filter definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	filter := &dash0.SpamFilter{
		Metadata: dash0.SpamFilterMetadata{Name: "Drop noisy health checks"},
	}
	fmt.Println(dash0.GetSpamFilterName(filter))
}
Output:
Drop noisy health checks

func GetSyntheticCheckDataset added in v1.6.0

func GetSyntheticCheckDataset(check *SyntheticCheckDefinition) string

GetSyntheticCheckDataset extracts the dataset from a synthetic check definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	check := &dash0.SyntheticCheckDefinition{
		Metadata: dash0.SyntheticCheckMetadata{
			Labels: &dash0.SyntheticCheckLabels{Dash0Comdataset: dash0.Ptr("production")},
		},
	}
	fmt.Println(dash0.GetSyntheticCheckDataset(check))
}
Output:
production

func GetSyntheticCheckID added in v1.6.0

func GetSyntheticCheckID(check *SyntheticCheckDefinition) string

GetSyntheticCheckID extracts the ID from a synthetic check definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	check := &dash0.SyntheticCheckDefinition{
		Metadata: dash0.SyntheticCheckMetadata{
			Labels: &dash0.SyntheticCheckLabels{Dash0Comid: dash0.Ptr("sc-7")},
		},
	}
	fmt.Println(dash0.GetSyntheticCheckID(check))
}
Output:
sc-7

func GetSyntheticCheckName added in v1.6.0

func GetSyntheticCheckName(check *SyntheticCheckDefinition) string

GetSyntheticCheckName extracts the display name from a synthetic check definition, falling back to metadata.name if no display name is set.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	check := &dash0.SyntheticCheckDefinition{
		Spec: dash0.SyntheticCheckSpec{
			Display: &dash0.SyntheticCheckDisplay{Name: "Homepage Ping"},
		},
	}
	fmt.Println(dash0.GetSyntheticCheckName(check))
}
Output:
Homepage Ping

func GetTeamDisplayName added in v1.17.0

func GetTeamDisplayName(team *TeamDefinitionV1Alpha1) string

GetTeamDisplayName extracts the spec.display.name (human-facing name) from a team definition. Returns the empty string when the team is nil.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	team := &dash0.TeamDefinitionV1Alpha1{
		Spec: dash0.TeamSpec{Display: dash0.TeamDisplay{Name: "Backend Team"}},
	}
	fmt.Println(dash0.GetTeamDisplayName(team))
}
Output:
Backend Team

func GetTeamID added in v1.17.0

func GetTeamID(team *TeamDefinitionV1Alpha1) string

GetTeamID extracts the dash0.com/id label from a team definition. Returns the empty string when the team is nil, has no labels, or the label is unset.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	team := &dash0.TeamDefinitionV1Alpha1{
		Metadata: dash0.TeamMetadata{
			Labels: &dash0.TeamLabels{Dash0Comid: dash0.Ptr("00000000-0000-0000-0000-000000000001")},
		},
	}
	fmt.Println(dash0.GetTeamID(team))
}
Output:
00000000-0000-0000-0000-000000000001

func GetTeamName added in v1.17.0

func GetTeamName(team *TeamDefinitionV1Alpha1) string

GetTeamName extracts the metadata.name (technical name) from a team definition. Returns the empty string when the team is nil.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	team := &dash0.TeamDefinitionV1Alpha1{
		Metadata: dash0.TeamMetadata{Name: "backend-team"},
	}
	fmt.Println(dash0.GetTeamName(team))
}
Output:
backend-team

func GetTeamOrigin added in v1.17.0

func GetTeamOrigin(team *TeamDefinitionV1Alpha1) string

GetTeamOrigin extracts the dash0.com/origin label from a team definition. Returns the empty string when the team is nil, has no labels, or the label is unset.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	team := &dash0.TeamDefinitionV1Alpha1{
		Metadata: dash0.TeamMetadata{
			Labels: &dash0.TeamLabels{Dash0Comorigin: dash0.Ptr("tf_backend")},
		},
	}
	fmt.Println(dash0.GetTeamOrigin(team))
}
Output:
tf_backend

func GetViewDataset added in v1.6.0

func GetViewDataset(view *ViewDefinition) string

GetViewDataset extracts the dataset from a view definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	view := &dash0.ViewDefinition{
		Metadata: dash0.ViewMetadata{
			Labels: &dash0.ViewLabels{Dash0Comdataset: dash0.Ptr("production")},
		},
	}
	fmt.Println(dash0.GetViewDataset(view))
}
Output:
production

func GetViewID added in v1.6.0

func GetViewID(view *ViewDefinition) string

GetViewID extracts the ID from a view definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	view := &dash0.ViewDefinition{
		Metadata: dash0.ViewMetadata{
			Labels: &dash0.ViewLabels{Dash0Comid: dash0.Ptr("v-99")},
		},
	}
	fmt.Println(dash0.GetViewID(view))
}
Output:
v-99

func GetViewName added in v1.6.0

func GetViewName(view *ViewDefinition) string

GetViewName extracts the display name from a view definition, falling back to metadata.name if the display name is empty.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	view := &dash0.ViewDefinition{
		Spec: dash0.ViewSpec{Display: dash0.ViewDisplay{Name: "Error Logs"}},
	}
	fmt.Println(dash0.GetViewName(view))
}
Output:
Error Logs
Example (Fallback)
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	// Falls back to metadata.name when no display name is set.
	view := &dash0.ViewDefinition{
		Metadata: dash0.ViewMetadata{Name: "error-logs"},
	}
	fmt.Println(dash0.GetViewName(view))
}
Output:
error-logs

func Int64

func Int64(v int64) *int64

Int64 returns a pointer to the given int64 value.

func Int64Value

func Int64Value(p *int64) int64

Int64Value returns the value of an int64 pointer, or 0 if nil.

func IsBadRequest

func IsBadRequest(err error) bool

IsBadRequest returns true if the error is a 400 Bad Request.

func IsConflict

func IsConflict(err error) bool

IsConflict returns true if the error is a 409 Conflict.

func IsForbidden

func IsForbidden(err error) bool

IsForbidden returns true if the error is a 403 Forbidden.

func IsNotFound

func IsNotFound(err error) bool

IsNotFound returns true if the error is a 404 Not Found.

func IsOAuthInvalidGrant added in v1.15.0

func IsOAuthInvalidGrant(err error) bool

IsOAuthInvalidGrant returns true if the error is an *OAuthTokenError whose Code is "invalid_grant". This is the OAuth 2.0 signal that the refresh token is no longer accepted by the authorization server (rotated, revoked, expired, or the user's session was terminated) and the caller must initiate a fresh interactive login. See RFC 6749 §5.2.

Note: IsOAuthInvalidGrant is the narrow predicate for the single "invalid_grant" code. Callers that want the broader "should I prompt for re-authentication?" check should use IsOAuthTerminalError, which also covers "invalid_client" and "unauthorized_client" — codes the library itself treats as terminal for the stored credential.

Example
package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/http/httptest"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.Header().Set("Content-Type", "application/json")
		w.WriteHeader(http.StatusBadRequest)
		_ = json.NewEncoder(w).Encode(map[string]string{
			"error":             "invalid_grant",
			"error_description": "refresh token revoked",
		})
	}))
	defer server.Close()

	client, err := dash0.NewOAuthClient(dash0.WithApiUrl(server.URL))
	if err != nil {
		log.Fatal(err)
	}
	defer func() { _ = client.Close(context.Background()) }()

	_, err = client.ExchangeToken(context.Background(), &dash0.OAuthTokenRequest{
		GrantType:    dash0.OAuthGrantTypeRefreshToken,
		RefreshToken: dash0.Ptr("dash0_rt_revoked"),
		ClientId:     dash0.Ptr("my-client"),
	})
	fmt.Println(dash0.IsOAuthInvalidGrant(err))
}
Output:
true

func IsOAuthTerminalError added in v1.15.0

func IsOAuthTerminalError(err error) bool

IsOAuthTerminalError reports whether err carries an *OAuthTokenError whose Code identifies a terminal credential rejection. A terminal rejection means the stored credential is no longer accepted by the authorization server and the caller must initiate a fresh interactive login; no amount of retry, refresh, or back-off will recover the session. The current terminal set per RFC 6749 §5.2 is "invalid_grant", "invalid_client", and "unauthorized_client".

This is the predicate the github.com/dash0hq/dash0-api-client-go/profiles package uses to decide when to clear stored OAuth state from disk; callers driving a login UI should align with the same set so the UI prompt matches the library's recovery model.

Example
package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/http/httptest"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.Header().Set("Content-Type", "application/json")
		w.WriteHeader(http.StatusBadRequest)
		_ = json.NewEncoder(w).Encode(map[string]string{
			"error":             "invalid_client",
			"error_description": "client deleted server-side",
		})
	}))
	defer server.Close()

	client, err := dash0.NewOAuthClient(dash0.WithApiUrl(server.URL))
	if err != nil {
		log.Fatal(err)
	}
	defer func() { _ = client.Close(context.Background()) }()

	_, err = client.ExchangeToken(context.Background(), &dash0.OAuthTokenRequest{
		GrantType:    dash0.OAuthGrantTypeRefreshToken,
		RefreshToken: dash0.Ptr("dash0_rt_orphaned"),
		ClientId:     dash0.Ptr("deleted-client"),
	})
	// IsOAuthTerminalError covers invalid_grant, invalid_client, and
	// unauthorized_client — any "the IdP will not accept this credential
	// again" signal that warrants a fresh interactive login.
	fmt.Println(dash0.IsOAuthTerminalError(err))
}
Output:
true

func IsOAuthTokenError added in v1.15.0

func IsOAuthTokenError(err error) bool

IsOAuthTokenError returns true if the error is an OAuthTokenError.

Example
package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/http/httptest"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.Header().Set("Content-Type", "application/json")
		w.WriteHeader(http.StatusBadRequest)
		_ = json.NewEncoder(w).Encode(map[string]string{
			"error":             "invalid_grant",
			"error_description": "authorization code has expired",
		})
	}))
	defer server.Close()

	client, err := dash0.NewOAuthClient(dash0.WithApiUrl(server.URL))
	if err != nil {
		log.Fatal(err)
	}
	defer func() { _ = client.Close(context.Background()) }()

	_, err = client.ExchangeToken(context.Background(), &dash0.OAuthTokenRequest{
		GrantType: dash0.OAuthGrantTypeAuthorizationCode,
		Code:      dash0.Ptr("expired"),
		ClientId:  dash0.Ptr("my-client"),
	})
	fmt.Println(dash0.IsOAuthTokenError(err))
}
Output:
true

func IsRateLimited

func IsRateLimited(err error) bool

IsRateLimited returns true if the error is a 429 Too Many Requests.

func IsServerError

func IsServerError(err error) bool

IsServerError returns true if the error is a 5xx server error.

func IsUnauthorized

func IsUnauthorized(err error) bool

IsUnauthorized returns true if the error is a 401 Unauthorized.

func LogsExplorerURL added in v1.13.0

func LogsExplorerURL(apiURL string, filters []DeeplinkFilter, from, to string, dataset *string) string

LogsExplorerURL builds a deep link to the Dash0 logs explorer. The URL includes filter criteria, time range, and optional dataset as query parameters. It returns an empty string if the API URL is empty or cannot be parsed.

func NewDeleteApiAgenticWorkflowsOriginOrIdRequest added in v1.17.0

func NewDeleteApiAgenticWorkflowsOriginOrIdRequest(server string, originOrId string, params *DeleteApiAgenticWorkflowsOriginOrIdParams) (*http.Request, error)

NewDeleteApiAgenticWorkflowsOriginOrIdRequest generates requests for DeleteApiAgenticWorkflowsOriginOrId

func NewDeleteApiAlertingCheckRulesOriginOrIdRequest

func NewDeleteApiAlertingCheckRulesOriginOrIdRequest(server string, originOrId string, params *DeleteApiAlertingCheckRulesOriginOrIdParams) (*http.Request, error)

NewDeleteApiAlertingCheckRulesOriginOrIdRequest generates requests for DeleteApiAlertingCheckRulesOriginOrId

func NewDeleteApiDashboardsOriginOrIdRequest

func NewDeleteApiDashboardsOriginOrIdRequest(server string, originOrId string, params *DeleteApiDashboardsOriginOrIdParams) (*http.Request, error)

NewDeleteApiDashboardsOriginOrIdRequest generates requests for DeleteApiDashboardsOriginOrId

func NewDeleteApiMembersMemberIDRequest added in v1.4.0

func NewDeleteApiMembersMemberIDRequest(server string, memberID string) (*http.Request, error)

NewDeleteApiMembersMemberIDRequest generates requests for DeleteApiMembersMemberID

func NewDeleteApiNotificationChannelsOriginOrIdRequest added in v1.9.0

func NewDeleteApiNotificationChannelsOriginOrIdRequest(server string, originOrId string) (*http.Request, error)

NewDeleteApiNotificationChannelsOriginOrIdRequest generates requests for DeleteApiNotificationChannelsOriginOrId

func NewDeleteApiRecordingRulesOriginOrIdRequest added in v1.9.0

func NewDeleteApiRecordingRulesOriginOrIdRequest(server string, originOrId string, params *DeleteApiRecordingRulesOriginOrIdParams) (*http.Request, error)

NewDeleteApiRecordingRulesOriginOrIdRequest generates requests for DeleteApiRecordingRulesOriginOrId

func NewDeleteApiSamplingRulesOriginOrIdRequest added in v1.1.0

func NewDeleteApiSamplingRulesOriginOrIdRequest(server string, originOrId string, params *DeleteApiSamplingRulesOriginOrIdParams) (*http.Request, error)

NewDeleteApiSamplingRulesOriginOrIdRequest generates requests for DeleteApiSamplingRulesOriginOrId

func NewDeleteApiSignalToMetricsOriginOrIdRequest added in v1.9.0

func NewDeleteApiSignalToMetricsOriginOrIdRequest(server string, originOrId string, params *DeleteApiSignalToMetricsOriginOrIdParams) (*http.Request, error)

NewDeleteApiSignalToMetricsOriginOrIdRequest generates requests for DeleteApiSignalToMetricsOriginOrId

func NewDeleteApiSlosOriginOrIdRequest added in v1.14.0

func NewDeleteApiSlosOriginOrIdRequest(server string, originOrId string, params *DeleteApiSlosOriginOrIdParams) (*http.Request, error)

NewDeleteApiSlosOriginOrIdRequest generates requests for DeleteApiSlosOriginOrId

func NewDeleteApiSpamFiltersOriginOrIdRequest added in v1.12.0

func NewDeleteApiSpamFiltersOriginOrIdRequest(server string, originOrId string, params *DeleteApiSpamFiltersOriginOrIdParams) (*http.Request, error)

NewDeleteApiSpamFiltersOriginOrIdRequest generates requests for DeleteApiSpamFiltersOriginOrId

func NewDeleteApiSyntheticChecksOriginOrIdRequest

func NewDeleteApiSyntheticChecksOriginOrIdRequest(server string, originOrId string, params *DeleteApiSyntheticChecksOriginOrIdParams) (*http.Request, error)

NewDeleteApiSyntheticChecksOriginOrIdRequest generates requests for DeleteApiSyntheticChecksOriginOrId

func NewDeleteApiTeamsOriginOrIdMembersMemberIDRequest added in v1.4.0

func NewDeleteApiTeamsOriginOrIdMembersMemberIDRequest(server string, originOrId string, memberID string) (*http.Request, error)

NewDeleteApiTeamsOriginOrIdMembersMemberIDRequest generates requests for DeleteApiTeamsOriginOrIdMembersMemberID

func NewDeleteApiTeamsOriginOrIdRequest added in v1.4.0

func NewDeleteApiTeamsOriginOrIdRequest(server string, originOrId string) (*http.Request, error)

NewDeleteApiTeamsOriginOrIdRequest generates requests for DeleteApiTeamsOriginOrId

func NewDeleteApiTimeSeriesAggregationsOriginOrIdRequest added in v1.17.0

func NewDeleteApiTimeSeriesAggregationsOriginOrIdRequest(server string, originOrId string, params *DeleteApiTimeSeriesAggregationsOriginOrIdParams) (*http.Request, error)

NewDeleteApiTimeSeriesAggregationsOriginOrIdRequest generates requests for DeleteApiTimeSeriesAggregationsOriginOrId

func NewDeleteApiViewsOriginOrIdRequest

func NewDeleteApiViewsOriginOrIdRequest(server string, originOrId string, params *DeleteApiViewsOriginOrIdParams) (*http.Request, error)

NewDeleteApiViewsOriginOrIdRequest generates requests for DeleteApiViewsOriginOrId

func NewGetApiAgenticWorkflowsOriginOrIdRequest added in v1.17.0

func NewGetApiAgenticWorkflowsOriginOrIdRequest(server string, originOrId string, params *GetApiAgenticWorkflowsOriginOrIdParams) (*http.Request, error)

NewGetApiAgenticWorkflowsOriginOrIdRequest generates requests for GetApiAgenticWorkflowsOriginOrId

func NewGetApiAgenticWorkflowsRequest added in v1.17.0

func NewGetApiAgenticWorkflowsRequest(server string, params *GetApiAgenticWorkflowsParams) (*http.Request, error)

NewGetApiAgenticWorkflowsRequest generates requests for GetApiAgenticWorkflows

func NewGetApiAlertingCheckRulesOriginOrIdRequest

func NewGetApiAlertingCheckRulesOriginOrIdRequest(server string, originOrId string, params *GetApiAlertingCheckRulesOriginOrIdParams) (*http.Request, error)

NewGetApiAlertingCheckRulesOriginOrIdRequest generates requests for GetApiAlertingCheckRulesOriginOrId

func NewGetApiAlertingCheckRulesRequest

func NewGetApiAlertingCheckRulesRequest(server string, params *GetApiAlertingCheckRulesParams) (*http.Request, error)

NewGetApiAlertingCheckRulesRequest generates requests for GetApiAlertingCheckRules

func NewGetApiDashboardsOriginOrIdRequest

func NewGetApiDashboardsOriginOrIdRequest(server string, originOrId string, params *GetApiDashboardsOriginOrIdParams) (*http.Request, error)

NewGetApiDashboardsOriginOrIdRequest generates requests for GetApiDashboardsOriginOrId

func NewGetApiDashboardsRequest

func NewGetApiDashboardsRequest(server string, params *GetApiDashboardsParams) (*http.Request, error)

NewGetApiDashboardsRequest generates requests for GetApiDashboards

func NewGetApiEdgeSettingsRequest added in v1.12.3

func NewGetApiEdgeSettingsRequest(server string) (*http.Request, error)

NewGetApiEdgeSettingsRequest generates requests for GetApiEdgeSettings

func NewGetApiMembersRequest added in v1.4.0

func NewGetApiMembersRequest(server string) (*http.Request, error)

NewGetApiMembersRequest generates requests for GetApiMembers

func NewGetApiNotificationChannelsOriginOrIdRequest added in v1.9.0

func NewGetApiNotificationChannelsOriginOrIdRequest(server string, originOrId string) (*http.Request, error)

NewGetApiNotificationChannelsOriginOrIdRequest generates requests for GetApiNotificationChannelsOriginOrId

func NewGetApiNotificationChannelsRequest added in v1.9.0

func NewGetApiNotificationChannelsRequest(server string) (*http.Request, error)

NewGetApiNotificationChannelsRequest generates requests for GetApiNotificationChannels

func NewGetApiPrometheusApiV1FormatQueryRequest added in v1.13.1

func NewGetApiPrometheusApiV1FormatQueryRequest(server string, params *GetApiPrometheusApiV1FormatQueryParams) (*http.Request, error)

NewGetApiPrometheusApiV1FormatQueryRequest generates requests for GetApiPrometheusApiV1FormatQuery

func NewGetApiPrometheusApiV1LabelLabelNameValuesRequest added in v1.13.1

func NewGetApiPrometheusApiV1LabelLabelNameValuesRequest(server string, labelName string, params *GetApiPrometheusApiV1LabelLabelNameValuesParams) (*http.Request, error)

NewGetApiPrometheusApiV1LabelLabelNameValuesRequest generates requests for GetApiPrometheusApiV1LabelLabelNameValues

func NewGetApiPrometheusApiV1LabelsRequest added in v1.13.1

func NewGetApiPrometheusApiV1LabelsRequest(server string, params *GetApiPrometheusApiV1LabelsParams) (*http.Request, error)

NewGetApiPrometheusApiV1LabelsRequest generates requests for GetApiPrometheusApiV1Labels

func NewGetApiPrometheusApiV1MetadataRequest added in v1.13.1

func NewGetApiPrometheusApiV1MetadataRequest(server string, params *GetApiPrometheusApiV1MetadataParams) (*http.Request, error)

NewGetApiPrometheusApiV1MetadataRequest generates requests for GetApiPrometheusApiV1Metadata

func NewGetApiPrometheusApiV1QueryRangeRequest added in v1.13.1

func NewGetApiPrometheusApiV1QueryRangeRequest(server string, params *GetApiPrometheusApiV1QueryRangeParams) (*http.Request, error)

NewGetApiPrometheusApiV1QueryRangeRequest generates requests for GetApiPrometheusApiV1QueryRange

func NewGetApiPrometheusApiV1QueryRequest added in v1.13.1

func NewGetApiPrometheusApiV1QueryRequest(server string, params *GetApiPrometheusApiV1QueryParams) (*http.Request, error)

NewGetApiPrometheusApiV1QueryRequest generates requests for GetApiPrometheusApiV1Query

func NewGetApiPrometheusApiV1SeriesRequest added in v1.13.1

func NewGetApiPrometheusApiV1SeriesRequest(server string, params *GetApiPrometheusApiV1SeriesParams) (*http.Request, error)

NewGetApiPrometheusApiV1SeriesRequest generates requests for GetApiPrometheusApiV1Series

func NewGetApiPrometheusApiV1StatusBuildinfoRequest added in v1.13.1

func NewGetApiPrometheusApiV1StatusBuildinfoRequest(server string) (*http.Request, error)

NewGetApiPrometheusApiV1StatusBuildinfoRequest generates requests for GetApiPrometheusApiV1StatusBuildinfo

func NewGetApiPrometheusApiV1StatusRuntimeinfoRequest added in v1.13.1

func NewGetApiPrometheusApiV1StatusRuntimeinfoRequest(server string) (*http.Request, error)

NewGetApiPrometheusApiV1StatusRuntimeinfoRequest generates requests for GetApiPrometheusApiV1StatusRuntimeinfo

func NewGetApiRecordingRulesOriginOrIdRequest added in v1.9.0

func NewGetApiRecordingRulesOriginOrIdRequest(server string, originOrId string, params *GetApiRecordingRulesOriginOrIdParams) (*http.Request, error)

NewGetApiRecordingRulesOriginOrIdRequest generates requests for GetApiRecordingRulesOriginOrId

func NewGetApiRecordingRulesRequest added in v1.9.0

func NewGetApiRecordingRulesRequest(server string, params *GetApiRecordingRulesParams) (*http.Request, error)

NewGetApiRecordingRulesRequest generates requests for GetApiRecordingRules

func NewGetApiSamplingRulesOriginOrIdRequest added in v1.1.0

func NewGetApiSamplingRulesOriginOrIdRequest(server string, originOrId string, params *GetApiSamplingRulesOriginOrIdParams) (*http.Request, error)

NewGetApiSamplingRulesOriginOrIdRequest generates requests for GetApiSamplingRulesOriginOrId

func NewGetApiSamplingRulesRequest added in v1.1.0

func NewGetApiSamplingRulesRequest(server string, params *GetApiSamplingRulesParams) (*http.Request, error)

NewGetApiSamplingRulesRequest generates requests for GetApiSamplingRules

func NewGetApiSignalToMetricsOriginOrIdRequest added in v1.9.0

func NewGetApiSignalToMetricsOriginOrIdRequest(server string, originOrId string, params *GetApiSignalToMetricsOriginOrIdParams) (*http.Request, error)

NewGetApiSignalToMetricsOriginOrIdRequest generates requests for GetApiSignalToMetricsOriginOrId

func NewGetApiSignalToMetricsRequest added in v1.9.0

func NewGetApiSignalToMetricsRequest(server string, params *GetApiSignalToMetricsParams) (*http.Request, error)

NewGetApiSignalToMetricsRequest generates requests for GetApiSignalToMetrics

func NewGetApiSlosOriginOrIdRequest added in v1.14.0

func NewGetApiSlosOriginOrIdRequest(server string, originOrId string, params *GetApiSlosOriginOrIdParams) (*http.Request, error)

NewGetApiSlosOriginOrIdRequest generates requests for GetApiSlosOriginOrId

func NewGetApiSlosRequest added in v1.14.0

func NewGetApiSlosRequest(server string, params *GetApiSlosParams) (*http.Request, error)

NewGetApiSlosRequest generates requests for GetApiSlos

func NewGetApiSpamFiltersOriginOrIdRequest added in v1.12.0

func NewGetApiSpamFiltersOriginOrIdRequest(server string, originOrId string, params *GetApiSpamFiltersOriginOrIdParams) (*http.Request, error)

NewGetApiSpamFiltersOriginOrIdRequest generates requests for GetApiSpamFiltersOriginOrId

func NewGetApiSpamFiltersRequest added in v1.12.0

func NewGetApiSpamFiltersRequest(server string, params *GetApiSpamFiltersParams) (*http.Request, error)

NewGetApiSpamFiltersRequest generates requests for GetApiSpamFilters

func NewGetApiSyntheticChecksLocationsRequest added in v1.6.0

func NewGetApiSyntheticChecksLocationsRequest(server string) (*http.Request, error)

NewGetApiSyntheticChecksLocationsRequest generates requests for GetApiSyntheticChecksLocations

func NewGetApiSyntheticChecksOriginOrIdRequest

func NewGetApiSyntheticChecksOriginOrIdRequest(server string, originOrId string, params *GetApiSyntheticChecksOriginOrIdParams) (*http.Request, error)

NewGetApiSyntheticChecksOriginOrIdRequest generates requests for GetApiSyntheticChecksOriginOrId

func NewGetApiSyntheticChecksRequest

func NewGetApiSyntheticChecksRequest(server string, params *GetApiSyntheticChecksParams) (*http.Request, error)

NewGetApiSyntheticChecksRequest generates requests for GetApiSyntheticChecks

func NewGetApiTeamsOriginOrIdRequest added in v1.4.0

func NewGetApiTeamsOriginOrIdRequest(server string, originOrId string) (*http.Request, error)

NewGetApiTeamsOriginOrIdRequest generates requests for GetApiTeamsOriginOrId

func NewGetApiTeamsRequest added in v1.4.0

func NewGetApiTeamsRequest(server string) (*http.Request, error)

NewGetApiTeamsRequest generates requests for GetApiTeams

func NewGetApiTimeSeriesAggregationsOriginOrIdRequest added in v1.17.0

func NewGetApiTimeSeriesAggregationsOriginOrIdRequest(server string, originOrId string, params *GetApiTimeSeriesAggregationsOriginOrIdParams) (*http.Request, error)

NewGetApiTimeSeriesAggregationsOriginOrIdRequest generates requests for GetApiTimeSeriesAggregationsOriginOrId

func NewGetApiTimeSeriesAggregationsRequest added in v1.17.0

func NewGetApiTimeSeriesAggregationsRequest(server string, params *GetApiTimeSeriesAggregationsParams) (*http.Request, error)

NewGetApiTimeSeriesAggregationsRequest generates requests for GetApiTimeSeriesAggregations

func NewGetApiViewsOriginOrIdRequest

func NewGetApiViewsOriginOrIdRequest(server string, originOrId string, params *GetApiViewsOriginOrIdParams) (*http.Request, error)

NewGetApiViewsOriginOrIdRequest generates requests for GetApiViewsOriginOrId

func NewGetApiViewsRequest

func NewGetApiViewsRequest(server string, params *GetApiViewsParams) (*http.Request, error)

NewGetApiViewsRequest generates requests for GetApiViews

func NewGetOauthAuthorizeRequest added in v1.6.0

func NewGetOauthAuthorizeRequest(server string, params *GetOauthAuthorizeParams) (*http.Request, error)

NewGetOauthAuthorizeRequest generates requests for GetOauthAuthorize

func NewGetWellKnownOauthAuthorizationServerRequest added in v1.6.0

func NewGetWellKnownOauthAuthorizationServerRequest(server string) (*http.Request, error)

NewGetWellKnownOauthAuthorizationServerRequest generates requests for GetWellKnownOauthAuthorizationServer

func NewGetWellKnownOauthProtectedResourceRequest added in v1.6.0

func NewGetWellKnownOauthProtectedResourceRequest(server string) (*http.Request, error)

NewGetWellKnownOauthProtectedResourceRequest generates requests for GetWellKnownOauthProtectedResource

func NewPostApiAgenticWorkflowsRequest added in v1.17.0

func NewPostApiAgenticWorkflowsRequest(server string, params *PostApiAgenticWorkflowsParams, body PostApiAgenticWorkflowsJSONRequestBody) (*http.Request, error)

NewPostApiAgenticWorkflowsRequest calls the generic PostApiAgenticWorkflows builder with application/json body

func NewPostApiAgenticWorkflowsRequestWithBody added in v1.17.0

func NewPostApiAgenticWorkflowsRequestWithBody(server string, params *PostApiAgenticWorkflowsParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiAgenticWorkflowsRequestWithBody generates requests for PostApiAgenticWorkflows with any type of body

func NewPostApiAlertingCheckRulesBulkRequest added in v1.12.1

func NewPostApiAlertingCheckRulesBulkRequest(server string, params *PostApiAlertingCheckRulesBulkParams, body PostApiAlertingCheckRulesBulkJSONRequestBody) (*http.Request, error)

NewPostApiAlertingCheckRulesBulkRequest calls the generic PostApiAlertingCheckRulesBulk builder with application/json body

func NewPostApiAlertingCheckRulesBulkRequestWithBody added in v1.12.1

func NewPostApiAlertingCheckRulesBulkRequestWithBody(server string, params *PostApiAlertingCheckRulesBulkParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiAlertingCheckRulesBulkRequestWithBody generates requests for PostApiAlertingCheckRulesBulk with any type of body

func NewPostApiAlertingCheckRulesRequest

func NewPostApiAlertingCheckRulesRequest(server string, params *PostApiAlertingCheckRulesParams, body PostApiAlertingCheckRulesJSONRequestBody) (*http.Request, error)

NewPostApiAlertingCheckRulesRequest calls the generic PostApiAlertingCheckRules builder with application/json body

func NewPostApiAlertingCheckRulesRequestWithBody

func NewPostApiAlertingCheckRulesRequestWithBody(server string, params *PostApiAlertingCheckRulesParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiAlertingCheckRulesRequestWithBody generates requests for PostApiAlertingCheckRules with any type of body

func NewPostApiDashboardsRequest

func NewPostApiDashboardsRequest(server string, params *PostApiDashboardsParams, body PostApiDashboardsJSONRequestBody) (*http.Request, error)

NewPostApiDashboardsRequest calls the generic PostApiDashboards builder with application/json body

func NewPostApiDashboardsRequestWithBody

func NewPostApiDashboardsRequestWithBody(server string, params *PostApiDashboardsParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiDashboardsRequestWithBody generates requests for PostApiDashboards with any type of body

func NewPostApiImportCheckRuleRequest

func NewPostApiImportCheckRuleRequest(server string, params *PostApiImportCheckRuleParams, body PostApiImportCheckRuleJSONRequestBody) (*http.Request, error)

NewPostApiImportCheckRuleRequest calls the generic PostApiImportCheckRule builder with application/json body

func NewPostApiImportCheckRuleRequestWithBody

func NewPostApiImportCheckRuleRequestWithBody(server string, params *PostApiImportCheckRuleParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiImportCheckRuleRequestWithBody generates requests for PostApiImportCheckRule with any type of body

func NewPostApiImportCheckRulesRequest added in v1.12.1

func NewPostApiImportCheckRulesRequest(server string, params *PostApiImportCheckRulesParams, body PostApiImportCheckRulesJSONRequestBody) (*http.Request, error)

NewPostApiImportCheckRulesRequest calls the generic PostApiImportCheckRules builder with application/json body

func NewPostApiImportCheckRulesRequestWithBody added in v1.12.1

func NewPostApiImportCheckRulesRequestWithBody(server string, params *PostApiImportCheckRulesParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiImportCheckRulesRequestWithBody generates requests for PostApiImportCheckRules with any type of body

func NewPostApiImportDashboardRequest

func NewPostApiImportDashboardRequest(server string, params *PostApiImportDashboardParams, body PostApiImportDashboardJSONRequestBody) (*http.Request, error)

NewPostApiImportDashboardRequest calls the generic PostApiImportDashboard builder with application/json body

func NewPostApiImportDashboardRequestWithBody

func NewPostApiImportDashboardRequestWithBody(server string, params *PostApiImportDashboardParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiImportDashboardRequestWithBody generates requests for PostApiImportDashboard with any type of body

func NewPostApiImportSyntheticCheckRequest

func NewPostApiImportSyntheticCheckRequest(server string, params *PostApiImportSyntheticCheckParams, body PostApiImportSyntheticCheckJSONRequestBody) (*http.Request, error)

NewPostApiImportSyntheticCheckRequest calls the generic PostApiImportSyntheticCheck builder with application/json body

func NewPostApiImportSyntheticCheckRequestWithBody

func NewPostApiImportSyntheticCheckRequestWithBody(server string, params *PostApiImportSyntheticCheckParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiImportSyntheticCheckRequestWithBody generates requests for PostApiImportSyntheticCheck with any type of body

func NewPostApiImportViewRequest

func NewPostApiImportViewRequest(server string, params *PostApiImportViewParams, body PostApiImportViewJSONRequestBody) (*http.Request, error)

NewPostApiImportViewRequest calls the generic PostApiImportView builder with application/json body

func NewPostApiImportViewRequestWithBody

func NewPostApiImportViewRequestWithBody(server string, params *PostApiImportViewParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiImportViewRequestWithBody generates requests for PostApiImportView with any type of body

func NewPostApiLogsDownloadRequest added in v1.18.1

func NewPostApiLogsDownloadRequest(server string, body PostApiLogsDownloadJSONRequestBody) (*http.Request, error)

NewPostApiLogsDownloadRequest calls the generic PostApiLogsDownload builder with application/json body

func NewPostApiLogsDownloadRequestWithBody added in v1.18.1

func NewPostApiLogsDownloadRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiLogsDownloadRequestWithBody generates requests for PostApiLogsDownload with any type of body

func NewPostApiLogsRequest

func NewPostApiLogsRequest(server string, body PostApiLogsJSONRequestBody) (*http.Request, error)

NewPostApiLogsRequest calls the generic PostApiLogs builder with application/json body

func NewPostApiLogsRequestWithBody

func NewPostApiLogsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiLogsRequestWithBody generates requests for PostApiLogs with any type of body

func NewPostApiMembersRequest added in v1.4.0

func NewPostApiMembersRequest(server string, body PostApiMembersJSONRequestBody) (*http.Request, error)

NewPostApiMembersRequest calls the generic PostApiMembers builder with application/json body

func NewPostApiMembersRequestWithBody added in v1.4.0

func NewPostApiMembersRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiMembersRequestWithBody generates requests for PostApiMembers with any type of body

func NewPostApiNotificationChannelsRequest added in v1.9.0

func NewPostApiNotificationChannelsRequest(server string, body PostApiNotificationChannelsJSONRequestBody) (*http.Request, error)

NewPostApiNotificationChannelsRequest calls the generic PostApiNotificationChannels builder with application/json body

func NewPostApiNotificationChannelsRequestWithBody added in v1.9.0

func NewPostApiNotificationChannelsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiNotificationChannelsRequestWithBody generates requests for PostApiNotificationChannels with any type of body

func NewPostApiPrometheusApiV1FormatQueryRequest added in v1.13.1

func NewPostApiPrometheusApiV1FormatQueryRequest(server string, body PostApiPrometheusApiV1FormatQueryJSONRequestBody) (*http.Request, error)

NewPostApiPrometheusApiV1FormatQueryRequest calls the generic PostApiPrometheusApiV1FormatQuery builder with application/json body

func NewPostApiPrometheusApiV1FormatQueryRequestWithBody added in v1.13.1

func NewPostApiPrometheusApiV1FormatQueryRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiPrometheusApiV1FormatQueryRequestWithBody generates requests for PostApiPrometheusApiV1FormatQuery with any type of body

func NewPostApiPrometheusApiV1LabelLabelNameValuesRequest added in v1.13.1

func NewPostApiPrometheusApiV1LabelLabelNameValuesRequest(server string, labelName string, body PostApiPrometheusApiV1LabelLabelNameValuesJSONRequestBody) (*http.Request, error)

NewPostApiPrometheusApiV1LabelLabelNameValuesRequest calls the generic PostApiPrometheusApiV1LabelLabelNameValues builder with application/json body

func NewPostApiPrometheusApiV1LabelLabelNameValuesRequestWithBody added in v1.13.1

func NewPostApiPrometheusApiV1LabelLabelNameValuesRequestWithBody(server string, labelName string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiPrometheusApiV1LabelLabelNameValuesRequestWithBody generates requests for PostApiPrometheusApiV1LabelLabelNameValues with any type of body

func NewPostApiPrometheusApiV1LabelsRequest added in v1.13.1

func NewPostApiPrometheusApiV1LabelsRequest(server string, body PostApiPrometheusApiV1LabelsJSONRequestBody) (*http.Request, error)

NewPostApiPrometheusApiV1LabelsRequest calls the generic PostApiPrometheusApiV1Labels builder with application/json body

func NewPostApiPrometheusApiV1LabelsRequestWithBody added in v1.13.1

func NewPostApiPrometheusApiV1LabelsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiPrometheusApiV1LabelsRequestWithBody generates requests for PostApiPrometheusApiV1Labels with any type of body

func NewPostApiPrometheusApiV1MetadataRequest added in v1.13.1

func NewPostApiPrometheusApiV1MetadataRequest(server string, body PostApiPrometheusApiV1MetadataJSONRequestBody) (*http.Request, error)

NewPostApiPrometheusApiV1MetadataRequest calls the generic PostApiPrometheusApiV1Metadata builder with application/json body

func NewPostApiPrometheusApiV1MetadataRequestWithBody added in v1.13.1

func NewPostApiPrometheusApiV1MetadataRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiPrometheusApiV1MetadataRequestWithBody generates requests for PostApiPrometheusApiV1Metadata with any type of body

func NewPostApiPrometheusApiV1QueryRangeRequest added in v1.13.1

func NewPostApiPrometheusApiV1QueryRangeRequest(server string, body PostApiPrometheusApiV1QueryRangeJSONRequestBody) (*http.Request, error)

NewPostApiPrometheusApiV1QueryRangeRequest calls the generic PostApiPrometheusApiV1QueryRange builder with application/json body

func NewPostApiPrometheusApiV1QueryRangeRequestWithBody added in v1.13.1

func NewPostApiPrometheusApiV1QueryRangeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiPrometheusApiV1QueryRangeRequestWithBody generates requests for PostApiPrometheusApiV1QueryRange with any type of body

func NewPostApiPrometheusApiV1QueryRequest added in v1.13.1

func NewPostApiPrometheusApiV1QueryRequest(server string, body PostApiPrometheusApiV1QueryJSONRequestBody) (*http.Request, error)

NewPostApiPrometheusApiV1QueryRequest calls the generic PostApiPrometheusApiV1Query builder with application/json body

func NewPostApiPrometheusApiV1QueryRequestWithBody added in v1.13.1

func NewPostApiPrometheusApiV1QueryRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiPrometheusApiV1QueryRequestWithBody generates requests for PostApiPrometheusApiV1Query with any type of body

func NewPostApiPrometheusApiV1SeriesRequest added in v1.13.1

func NewPostApiPrometheusApiV1SeriesRequest(server string, body PostApiPrometheusApiV1SeriesJSONRequestBody) (*http.Request, error)

NewPostApiPrometheusApiV1SeriesRequest calls the generic PostApiPrometheusApiV1Series builder with application/json body

func NewPostApiPrometheusApiV1SeriesRequestWithBody added in v1.13.1

func NewPostApiPrometheusApiV1SeriesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiPrometheusApiV1SeriesRequestWithBody generates requests for PostApiPrometheusApiV1Series with any type of body

func NewPostApiRecordingRulesRequest added in v1.9.0

func NewPostApiRecordingRulesRequest(server string, params *PostApiRecordingRulesParams, body PostApiRecordingRulesJSONRequestBody) (*http.Request, error)

NewPostApiRecordingRulesRequest calls the generic PostApiRecordingRules builder with application/json body

func NewPostApiRecordingRulesRequestWithBody added in v1.9.0

func NewPostApiRecordingRulesRequestWithBody(server string, params *PostApiRecordingRulesParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiRecordingRulesRequestWithBody generates requests for PostApiRecordingRules with any type of body

func NewPostApiSamplingRulesRequest added in v1.1.0

func NewPostApiSamplingRulesRequest(server string, params *PostApiSamplingRulesParams, body PostApiSamplingRulesJSONRequestBody) (*http.Request, error)

NewPostApiSamplingRulesRequest calls the generic PostApiSamplingRules builder with application/json body

func NewPostApiSamplingRulesRequestWithBody added in v1.1.0

func NewPostApiSamplingRulesRequestWithBody(server string, params *PostApiSamplingRulesParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSamplingRulesRequestWithBody generates requests for PostApiSamplingRules with any type of body

func NewPostApiSignalToMetricsRequest added in v1.9.0

func NewPostApiSignalToMetricsRequest(server string, params *PostApiSignalToMetricsParams, body PostApiSignalToMetricsJSONRequestBody) (*http.Request, error)

NewPostApiSignalToMetricsRequest calls the generic PostApiSignalToMetrics builder with application/json body

func NewPostApiSignalToMetricsRequestWithBody added in v1.9.0

func NewPostApiSignalToMetricsRequestWithBody(server string, params *PostApiSignalToMetricsParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSignalToMetricsRequestWithBody generates requests for PostApiSignalToMetrics with any type of body

func NewPostApiSignalToMetricsTestRequest added in v1.12.0

func NewPostApiSignalToMetricsTestRequest(server string, params *PostApiSignalToMetricsTestParams, body PostApiSignalToMetricsTestJSONRequestBody) (*http.Request, error)

NewPostApiSignalToMetricsTestRequest calls the generic PostApiSignalToMetricsTest builder with application/json body

func NewPostApiSignalToMetricsTestRequestWithBody added in v1.12.0

func NewPostApiSignalToMetricsTestRequestWithBody(server string, params *PostApiSignalToMetricsTestParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSignalToMetricsTestRequestWithBody generates requests for PostApiSignalToMetricsTest with any type of body

func NewPostApiSlosRequest added in v1.14.0

func NewPostApiSlosRequest(server string, params *PostApiSlosParams, body PostApiSlosJSONRequestBody) (*http.Request, error)

NewPostApiSlosRequest calls the generic PostApiSlos builder with application/json body

func NewPostApiSlosRequestWithBody added in v1.14.0

func NewPostApiSlosRequestWithBody(server string, params *PostApiSlosParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSlosRequestWithBody generates requests for PostApiSlos with any type of body

func NewPostApiSpamFiltersRequest added in v1.12.0

func NewPostApiSpamFiltersRequest(server string, params *PostApiSpamFiltersParams, body PostApiSpamFiltersJSONRequestBody) (*http.Request, error)

NewPostApiSpamFiltersRequest calls the generic PostApiSpamFilters builder with application/json body

func NewPostApiSpamFiltersRequestWithBody added in v1.12.0

func NewPostApiSpamFiltersRequestWithBody(server string, params *PostApiSpamFiltersParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSpamFiltersRequestWithBody generates requests for PostApiSpamFilters with any type of body

func NewPostApiSpansDownloadRequest added in v1.18.1

func NewPostApiSpansDownloadRequest(server string, body PostApiSpansDownloadJSONRequestBody) (*http.Request, error)

NewPostApiSpansDownloadRequest calls the generic PostApiSpansDownload builder with application/json body

func NewPostApiSpansDownloadRequestWithBody added in v1.18.1

func NewPostApiSpansDownloadRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSpansDownloadRequestWithBody generates requests for PostApiSpansDownload with any type of body

func NewPostApiSpansRequest

func NewPostApiSpansRequest(server string, body PostApiSpansJSONRequestBody) (*http.Request, error)

NewPostApiSpansRequest calls the generic PostApiSpans builder with application/json body

func NewPostApiSpansRequestWithBody

func NewPostApiSpansRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSpansRequestWithBody generates requests for PostApiSpans with any type of body

func NewPostApiSqlRequest added in v1.6.0

func NewPostApiSqlRequest(server string, body PostApiSqlJSONRequestBody) (*http.Request, error)

NewPostApiSqlRequest calls the generic PostApiSql builder with application/json body

func NewPostApiSqlRequestWithBody added in v1.6.0

func NewPostApiSqlRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSqlRequestWithBody generates requests for PostApiSql with any type of body

func NewPostApiSyntheticChecksRequest

func NewPostApiSyntheticChecksRequest(server string, params *PostApiSyntheticChecksParams, body PostApiSyntheticChecksJSONRequestBody) (*http.Request, error)

NewPostApiSyntheticChecksRequest calls the generic PostApiSyntheticChecks builder with application/json body

func NewPostApiSyntheticChecksRequestWithBody

func NewPostApiSyntheticChecksRequestWithBody(server string, params *PostApiSyntheticChecksParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSyntheticChecksRequestWithBody generates requests for PostApiSyntheticChecks with any type of body

func NewPostApiSyntheticChecksTestRequest added in v1.4.0

func NewPostApiSyntheticChecksTestRequest(server string, body PostApiSyntheticChecksTestJSONRequestBody) (*http.Request, error)

NewPostApiSyntheticChecksTestRequest calls the generic PostApiSyntheticChecksTest builder with application/json body

func NewPostApiSyntheticChecksTestRequestWithBody added in v1.4.0

func NewPostApiSyntheticChecksTestRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSyntheticChecksTestRequestWithBody generates requests for PostApiSyntheticChecksTest with any type of body

func NewPostApiTeamsOriginOrIdMembersRequest added in v1.4.0

func NewPostApiTeamsOriginOrIdMembersRequest(server string, originOrId string, body PostApiTeamsOriginOrIdMembersJSONRequestBody) (*http.Request, error)

NewPostApiTeamsOriginOrIdMembersRequest calls the generic PostApiTeamsOriginOrIdMembers builder with application/json body

func NewPostApiTeamsOriginOrIdMembersRequestWithBody added in v1.4.0

func NewPostApiTeamsOriginOrIdMembersRequestWithBody(server string, originOrId string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiTeamsOriginOrIdMembersRequestWithBody generates requests for PostApiTeamsOriginOrIdMembers with any type of body

func NewPostApiTeamsRequest added in v1.4.0

func NewPostApiTeamsRequest(server string, body PostApiTeamsJSONRequestBody) (*http.Request, error)

NewPostApiTeamsRequest calls the generic PostApiTeams builder with application/json body

func NewPostApiTeamsRequestWithBody added in v1.4.0

func NewPostApiTeamsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiTeamsRequestWithBody generates requests for PostApiTeams with any type of body

func NewPostApiTimeSeriesAggregationsRequest added in v1.17.0

func NewPostApiTimeSeriesAggregationsRequest(server string, params *PostApiTimeSeriesAggregationsParams, body PostApiTimeSeriesAggregationsJSONRequestBody) (*http.Request, error)

NewPostApiTimeSeriesAggregationsRequest calls the generic PostApiTimeSeriesAggregations builder with application/json body

func NewPostApiTimeSeriesAggregationsRequestWithBody added in v1.17.0

func NewPostApiTimeSeriesAggregationsRequestWithBody(server string, params *PostApiTimeSeriesAggregationsParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiTimeSeriesAggregationsRequestWithBody generates requests for PostApiTimeSeriesAggregations with any type of body

func NewPostApiTraceDetailsRequest added in v1.12.0

func NewPostApiTraceDetailsRequest(server string, body PostApiTraceDetailsJSONRequestBody) (*http.Request, error)

NewPostApiTraceDetailsRequest calls the generic PostApiTraceDetails builder with application/json body

func NewPostApiTraceDetailsRequestWithBody added in v1.12.0

func NewPostApiTraceDetailsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiTraceDetailsRequestWithBody generates requests for PostApiTraceDetails with any type of body

func NewPostApiTraceIdsRequest added in v1.12.1

func NewPostApiTraceIdsRequest(server string, body PostApiTraceIdsJSONRequestBody) (*http.Request, error)

NewPostApiTraceIdsRequest calls the generic PostApiTraceIds builder with application/json body

func NewPostApiTraceIdsRequestWithBody added in v1.12.1

func NewPostApiTraceIdsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiTraceIdsRequestWithBody generates requests for PostApiTraceIds with any type of body

func NewPostApiViewsRequest

func NewPostApiViewsRequest(server string, params *PostApiViewsParams, body PostApiViewsJSONRequestBody) (*http.Request, error)

NewPostApiViewsRequest calls the generic PostApiViews builder with application/json body

func NewPostApiViewsRequestWithBody

func NewPostApiViewsRequestWithBody(server string, params *PostApiViewsParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiViewsRequestWithBody generates requests for PostApiViews with any type of body

func NewPostApiWebEventsDownloadRequest added in v1.18.1

func NewPostApiWebEventsDownloadRequest(server string, body PostApiWebEventsDownloadJSONRequestBody) (*http.Request, error)

NewPostApiWebEventsDownloadRequest calls the generic PostApiWebEventsDownload builder with application/json body

func NewPostApiWebEventsDownloadRequestWithBody added in v1.18.1

func NewPostApiWebEventsDownloadRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiWebEventsDownloadRequestWithBody generates requests for PostApiWebEventsDownload with any type of body

func NewPostOauthRegisterRequest added in v1.6.0

func NewPostOauthRegisterRequest(server string, body PostOauthRegisterJSONRequestBody) (*http.Request, error)

NewPostOauthRegisterRequest calls the generic PostOauthRegister builder with application/json body

func NewPostOauthRegisterRequestWithBody added in v1.6.0

func NewPostOauthRegisterRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostOauthRegisterRequestWithBody generates requests for PostOauthRegister with any type of body

func NewPostOauthRevokeRequestWithBody added in v1.6.0

func NewPostOauthRevokeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostOauthRevokeRequestWithBody generates requests for PostOauthRevoke with any type of body

func NewPostOauthRevokeRequestWithFormdataBody added in v1.6.0

func NewPostOauthRevokeRequestWithFormdataBody(server string, body PostOauthRevokeFormdataRequestBody) (*http.Request, error)

NewPostOauthRevokeRequestWithFormdataBody calls the generic PostOauthRevoke builder with application/x-www-form-urlencoded body

func NewPostOauthTokenRequestWithBody added in v1.6.0

func NewPostOauthTokenRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostOauthTokenRequestWithBody generates requests for PostOauthToken with any type of body

func NewPostOauthTokenRequestWithFormdataBody added in v1.6.0

func NewPostOauthTokenRequestWithFormdataBody(server string, body PostOauthTokenFormdataRequestBody) (*http.Request, error)

NewPostOauthTokenRequestWithFormdataBody calls the generic PostOauthToken builder with application/x-www-form-urlencoded body

func NewPutApiAgenticWorkflowsOriginOrIdRequest added in v1.17.0

func NewPutApiAgenticWorkflowsOriginOrIdRequest(server string, originOrId string, params *PutApiAgenticWorkflowsOriginOrIdParams, body PutApiAgenticWorkflowsOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiAgenticWorkflowsOriginOrIdRequest calls the generic PutApiAgenticWorkflowsOriginOrId builder with application/json body

func NewPutApiAgenticWorkflowsOriginOrIdRequestWithBody added in v1.17.0

func NewPutApiAgenticWorkflowsOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiAgenticWorkflowsOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiAgenticWorkflowsOriginOrIdRequestWithBody generates requests for PutApiAgenticWorkflowsOriginOrId with any type of body

func NewPutApiAlertingCheckRulesOriginOrIdRequest

func NewPutApiAlertingCheckRulesOriginOrIdRequest(server string, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, body PutApiAlertingCheckRulesOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiAlertingCheckRulesOriginOrIdRequest calls the generic PutApiAlertingCheckRulesOriginOrId builder with application/json body

func NewPutApiAlertingCheckRulesOriginOrIdRequestWithBody

func NewPutApiAlertingCheckRulesOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiAlertingCheckRulesOriginOrIdRequestWithBody generates requests for PutApiAlertingCheckRulesOriginOrId with any type of body

func NewPutApiDashboardsOriginOrIdRequest

func NewPutApiDashboardsOriginOrIdRequest(server string, originOrId string, params *PutApiDashboardsOriginOrIdParams, body PutApiDashboardsOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiDashboardsOriginOrIdRequest calls the generic PutApiDashboardsOriginOrId builder with application/json body

func NewPutApiDashboardsOriginOrIdRequestWithBody

func NewPutApiDashboardsOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiDashboardsOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiDashboardsOriginOrIdRequestWithBody generates requests for PutApiDashboardsOriginOrId with any type of body

func NewPutApiImportSignalToMetricsRequest added in v1.12.3

func NewPutApiImportSignalToMetricsRequest(server string, params *PutApiImportSignalToMetricsParams, body PutApiImportSignalToMetricsJSONRequestBody) (*http.Request, error)

NewPutApiImportSignalToMetricsRequest calls the generic PutApiImportSignalToMetrics builder with application/json body

func NewPutApiImportSignalToMetricsRequestWithBody added in v1.12.3

func NewPutApiImportSignalToMetricsRequestWithBody(server string, params *PutApiImportSignalToMetricsParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiImportSignalToMetricsRequestWithBody generates requests for PutApiImportSignalToMetrics with any type of body

func NewPutApiNotificationChannelsOriginOrIdRequest added in v1.9.0

func NewPutApiNotificationChannelsOriginOrIdRequest(server string, originOrId string, body PutApiNotificationChannelsOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiNotificationChannelsOriginOrIdRequest calls the generic PutApiNotificationChannelsOriginOrId builder with application/json body

func NewPutApiNotificationChannelsOriginOrIdRequestWithBody added in v1.9.0

func NewPutApiNotificationChannelsOriginOrIdRequestWithBody(server string, originOrId string, contentType string, body io.Reader) (*http.Request, error)

NewPutApiNotificationChannelsOriginOrIdRequestWithBody generates requests for PutApiNotificationChannelsOriginOrId with any type of body

func NewPutApiRecordingRulesOriginOrIdRequest added in v1.9.0

func NewPutApiRecordingRulesOriginOrIdRequest(server string, originOrId string, params *PutApiRecordingRulesOriginOrIdParams, body PutApiRecordingRulesOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiRecordingRulesOriginOrIdRequest calls the generic PutApiRecordingRulesOriginOrId builder with application/json body

func NewPutApiRecordingRulesOriginOrIdRequestWithBody added in v1.9.0

func NewPutApiRecordingRulesOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiRecordingRulesOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiRecordingRulesOriginOrIdRequestWithBody generates requests for PutApiRecordingRulesOriginOrId with any type of body

func NewPutApiSamplingRulesOriginOrIdRequest added in v1.1.0

func NewPutApiSamplingRulesOriginOrIdRequest(server string, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, body PutApiSamplingRulesOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiSamplingRulesOriginOrIdRequest calls the generic PutApiSamplingRulesOriginOrId builder with application/json body

func NewPutApiSamplingRulesOriginOrIdRequestWithBody added in v1.1.0

func NewPutApiSamplingRulesOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiSamplingRulesOriginOrIdRequestWithBody generates requests for PutApiSamplingRulesOriginOrId with any type of body

func NewPutApiSignalToMetricsOriginOrIdRequest added in v1.9.0

func NewPutApiSignalToMetricsOriginOrIdRequest(server string, originOrId string, params *PutApiSignalToMetricsOriginOrIdParams, body PutApiSignalToMetricsOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiSignalToMetricsOriginOrIdRequest calls the generic PutApiSignalToMetricsOriginOrId builder with application/json body

func NewPutApiSignalToMetricsOriginOrIdRequestWithBody added in v1.9.0

func NewPutApiSignalToMetricsOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiSignalToMetricsOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiSignalToMetricsOriginOrIdRequestWithBody generates requests for PutApiSignalToMetricsOriginOrId with any type of body

func NewPutApiSlosOriginOrIdRequest added in v1.14.0

func NewPutApiSlosOriginOrIdRequest(server string, originOrId string, params *PutApiSlosOriginOrIdParams, body PutApiSlosOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiSlosOriginOrIdRequest calls the generic PutApiSlosOriginOrId builder with application/json body

func NewPutApiSlosOriginOrIdRequestWithBody added in v1.14.0

func NewPutApiSlosOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiSlosOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiSlosOriginOrIdRequestWithBody generates requests for PutApiSlosOriginOrId with any type of body

func NewPutApiSpamFiltersOriginOrIdRequest added in v1.12.0

func NewPutApiSpamFiltersOriginOrIdRequest(server string, originOrId string, params *PutApiSpamFiltersOriginOrIdParams, body PutApiSpamFiltersOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiSpamFiltersOriginOrIdRequest calls the generic PutApiSpamFiltersOriginOrId builder with application/json body

func NewPutApiSpamFiltersOriginOrIdRequestWithBody added in v1.12.0

func NewPutApiSpamFiltersOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiSpamFiltersOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiSpamFiltersOriginOrIdRequestWithBody generates requests for PutApiSpamFiltersOriginOrId with any type of body

func NewPutApiSyntheticChecksOriginOrIdRequest

func NewPutApiSyntheticChecksOriginOrIdRequest(server string, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, body PutApiSyntheticChecksOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiSyntheticChecksOriginOrIdRequest calls the generic PutApiSyntheticChecksOriginOrId builder with application/json body

func NewPutApiSyntheticChecksOriginOrIdRequestWithBody

func NewPutApiSyntheticChecksOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiSyntheticChecksOriginOrIdRequestWithBody generates requests for PutApiSyntheticChecksOriginOrId with any type of body

func NewPutApiTeamsOriginOrIdDisplayRequest added in v1.4.0

func NewPutApiTeamsOriginOrIdDisplayRequest(server string, originOrId string, body PutApiTeamsOriginOrIdDisplayJSONRequestBody) (*http.Request, error)

NewPutApiTeamsOriginOrIdDisplayRequest calls the generic PutApiTeamsOriginOrIdDisplay builder with application/json body

func NewPutApiTeamsOriginOrIdDisplayRequestWithBody added in v1.4.0

func NewPutApiTeamsOriginOrIdDisplayRequestWithBody(server string, originOrId string, contentType string, body io.Reader) (*http.Request, error)

NewPutApiTeamsOriginOrIdDisplayRequestWithBody generates requests for PutApiTeamsOriginOrIdDisplay with any type of body

func NewPutApiTeamsOriginOrIdRequest added in v1.17.0

func NewPutApiTeamsOriginOrIdRequest(server string, originOrId string, body PutApiTeamsOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiTeamsOriginOrIdRequest calls the generic PutApiTeamsOriginOrId builder with application/json body

func NewPutApiTeamsOriginOrIdRequestWithBody added in v1.17.0

func NewPutApiTeamsOriginOrIdRequestWithBody(server string, originOrId string, contentType string, body io.Reader) (*http.Request, error)

NewPutApiTeamsOriginOrIdRequestWithBody generates requests for PutApiTeamsOriginOrId with any type of body

func NewPutApiTimeSeriesAggregationsOriginOrIdRequest added in v1.17.0

func NewPutApiTimeSeriesAggregationsOriginOrIdRequest(server string, originOrId string, params *PutApiTimeSeriesAggregationsOriginOrIdParams, body PutApiTimeSeriesAggregationsOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiTimeSeriesAggregationsOriginOrIdRequest calls the generic PutApiTimeSeriesAggregationsOriginOrId builder with application/json body

func NewPutApiTimeSeriesAggregationsOriginOrIdRequestWithBody added in v1.17.0

func NewPutApiTimeSeriesAggregationsOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiTimeSeriesAggregationsOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiTimeSeriesAggregationsOriginOrIdRequestWithBody generates requests for PutApiTimeSeriesAggregationsOriginOrId with any type of body

func NewPutApiViewsOriginOrIdRequest

func NewPutApiViewsOriginOrIdRequest(server string, originOrId string, params *PutApiViewsOriginOrIdParams, body PutApiViewsOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiViewsOriginOrIdRequest calls the generic PutApiViewsOriginOrId builder with application/json body

func NewPutApiViewsOriginOrIdRequestWithBody

func NewPutApiViewsOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiViewsOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiViewsOriginOrIdRequestWithBody generates requests for PutApiViewsOriginOrId with any type of body

func NormalizeDash0ApiVersion added in v1.12.3

func NormalizeDash0ApiVersion(apiVersion string) (version string, ok bool)

NormalizeDash0ApiVersion strips a Dash0-owned apiGroup prefix from an apiVersion string and returns the bare version. It accepts:

  • Bare versions like "v1alpha1" or "v1alpha2" (no slash, returned as-is).
  • Group-prefixed forms whose group is "dash0.com" or a subdomain of "dash0.com" (e.g. "operator.dash0.com/v1alpha1"). The group prefix is removed and only the version after the slash is returned.

ok is false (and version is "") when the apiVersion carries a group prefix that is neither "dash0.com" nor a "*.dash0.com" subdomain — including the pathological "/v1alpha1" (empty prefix) and group names that merely embed "dash0.com" as a substring (e.g. "evildash0.com").

Callers are responsible for matching the returned version against their asset's supported set. This helper only enforces the apiGroup contract: the version itself can be anything once the prefix check passes.

Motivation: the Dash0 Kubernetes operator marshals its custom resources directly into Dash0 API requests, which leaks "metav1.TypeMeta" — so an asset written by the operator carries an apiGroup-prefixed apiVersion rather than the bare version the API contract specifies. Tolerating that prefix on the client side lets old API client builds still read those records.

func Ptr

func Ptr[T any](v T) *T

Ptr returns a pointer to the given value. This is useful for creating pointers to literals when calling API methods that accept optional parameters.

Example:

client.ListDashboards(ctx, dash0.Ptr("default"))

func ResolveTeamMembersToEmails added in v1.17.0

func ResolveTeamMembersToEmails(ctx context.Context, apiClient Client, team *TeamDefinitionV1Alpha1) error

ResolveTeamMembersToEmails rewrites team.Spec.Members from internal IDs to email addresses using ResolveMemberIDsToEmails. It is a convenience wrapper around the same logic used by the CLI's export path and the Terraform provider's state-normalization path, so both IaC facilities display team membership as emails without duplicating the translation.

A nil team, or a team with an empty Spec.Members, is a no-op. IDs that do not resolve to an email are left in place (via the pass-through behavior of ResolveMemberIDsToEmails). Errors from the underlying members lookup are returned so callers can decide whether the mismatch matters — typical callers log-and-ignore, keeping the raw IDs.

func SetCheckRuleDataset added in v1.6.0

func SetCheckRuleDataset(rule *PrometheusAlertRule, dataset string)

SetCheckRuleDataset sets the dataset on a check rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.PrometheusAlertRule{Name: "HighErrorRate"}
	dash0.SetCheckRuleDataset(rule, "production")
	fmt.Println(dash0.StringValue(rule.Dataset))
}
Output:
production

func SetCheckRuleID added in v1.6.0

func SetCheckRuleID(rule *PrometheusAlertRule, id string)

SetCheckRuleID sets the ID on a check rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.PrometheusAlertRule{Name: "HighErrorRate"}
	dash0.SetCheckRuleID(rule, "cr-42")
	fmt.Println(*rule.Id)
}
Output:
cr-42

func SetCheckRuleIDIfAbsent added in v1.6.0

func SetCheckRuleIDIfAbsent(rule *PrometheusAlertRule, id string)

SetCheckRuleIDIfAbsent sets the ID on a check rule definition only if it is not already set.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.PrometheusAlertRule{Id: dash0.Ptr("existing")}
	dash0.SetCheckRuleIDIfAbsent(rule, "new-id")
	fmt.Println(*rule.Id)
}
Output:
existing

func SetDashboardDataset added in v1.6.0

func SetDashboardDataset(dashboard *DashboardDefinition, dataset string)

SetDashboardDataset sets the dataset on a dashboard definition, initializing the dash0Extensions struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	dashboard := &dash0.DashboardDefinition{}
	dash0.SetDashboardDataset(dashboard, "production")
	fmt.Println(string(*dashboard.Metadata.Dash0Extensions.Dataset))
}
Output:
production

func SetDashboardFolderPath added in v1.6.0

func SetDashboardFolderPath(dashboard *DashboardDefinition, folderPath string)

SetDashboardFolderPath sets the folder path on a dashboard definition, initializing the annotations struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	dashboard := &dash0.DashboardDefinition{}
	dash0.SetDashboardFolderPath(dashboard, "/team/sre")
	fmt.Println(*dashboard.Metadata.Annotations.Dash0ComfolderPath)
}
Output:
/team/sre

func SetDashboardID added in v1.6.0

func SetDashboardID(dashboard *DashboardDefinition, id string)

SetDashboardID sets the ID on a dashboard definition, initializing the dash0Extensions struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	dashboard := &dash0.DashboardDefinition{}
	dash0.SetDashboardID(dashboard, "d-456")
	fmt.Println(*dashboard.Metadata.Dash0Extensions.Id)
}
Output:
d-456

func SetDashboardIDIfAbsent added in v1.6.0

func SetDashboardIDIfAbsent(dashboard *DashboardDefinition, id string)

SetDashboardIDIfAbsent sets the ID on a dashboard definition only if it is not already set, initializing the dash0Extensions struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	dashboard := &dash0.DashboardDefinition{
		Metadata: dash0.DashboardMetadata{
			Dash0Extensions: &dash0.DashboardMetadataExtensions{
				Id: dash0.Ptr("existing"),
			},
		},
	}
	// Does not overwrite an existing ID.
	dash0.SetDashboardIDIfAbsent(dashboard, "new-id")
	fmt.Println(*dashboard.Metadata.Dash0Extensions.Id)
}
Output:
existing

func SetNotificationChannelID added in v1.9.0

func SetNotificationChannelID(channel *NotificationChannelDefinition, id string)

SetNotificationChannelID sets the dash0.com/id label on a notification channel definition, initializing the labels struct if needed.

func SetNotificationChannelIDIfAbsent added in v1.9.0

func SetNotificationChannelIDIfAbsent(channel *NotificationChannelDefinition, id string)

SetNotificationChannelIDIfAbsent sets the dash0.com/id label on a notification channel definition only if it is not already set, initializing the labels struct if needed.

func SetNotificationChannelOrigin added in v1.9.0

func SetNotificationChannelOrigin(channel *NotificationChannelDefinition, origin string)

SetNotificationChannelOrigin sets the dash0.com/origin label on a notification channel definition, initializing the labels struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	channel := &dash0.NotificationChannelDefinition{
		Metadata: dash0.NotificationChannelMetadata{Name: "Slack Alerts"},
	}
	dash0.SetNotificationChannelOrigin(channel, "terraform")
	fmt.Println(*channel.Metadata.Labels.Dash0Comorigin)
}
Output:
terraform

func SetPersesDashboardDataset added in v1.6.0

func SetPersesDashboardDataset(perses *PersesDashboard, dataset string)

SetPersesDashboardDataset sets the dash0.com/dataset label on a PersesDashboard CRD, initializing the labels map if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	perses := &dash0.PersesDashboard{}
	dash0.SetPersesDashboardDataset(perses, "production")
	fmt.Println(perses.Metadata.Labels["dash0.com/dataset"])
}
Output:
production

func SetPersesDashboardFolderPath added in v1.6.0

func SetPersesDashboardFolderPath(perses *PersesDashboard, folderPath string)

SetPersesDashboardFolderPath sets the dash0.com/folder-path annotation on a PersesDashboard CRD, initializing the annotations map if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	perses := &dash0.PersesDashboard{}
	dash0.SetPersesDashboardFolderPath(perses, "/team/sre")
	fmt.Println(perses.Metadata.Annotations[dash0.AnnotationFolderPath])
}
Output:
/team/sre

func SetPersesDashboardID added in v1.6.0

func SetPersesDashboardID(perses *PersesDashboard, id string)

SetPersesDashboardID sets the dash0.com/id label on a PersesDashboard CRD, initializing the labels map if needed.

func SetPersesDashboardIDIfAbsent added in v1.6.0

func SetPersesDashboardIDIfAbsent(perses *PersesDashboard, id string)

SetPersesDashboardIDIfAbsent sets the dash0.com/id label on a PersesDashboard CRD only if it is not already set, initializing the labels map if needed.

func SetPrometheusRuleDataset added in v1.6.0

func SetPrometheusRuleDataset(rule *PrometheusRules, dataset string)

SetPrometheusRuleDataset sets the dash0.com/dataset label on a PrometheusRules CRD, initializing the labels map if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.PrometheusRules{}
	dash0.SetPrometheusRuleDataset(rule, "production")
	fmt.Println(rule.Metadata.Labels["dash0.com/dataset"])
}
Output:
production

func SetPrometheusRuleID added in v1.6.0

func SetPrometheusRuleID(rule *PrometheusRules, id string)

SetPrometheusRuleID sets the dash0.com/id label on a PrometheusRules CRD, initializing the labels map if needed.

func SetPrometheusRuleIDIfAbsent added in v1.6.0

func SetPrometheusRuleIDIfAbsent(rule *PrometheusRules, id string)

SetPrometheusRuleIDIfAbsent sets the dash0.com/id label on a PrometheusRules CRD only if it is not already set, initializing the labels map if needed.

func SetRecordingRuleDataset added in v1.10.0

func SetRecordingRuleDataset(rule *RecordingRule, dataset string)

SetRecordingRuleDataset sets the dataset on a recording rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.RecordingRule{
		Metadata: dash0.PrometheusRuleMetadata{Name: "cpu-usage-rules"},
	}
	dash0.SetRecordingRuleDataset(rule, "production")
	fmt.Println((*rule.Metadata.Labels)["dash0.com/dataset"])
}
Output:
production

func SetRecordingRuleID added in v1.10.0

func SetRecordingRuleID(rule *RecordingRule, id string)

SetRecordingRuleID sets the ID on a recording rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.RecordingRule{
		Metadata: dash0.PrometheusRuleMetadata{Name: "cpu-usage-rules"},
	}
	dash0.SetRecordingRuleID(rule, "rr-42")
	fmt.Println((*rule.Metadata.Labels)["dash0.com/id"])
}
Output:
rr-42

func SetRecordingRuleIDIfAbsent added in v1.10.0

func SetRecordingRuleIDIfAbsent(rule *RecordingRule, id string)

SetRecordingRuleIDIfAbsent sets the ID on a recording rule definition only if it is not already set.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	labels := map[string]string{"dash0.com/id": "existing"}
	rule := &dash0.RecordingRule{
		Metadata: dash0.PrometheusRuleMetadata{Labels: &labels},
	}
	dash0.SetRecordingRuleIDIfAbsent(rule, "new-id")
	fmt.Println((*rule.Metadata.Labels)["dash0.com/id"])
}
Output:
existing

func SetSLODataset added in v1.18.0

func SetSLODataset(slo *SloDefinition, dataset string)

SetSLODataset sets the dataset on an SLO definition, initializing the labels struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	slo := &dash0.SloDefinition{}
	dash0.SetSLODataset(slo, "default")
	fmt.Println(*slo.Metadata.Labels.Dash0Comdataset)
}
Output:
default

func SetSLOID added in v1.18.0

func SetSLOID(slo *SloDefinition, id string)

SetSLOID sets the dash0.com/id label on an SLO definition, initializing the labels struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	slo := &dash0.SloDefinition{}
	dash0.SetSLOID(slo, "slo_01k5vpx97efdnrkqan15b41k84")
	fmt.Println(*slo.Metadata.Labels.Dash0Comid)
}
Output:
slo_01k5vpx97efdnrkqan15b41k84

func SetSLOIDIfAbsent added in v1.18.0

func SetSLOIDIfAbsent(slo *SloDefinition, id string)

SetSLOIDIfAbsent sets the dash0.com/id label on an SLO definition only if it is not already set, initializing the labels struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	slo := &dash0.SloDefinition{
		Metadata: dash0.SloMetadata{
			Labels: &dash0.SloLabels{Dash0Comid: dash0.Ptr("existing-id")},
		},
	}
	dash0.SetSLOIDIfAbsent(slo, "new-id")
	fmt.Println(*slo.Metadata.Labels.Dash0Comid)
}
Output:
existing-id

func SetSpamFilterDataset added in v1.12.0

func SetSpamFilterDataset(filter *SpamFilter, dataset string)

SetSpamFilterDataset sets the dash0.com/dataset label on a spam filter definition, initializing the labels struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	filter := &dash0.SpamFilter{}
	dash0.SetSpamFilterDataset(filter, "production")
	fmt.Println(*filter.Metadata.Labels.Dash0Comdataset)
}
Output:
production

func SetSpamFilterID added in v1.12.0

func SetSpamFilterID(filter *SpamFilter, id string)

SetSpamFilterID sets the dash0.com/id label on a spam filter definition, initializing the labels struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	filter := &dash0.SpamFilter{}
	dash0.SetSpamFilterID(filter, "sf-456")
	fmt.Println(*filter.Metadata.Labels.Dash0Comid)
}
Output:
sf-456

func SetSpamFilterIDIfAbsent added in v1.12.0

func SetSpamFilterIDIfAbsent(filter *SpamFilter, id string)

SetSpamFilterIDIfAbsent sets the dash0.com/id label on a spam filter definition only if it is not already set, initializing the labels struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	filter := &dash0.SpamFilter{
		Metadata: dash0.SpamFilterMetadata{
			Labels: &dash0.SpamFilterLabels{Dash0Comid: dash0.Ptr("existing")},
		},
	}
	// Does not overwrite an existing ID.
	dash0.SetSpamFilterIDIfAbsent(filter, "new-id")
	fmt.Println(*filter.Metadata.Labels.Dash0Comid)
}
Output:
existing

func SetSyntheticCheckDataset added in v1.6.0

func SetSyntheticCheckDataset(check *SyntheticCheckDefinition, dataset string)

SetSyntheticCheckDataset sets the dataset on a synthetic check definition, initializing the labels struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	check := &dash0.SyntheticCheckDefinition{}
	dash0.SetSyntheticCheckDataset(check, "production")
	fmt.Println(*check.Metadata.Labels.Dash0Comdataset)
}
Output:
production

func SetSyntheticCheckID added in v1.6.0

func SetSyntheticCheckID(check *SyntheticCheckDefinition, id string)

SetSyntheticCheckID sets the dash0.com/id label on a synthetic check definition, initializing the labels struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	check := &dash0.SyntheticCheckDefinition{}
	dash0.SetSyntheticCheckID(check, "sc-7")
	fmt.Println(*check.Metadata.Labels.Dash0Comid)
}
Output:
sc-7

func SetSyntheticCheckIDIfAbsent added in v1.6.0

func SetSyntheticCheckIDIfAbsent(check *SyntheticCheckDefinition, id string)

SetSyntheticCheckIDIfAbsent sets the dash0.com/id label on a synthetic check definition only if it is not already set, initializing the labels struct if needed.

func SetTeamID added in v1.17.0

func SetTeamID(team *TeamDefinitionV1Alpha1, id string)

SetTeamID sets the dash0.com/id label on a team definition, initializing the labels struct if needed. No-op when the team is nil.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	team := &dash0.TeamDefinitionV1Alpha1{
		Metadata: dash0.TeamMetadata{Name: "backend-team"},
	}
	dash0.SetTeamID(team, "00000000-0000-0000-0000-000000000001")
	fmt.Println(*team.Metadata.Labels.Dash0Comid)
}
Output:
00000000-0000-0000-0000-000000000001

func SetTeamIDIfAbsent added in v1.17.0

func SetTeamIDIfAbsent(team *TeamDefinitionV1Alpha1, id string)

SetTeamIDIfAbsent sets the dash0.com/id label on a team definition only when it is not already set. No-op when the team is nil.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	team := &dash0.TeamDefinitionV1Alpha1{
		Metadata: dash0.TeamMetadata{
			Labels: &dash0.TeamLabels{Dash0Comid: dash0.Ptr("existing")},
		},
	}
	// Does not overwrite an existing ID.
	dash0.SetTeamIDIfAbsent(team, "new-id")
	fmt.Println(*team.Metadata.Labels.Dash0Comid)
}
Output:
existing

func SetViewDataset added in v1.6.0

func SetViewDataset(view *ViewDefinition, dataset string)

SetViewDataset sets the dataset on a view definition, initializing the labels struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	view := &dash0.ViewDefinition{}
	dash0.SetViewDataset(view, "production")
	fmt.Println(*view.Metadata.Labels.Dash0Comdataset)
}
Output:
production

func SetViewID added in v1.6.0

func SetViewID(view *ViewDefinition, id string)

SetViewID sets the dash0.com/id label on a view definition, initializing the labels struct if needed.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	view := &dash0.ViewDefinition{}
	dash0.SetViewID(view, "v-99")
	fmt.Println(*view.Metadata.Labels.Dash0Comid)
}
Output:
v-99

func SetViewIDIfAbsent added in v1.6.0

func SetViewIDIfAbsent(view *ViewDefinition, id string)

SetViewIDIfAbsent sets the dash0.com/id label on a view definition only if it is not already set, initializing the labels struct if needed.

func SpansExplorerURL added in v1.13.0

func SpansExplorerURL(apiURL string, filters []DeeplinkFilter, from, to string, dataset *string) string

SpansExplorerURL builds a deep link to the Dash0 traces explorer. The URL includes optional filter criteria, time range, and optional dataset as query parameters. It returns an empty string if the API URL is empty or cannot be parsed.

func String

func String(v string) *string

String returns a pointer to the given string value. This is a convenience wrapper around Ptr for the common case of string pointers.

Example:

client.ListDashboards(ctx, dash0.String("default"))

func StringValue

func StringValue(p *string) string

StringValue returns the value of a string pointer, or empty string if nil.

func StripCheckRuleServerFields added in v1.6.0

func StripCheckRuleServerFields(rule *PrometheusAlertRule)

StripCheckRuleServerFields removes server-generated fields from a check rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	rule := &dash0.PrometheusAlertRule{
		Name:    "HighErrorRate",
		Dataset: dash0.Ptr("prod"),
	}
	dash0.StripCheckRuleServerFields(rule)
	fmt.Println(rule.Dataset == nil)
}
Output:
true

func StripDashboardServerFields added in v1.6.0

func StripDashboardServerFields(dashboard *DashboardDefinition)

StripDashboardServerFields removes server-generated metadata fields from a dashboard definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	dashboard := &dash0.DashboardDefinition{
		Metadata: dash0.DashboardMetadata{
			Version: dash0.Ptr(int64(3)),
		},
	}
	dash0.StripDashboardServerFields(dashboard)
	fmt.Println(dashboard.Metadata.Version == nil)
}
Output:
true

func StripNotificationChannelServerFields added in v1.9.0

func StripNotificationChannelServerFields(channel *NotificationChannelDefinition)

StripNotificationChannelServerFields removes server-generated fields from a notification channel definition. It clears the created-at/updated-at annotations, the dash0.com/id label, and spec.routing.assets. The assets list is a read-only back-reference the server derives from the check rules and synthetic checks bound to the channel — the API silently ignores any value supplied on write, so stripping it keeps write payloads honest and stops derived server state from churning IaC diffs. Bindings are managed on the other resource: the check rule's dash0.com/notification-channel-ids annotation, or the synthetic check's spec.notifications.channels. spec.routing.filters is user-managed and preserved.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	channel := &dash0.NotificationChannelDefinition{
		Metadata: dash0.NotificationChannelMetadata{Name: "Slack Alerts"},
	}
	dash0.SetNotificationChannelID(channel, "nc-123")
	dash0.StripNotificationChannelServerFields(channel)
	fmt.Println(channel.Metadata.Labels.Dash0Comid == nil)
}
Output:
true

func StripRecordingRuleServerFields added in v1.10.0

func StripRecordingRuleServerFields(rule *RecordingRule)

StripRecordingRuleServerFields removes server-generated fields from a recording rule definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	labels := map[string]string{
		"dash0.com/id":     "rr-42",
		"dash0.com/origin": "terraform",
	}
	rule := &dash0.RecordingRule{
		Metadata: dash0.PrometheusRuleMetadata{Labels: &labels},
	}
	dash0.StripRecordingRuleServerFields(rule)
	_, hasID := (*rule.Metadata.Labels)["dash0.com/id"]
	fmt.Println(hasID)
}
Output:
false

func StripSLOServerFields added in v1.18.0

func StripSLOServerFields(slo *SloDefinition)

StripSLOServerFields removes server-generated fields from an SLO definition.

This includes dash0.com/id: unlike dashboards, views, check rules, and synthetic checks — whose ids are client-settable upsert keys and therefore user intent — SLO ids are assigned by the server (`slo_<ulid>`) and cannot be chosen by a caller. The id is server-managed metadata, so it is stripped here alongside version/origin/dataset/source, matching StripSpamFilterServerFields, StripNotificationChannelServerFields, StripRecordingRuleServerFields, and StripTeamServerFields, which all clear their (likewise non-client-settable) ids.

Note that dash0.com/origin is stripped here even though StripTeamServerFields deliberately preserves a team's origin. The two are not equivalent: a team's origin is client-settable on create, so it must survive into the request body, whereas every reserved dash0.com/* label on an SLO — origin included — is ignored when supplied by a caller (an SLO's origin is populated through the internal API used by the operator and the Terraform provider, which carry it in the request path rather than the body). Stripping it is therefore a no-op for public writes, not a loss of user intent.

User-defined (non-dash0.com/*) labels and annotations are preserved.

Callers that need the id must read it (via GetSLOID) before calling this.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	slo := &dash0.SloDefinition{
		Metadata: dash0.SloMetadata{
			Labels: &dash0.SloLabels{
				Dash0Comid:      dash0.Ptr("slo_01k5vpx97efdnrkqan15b41k84"),
				Dash0Comversion: dash0.Ptr("2"),
				Dash0Comdataset: dash0.Ptr("default"),
				Dash0Comorigin:  dash0.Ptr("my-origin"),
			},
		},
	}
	// Read any identifier you still need before stripping — the id is
	// server-assigned for SLOs, so it is removed along with the other
	// server-managed labels.
	id := dash0.GetSLOID(slo)
	dash0.StripSLOServerFields(slo)
	fmt.Println(id, dash0.GetSLOID(slo) == "", slo.Metadata.Labels.Dash0Comversion == nil)
}
Output:
slo_01k5vpx97efdnrkqan15b41k84 true true

func StripSpamFilterServerFields added in v1.12.0

func StripSpamFilterServerFields(filter *SpamFilter)

StripSpamFilterServerFields removes server-generated fields from a spam filter definition.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	filter := &dash0.SpamFilter{
		Metadata: dash0.SpamFilterMetadata{Name: "Drop noisy health checks"},
	}
	dash0.SetSpamFilterID(filter, "sf-123")
	dash0.StripSpamFilterServerFields(filter)
	fmt.Println(filter.Metadata.Labels.Dash0Comid == nil)
}
Output:
true

func StripSyntheticCheckServerFields added in v1.6.0

func StripSyntheticCheckServerFields(check *SyntheticCheckDefinition)

StripSyntheticCheckServerFields removes server-generated fields from a synthetic check definition.

func StripTeamServerFields added in v1.17.0

func StripTeamServerFields(team *TeamDefinitionV1Alpha1)

StripTeamServerFields clears the server-managed fields from a team definition so callers can round-trip a team through a write endpoint without accidentally shipping a stale server-set ID, origin, or source. Cleared fields are:

  • metadata.labels["dash0.com/id"], [".../origin"], [".../source"].

Arbitrary user-supplied labels are preserved. No-op when the team is nil.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	team := &dash0.TeamDefinitionV1Alpha1{
		Metadata: dash0.TeamMetadata{
			Name: "backend-team",
			Labels: &dash0.TeamLabels{
				Dash0Comid:     dash0.Ptr("00000000-0000-0000-0000-000000000001"),
				Dash0Comorigin: dash0.Ptr("00000000-0000-0000-0000-000000000001"),
			},
		},
	}
	dash0.StripTeamServerFields(team)
	// dash0.com/origin is preserved because it is client-settable on create
	// and immutable after; IaC callers rely on it for PUT-by-origin idempotency.
	fmt.Println(team.Metadata.Labels.Dash0Comid == nil)
	fmt.Println(*team.Metadata.Labels.Dash0Comorigin)
	fmt.Println(team.Metadata.Name)
}
Output:
true
00000000-0000-0000-0000-000000000001
backend-team

func StripViewServerFields added in v1.6.0

func StripViewServerFields(view *ViewDefinition)

StripViewServerFields removes server-generated fields from a view definition.

func TracesExplorerURL added in v1.13.0

func TracesExplorerURL(apiURL, traceID string, dataset *string) string

TracesExplorerURL builds a deep link to the Dash0 traces explorer for a specific trace. The URL includes the trace ID and optional dataset as query parameters. It returns an empty string if the API URL is empty or cannot be parsed.

func ViewDeeplinkURL added in v1.13.0

func ViewDeeplinkURL(apiURL string, viewType ViewType, viewID string, dataset *string) string

ViewDeeplinkURL constructs a Dash0 web app deep link for a view, using the view's type to select the correct page (for example "/goto/traces/explorer" for span views, "/goto/logs" for log views).

When dataset is non-nil and non-empty, a `dataset=<dataset>` query parameter is appended so the web app opens the view scoped to that dataset.

It returns an empty string if the API URL cannot be parsed or the view type has no associated page.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	fmt.Println(dash0.ViewDeeplinkURL("https://api.us-west-2.aws.dash0.com", dash0.Spans, "view-7", dash0.Ptr("production")))
}
Output:
https://app.dash0.com/goto/traces/explorer?dataset=production&view_id=view-7

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) generatedClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

Types

type APIError

type APIError struct {
	// StatusCode is the HTTP status code.
	StatusCode int

	// Status is the HTTP status text.
	Status string

	// Body is the raw response body.
	Body string

	// Message is the error message extracted from the response.
	Message string

	// TraceID is the trace ID from the x-trace-id header if available.
	TraceID string
}

APIError represents an error response from the Dash0 API.

func NewAPIError

func NewAPIError(resp *http.Response) *APIError

NewAPIError creates an APIError from an HTTP response. Note: This function tries to read the response body. If the body has already been read (e.g., by oapi-codegen), use newAPIErrorWithBody instead.

func (*APIError) Error

func (e *APIError) Error() string

Error implements the error interface.

type AccessibleAsset added in v1.4.0

type AccessibleAsset struct {
	// CreatedAt A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	CreatedAt FixedTime         `json:"createdAt"`
	Creator   *MemberDefinition `json:"creator,omitempty"`

	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset Dataset `json:"dataset"`

	// HasAccess returns the information if the logged-in user has access to this asset
	HasAccess        bool     `json:"hasAccess"`
	Id               string   `json:"id"`
	Name             string   `json:"name"`
	PermittedActions []Action `json:"permittedActions"`

	// Type returns for views the information which type of view it is
	Type *string `json:"type,omitempty"`
}

AccessibleAsset defines model for AccessibleAsset.

type Action added in v1.4.0

type Action = string

Action Not defined as an enum, because we will eventually support wildcards like `ingest:*`.

type AddTeamMembersRequest added in v1.4.0

type AddTeamMembersRequest struct {
	// MemberIds Add an existing organization member to this team.
	MemberIds []string `json:"memberIds"`
}

AddTeamMembersRequest defines model for AddTeamMembersRequest.

type AgenticWorkflowAction added in v1.17.0

type AgenticWorkflowAction string

AgenticWorkflowAction defines model for AgenticWorkflowAction.

const (
	AgenticWorkflowDelete AgenticWorkflowAction = "agentic_workflow:delete"
	AgenticWorkflowRead   AgenticWorkflowAction = "agentic_workflow:read"
	AgenticWorkflowWrite  AgenticWorkflowAction = "agentic_workflow:write"
)

Defines values for AgenticWorkflowAction.

type AgenticWorkflowAnnotations added in v1.17.0

type AgenticWorkflowAnnotations struct {
	// Dash0ComcreatedAt The time at which this automation was originally created.
	Dash0ComcreatedAt *time.Time `json:"dash0.com/created-at,omitempty"`

	// Dash0ComcreatedBy The member ID of the user who originally created this automation.
	Dash0ComcreatedBy *string    `json:"dash0.com/created-by,omitempty"`
	Dash0ComdeletedAt *time.Time `json:"dash0.com/deleted-at,omitempty"`

	// Dash0ComfolderPath Optional UI folder path for organising groups (e.g. '/infrastructure/hosts'). Nesting is expressed with '/' separators.
	Dash0ComfolderPath *string `json:"dash0.com/folder-path,omitempty"`

	// Dash0ComlastUpdatedAt The time at which the current version of this automation was created.
	Dash0ComlastUpdatedAt *time.Time `json:"dash0.com/last-updated-at,omitempty"`

	// Dash0ComlastUpdatedBy The member ID of the user who created the current version of this automation.
	Dash0ComlastUpdatedBy *string `json:"dash0.com/last-updated-by,omitempty"`

	// Dash0Comsharing Comma-separated list of principals to grant read access to. Supported formats: 'team:<team_id>' and 'user:<email>'. Example: 'team:team_01abc,user:alice@example.com'. Sharing is honored only on assets that declare a dash0.com/origin (for example those managed by Terraform, the operator, the CLI, or the API). Setting it on an asset that declares no dash0.com/origin is rejected with a 400 — manage that asset's access via the UI share dialog instead.
	Dash0Comsharing *string `json:"dash0.com/sharing,omitempty"`

	// Dash0ComwebhookSecret The plaintext webhook secret, returned exactly once: immediately after the backend
	// auto-provisions it on create or update (the first time a webhook trigger is added).
	// Absent on every other response, including subsequent reads of the same workflow — it
	// is stored only as an encrypted value and cannot be retrieved again. Use
	// `POST .../webhook` (regenerate) to obtain a new one if this value was missed.
	Dash0ComwebhookSecret *string `json:"dash0.com/webhook-secret,omitempty"`

	// Dash0ComwebhookTriggerEnabled Webhook-trigger-scoped feature flag, independent of the workflow's own `spec.enabled`.
	// Client-settable on write (via PUT/upsert), defaults to `"true"`. `"true"` if the
	// webhook trigger is active, `"false"` if it is paused. Pausing keeps the secret and
	// webhook id intact; incoming requests are silently accepted but not forwarded.
	Dash0ComwebhookTriggerEnabled *string `json:"dash0.com/webhook-trigger-enabled,omitempty"`
}

AgenticWorkflowAnnotations defines model for AgenticWorkflowAnnotations.

type AgenticWorkflowConcurrency added in v1.17.0

type AgenticWorkflowConcurrency struct {
	// MaxParallel The maximum number of parallel executions allowed. Only meaningful when `policy` is set to `parallel`.
	// Defaults to `50`.
	MaxParallel *int `json:"maxParallel,omitempty"`

	// Policy The concurrency policy to apply when an automation is triggered while a previous execution is still running.
	//
	// - `queue`: Queue the new execution and run it after the current one completes.
	// - `skip`: Skip the new execution entirely.
	// - `supersede`: Cancel the current execution and start the new one.
	// - `parallel`: Run executions in parallel, up to `maxParallel`.
	Policy AgenticWorkflowConcurrencyPolicy `json:"policy"`
}

AgenticWorkflowConcurrency defines model for AgenticWorkflowConcurrency.

type AgenticWorkflowConcurrencyPolicy added in v1.17.0

type AgenticWorkflowConcurrencyPolicy string

AgenticWorkflowConcurrencyPolicy The concurrency policy to apply when an automation is triggered while a previous execution is still running.

- `queue`: Queue the new execution and run it after the current one completes. - `skip`: Skip the new execution entirely. - `supersede`: Cancel the current execution and start the new one. - `parallel`: Run executions in parallel, up to `maxParallel`.

const (
	Parallel  AgenticWorkflowConcurrencyPolicy = "parallel"
	Queue     AgenticWorkflowConcurrencyPolicy = "queue"
	Skip      AgenticWorkflowConcurrencyPolicy = "skip"
	Supersede AgenticWorkflowConcurrencyPolicy = "supersede"
)

Defines values for AgenticWorkflowConcurrencyPolicy.

type AgenticWorkflowCreateRequest added in v1.17.0

type AgenticWorkflowCreateRequest = AgenticWorkflowDefinition

AgenticWorkflowCreateRequest defines model for AgenticWorkflowCreateRequest.

type AgenticWorkflowCreditBudget added in v1.17.0

type AgenticWorkflowCreditBudget struct {
	// Credits The maximum number of credits this workflow may consume within the rolling window.
	Credits float32 `json:"credits"`

	// WarningThreshold Optional warning threshold, as a percentage (0-100) of `credits`. A `budget_warning`
	// notification is dispatched once, to `notifications.onBudgetWarningChannels`, the first time
	// a completed run pushes rolling spend across this percentage of the budget. Leave unset to
	// disable budget warnings.
	WarningThreshold *float32 `json:"warningThreshold,omitempty"`
	Window           Duration `json:"window"`
}

AgenticWorkflowCreditBudget defines model for AgenticWorkflowCreditBudget.

type AgenticWorkflowDefinition added in v1.17.0

type AgenticWorkflowDefinition struct {
	Kind     AgenticWorkflowDefinitionKind `json:"kind"`
	Metadata AgenticWorkflowMetadata       `json:"metadata"`
	Spec     AgenticWorkflowSpec           `json:"spec"`
}

AgenticWorkflowDefinition defines model for AgenticWorkflowDefinition.

type AgenticWorkflowDefinitionKind added in v1.17.0

type AgenticWorkflowDefinitionKind string

AgenticWorkflowDefinitionKind defines model for AgenticWorkflowDefinition.Kind.

const (
	Dash0AgenticWorkflow AgenticWorkflowDefinitionKind = "Dash0AgenticWorkflow"
)

Defines values for AgenticWorkflowDefinitionKind.

type AgenticWorkflowDisplay added in v1.17.0

type AgenticWorkflowDisplay struct {
	Description *string `json:"description,omitempty"`
	Name        string  `json:"name"`
}

AgenticWorkflowDisplay defines model for AgenticWorkflowDisplay.

type AgenticWorkflowGuardrails added in v1.17.0

type AgenticWorkflowGuardrails struct {
	// AllowedTools Optionally restrict which tools are allowed. By default, all tools are allowed to be used. You can use the
	// `*` character to allow all tools matching a pattern.
	AllowedTools       *[]string                    `json:"allowedTools,omitempty"`
	Concurrency        *AgenticWorkflowConcurrency  `json:"concurrency,omitempty"`
	CreditBudgetWindow *AgenticWorkflowCreditBudget `json:"creditBudgetWindow,omitempty"`
	Debounce           *Duration                    `json:"debounce,omitempty"`

	// McpTools Per-automation overrides for MCP server tools. Each entry sets whether a specific MCP
	// tool is available to this automation, overriding the tool's enabled/disabled state in
	// the organization's MCP integration settings. Tools not listed here fall back to their
	// integration-settings default. This lets an automation enable a tool that is disabled in
	// settings, or disable a tool that is enabled there, scoped to this automation only.
	McpTools *[]AgenticWorkflowMcpTool `json:"mcpTools,omitempty"`

	// NetworkLevel Controls outbound network access for the sandbox running this thread.
	// - `no_network`: Block all outbound network access.
	// - `trusted_only`: Allow outbound access only to a curated list of trusted addresses.
	// - `full`: No network restrictions.
	NetworkLevel NetworkLevel `json:"networkLevel"`

	// RequiredToolCalls Optionally enforce that the Agent0 automation has executed these tool calls. If the agent is concluding is
	// automation, but hasn't called these tools, the agent receives a follow-up prompt to call these tools. This
	// auto-correction of the LLM behavior is only attempted once.
	//
	// This is useful if you wanna ensure that the agent makes specific tool calls to external systems, e.g., to
	// leave a message on Slack or GitHub.
	RequiredToolCalls *[]string `json:"requiredToolCalls,omitempty"`
	Timeout           *Duration `json:"timeout,omitempty"`

	// ToolParameterOverrides Pre-configure tool parameters that are enforced at invocation time. When a listed
	// tool is called by the agent, these parameters are merged into the tool's arguments,
	// overriding any values the LLM may have provided.
	// Keys can be either fully qualified with namespace (e.g., "dash0.slackSendMessage")
	// or bare tool names without namespace (e.g., "slackSendMessage"). Namespaced keys
	// take precedence and allow disambiguation when multiple integrations expose tools
	// with the same name.
	// Values are objects of key-value pairs merged into tool arguments.
	// Values support {{variable}} substitution using built-in variables, constants,
	// and trigger variables.
	ToolParameterOverrides *map[string]AgenticWorkflowToolParameterOverride `json:"toolParameterOverrides,omitempty"`
}

AgenticWorkflowGuardrails defines model for AgenticWorkflowGuardrails.

type AgenticWorkflowLabels added in v1.17.0

type AgenticWorkflowLabels struct {
	Dash0Comdataset *string `json:"dash0.com/dataset,omitempty"`
	Dash0Comid      *string `json:"dash0.com/id,omitempty"`
	Dash0Comorigin  *string `json:"dash0.com/origin,omitempty"`

	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource    *CrdSource `json:"dash0.com/source,omitempty"`
	Dash0Comversion   *string    `json:"dash0.com/version,omitempty"`
	Dash0ComwebhookId *string    `json:"dash0.com/webhook-id,omitempty"`
}

AgenticWorkflowLabels defines model for AgenticWorkflowLabels.

type AgenticWorkflowMcpTool added in v1.17.0

type AgenticWorkflowMcpTool struct {
	// Enabled Whether this MCP tool is available to this automation, overriding the integration-settings default.
	Enabled bool `json:"enabled"`

	// Server The MCP server (integration) display name, kebab-cased — matches the name agent0 uses for the server.
	Server string `json:"server"`

	// Tool The tool name as reported by the MCP server.
	Tool string `json:"tool"`
}

AgenticWorkflowMcpTool defines model for AgenticWorkflowMcpTool.

type AgenticWorkflowMetadata added in v1.17.0

type AgenticWorkflowMetadata struct {
	Annotations *AgenticWorkflowAnnotations `json:"annotations,omitempty"`
	Labels      *AgenticWorkflowLabels      `json:"labels,omitempty"`
	Name        string                      `json:"name"`
}

AgenticWorkflowMetadata defines model for AgenticWorkflowMetadata.

type AgenticWorkflowNotifications added in v1.17.0

type AgenticWorkflowNotifications struct {
	// OnBudgetWarningChannels Notification channels to notify when this workflow's rolling credit budget crosses its
	// warning threshold (`guardrails.creditBudgetWindow.warningThreshold`). Each value is an opaque channel
	// identifier: either the channel's UUID or its origin. An empty or absent list notifies no
	// channels on budget warnings.
	OnBudgetWarningChannels *[]string `json:"onBudgetWarningChannels,omitempty"`

	// OnFailureChannels Notification channels to notify when an automation run fails. Each value is an opaque channel
	// identifier: either the channel's UUID or its origin. An empty or absent list notifies no
	// channels on failure.
	OnFailureChannels *[]string `json:"onFailureChannels,omitempty"`

	// OnSuccessChannels Notification channels to notify when an automation run completes successfully. Each value is an
	// opaque channel identifier: either the channel's UUID or its origin (the stable identifier
	// infrastructure-as-code tooling assigns). Identifiers are resolved at dispatch time, so an
	// automation authored via Terraform or the operator can reference channels without knowing their
	// per-environment UUID. An empty or absent list notifies no channels on success.
	OnSuccessChannels *[]string `json:"onSuccessChannels,omitempty"`
}

AgenticWorkflowNotifications Notification channels to notify when an automation run completes, grouped by outcome. Both lists are optional; omit one to skip notifying on that outcome.

type AgenticWorkflowParent added in v1.17.0

type AgenticWorkflowParent struct {
	RunId   string `json:"runId"`
	Version string `json:"version"`

	// WorkflowId The parent automation's ID.
	WorkflowId string `json:"workflowId"`
}

AgenticWorkflowParent Establish as a parent-child hierarchy between automations. You will not want to set this explicitly; instead, this is going to be set by the automation engine when one automation is deciding to create another.

type AgenticWorkflowPermission added in v1.17.0

type AgenticWorkflowPermission struct {
	Actions []AgenticWorkflowAction `json:"actions"`
	Role    *string                 `json:"role,omitempty"`
	TeamId  *string                 `json:"teamId,omitempty"`
	UserId  *string                 `json:"userId,omitempty"`
}

AgenticWorkflowPermission defines model for AgenticWorkflowPermission.

type AgenticWorkflowPrompt added in v1.17.0

type AgenticWorkflowPrompt struct {
	User string `json:"user"`
}

AgenticWorkflowPrompt defines model for AgenticWorkflowPrompt.

type AgenticWorkflowResponse added in v1.17.0

type AgenticWorkflowResponse = AgenticWorkflowDefinition

AgenticWorkflowResponse defines model for AgenticWorkflowResponse.

type AgenticWorkflowSpec added in v1.17.0

type AgenticWorkflowSpec struct {
	// Constants Static key-value pairs available as {{variable.name}} in the prompt and
	// tool parameter overrides. Constants are always available regardless of trigger type.
	// Trigger variables take precedence over constants on conflict.
	Constants  *map[string]string        `json:"constants,omitempty"`
	Display    AgenticWorkflowDisplay    `json:"display"`
	Enabled    bool                      `json:"enabled"`
	Guardrails AgenticWorkflowGuardrails `json:"guardrails"`

	// Notifications Notification channels to notify when an automation run completes, grouped by outcome.
	// Both lists are optional; omit one to skip notifying on that outcome.
	Notifications *AgenticWorkflowNotifications `json:"notifications,omitempty"`

	// Parent Establish as a parent-child hierarchy between automations. You will not want to set this explicitly; instead,
	// this is going to be set by the automation engine when one automation is deciding to create another.
	Parent      *AgenticWorkflowParent       `json:"parent,omitempty"`
	Permissions *[]AgenticWorkflowPermission `json:"permissions,omitempty"`

	// PermittedActions Computed, read-only. The set of actions the requesting user is permitted to perform on this automation, derived from their org role, dataset permissions, team memberships, and explicit permission entries. Ignored on write.
	PermittedActions *[]AgenticWorkflowAction `json:"permittedActions,omitempty"`
	Prompt           AgenticWorkflowPrompt    `json:"prompt"`
	Triggers         []AgenticWorkflowTrigger `json:"triggers"`
}

AgenticWorkflowSpec defines model for AgenticWorkflowSpec.

type AgenticWorkflowToolParameterOverride added in v1.17.0

type AgenticWorkflowToolParameterOverride map[string]string

AgenticWorkflowToolParameterOverride Key-value pairs merged into tool arguments at invocation time. Keys are parameter names (use dot notation for nested parameters, e.g. "timeframe.from"), values are the enforced parameter values. Values can contain {{variables}} resolved from built-in variables, constants, and trigger variables.

type AgenticWorkflowTrigger added in v1.17.0

type AgenticWorkflowTrigger struct {
	// contains filtered or unexported fields
}

AgenticWorkflowTrigger defines model for AgenticWorkflowTrigger.

func (AgenticWorkflowTrigger) AsFailedCheckAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsFailedCheckAgenticWorkflowTrigger() (FailedCheckAgenticWorkflowTrigger, error)

AsFailedCheckAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a FailedCheckAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsGitHubDeploymentAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsGitHubDeploymentAgenticWorkflowTrigger() (GitHubDeploymentAgenticWorkflowTrigger, error)

AsGitHubDeploymentAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a GitHubDeploymentAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsGitHubDeploymentStatusAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsGitHubDeploymentStatusAgenticWorkflowTrigger() (GitHubDeploymentStatusAgenticWorkflowTrigger, error)

AsGitHubDeploymentStatusAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a GitHubDeploymentStatusAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsGitHubIssueCommentAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsGitHubIssueCommentAgenticWorkflowTrigger() (GitHubIssueCommentAgenticWorkflowTrigger, error)

AsGitHubIssueCommentAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a GitHubIssueCommentAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsGitHubPullRequestAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsGitHubPullRequestAgenticWorkflowTrigger() (GitHubPullRequestAgenticWorkflowTrigger, error)

AsGitHubPullRequestAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a GitHubPullRequestAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsGitHubPullRequestReviewAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsGitHubPullRequestReviewAgenticWorkflowTrigger() (GitHubPullRequestReviewAgenticWorkflowTrigger, error)

AsGitHubPullRequestReviewAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a GitHubPullRequestReviewAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsGitHubPullRequestReviewCommentAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsGitHubPullRequestReviewCommentAgenticWorkflowTrigger() (GitHubPullRequestReviewCommentAgenticWorkflowTrigger, error)

AsGitHubPullRequestReviewCommentAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a GitHubPullRequestReviewCommentAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsGitHubReleaseAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsGitHubReleaseAgenticWorkflowTrigger() (GitHubReleaseAgenticWorkflowTrigger, error)

AsGitHubReleaseAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a GitHubReleaseAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsLinearCommentAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsLinearCommentAgenticWorkflowTrigger() (LinearCommentAgenticWorkflowTrigger, error)

AsLinearCommentAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a LinearCommentAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsLinearLabelAddedAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsLinearLabelAddedAgenticWorkflowTrigger() (LinearLabelAddedAgenticWorkflowTrigger, error)

AsLinearLabelAddedAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a LinearLabelAddedAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsManualAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsManualAgenticWorkflowTrigger() (ManualAgenticWorkflowTrigger, error)

AsManualAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a ManualAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsScheduledAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsScheduledAgenticWorkflowTrigger() (ScheduledAgenticWorkflowTrigger, error)

AsScheduledAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a ScheduledAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsSlackBotFailedCheckAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsSlackBotFailedCheckAgenticWorkflowTrigger() (SlackBotFailedCheckAgenticWorkflowTrigger, error)

AsSlackBotFailedCheckAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a SlackBotFailedCheckAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsSlackBotMessageAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsSlackBotMessageAgenticWorkflowTrigger() (SlackBotMessageAgenticWorkflowTrigger, error)

AsSlackBotMessageAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a SlackBotMessageAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsSlackBotReactionAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsSlackBotReactionAgenticWorkflowTrigger() (SlackBotReactionAgenticWorkflowTrigger, error)

AsSlackBotReactionAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a SlackBotReactionAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) AsWebhookAgenticWorkflowTrigger added in v1.17.0

func (t AgenticWorkflowTrigger) AsWebhookAgenticWorkflowTrigger() (WebhookAgenticWorkflowTrigger, error)

AsWebhookAgenticWorkflowTrigger returns the union data inside the AgenticWorkflowTrigger as a WebhookAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromFailedCheckAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromFailedCheckAgenticWorkflowTrigger(v FailedCheckAgenticWorkflowTrigger) error

FromFailedCheckAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided FailedCheckAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromGitHubDeploymentAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromGitHubDeploymentAgenticWorkflowTrigger(v GitHubDeploymentAgenticWorkflowTrigger) error

FromGitHubDeploymentAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided GitHubDeploymentAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromGitHubDeploymentStatusAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromGitHubDeploymentStatusAgenticWorkflowTrigger(v GitHubDeploymentStatusAgenticWorkflowTrigger) error

FromGitHubDeploymentStatusAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided GitHubDeploymentStatusAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromGitHubIssueCommentAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromGitHubIssueCommentAgenticWorkflowTrigger(v GitHubIssueCommentAgenticWorkflowTrigger) error

FromGitHubIssueCommentAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided GitHubIssueCommentAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromGitHubPullRequestAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromGitHubPullRequestAgenticWorkflowTrigger(v GitHubPullRequestAgenticWorkflowTrigger) error

FromGitHubPullRequestAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided GitHubPullRequestAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromGitHubPullRequestReviewAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromGitHubPullRequestReviewAgenticWorkflowTrigger(v GitHubPullRequestReviewAgenticWorkflowTrigger) error

FromGitHubPullRequestReviewAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided GitHubPullRequestReviewAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromGitHubPullRequestReviewCommentAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromGitHubPullRequestReviewCommentAgenticWorkflowTrigger(v GitHubPullRequestReviewCommentAgenticWorkflowTrigger) error

FromGitHubPullRequestReviewCommentAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided GitHubPullRequestReviewCommentAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromGitHubReleaseAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromGitHubReleaseAgenticWorkflowTrigger(v GitHubReleaseAgenticWorkflowTrigger) error

FromGitHubReleaseAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided GitHubReleaseAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromLinearCommentAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromLinearCommentAgenticWorkflowTrigger(v LinearCommentAgenticWorkflowTrigger) error

FromLinearCommentAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided LinearCommentAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromLinearLabelAddedAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromLinearLabelAddedAgenticWorkflowTrigger(v LinearLabelAddedAgenticWorkflowTrigger) error

FromLinearLabelAddedAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided LinearLabelAddedAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromManualAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromManualAgenticWorkflowTrigger(v ManualAgenticWorkflowTrigger) error

FromManualAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided ManualAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromScheduledAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromScheduledAgenticWorkflowTrigger(v ScheduledAgenticWorkflowTrigger) error

FromScheduledAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided ScheduledAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromSlackBotFailedCheckAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromSlackBotFailedCheckAgenticWorkflowTrigger(v SlackBotFailedCheckAgenticWorkflowTrigger) error

FromSlackBotFailedCheckAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided SlackBotFailedCheckAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromSlackBotMessageAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromSlackBotMessageAgenticWorkflowTrigger(v SlackBotMessageAgenticWorkflowTrigger) error

FromSlackBotMessageAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided SlackBotMessageAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromSlackBotReactionAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromSlackBotReactionAgenticWorkflowTrigger(v SlackBotReactionAgenticWorkflowTrigger) error

FromSlackBotReactionAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided SlackBotReactionAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) FromWebhookAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) FromWebhookAgenticWorkflowTrigger(v WebhookAgenticWorkflowTrigger) error

FromWebhookAgenticWorkflowTrigger overwrites any union data inside the AgenticWorkflowTrigger as the provided WebhookAgenticWorkflowTrigger

func (AgenticWorkflowTrigger) MarshalJSON added in v1.17.0

func (t AgenticWorkflowTrigger) MarshalJSON() ([]byte, error)

func (*AgenticWorkflowTrigger) MergeFailedCheckAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeFailedCheckAgenticWorkflowTrigger(v FailedCheckAgenticWorkflowTrigger) error

MergeFailedCheckAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided FailedCheckAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeGitHubDeploymentAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeGitHubDeploymentAgenticWorkflowTrigger(v GitHubDeploymentAgenticWorkflowTrigger) error

MergeGitHubDeploymentAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided GitHubDeploymentAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeGitHubDeploymentStatusAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeGitHubDeploymentStatusAgenticWorkflowTrigger(v GitHubDeploymentStatusAgenticWorkflowTrigger) error

MergeGitHubDeploymentStatusAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided GitHubDeploymentStatusAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeGitHubIssueCommentAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeGitHubIssueCommentAgenticWorkflowTrigger(v GitHubIssueCommentAgenticWorkflowTrigger) error

MergeGitHubIssueCommentAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided GitHubIssueCommentAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeGitHubPullRequestAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeGitHubPullRequestAgenticWorkflowTrigger(v GitHubPullRequestAgenticWorkflowTrigger) error

MergeGitHubPullRequestAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided GitHubPullRequestAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeGitHubPullRequestReviewAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeGitHubPullRequestReviewAgenticWorkflowTrigger(v GitHubPullRequestReviewAgenticWorkflowTrigger) error

MergeGitHubPullRequestReviewAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided GitHubPullRequestReviewAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeGitHubPullRequestReviewCommentAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeGitHubPullRequestReviewCommentAgenticWorkflowTrigger(v GitHubPullRequestReviewCommentAgenticWorkflowTrigger) error

MergeGitHubPullRequestReviewCommentAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided GitHubPullRequestReviewCommentAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeGitHubReleaseAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeGitHubReleaseAgenticWorkflowTrigger(v GitHubReleaseAgenticWorkflowTrigger) error

MergeGitHubReleaseAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided GitHubReleaseAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeLinearCommentAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeLinearCommentAgenticWorkflowTrigger(v LinearCommentAgenticWorkflowTrigger) error

MergeLinearCommentAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided LinearCommentAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeLinearLabelAddedAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeLinearLabelAddedAgenticWorkflowTrigger(v LinearLabelAddedAgenticWorkflowTrigger) error

MergeLinearLabelAddedAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided LinearLabelAddedAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeManualAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeManualAgenticWorkflowTrigger(v ManualAgenticWorkflowTrigger) error

MergeManualAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided ManualAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeScheduledAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeScheduledAgenticWorkflowTrigger(v ScheduledAgenticWorkflowTrigger) error

MergeScheduledAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided ScheduledAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeSlackBotFailedCheckAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeSlackBotFailedCheckAgenticWorkflowTrigger(v SlackBotFailedCheckAgenticWorkflowTrigger) error

MergeSlackBotFailedCheckAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided SlackBotFailedCheckAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeSlackBotMessageAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeSlackBotMessageAgenticWorkflowTrigger(v SlackBotMessageAgenticWorkflowTrigger) error

MergeSlackBotMessageAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided SlackBotMessageAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeSlackBotReactionAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeSlackBotReactionAgenticWorkflowTrigger(v SlackBotReactionAgenticWorkflowTrigger) error

MergeSlackBotReactionAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided SlackBotReactionAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) MergeWebhookAgenticWorkflowTrigger added in v1.17.0

func (t *AgenticWorkflowTrigger) MergeWebhookAgenticWorkflowTrigger(v WebhookAgenticWorkflowTrigger) error

MergeWebhookAgenticWorkflowTrigger performs a merge with any union data inside the AgenticWorkflowTrigger, using the provided WebhookAgenticWorkflowTrigger

func (*AgenticWorkflowTrigger) UnmarshalJSON added in v1.17.0

func (t *AgenticWorkflowTrigger) UnmarshalJSON(b []byte) error

type AgenticWorkflowTriggerDelivery added in v1.17.0

type AgenticWorkflowTriggerDelivery string

AgenticWorkflowTriggerDelivery How a trigger delivers its event to an agent. An automation is the agent definition; triggers are the pipes into it, and each pipe is configured independently.

  • `spawn`: Start a new agent thread for this event. This is today's behavior.
  • `continue`: Route the event into the existing agent thread that owns the matching entity, falling back to spawning a fresh thread when none is active (resume-or-spawn). Only valid on continuation-capable triggers that carry an entity ref to route by; spawn-only triggers (e.g. `schedule`, `webhook`, `failed_check.new`) must not set it.
const (
	Continue AgenticWorkflowTriggerDelivery = "continue"
	Spawn    AgenticWorkflowTriggerDelivery = "spawn"
)

Defines values for AgenticWorkflowTriggerDelivery.

type AgenticWorkflowTriggerKind added in v1.17.0

type AgenticWorkflowTriggerKind string

AgenticWorkflowTriggerKind The kind of event that triggers the Agent0 automation.

- `schedule`: Cron-based scheduled trigger. - `failed_check.new`: Triggered directly when a new check failure is detected, without requiring Slack configuration. - `slack_bot.failed_check.new`: Triggered when a new failed check is detected via Slack bot. - `slack_bot.message`: Triggered when a Slack message matches a pattern. - `slack_bot.reaction`: Triggered when a specific emoji reaction is added in Slack. - `github.deployment`: Triggered when a GitHub deployment event occurs. - `github.deployment_status`: Triggered when a GitHub deployment status changes. - `github.pull_request`: Triggered when a GitHub pull request event occurs. - `github.pull_request_review`: Triggered when a GitHub pull request review event occurs. - `github.pull_request_review_comment`: Triggered when a GitHub pull request review comment event occurs. - `github.issue_comment`: Triggered when a comment is created, edited, or deleted on a GitHub pull request or issue. - `github.release`: Triggered when a GitHub release event occurs. - `linear.comment`: Triggered when the Dash0 agent is @mentioned or delegated in a Linear comment whose text contains the configured keyword. - `linear.label_added`: Triggered when a specific Linear label is added to an issue, optionally scoped to one or more Linear teams. - `webhook`: Triggered via an external webhook call. - `manual`: Triggered manually via the UI. Runtime-only — not valid in `spec.triggers[]`.

const (
	AgenticWorkflowTriggerKindFailedCheckNew                 AgenticWorkflowTriggerKind = "failed_check.new"
	AgenticWorkflowTriggerKindGithubDeployment               AgenticWorkflowTriggerKind = "github.deployment"
	AgenticWorkflowTriggerKindGithubDeploymentStatus         AgenticWorkflowTriggerKind = "github.deployment_status"
	AgenticWorkflowTriggerKindGithubIssueComment             AgenticWorkflowTriggerKind = "github.issue_comment"
	AgenticWorkflowTriggerKindGithubPullRequest              AgenticWorkflowTriggerKind = "github.pull_request"
	AgenticWorkflowTriggerKindGithubPullRequestReview        AgenticWorkflowTriggerKind = "github.pull_request_review"
	AgenticWorkflowTriggerKindGithubPullRequestReviewComment AgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	AgenticWorkflowTriggerKindGithubRelease                  AgenticWorkflowTriggerKind = "github.release"
	AgenticWorkflowTriggerKindLinearComment                  AgenticWorkflowTriggerKind = "linear.comment"
	AgenticWorkflowTriggerKindLinearLabelAdded               AgenticWorkflowTriggerKind = "linear.label_added"
	AgenticWorkflowTriggerKindManual                         AgenticWorkflowTriggerKind = "manual"
	AgenticWorkflowTriggerKindSchedule                       AgenticWorkflowTriggerKind = "schedule"
	AgenticWorkflowTriggerKindSlackBotFailedCheckNew         AgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	AgenticWorkflowTriggerKindSlackBotMessage                AgenticWorkflowTriggerKind = "slack_bot.message"
	AgenticWorkflowTriggerKindSlackBotReaction               AgenticWorkflowTriggerKind = "slack_bot.reaction"
	AgenticWorkflowTriggerKindWebhook                        AgenticWorkflowTriggerKind = "webhook"
)

Defines values for AgenticWorkflowTriggerKind.

type AgenticWorkflowTriggerTask added in v1.17.0

type AgenticWorkflowTriggerTask = string

AgenticWorkflowTriggerTask Optional per-trigger task/instruction prompt. When set, it is rendered with the same `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for invocations from this trigger: the kickoff framing when the trigger spawns a new agent, or the event framing when it continues an existing one. When omitted, the automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on continue) is used instead. The automation-level standing prompt is injected only once, on spawn, and is not re-sent on continue.

type AllQuietConfig added in v1.9.0

type AllQuietConfig struct {
	Url string `json:"url"`
}

AllQuietConfig defines model for AllQuietConfig.

type AnyValue

type AnyValue struct {
	BoolValue   *bool    `json:"boolValue,omitempty"`
	BytesValue  *[]byte  `json:"bytesValue,omitempty"`
	DoubleValue *float64 `json:"doubleValue,omitempty"`
	IntValue    *string  `json:"intValue,omitempty"`
	StringValue *string  `json:"stringValue,omitempty"`
}

AnyValue AnyValue is used to represent any type of attribute value. AnyValue may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.

type AttributeFilter

type AttributeFilter struct {
	// Key The attribute key to be filtered.
	Key AttributeFilterKey `json:"key"`

	// Operator The match operation for filtering attributes.
	//
	// #### Equality Operators
	// - `is` - equals (attribute exists and has a matching value)
	// - `is_not` - not equals (attribute exists and has a different value)
	//
	// #### Existence Operators
	// - `is_set` - is set (attribute exists)
	// - `is_not_set` - is not set (attribute does not exist)
	//
	// #### Multiple Value Operators
	// - `is_one_of` - is any of (attribute exists and has a value that is in the specified values)
	// - `is_not_one_of` - is not any of (attribute exists and has a value that is not in the specified values)
	//
	// #### Comparison Operators
	// - `gt` - greater than
	// - `lt` - less than
	// - `gte` - greater than or equal
	// - `lte` - less than or equal
	//
	// #### Pattern Matching Operators
	// - `matches` - match regex expression (attribute exists and matches the regular expression)
	// - `does_not_match` - does not match regex expression (attribute exists and does not match the regular expression)
	//
	// #### String Operators
	// - `contains` - contains (attribute exists and contains the specified value)
	// - `does_not_contain` - does not contain (attribute exists and does not contain the specified value)
	// - `starts_with` - starts with (attribute exists and starts with the specified value)
	// - `does_not_start_with` - does not start with (attribute exists and does not start with the specified value)
	// - `ends_with` - ends with (attribute exists and ends with the specified value)
	// - `does_not_end_with` - does not end with (attribute exists and does not end with the specified value)
	//
	// #### Special Operators
	// - `is_any` - matches any value, ignoring whether the key exists or not
	Operator AttributeFilterOperator `json:"operator"`
	Value    *AttributeFilter_Value  `json:"value,omitempty"`

	// Values List of values to match against. This parameter is mandatory for the is_one_of and is_not_one_of operators.
	Values *[]AttributeFilter_Values_Item `json:"values,omitempty"`
}

AttributeFilter defines model for AttributeFilter.

type AttributeFilterAnyValue

type AttributeFilterAnyValue = AnyValue

AttributeFilterAnyValue AnyValue is used to represent any type of attribute value. AnyValue may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.

type AttributeFilterKey

type AttributeFilterKey = string

AttributeFilterKey The attribute key to be filtered.

type AttributeFilterOperator

type AttributeFilterOperator string

AttributeFilterOperator The match operation for filtering attributes.

#### Equality Operators - `is` - equals (attribute exists and has a matching value) - `is_not` - not equals (attribute exists and has a different value)

#### Existence Operators - `is_set` - is set (attribute exists) - `is_not_set` - is not set (attribute does not exist)

#### Multiple Value Operators - `is_one_of` - is any of (attribute exists and has a value that is in the specified values) - `is_not_one_of` - is not any of (attribute exists and has a value that is not in the specified values)

#### Comparison Operators - `gt` - greater than - `lt` - less than - `gte` - greater than or equal - `lte` - less than or equal

#### Pattern Matching Operators - `matches` - match regex expression (attribute exists and matches the regular expression) - `does_not_match` - does not match regex expression (attribute exists and does not match the regular expression)

#### String Operators - `contains` - contains (attribute exists and contains the specified value) - `does_not_contain` - does not contain (attribute exists and does not contain the specified value) - `starts_with` - starts with (attribute exists and starts with the specified value) - `does_not_start_with` - does not start with (attribute exists and does not start with the specified value) - `ends_with` - ends with (attribute exists and ends with the specified value) - `does_not_end_with` - does not end with (attribute exists and does not end with the specified value)

#### Special Operators - `is_any` - matches any value, ignoring whether the key exists or not

const (
	AttributeFilterOperatorContains         AttributeFilterOperator = "contains"
	AttributeFilterOperatorDoesNotContain   AttributeFilterOperator = "does_not_contain"
	AttributeFilterOperatorDoesNotEndWith   AttributeFilterOperator = "does_not_end_with"
	AttributeFilterOperatorDoesNotMatch     AttributeFilterOperator = "does_not_match"
	AttributeFilterOperatorDoesNotStartWith AttributeFilterOperator = "does_not_start_with"
	AttributeFilterOperatorEndsWith         AttributeFilterOperator = "ends_with"
	AttributeFilterOperatorGt               AttributeFilterOperator = "gt"
	AttributeFilterOperatorGte              AttributeFilterOperator = "gte"
	AttributeFilterOperatorIs               AttributeFilterOperator = "is"
	AttributeFilterOperatorIsAny            AttributeFilterOperator = "is_any"
	AttributeFilterOperatorIsNot            AttributeFilterOperator = "is_not"
	AttributeFilterOperatorIsNotOneOf       AttributeFilterOperator = "is_not_one_of"
	AttributeFilterOperatorIsNotSet         AttributeFilterOperator = "is_not_set"
	AttributeFilterOperatorIsOneOf          AttributeFilterOperator = "is_one_of"
	AttributeFilterOperatorIsSet            AttributeFilterOperator = "is_set"
	AttributeFilterOperatorLt               AttributeFilterOperator = "lt"
	AttributeFilterOperatorLte              AttributeFilterOperator = "lte"
	AttributeFilterOperatorMatches          AttributeFilterOperator = "matches"
	AttributeFilterOperatorStartsWith       AttributeFilterOperator = "starts_with"
)

Defines values for AttributeFilterOperator.

type AttributeFilterStringValue

type AttributeFilterStringValue = string

AttributeFilterStringValue AttributeFilterStringValue may contain a primitive value such as a regex pattern or string.

type AttributeFilter_Value

type AttributeFilter_Value struct {
	// contains filtered or unexported fields
}

AttributeFilter_Value defines model for AttributeFilter.Value.

func (AttributeFilter_Value) AsAttributeFilterAnyValue

func (t AttributeFilter_Value) AsAttributeFilterAnyValue() (AttributeFilterAnyValue, error)

AsAttributeFilterAnyValue returns the union data inside the AttributeFilter_Value as a AttributeFilterAnyValue

func (AttributeFilter_Value) AsAttributeFilterStringValue

func (t AttributeFilter_Value) AsAttributeFilterStringValue() (AttributeFilterStringValue, error)

AsAttributeFilterStringValue returns the union data inside the AttributeFilter_Value as a AttributeFilterStringValue

func (*AttributeFilter_Value) FromAttributeFilterAnyValue

func (t *AttributeFilter_Value) FromAttributeFilterAnyValue(v AttributeFilterAnyValue) error

FromAttributeFilterAnyValue overwrites any union data inside the AttributeFilter_Value as the provided AttributeFilterAnyValue

func (*AttributeFilter_Value) FromAttributeFilterStringValue

func (t *AttributeFilter_Value) FromAttributeFilterStringValue(v AttributeFilterStringValue) error

FromAttributeFilterStringValue overwrites any union data inside the AttributeFilter_Value as the provided AttributeFilterStringValue

func (AttributeFilter_Value) MarshalJSON

func (t AttributeFilter_Value) MarshalJSON() ([]byte, error)

func (*AttributeFilter_Value) MergeAttributeFilterAnyValue

func (t *AttributeFilter_Value) MergeAttributeFilterAnyValue(v AttributeFilterAnyValue) error

MergeAttributeFilterAnyValue performs a merge with any union data inside the AttributeFilter_Value, using the provided AttributeFilterAnyValue

func (*AttributeFilter_Value) MergeAttributeFilterStringValue

func (t *AttributeFilter_Value) MergeAttributeFilterStringValue(v AttributeFilterStringValue) error

MergeAttributeFilterStringValue performs a merge with any union data inside the AttributeFilter_Value, using the provided AttributeFilterStringValue

func (*AttributeFilter_Value) UnmarshalJSON

func (t *AttributeFilter_Value) UnmarshalJSON(b []byte) error

type AttributeFilter_Values_Item

type AttributeFilter_Values_Item struct {
	// contains filtered or unexported fields
}

AttributeFilter_Values_Item defines model for AttributeFilter.values.Item.

func (AttributeFilter_Values_Item) AsAttributeFilterAnyValue

func (t AttributeFilter_Values_Item) AsAttributeFilterAnyValue() (AttributeFilterAnyValue, error)

AsAttributeFilterAnyValue returns the union data inside the AttributeFilter_Values_Item as a AttributeFilterAnyValue

func (AttributeFilter_Values_Item) AsAttributeFilterStringValue

func (t AttributeFilter_Values_Item) AsAttributeFilterStringValue() (AttributeFilterStringValue, error)

AsAttributeFilterStringValue returns the union data inside the AttributeFilter_Values_Item as a AttributeFilterStringValue

func (*AttributeFilter_Values_Item) FromAttributeFilterAnyValue

func (t *AttributeFilter_Values_Item) FromAttributeFilterAnyValue(v AttributeFilterAnyValue) error

FromAttributeFilterAnyValue overwrites any union data inside the AttributeFilter_Values_Item as the provided AttributeFilterAnyValue

func (*AttributeFilter_Values_Item) FromAttributeFilterStringValue

func (t *AttributeFilter_Values_Item) FromAttributeFilterStringValue(v AttributeFilterStringValue) error

FromAttributeFilterStringValue overwrites any union data inside the AttributeFilter_Values_Item as the provided AttributeFilterStringValue

func (AttributeFilter_Values_Item) MarshalJSON

func (t AttributeFilter_Values_Item) MarshalJSON() ([]byte, error)

func (*AttributeFilter_Values_Item) MergeAttributeFilterAnyValue

func (t *AttributeFilter_Values_Item) MergeAttributeFilterAnyValue(v AttributeFilterAnyValue) error

MergeAttributeFilterAnyValue performs a merge with any union data inside the AttributeFilter_Values_Item, using the provided AttributeFilterAnyValue

func (*AttributeFilter_Values_Item) MergeAttributeFilterStringValue

func (t *AttributeFilter_Values_Item) MergeAttributeFilterStringValue(v AttributeFilterStringValue) error

MergeAttributeFilterStringValue performs a merge with any union data inside the AttributeFilter_Values_Item, using the provided AttributeFilterStringValue

func (*AttributeFilter_Values_Item) UnmarshalJSON

func (t *AttributeFilter_Values_Item) UnmarshalJSON(b []byte) error

type AuthTokenProvider added in v1.21.0

type AuthTokenProvider interface {
	// AuthToken returns the bearer token to authenticate the next request.
	// The returned token must start with "auth_" or "dash0_at_"; the client
	// rejects anything else before the request leaves the process.
	AuthToken(ctx context.Context) (string, error)
}

AuthTokenProvider supplies the bearer token used to authenticate a Dash0 API request. The client calls AuthTokenProvider.AuthToken once per request rather than caching a token for the client's lifetime, so a provider backed by a short-lived credential can renew it without the caller rebuilding the client.

Implementations must be safe for concurrent use: the client issues up to MaxConcurrentRequests requests in parallel, and each one asks for a token.

func StaticAuthTokenProvider added in v1.21.0

func StaticAuthTokenProvider(authToken string) AuthTokenProvider

StaticAuthTokenProvider adapts a fixed auth token to AuthTokenProvider. It exists so the request path has a single code path for authentication regardless of whether the caller supplied a static token or a renewing one.

The returned provider deliberately does not implement RefreshingAuthTokenProvider: a static token cannot be refreshed, so a 401 is surfaced to the caller instead of being retried.

Example
package main

import (
	"context"
	"fmt"
	"log"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	provider := dash0.StaticAuthTokenProvider("auth_yourtoken")

	authToken, err := provider.AuthToken(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(authToken)
}
Output:
auth_yourtoken

type AuthorizeURLParams added in v1.15.0

type AuthorizeURLParams struct {
	// ResponseType must be [OAuthResponseTypeCode].
	// Defaults to [OAuthResponseTypeCode] when empty.
	ResponseType OAuthResponseType

	// ClientID is the client identifier obtained during registration.
	ClientID string

	// RedirectURI must match one of the client's registered redirect URIs.
	RedirectURI string

	// Scope is an optional space-separated list of requested scopes.
	Scope *string

	// State is an opaque value bound to the request for CSRF protection
	// (RFC 6749 §10.12); the authorization server returns it unchanged in
	// the redirect.
	// State is mandatory: use [GenerateOAuthState] to produce a fresh value.
	State string

	// CodeChallenge is the PKCE code challenge (RFC 7636).
	CodeChallenge string

	// CodeChallengeMethod must be [OAuthCodeChallengeMethodS256].
	// Defaults to [OAuthCodeChallengeMethodS256] when empty.
	CodeChallengeMethod OAuthCodeChallengeMethod

	// Prompt is an optional space-separated list of prompt directives.
	// Supported value: "consent".
	Prompt *string
}

AuthorizeURLParams contains the parameters for building an OAuth 2.0 authorization URL.

type AxisScale

type AxisScale string

AxisScale defines model for AxisScale.

const (
	AxisScaleLinear AxisScale = "linear"
	AxisScaleLog10  AxisScale = "log10"
)

Defines values for AxisScale.

type CheckThresholds

type CheckThresholds struct {
	// Degraded The threshold value that defines when the check is in a degraded state. The value will be
	// interpolated into the expression field as `$__threshold`.
	Degraded *float64 `json:"degraded,omitempty"`

	// Failed The threshold value that defines when the check is in a failed state. The value will be
	// interpolated into the expression field as `$__threshold`.
	Failed *float64 `json:"failed,omitempty"`
}

CheckThresholds Thresholds to use for the `$__threshold` variable in the expression field.

type Client

type Client interface {
	// Dashboards
	ListDashboards(ctx context.Context, dataset *string) ([]*DashboardApiListItem, error)
	GetDashboard(ctx context.Context, originOrID string, dataset *string) (*DashboardDefinition, error)
	CreateDashboard(ctx context.Context, dashboard *DashboardDefinition, dataset *string) (*DashboardDefinition, error)
	UpdateDashboard(ctx context.Context, originOrID string, dashboard *DashboardDefinition, dataset *string) (*DashboardDefinition, error)
	DeleteDashboard(ctx context.Context, originOrID string, dataset *string) error
	ListDashboardsIter(ctx context.Context, dataset *string) *Iter[DashboardApiListItem]

	// Check Rules
	ListCheckRules(ctx context.Context, dataset *string) ([]*PrometheusAlertRuleApiListItem, error)
	GetCheckRule(ctx context.Context, originOrID string, dataset *string) (*PrometheusAlertRule, error)
	CreateCheckRule(ctx context.Context, rule *PrometheusAlertRule, dataset *string) (*PrometheusAlertRule, error)
	UpdateCheckRule(ctx context.Context, originOrID string, rule *PrometheusAlertRule, dataset *string) (*PrometheusAlertRule, error)
	DeleteCheckRule(ctx context.Context, originOrID string, dataset *string) error
	ListCheckRulesIter(ctx context.Context, dataset *string) *Iter[PrometheusAlertRuleApiListItem]

	// Synthetic Checks
	ListSyntheticChecks(ctx context.Context, dataset *string) ([]*SyntheticChecksApiListItem, error)
	GetSyntheticCheck(ctx context.Context, originOrID string, dataset *string) (*SyntheticCheckDefinition, error)
	CreateSyntheticCheck(ctx context.Context, check *SyntheticCheckDefinition, dataset *string) (*SyntheticCheckDefinition, error)
	UpdateSyntheticCheck(ctx context.Context, originOrID string, check *SyntheticCheckDefinition, dataset *string) (*SyntheticCheckDefinition, error)
	DeleteSyntheticCheck(ctx context.Context, originOrID string, dataset *string) error
	ListSyntheticChecksIter(ctx context.Context, dataset *string) *Iter[SyntheticChecksApiListItem]

	// SLOs
	ListSLOs(ctx context.Context, dataset *string) ([]*SloDefinition, error)
	GetSLO(ctx context.Context, originOrID string, dataset *string) (*SloDefinition, error)
	CreateSLO(ctx context.Context, slo *SloDefinition, dataset *string) (*SloDefinition, error)
	UpdateSLO(ctx context.Context, originOrID string, slo *SloDefinition, dataset *string) (*SloDefinition, error)
	DeleteSLO(ctx context.Context, originOrID string, dataset *string) error
	ListSLOsIter(ctx context.Context, dataset *string) *Iter[SloDefinition]

	// Views
	ListViews(ctx context.Context, dataset *string) ([]*ViewApiListItem, error)
	GetView(ctx context.Context, originOrID string, dataset *string) (*ViewDefinition, error)
	CreateView(ctx context.Context, view *ViewDefinition, dataset *string) (*ViewDefinition, error)
	UpdateView(ctx context.Context, originOrID string, view *ViewDefinition, dataset *string) (*ViewDefinition, error)
	DeleteView(ctx context.Context, originOrID string, dataset *string) error
	ListViewsIter(ctx context.Context, dataset *string) *Iter[ViewApiListItem]

	// Sampling Rules
	ListSamplingRules(ctx context.Context, dataset *string) ([]*SamplingDefinition, error)
	GetSamplingRule(ctx context.Context, originOrID string, dataset *string) (*SamplingDefinition, error)
	CreateSamplingRule(ctx context.Context, rule *SamplingDefinition, dataset *string) (*SamplingDefinition, error)
	UpdateSamplingRule(ctx context.Context, originOrID string, rule *SamplingDefinition, dataset *string) (*SamplingDefinition, error)
	DeleteSamplingRule(ctx context.Context, originOrID string, dataset *string) error
	ListSamplingRulesIter(ctx context.Context, dataset *string) *Iter[SamplingDefinition]

	// Members
	ListMembers(ctx context.Context) ([]*MemberDefinition, error)
	InviteMember(ctx context.Context, request *InviteMemberRequest) error
	DeleteMember(ctx context.Context, memberID string) error
	ListMembersIter(ctx context.Context) *Iter[MemberDefinition]

	// Teams
	ListTeams(ctx context.Context) ([]*TeamsListItem, error)
	CreateTeam(ctx context.Context, team *TeamDefinitionV1Alpha1) (*TeamDefinitionV1Alpha1, error)
	UpsertTeam(ctx context.Context, originOrID string, team *TeamDefinitionV1Alpha1) (*TeamDefinitionV1Alpha1, error)
	GetTeam(ctx context.Context, originOrID string) (*TeamDefinitionV1Alpha1, error)
	GetTeamWithAssets(ctx context.Context, originOrID string) (*GetTeamResponse, error)
	DeleteTeam(ctx context.Context, originOrID string) error
	UpdateTeamDisplay(ctx context.Context, originOrID string, display *TeamDisplay) error
	AddTeamMembers(ctx context.Context, originOrID string, request *AddTeamMembersRequest) error
	RemoveTeamMember(ctx context.Context, originOrID string, memberID string) error
	ListTeamsIter(ctx context.Context) *Iter[TeamsListItem]
	ResolveMemberIDsToEmails(ctx context.Context, ids []string) ([]string, error)

	// Recording Rules
	ListRecordingRules(ctx context.Context, dataset *string) ([]*RecordingRule, error)
	GetRecordingRule(ctx context.Context, originOrID string, dataset *string) (*RecordingRule, error)
	CreateRecordingRule(ctx context.Context, rule *RecordingRule, dataset *string) (*RecordingRule, error)
	UpdateRecordingRule(ctx context.Context, originOrID string, rule *RecordingRule, dataset *string) (*RecordingRule, error)
	DeleteRecordingRule(ctx context.Context, originOrID string, dataset *string) error
	ListRecordingRulesIter(ctx context.Context, dataset *string) *Iter[RecordingRule]

	// Notification Channels
	ListNotificationChannels(ctx context.Context) ([]*NotificationChannelDefinition, error)
	GetNotificationChannel(ctx context.Context, originOrID string) (*NotificationChannelDefinition, error)
	CreateNotificationChannel(ctx context.Context, channel *NotificationChannelDefinition) (*NotificationChannelDefinition, error)
	UpdateNotificationChannel(ctx context.Context, originOrID string, channel *NotificationChannelDefinition) (*NotificationChannelDefinition, error)
	DeleteNotificationChannel(ctx context.Context, originOrID string) error
	ListNotificationChannelsIter(ctx context.Context) *Iter[NotificationChannelDefinition]

	// Spam Filters. The read endpoint returns whichever version is stored, so
	// GetSpamFilter exposes the result through the SpamFilterObject marker for
	// the caller to type-switch on. The list endpoint returns items in the
	// same native shape; ListSpamFilters keeps the v1alpha1 shape for backward
	// compatibility (v1alpha2 entries lose their spec.context scalar), while
	// ListSpamFilterObjects exposes the union. The version sent on
	// Create/Update is a caller choice, so v1alpha1 and v1alpha2 are exposed
	// as typed sibling methods. Delete is version-agnostic.
	ListSpamFilters(ctx context.Context, dataset *string) ([]*SpamFilter, error)
	ListSpamFilterObjects(ctx context.Context, dataset *string) ([]SpamFilterObject, error)
	GetSpamFilter(ctx context.Context, originOrID string, dataset *string) (SpamFilterObject, error)
	CreateSpamFilter(ctx context.Context, filter *SpamFilter, dataset *string) (*SpamFilter, error)
	UpdateSpamFilter(ctx context.Context, originOrID string, filter *SpamFilter, dataset *string) (*SpamFilter, error)
	CreateSpamFilterV1Alpha2(ctx context.Context, filter *SpamFilterV1Alpha2, dataset *string) (*SpamFilterV1Alpha2, error)
	UpdateSpamFilterV1Alpha2(ctx context.Context, originOrID string, filter *SpamFilterV1Alpha2, dataset *string) (*SpamFilterV1Alpha2, error)
	DeleteSpamFilter(ctx context.Context, originOrID string, dataset *string) error
	ListSpamFiltersIter(ctx context.Context, dataset *string) *Iter[SpamFilter]

	// Spans
	GetSpans(ctx context.Context, request *GetSpansRequest) (*GetSpansResponse, error)
	GetSpansIter(ctx context.Context, request *GetSpansRequest) *Iter[ResourceSpans]

	// Logs
	GetLogRecords(ctx context.Context, request *GetLogRecordsRequest) (*GetLogRecordsResponse, error)
	GetLogRecordsIter(ctx context.Context, request *GetLogRecordsRequest) *Iter[ResourceLogs]

	// Failed Checks
	GetFailedChecks(ctx context.Context, request *GetFailedChecksRequest) (*GetFailedChecksResponse, error)
	GetFailedChecksIter(ctx context.Context, request *GetFailedChecksRequest) *Iter[Issue]

	// Import
	ImportCheckRule(ctx context.Context, rule *PrometheusAlertRule, dataset *string) (*PrometheusAlertRule, error)
	ImportDashboard(ctx context.Context, dashboard *DashboardDefinition, dataset *string) (*DashboardDefinition, error)
	ImportSyntheticCheck(ctx context.Context, check *SyntheticCheckDefinition, dataset *string) (*SyntheticCheckDefinition, error)
	ImportView(ctx context.Context, view *ViewDefinition, dataset *string) (*ViewDefinition, error)

	// OTLP
	SendLogs(ctx context.Context, logs plog.Logs, dataset *string) error
	SendMetrics(ctx context.Context, metrics pmetric.Metrics, dataset *string) error
	SendTraces(ctx context.Context, traces ptrace.Traces, dataset *string) error

	// Close releases resources associated with the client. Callers should
	// call Close when the client is no longer needed.
	Close(ctx context.Context) error

	// Inner returns the underlying generated client for advanced use cases.
	Inner() *ClientWithResponses
}

Client defines the Dash0 API client interface. Use NewClient to create a concrete implementation.

func NewClient

func NewClient(opts ...ClientOption) (Client, error)

NewClient creates a new Dash0 API client.

Required options:

  • WithAuthToken: The auth token for authentication
  • At least one of WithApiUrl or WithOtlpEndpoint

Example:

client, err := dash0.NewClient(
    dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
    dash0.WithAuthToken("your-auth-token"),
)
Example (ApiAndOtlp)
package main

import (
	"context"
	"log"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	client, err := dash0.NewClient(
		dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
		dash0.WithOtlpEndpoint(dash0.OtlpEncodingJson, "https://ingress.eu-west-1.aws.dash0.com"),
		dash0.WithAuthToken("auth_yourtoken"),
	)
	if err != nil {
		log.Fatal(err)
	}
	defer func() { _ = client.Close(context.Background()) }()
	_ = client
}
Example (ApiOnly)
package main

import (
	"context"
	"fmt"
	"log"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	client, err := dash0.NewClient(
		dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
		dash0.WithAuthToken("auth_yourtoken"),
	)
	if err != nil {
		log.Fatal(err)
	}
	defer func() { _ = client.Close(context.Background()) }()

	dashboards, err := client.ListDashboards(context.Background(), nil)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Found %d dashboards\n", len(dashboards))
}
Example (FromProfile)
package main

import (
	"context"
	"fmt"
	"log"

	dash0 "github.com/dash0hq/dash0-api-client-go"
	"github.com/dash0hq/dash0-api-client-go/profiles"
)

func main() {
	cfg, err := profiles.ResolveConfiguration("", "")
	if err != nil {
		log.Fatal(err)
	}

	opts := append(cfg.ClientOptions(), dash0.WithUserAgent("my-tool/1.0"))
	client, err := dash0.NewClient(opts...)
	if err != nil {
		log.Fatal(err)
	}
	defer func() { _ = client.Close(context.Background()) }()

	dashboards, err := client.ListDashboards(context.Background(), cfg.DatasetPtr())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Found %d dashboards\n", len(dashboards))
}

type ClientInterface

type ClientInterface interface {
	// GetWellKnownOauthAuthorizationServer request
	GetWellKnownOauthAuthorizationServer(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetWellKnownOauthProtectedResource request
	GetWellKnownOauthProtectedResource(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiAgenticWorkflows request
	GetApiAgenticWorkflows(ctx context.Context, params *GetApiAgenticWorkflowsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiAgenticWorkflowsWithBody request with any body
	PostApiAgenticWorkflowsWithBody(ctx context.Context, params *PostApiAgenticWorkflowsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiAgenticWorkflows(ctx context.Context, params *PostApiAgenticWorkflowsParams, body PostApiAgenticWorkflowsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiAgenticWorkflowsOriginOrId request
	DeleteApiAgenticWorkflowsOriginOrId(ctx context.Context, originOrId string, params *DeleteApiAgenticWorkflowsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiAgenticWorkflowsOriginOrId request
	GetApiAgenticWorkflowsOriginOrId(ctx context.Context, originOrId string, params *GetApiAgenticWorkflowsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiAgenticWorkflowsOriginOrIdWithBody request with any body
	PutApiAgenticWorkflowsOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiAgenticWorkflowsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiAgenticWorkflowsOriginOrId(ctx context.Context, originOrId string, params *PutApiAgenticWorkflowsOriginOrIdParams, body PutApiAgenticWorkflowsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiAlertingCheckRules request
	GetApiAlertingCheckRules(ctx context.Context, params *GetApiAlertingCheckRulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiAlertingCheckRulesWithBody request with any body
	PostApiAlertingCheckRulesWithBody(ctx context.Context, params *PostApiAlertingCheckRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiAlertingCheckRules(ctx context.Context, params *PostApiAlertingCheckRulesParams, body PostApiAlertingCheckRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiAlertingCheckRulesBulkWithBody request with any body
	PostApiAlertingCheckRulesBulkWithBody(ctx context.Context, params *PostApiAlertingCheckRulesBulkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiAlertingCheckRulesBulk(ctx context.Context, params *PostApiAlertingCheckRulesBulkParams, body PostApiAlertingCheckRulesBulkJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiAlertingCheckRulesOriginOrId request
	DeleteApiAlertingCheckRulesOriginOrId(ctx context.Context, originOrId string, params *DeleteApiAlertingCheckRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiAlertingCheckRulesOriginOrId request
	GetApiAlertingCheckRulesOriginOrId(ctx context.Context, originOrId string, params *GetApiAlertingCheckRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiAlertingCheckRulesOriginOrIdWithBody request with any body
	PutApiAlertingCheckRulesOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiAlertingCheckRulesOriginOrId(ctx context.Context, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, body PutApiAlertingCheckRulesOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiDashboards request
	GetApiDashboards(ctx context.Context, params *GetApiDashboardsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiDashboardsWithBody request with any body
	PostApiDashboardsWithBody(ctx context.Context, params *PostApiDashboardsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiDashboards(ctx context.Context, params *PostApiDashboardsParams, body PostApiDashboardsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiDashboardsOriginOrId request
	DeleteApiDashboardsOriginOrId(ctx context.Context, originOrId string, params *DeleteApiDashboardsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiDashboardsOriginOrId request
	GetApiDashboardsOriginOrId(ctx context.Context, originOrId string, params *GetApiDashboardsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiDashboardsOriginOrIdWithBody request with any body
	PutApiDashboardsOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiDashboardsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiDashboardsOriginOrId(ctx context.Context, originOrId string, params *PutApiDashboardsOriginOrIdParams, body PutApiDashboardsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiEdgeSettings request
	GetApiEdgeSettings(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiImportCheckRuleWithBody request with any body
	PostApiImportCheckRuleWithBody(ctx context.Context, params *PostApiImportCheckRuleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiImportCheckRule(ctx context.Context, params *PostApiImportCheckRuleParams, body PostApiImportCheckRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiImportCheckRulesWithBody request with any body
	PostApiImportCheckRulesWithBody(ctx context.Context, params *PostApiImportCheckRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiImportCheckRules(ctx context.Context, params *PostApiImportCheckRulesParams, body PostApiImportCheckRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiImportDashboardWithBody request with any body
	PostApiImportDashboardWithBody(ctx context.Context, params *PostApiImportDashboardParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiImportDashboard(ctx context.Context, params *PostApiImportDashboardParams, body PostApiImportDashboardJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiImportSignalToMetricsWithBody request with any body
	PutApiImportSignalToMetricsWithBody(ctx context.Context, params *PutApiImportSignalToMetricsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiImportSignalToMetrics(ctx context.Context, params *PutApiImportSignalToMetricsParams, body PutApiImportSignalToMetricsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiImportSyntheticCheckWithBody request with any body
	PostApiImportSyntheticCheckWithBody(ctx context.Context, params *PostApiImportSyntheticCheckParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiImportSyntheticCheck(ctx context.Context, params *PostApiImportSyntheticCheckParams, body PostApiImportSyntheticCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiImportViewWithBody request with any body
	PostApiImportViewWithBody(ctx context.Context, params *PostApiImportViewParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiImportView(ctx context.Context, params *PostApiImportViewParams, body PostApiImportViewJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiLogsWithBody request with any body
	PostApiLogsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiLogs(ctx context.Context, body PostApiLogsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiLogsDownloadWithBody request with any body
	PostApiLogsDownloadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiLogsDownload(ctx context.Context, body PostApiLogsDownloadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiMembers request
	GetApiMembers(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiMembersWithBody request with any body
	PostApiMembersWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiMembers(ctx context.Context, body PostApiMembersJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiMembersMemberID request
	DeleteApiMembersMemberID(ctx context.Context, memberID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiNotificationChannels request
	GetApiNotificationChannels(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiNotificationChannelsWithBody request with any body
	PostApiNotificationChannelsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiNotificationChannels(ctx context.Context, body PostApiNotificationChannelsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiNotificationChannelsOriginOrId request
	DeleteApiNotificationChannelsOriginOrId(ctx context.Context, originOrId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiNotificationChannelsOriginOrId request
	GetApiNotificationChannelsOriginOrId(ctx context.Context, originOrId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiNotificationChannelsOriginOrIdWithBody request with any body
	PutApiNotificationChannelsOriginOrIdWithBody(ctx context.Context, originOrId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiNotificationChannelsOriginOrId(ctx context.Context, originOrId string, body PutApiNotificationChannelsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiPrometheusApiV1FormatQuery request
	GetApiPrometheusApiV1FormatQuery(ctx context.Context, params *GetApiPrometheusApiV1FormatQueryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiPrometheusApiV1FormatQueryWithBody request with any body
	PostApiPrometheusApiV1FormatQueryWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiPrometheusApiV1FormatQuery(ctx context.Context, body PostApiPrometheusApiV1FormatQueryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiPrometheusApiV1LabelLabelNameValues request
	GetApiPrometheusApiV1LabelLabelNameValues(ctx context.Context, labelName string, params *GetApiPrometheusApiV1LabelLabelNameValuesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiPrometheusApiV1LabelLabelNameValuesWithBody request with any body
	PostApiPrometheusApiV1LabelLabelNameValuesWithBody(ctx context.Context, labelName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiPrometheusApiV1LabelLabelNameValues(ctx context.Context, labelName string, body PostApiPrometheusApiV1LabelLabelNameValuesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiPrometheusApiV1Labels request
	GetApiPrometheusApiV1Labels(ctx context.Context, params *GetApiPrometheusApiV1LabelsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiPrometheusApiV1LabelsWithBody request with any body
	PostApiPrometheusApiV1LabelsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiPrometheusApiV1Labels(ctx context.Context, body PostApiPrometheusApiV1LabelsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiPrometheusApiV1Metadata request
	GetApiPrometheusApiV1Metadata(ctx context.Context, params *GetApiPrometheusApiV1MetadataParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiPrometheusApiV1MetadataWithBody request with any body
	PostApiPrometheusApiV1MetadataWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiPrometheusApiV1Metadata(ctx context.Context, body PostApiPrometheusApiV1MetadataJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiPrometheusApiV1Query request
	GetApiPrometheusApiV1Query(ctx context.Context, params *GetApiPrometheusApiV1QueryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiPrometheusApiV1QueryWithBody request with any body
	PostApiPrometheusApiV1QueryWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiPrometheusApiV1Query(ctx context.Context, body PostApiPrometheusApiV1QueryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiPrometheusApiV1QueryRange request
	GetApiPrometheusApiV1QueryRange(ctx context.Context, params *GetApiPrometheusApiV1QueryRangeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiPrometheusApiV1QueryRangeWithBody request with any body
	PostApiPrometheusApiV1QueryRangeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiPrometheusApiV1QueryRange(ctx context.Context, body PostApiPrometheusApiV1QueryRangeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiPrometheusApiV1Series request
	GetApiPrometheusApiV1Series(ctx context.Context, params *GetApiPrometheusApiV1SeriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiPrometheusApiV1SeriesWithBody request with any body
	PostApiPrometheusApiV1SeriesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiPrometheusApiV1Series(ctx context.Context, body PostApiPrometheusApiV1SeriesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiPrometheusApiV1StatusBuildinfo request
	GetApiPrometheusApiV1StatusBuildinfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiPrometheusApiV1StatusRuntimeinfo request
	GetApiPrometheusApiV1StatusRuntimeinfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiRecordingRules request
	GetApiRecordingRules(ctx context.Context, params *GetApiRecordingRulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiRecordingRulesWithBody request with any body
	PostApiRecordingRulesWithBody(ctx context.Context, params *PostApiRecordingRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiRecordingRules(ctx context.Context, params *PostApiRecordingRulesParams, body PostApiRecordingRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiRecordingRulesOriginOrId request
	DeleteApiRecordingRulesOriginOrId(ctx context.Context, originOrId string, params *DeleteApiRecordingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiRecordingRulesOriginOrId request
	GetApiRecordingRulesOriginOrId(ctx context.Context, originOrId string, params *GetApiRecordingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiRecordingRulesOriginOrIdWithBody request with any body
	PutApiRecordingRulesOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiRecordingRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiRecordingRulesOriginOrId(ctx context.Context, originOrId string, params *PutApiRecordingRulesOriginOrIdParams, body PutApiRecordingRulesOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSamplingRules request
	GetApiSamplingRules(ctx context.Context, params *GetApiSamplingRulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSamplingRulesWithBody request with any body
	PostApiSamplingRulesWithBody(ctx context.Context, params *PostApiSamplingRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSamplingRules(ctx context.Context, params *PostApiSamplingRulesParams, body PostApiSamplingRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiSamplingRulesOriginOrId request
	DeleteApiSamplingRulesOriginOrId(ctx context.Context, originOrId string, params *DeleteApiSamplingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSamplingRulesOriginOrId request
	GetApiSamplingRulesOriginOrId(ctx context.Context, originOrId string, params *GetApiSamplingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiSamplingRulesOriginOrIdWithBody request with any body
	PutApiSamplingRulesOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiSamplingRulesOriginOrId(ctx context.Context, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, body PutApiSamplingRulesOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSignalToMetrics request
	GetApiSignalToMetrics(ctx context.Context, params *GetApiSignalToMetricsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSignalToMetricsWithBody request with any body
	PostApiSignalToMetricsWithBody(ctx context.Context, params *PostApiSignalToMetricsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSignalToMetrics(ctx context.Context, params *PostApiSignalToMetricsParams, body PostApiSignalToMetricsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSignalToMetricsTestWithBody request with any body
	PostApiSignalToMetricsTestWithBody(ctx context.Context, params *PostApiSignalToMetricsTestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSignalToMetricsTest(ctx context.Context, params *PostApiSignalToMetricsTestParams, body PostApiSignalToMetricsTestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiSignalToMetricsOriginOrId request
	DeleteApiSignalToMetricsOriginOrId(ctx context.Context, originOrId string, params *DeleteApiSignalToMetricsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSignalToMetricsOriginOrId request
	GetApiSignalToMetricsOriginOrId(ctx context.Context, originOrId string, params *GetApiSignalToMetricsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiSignalToMetricsOriginOrIdWithBody request with any body
	PutApiSignalToMetricsOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiSignalToMetricsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiSignalToMetricsOriginOrId(ctx context.Context, originOrId string, params *PutApiSignalToMetricsOriginOrIdParams, body PutApiSignalToMetricsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSlos request
	GetApiSlos(ctx context.Context, params *GetApiSlosParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSlosWithBody request with any body
	PostApiSlosWithBody(ctx context.Context, params *PostApiSlosParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSlos(ctx context.Context, params *PostApiSlosParams, body PostApiSlosJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiSlosOriginOrId request
	DeleteApiSlosOriginOrId(ctx context.Context, originOrId string, params *DeleteApiSlosOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSlosOriginOrId request
	GetApiSlosOriginOrId(ctx context.Context, originOrId string, params *GetApiSlosOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiSlosOriginOrIdWithBody request with any body
	PutApiSlosOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiSlosOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiSlosOriginOrId(ctx context.Context, originOrId string, params *PutApiSlosOriginOrIdParams, body PutApiSlosOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSpamFilters request
	GetApiSpamFilters(ctx context.Context, params *GetApiSpamFiltersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSpamFiltersWithBody request with any body
	PostApiSpamFiltersWithBody(ctx context.Context, params *PostApiSpamFiltersParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSpamFilters(ctx context.Context, params *PostApiSpamFiltersParams, body PostApiSpamFiltersJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiSpamFiltersOriginOrId request
	DeleteApiSpamFiltersOriginOrId(ctx context.Context, originOrId string, params *DeleteApiSpamFiltersOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSpamFiltersOriginOrId request
	GetApiSpamFiltersOriginOrId(ctx context.Context, originOrId string, params *GetApiSpamFiltersOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiSpamFiltersOriginOrIdWithBody request with any body
	PutApiSpamFiltersOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiSpamFiltersOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiSpamFiltersOriginOrId(ctx context.Context, originOrId string, params *PutApiSpamFiltersOriginOrIdParams, body PutApiSpamFiltersOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSpansWithBody request with any body
	PostApiSpansWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSpans(ctx context.Context, body PostApiSpansJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSpansDownloadWithBody request with any body
	PostApiSpansDownloadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSpansDownload(ctx context.Context, body PostApiSpansDownloadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSqlWithBody request with any body
	PostApiSqlWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSql(ctx context.Context, body PostApiSqlJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSyntheticChecks request
	GetApiSyntheticChecks(ctx context.Context, params *GetApiSyntheticChecksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSyntheticChecksWithBody request with any body
	PostApiSyntheticChecksWithBody(ctx context.Context, params *PostApiSyntheticChecksParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSyntheticChecks(ctx context.Context, params *PostApiSyntheticChecksParams, body PostApiSyntheticChecksJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSyntheticChecksLocations request
	GetApiSyntheticChecksLocations(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSyntheticChecksTestWithBody request with any body
	PostApiSyntheticChecksTestWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSyntheticChecksTest(ctx context.Context, body PostApiSyntheticChecksTestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiSyntheticChecksOriginOrId request
	DeleteApiSyntheticChecksOriginOrId(ctx context.Context, originOrId string, params *DeleteApiSyntheticChecksOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSyntheticChecksOriginOrId request
	GetApiSyntheticChecksOriginOrId(ctx context.Context, originOrId string, params *GetApiSyntheticChecksOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiSyntheticChecksOriginOrIdWithBody request with any body
	PutApiSyntheticChecksOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiSyntheticChecksOriginOrId(ctx context.Context, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, body PutApiSyntheticChecksOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiTeams request
	GetApiTeams(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiTeamsWithBody request with any body
	PostApiTeamsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiTeams(ctx context.Context, body PostApiTeamsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiTeamsOriginOrId request
	DeleteApiTeamsOriginOrId(ctx context.Context, originOrId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiTeamsOriginOrId request
	GetApiTeamsOriginOrId(ctx context.Context, originOrId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiTeamsOriginOrIdWithBody request with any body
	PutApiTeamsOriginOrIdWithBody(ctx context.Context, originOrId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiTeamsOriginOrId(ctx context.Context, originOrId string, body PutApiTeamsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiTeamsOriginOrIdDisplayWithBody request with any body
	PutApiTeamsOriginOrIdDisplayWithBody(ctx context.Context, originOrId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiTeamsOriginOrIdDisplay(ctx context.Context, originOrId string, body PutApiTeamsOriginOrIdDisplayJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiTeamsOriginOrIdMembersWithBody request with any body
	PostApiTeamsOriginOrIdMembersWithBody(ctx context.Context, originOrId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiTeamsOriginOrIdMembers(ctx context.Context, originOrId string, body PostApiTeamsOriginOrIdMembersJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiTeamsOriginOrIdMembersMemberID request
	DeleteApiTeamsOriginOrIdMembersMemberID(ctx context.Context, originOrId string, memberID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiTimeSeriesAggregations request
	GetApiTimeSeriesAggregations(ctx context.Context, params *GetApiTimeSeriesAggregationsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiTimeSeriesAggregationsWithBody request with any body
	PostApiTimeSeriesAggregationsWithBody(ctx context.Context, params *PostApiTimeSeriesAggregationsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiTimeSeriesAggregations(ctx context.Context, params *PostApiTimeSeriesAggregationsParams, body PostApiTimeSeriesAggregationsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiTimeSeriesAggregationsOriginOrId request
	DeleteApiTimeSeriesAggregationsOriginOrId(ctx context.Context, originOrId string, params *DeleteApiTimeSeriesAggregationsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiTimeSeriesAggregationsOriginOrId request
	GetApiTimeSeriesAggregationsOriginOrId(ctx context.Context, originOrId string, params *GetApiTimeSeriesAggregationsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiTimeSeriesAggregationsOriginOrIdWithBody request with any body
	PutApiTimeSeriesAggregationsOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiTimeSeriesAggregationsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiTimeSeriesAggregationsOriginOrId(ctx context.Context, originOrId string, params *PutApiTimeSeriesAggregationsOriginOrIdParams, body PutApiTimeSeriesAggregationsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiTraceDetailsWithBody request with any body
	PostApiTraceDetailsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiTraceDetails(ctx context.Context, body PostApiTraceDetailsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiTraceIdsWithBody request with any body
	PostApiTraceIdsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiTraceIds(ctx context.Context, body PostApiTraceIdsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiViews request
	GetApiViews(ctx context.Context, params *GetApiViewsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiViewsWithBody request with any body
	PostApiViewsWithBody(ctx context.Context, params *PostApiViewsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiViews(ctx context.Context, params *PostApiViewsParams, body PostApiViewsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiViewsOriginOrId request
	DeleteApiViewsOriginOrId(ctx context.Context, originOrId string, params *DeleteApiViewsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiViewsOriginOrId request
	GetApiViewsOriginOrId(ctx context.Context, originOrId string, params *GetApiViewsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiViewsOriginOrIdWithBody request with any body
	PutApiViewsOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiViewsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiViewsOriginOrId(ctx context.Context, originOrId string, params *PutApiViewsOriginOrIdParams, body PutApiViewsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiWebEventsDownloadWithBody request with any body
	PostApiWebEventsDownloadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiWebEventsDownload(ctx context.Context, body PostApiWebEventsDownloadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOauthAuthorize request
	GetOauthAuthorize(ctx context.Context, params *GetOauthAuthorizeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostOauthRegisterWithBody request with any body
	PostOauthRegisterWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostOauthRegister(ctx context.Context, body PostOauthRegisterJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostOauthRevokeWithBody request with any body
	PostOauthRevokeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostOauthRevokeWithFormdataBody(ctx context.Context, body PostOauthRevokeFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostOauthTokenWithBody request with any body
	PostOauthTokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostOauthTokenWithFormdataBody(ctx context.Context, body PostOauthTokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*clientConfig)

ClientOption configures a Dash0 client.

func WithApiUrl

func WithApiUrl(url string) ClientOption

WithApiUrl sets the Dash0 API URL. This is required for REST API operations (dashboards, check rules, etc.). Examples:

func WithAuthToken

func WithAuthToken(authToken string) ClientOption

WithAuthToken sets the auth token for authentication. Either this or WithAuthTokenProvider is required for all API requests.

The two are alternatives rather than a conflict: whichever is applied last wins, so appending either to an existing option slice overrides the other.

func WithAuthTokenProvider added in v1.21.0

func WithAuthTokenProvider(provider AuthTokenProvider) ClientOption

WithAuthTokenProvider sets a provider consulted for an auth token before every request, instead of the fixed token WithAuthToken supplies. Either this or WithAuthToken is required for all API requests; whichever is applied last wins.

Use this when the credential is short-lived and has to be renewed while the client is in use, most notably an OAuth access token: a client built with WithAuthToken holds that token for its whole lifetime, so any operation outliving the token's validity starts failing partway through. Configuration.AuthTokenProvider in the profiles subpackage returns a provider that refreshes a Dash0 CLI profile's OAuth access token.

Example
package main

import (
	"context"
	"fmt"
	"log"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	// A provider is consulted before every request, so a short-lived credential
	// can be renewed while the client is in use. Use this instead of
	// dash0.WithAuthToken whenever an operation may outlive its access token,
	// for example a long telemetry export driven by an OAuth login.
	provider := dash0.StaticAuthTokenProvider("dash0_at_yourtoken")

	client, err := dash0.NewClient(
		dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
		dash0.WithAuthTokenProvider(provider),
	)
	if err != nil {
		log.Fatal(err)
	}
	defer func() { _ = client.Close(context.Background()) }()

	fmt.Println(client != nil)
}
Output:
true

func WithHTTPClient

func WithHTTPClient(client *http.Client) ClientOption

WithHTTPClient sets a custom HTTP client. The client's transport will be wrapped with rate limiting middleware. Other settings like CheckRedirect and Jar will be preserved.

This option conflicts with WithTransport.

func WithMaxConcurrentRequests

func WithMaxConcurrentRequests(n int64) ClientOption

WithMaxConcurrentRequests sets the maximum number of concurrent API calls. The value must be between 1 and 10 (inclusive). Values outside this range will be clamped. Default is 3.

This option conflicts with WithTransport.

func WithMaxRetries

func WithMaxRetries(n int) ClientOption

WithMaxRetries sets the maximum number of retries for failed requests. Only idempotent requests (GET, PUT, DELETE) and requests marked with withIdempotent context are retried. Default is 1. Maximum is 5. Set to 0 to disable retries.

This option conflicts with WithTransport.

Example:

client, _ := dash0.NewClient(
    dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
    dash0.WithAuthToken("your-auth-token"),
    dash0.WithMaxRetries(3),
)

func WithOtlpEndpoint added in v1.2.0

func WithOtlpEndpoint(encoding OtlpEncoding, url string) ClientOption

WithOtlpEndpoint configures the client to push telemetry data via OTLP/HTTP. The encoding parameter specifies the wire format; currently only OtlpEncodingJson is supported. The url is the base OTLP endpoint (e.g., "https://otlp.example.com:4318"); signal-specific paths like /v1/traces are appended automatically.

This option is optional. If not set, SendTraces, SendMetrics, and SendLogs will return an error.

func WithRetryOnConflict added in v1.21.1

func WithRetryOnConflict() ClientOption

WithRetryOnConflict enables retrying requests that fail with 409 Conflict. Retrying a conflict is off unless this option is passed, so the option takes no argument.

A Dash0 dataset is guarded by an optimistic-concurrency dataset version: when two writes to the same dataset race, exactly one wins and the other comes back as a 409 asking the caller to retry. Nothing retries that by default, so the losing write surfaces as a fatal error even though repeating it converges. This happens whenever writes to one dataset are issued concurrently, whether from goroutines in one process or from separate processes, such as a CI matrix running `dash0 apply` in parallel.

Unlike the 429 and 5xx retries WithMaxRetries governs, a 409 retry also applies to non-idempotent requests, including the Import methods, which are POSTs. That is safe because a 409 means the server rejected the write without applying it, so sending it again does not duplicate anything.

The retry budget is the one WithMaxRetries sets. The backoff is not the WithRetryWaitMin window: a conflict retry uses full jitter from 100ms up to 2s, because the wait is on a writer that has already won rather than on an overloaded server.

This option conflicts with WithTransport; configure WithTransportRetryOnConflict on the Transport instead.

Example:

client, _ := dash0.NewClient(
    dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
    dash0.WithAuthToken("auth_yourtoken"),
    dash0.WithRetryOnConflict(),
)
Example
package main

import (
	"context"
	"fmt"
	"log"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	// Concurrent writes to one dataset race its optimistic-concurrency version
	// check, and the loser comes back as a 409. Retrying converges instead of
	// failing the write.
	client, err := dash0.NewClient(
		dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
		dash0.WithAuthToken("auth_yourtoken"),
		dash0.WithRetryOnConflict(),
	)
	if err != nil {
		log.Fatal(err)
	}
	defer func() { _ = client.Close(context.Background()) }()
	fmt.Println(client != nil)
}
Output:
true

func WithRetryWaitMax

func WithRetryWaitMax(d time.Duration) ClientOption

WithRetryWaitMax sets the maximum wait time between retries. Default is 30s. The backoff will not exceed this value.

This option conflicts with WithTransport.

func WithRetryWaitMin

func WithRetryWaitMin(d time.Duration) ClientOption

WithRetryWaitMin sets the minimum wait time between retries. Default is 500ms. The actual wait time uses exponential backoff starting from this value.

This option conflicts with WithTransport.

func WithTimeout

func WithTimeout(d time.Duration) ClientOption

WithTimeout sets the HTTP request timeout. Default is 30 seconds.

When used with WithTransport, this overrides the timeout configured on the Transport.

func WithTransport added in v1.8.0

func WithTransport(t *Transport) ClientOption

WithTransport configures the client to use a pre-built Transport for rate limiting and retry. When set, transport-level ClientOption functions (WithMaxRetries, WithRetryWaitMin, WithRetryWaitMax, WithRetryOnConflict, WithMaxConcurrentRequests, and WithHTTPClient) must not be used. NewClient returns an error if both WithTransport and any of these options are provided.

WithTimeout remains compatible: when set alongside WithTransport it overrides the timeout configured on the Transport.

Example:

t := dash0.NewTransport(
    dash0.WithTransportMaxRetries(3),
)
client, err := dash0.NewClient(
    dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
    dash0.WithAuthToken("auth_yourtoken"),
    dash0.WithTransport(t),
)
Example
package main

import (
	"context"
	"fmt"
	"log"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	t := dash0.NewTransport(
		dash0.WithTransportMaxRetries(3),
		dash0.WithTransportMaxConcurrentRequests(5),
	)

	// Use the same transport for both a raw HTTP client and a typed client.
	httpClient := t.HTTPClient()
	_ = httpClient

	client, err := dash0.NewClient(
		dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
		dash0.WithAuthToken("auth_yourtoken"),
		dash0.WithTransport(t),
	)
	if err != nil {
		log.Fatal(err)
	}
	defer func() { _ = client.Close(context.Background()) }()
	fmt.Println(client != nil)
}
Output:
true

func WithUserAgent

func WithUserAgent(ua string) ClientOption

WithUserAgent sets a custom User-Agent header. Default is "dash0-api-client-go/" followed by the current library version.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...generatedClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) DeleteApiAgenticWorkflowsOriginOrIdWithResponse added in v1.17.0

func (c *ClientWithResponses) DeleteApiAgenticWorkflowsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiAgenticWorkflowsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiAgenticWorkflowsOriginOrIdResponse, error)

DeleteApiAgenticWorkflowsOriginOrIdWithResponse request returning *DeleteApiAgenticWorkflowsOriginOrIdResponse

func (*ClientWithResponses) DeleteApiAlertingCheckRulesOriginOrIdWithResponse

func (c *ClientWithResponses) DeleteApiAlertingCheckRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiAlertingCheckRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiAlertingCheckRulesOriginOrIdResponse, error)

DeleteApiAlertingCheckRulesOriginOrIdWithResponse request returning *DeleteApiAlertingCheckRulesOriginOrIdResponse

func (*ClientWithResponses) DeleteApiDashboardsOriginOrIdWithResponse

func (c *ClientWithResponses) DeleteApiDashboardsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiDashboardsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiDashboardsOriginOrIdResponse, error)

DeleteApiDashboardsOriginOrIdWithResponse request returning *DeleteApiDashboardsOriginOrIdResponse

func (*ClientWithResponses) DeleteApiMembersMemberIDWithResponse added in v1.4.0

func (c *ClientWithResponses) DeleteApiMembersMemberIDWithResponse(ctx context.Context, memberID string, reqEditors ...RequestEditorFn) (*DeleteApiMembersMemberIDResponse, error)

DeleteApiMembersMemberIDWithResponse request returning *DeleteApiMembersMemberIDResponse

func (*ClientWithResponses) DeleteApiNotificationChannelsOriginOrIdWithResponse added in v1.9.0

func (c *ClientWithResponses) DeleteApiNotificationChannelsOriginOrIdWithResponse(ctx context.Context, originOrId string, reqEditors ...RequestEditorFn) (*DeleteApiNotificationChannelsOriginOrIdResponse, error)

DeleteApiNotificationChannelsOriginOrIdWithResponse request returning *DeleteApiNotificationChannelsOriginOrIdResponse

func (*ClientWithResponses) DeleteApiRecordingRulesOriginOrIdWithResponse added in v1.9.0

func (c *ClientWithResponses) DeleteApiRecordingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiRecordingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiRecordingRulesOriginOrIdResponse, error)

DeleteApiRecordingRulesOriginOrIdWithResponse request returning *DeleteApiRecordingRulesOriginOrIdResponse

func (*ClientWithResponses) DeleteApiSamplingRulesOriginOrIdWithResponse added in v1.1.0

func (c *ClientWithResponses) DeleteApiSamplingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSamplingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSamplingRulesOriginOrIdResponse, error)

DeleteApiSamplingRulesOriginOrIdWithResponse request returning *DeleteApiSamplingRulesOriginOrIdResponse

func (*ClientWithResponses) DeleteApiSignalToMetricsOriginOrIdWithResponse added in v1.9.0

func (c *ClientWithResponses) DeleteApiSignalToMetricsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSignalToMetricsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSignalToMetricsOriginOrIdResponse, error)

DeleteApiSignalToMetricsOriginOrIdWithResponse request returning *DeleteApiSignalToMetricsOriginOrIdResponse

func (*ClientWithResponses) DeleteApiSlosOriginOrIdWithResponse added in v1.14.0

func (c *ClientWithResponses) DeleteApiSlosOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSlosOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSlosOriginOrIdResponse, error)

DeleteApiSlosOriginOrIdWithResponse request returning *DeleteApiSlosOriginOrIdResponse

func (*ClientWithResponses) DeleteApiSpamFiltersOriginOrIdWithResponse added in v1.12.0

func (c *ClientWithResponses) DeleteApiSpamFiltersOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSpamFiltersOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSpamFiltersOriginOrIdResponse, error)

DeleteApiSpamFiltersOriginOrIdWithResponse request returning *DeleteApiSpamFiltersOriginOrIdResponse

func (*ClientWithResponses) DeleteApiSyntheticChecksOriginOrIdWithResponse

func (c *ClientWithResponses) DeleteApiSyntheticChecksOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSyntheticChecksOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSyntheticChecksOriginOrIdResponse, error)

DeleteApiSyntheticChecksOriginOrIdWithResponse request returning *DeleteApiSyntheticChecksOriginOrIdResponse

func (*ClientWithResponses) DeleteApiTeamsOriginOrIdMembersMemberIDWithResponse added in v1.4.0

func (c *ClientWithResponses) DeleteApiTeamsOriginOrIdMembersMemberIDWithResponse(ctx context.Context, originOrId string, memberID string, reqEditors ...RequestEditorFn) (*DeleteApiTeamsOriginOrIdMembersMemberIDResponse, error)

DeleteApiTeamsOriginOrIdMembersMemberIDWithResponse request returning *DeleteApiTeamsOriginOrIdMembersMemberIDResponse

func (*ClientWithResponses) DeleteApiTeamsOriginOrIdWithResponse added in v1.4.0

func (c *ClientWithResponses) DeleteApiTeamsOriginOrIdWithResponse(ctx context.Context, originOrId string, reqEditors ...RequestEditorFn) (*DeleteApiTeamsOriginOrIdResponse, error)

DeleteApiTeamsOriginOrIdWithResponse request returning *DeleteApiTeamsOriginOrIdResponse

func (*ClientWithResponses) DeleteApiTimeSeriesAggregationsOriginOrIdWithResponse added in v1.17.0

func (c *ClientWithResponses) DeleteApiTimeSeriesAggregationsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiTimeSeriesAggregationsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiTimeSeriesAggregationsOriginOrIdResponse, error)

DeleteApiTimeSeriesAggregationsOriginOrIdWithResponse request returning *DeleteApiTimeSeriesAggregationsOriginOrIdResponse

func (*ClientWithResponses) DeleteApiViewsOriginOrIdWithResponse

func (c *ClientWithResponses) DeleteApiViewsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiViewsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiViewsOriginOrIdResponse, error)

DeleteApiViewsOriginOrIdWithResponse request returning *DeleteApiViewsOriginOrIdResponse

func (*ClientWithResponses) GetApiAgenticWorkflowsOriginOrIdWithResponse added in v1.17.0

func (c *ClientWithResponses) GetApiAgenticWorkflowsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiAgenticWorkflowsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiAgenticWorkflowsOriginOrIdResponse, error)

GetApiAgenticWorkflowsOriginOrIdWithResponse request returning *GetApiAgenticWorkflowsOriginOrIdResponse

func (*ClientWithResponses) GetApiAgenticWorkflowsWithResponse added in v1.17.0

func (c *ClientWithResponses) GetApiAgenticWorkflowsWithResponse(ctx context.Context, params *GetApiAgenticWorkflowsParams, reqEditors ...RequestEditorFn) (*GetApiAgenticWorkflowsResponse, error)

GetApiAgenticWorkflowsWithResponse request returning *GetApiAgenticWorkflowsResponse

func (*ClientWithResponses) GetApiAlertingCheckRulesOriginOrIdWithResponse

func (c *ClientWithResponses) GetApiAlertingCheckRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiAlertingCheckRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiAlertingCheckRulesOriginOrIdResponse, error)

GetApiAlertingCheckRulesOriginOrIdWithResponse request returning *GetApiAlertingCheckRulesOriginOrIdResponse

func (*ClientWithResponses) GetApiAlertingCheckRulesWithResponse

func (c *ClientWithResponses) GetApiAlertingCheckRulesWithResponse(ctx context.Context, params *GetApiAlertingCheckRulesParams, reqEditors ...RequestEditorFn) (*GetApiAlertingCheckRulesResponse, error)

GetApiAlertingCheckRulesWithResponse request returning *GetApiAlertingCheckRulesResponse

func (*ClientWithResponses) GetApiDashboardsOriginOrIdWithResponse

func (c *ClientWithResponses) GetApiDashboardsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiDashboardsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiDashboardsOriginOrIdResponse, error)

GetApiDashboardsOriginOrIdWithResponse request returning *GetApiDashboardsOriginOrIdResponse

func (*ClientWithResponses) GetApiDashboardsWithResponse

func (c *ClientWithResponses) GetApiDashboardsWithResponse(ctx context.Context, params *GetApiDashboardsParams, reqEditors ...RequestEditorFn) (*GetApiDashboardsResponse, error)

GetApiDashboardsWithResponse request returning *GetApiDashboardsResponse

func (*ClientWithResponses) GetApiEdgeSettingsWithResponse added in v1.12.3

func (c *ClientWithResponses) GetApiEdgeSettingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiEdgeSettingsResponse, error)

GetApiEdgeSettingsWithResponse request returning *GetApiEdgeSettingsResponse

func (*ClientWithResponses) GetApiMembersWithResponse added in v1.4.0

func (c *ClientWithResponses) GetApiMembersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiMembersResponse, error)

GetApiMembersWithResponse request returning *GetApiMembersResponse

func (*ClientWithResponses) GetApiNotificationChannelsOriginOrIdWithResponse added in v1.9.0

func (c *ClientWithResponses) GetApiNotificationChannelsOriginOrIdWithResponse(ctx context.Context, originOrId string, reqEditors ...RequestEditorFn) (*GetApiNotificationChannelsOriginOrIdResponse, error)

GetApiNotificationChannelsOriginOrIdWithResponse request returning *GetApiNotificationChannelsOriginOrIdResponse

func (*ClientWithResponses) GetApiNotificationChannelsWithResponse added in v1.9.0

func (c *ClientWithResponses) GetApiNotificationChannelsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiNotificationChannelsResponse, error)

GetApiNotificationChannelsWithResponse request returning *GetApiNotificationChannelsResponse

func (*ClientWithResponses) GetApiPrometheusApiV1FormatQueryWithResponse added in v1.13.1

func (c *ClientWithResponses) GetApiPrometheusApiV1FormatQueryWithResponse(ctx context.Context, params *GetApiPrometheusApiV1FormatQueryParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1FormatQueryResponse, error)

GetApiPrometheusApiV1FormatQueryWithResponse request returning *GetApiPrometheusApiV1FormatQueryResponse

func (*ClientWithResponses) GetApiPrometheusApiV1LabelLabelNameValuesWithResponse added in v1.13.1

func (c *ClientWithResponses) GetApiPrometheusApiV1LabelLabelNameValuesWithResponse(ctx context.Context, labelName string, params *GetApiPrometheusApiV1LabelLabelNameValuesParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1LabelLabelNameValuesResponse, error)

GetApiPrometheusApiV1LabelLabelNameValuesWithResponse request returning *GetApiPrometheusApiV1LabelLabelNameValuesResponse

func (*ClientWithResponses) GetApiPrometheusApiV1LabelsWithResponse added in v1.13.1

func (c *ClientWithResponses) GetApiPrometheusApiV1LabelsWithResponse(ctx context.Context, params *GetApiPrometheusApiV1LabelsParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1LabelsResponse, error)

GetApiPrometheusApiV1LabelsWithResponse request returning *GetApiPrometheusApiV1LabelsResponse

func (*ClientWithResponses) GetApiPrometheusApiV1MetadataWithResponse added in v1.13.1

func (c *ClientWithResponses) GetApiPrometheusApiV1MetadataWithResponse(ctx context.Context, params *GetApiPrometheusApiV1MetadataParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1MetadataResponse, error)

GetApiPrometheusApiV1MetadataWithResponse request returning *GetApiPrometheusApiV1MetadataResponse

func (*ClientWithResponses) GetApiPrometheusApiV1QueryRangeWithResponse added in v1.13.1

func (c *ClientWithResponses) GetApiPrometheusApiV1QueryRangeWithResponse(ctx context.Context, params *GetApiPrometheusApiV1QueryRangeParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1QueryRangeResponse, error)

GetApiPrometheusApiV1QueryRangeWithResponse request returning *GetApiPrometheusApiV1QueryRangeResponse

func (*ClientWithResponses) GetApiPrometheusApiV1QueryWithResponse added in v1.13.1

func (c *ClientWithResponses) GetApiPrometheusApiV1QueryWithResponse(ctx context.Context, params *GetApiPrometheusApiV1QueryParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1QueryResponse, error)

GetApiPrometheusApiV1QueryWithResponse request returning *GetApiPrometheusApiV1QueryResponse

func (*ClientWithResponses) GetApiPrometheusApiV1SeriesWithResponse added in v1.13.1

func (c *ClientWithResponses) GetApiPrometheusApiV1SeriesWithResponse(ctx context.Context, params *GetApiPrometheusApiV1SeriesParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1SeriesResponse, error)

GetApiPrometheusApiV1SeriesWithResponse request returning *GetApiPrometheusApiV1SeriesResponse

func (*ClientWithResponses) GetApiPrometheusApiV1StatusBuildinfoWithResponse added in v1.13.1

func (c *ClientWithResponses) GetApiPrometheusApiV1StatusBuildinfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1StatusBuildinfoResponse, error)

GetApiPrometheusApiV1StatusBuildinfoWithResponse request returning *GetApiPrometheusApiV1StatusBuildinfoResponse

func (*ClientWithResponses) GetApiPrometheusApiV1StatusRuntimeinfoWithResponse added in v1.13.1

func (c *ClientWithResponses) GetApiPrometheusApiV1StatusRuntimeinfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1StatusRuntimeinfoResponse, error)

GetApiPrometheusApiV1StatusRuntimeinfoWithResponse request returning *GetApiPrometheusApiV1StatusRuntimeinfoResponse

func (*ClientWithResponses) GetApiRecordingRulesOriginOrIdWithResponse added in v1.9.0

func (c *ClientWithResponses) GetApiRecordingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiRecordingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiRecordingRulesOriginOrIdResponse, error)

GetApiRecordingRulesOriginOrIdWithResponse request returning *GetApiRecordingRulesOriginOrIdResponse

func (*ClientWithResponses) GetApiRecordingRulesWithResponse added in v1.9.0

func (c *ClientWithResponses) GetApiRecordingRulesWithResponse(ctx context.Context, params *GetApiRecordingRulesParams, reqEditors ...RequestEditorFn) (*GetApiRecordingRulesResponse, error)

GetApiRecordingRulesWithResponse request returning *GetApiRecordingRulesResponse

func (*ClientWithResponses) GetApiSamplingRulesOriginOrIdWithResponse added in v1.1.0

func (c *ClientWithResponses) GetApiSamplingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSamplingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSamplingRulesOriginOrIdResponse, error)

GetApiSamplingRulesOriginOrIdWithResponse request returning *GetApiSamplingRulesOriginOrIdResponse

func (*ClientWithResponses) GetApiSamplingRulesWithResponse added in v1.1.0

func (c *ClientWithResponses) GetApiSamplingRulesWithResponse(ctx context.Context, params *GetApiSamplingRulesParams, reqEditors ...RequestEditorFn) (*GetApiSamplingRulesResponse, error)

GetApiSamplingRulesWithResponse request returning *GetApiSamplingRulesResponse

func (*ClientWithResponses) GetApiSignalToMetricsOriginOrIdWithResponse added in v1.9.0

func (c *ClientWithResponses) GetApiSignalToMetricsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSignalToMetricsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSignalToMetricsOriginOrIdResponse, error)

GetApiSignalToMetricsOriginOrIdWithResponse request returning *GetApiSignalToMetricsOriginOrIdResponse

func (*ClientWithResponses) GetApiSignalToMetricsWithResponse added in v1.9.0

func (c *ClientWithResponses) GetApiSignalToMetricsWithResponse(ctx context.Context, params *GetApiSignalToMetricsParams, reqEditors ...RequestEditorFn) (*GetApiSignalToMetricsResponse, error)

GetApiSignalToMetricsWithResponse request returning *GetApiSignalToMetricsResponse

func (*ClientWithResponses) GetApiSlosOriginOrIdWithResponse added in v1.14.0

func (c *ClientWithResponses) GetApiSlosOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSlosOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSlosOriginOrIdResponse, error)

GetApiSlosOriginOrIdWithResponse request returning *GetApiSlosOriginOrIdResponse

func (*ClientWithResponses) GetApiSlosWithResponse added in v1.14.0

func (c *ClientWithResponses) GetApiSlosWithResponse(ctx context.Context, params *GetApiSlosParams, reqEditors ...RequestEditorFn) (*GetApiSlosResponse, error)

GetApiSlosWithResponse request returning *GetApiSlosResponse

func (*ClientWithResponses) GetApiSpamFiltersOriginOrIdWithResponse added in v1.12.0

func (c *ClientWithResponses) GetApiSpamFiltersOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSpamFiltersOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSpamFiltersOriginOrIdResponse, error)

GetApiSpamFiltersOriginOrIdWithResponse request returning *GetApiSpamFiltersOriginOrIdResponse

func (*ClientWithResponses) GetApiSpamFiltersWithResponse added in v1.12.0

func (c *ClientWithResponses) GetApiSpamFiltersWithResponse(ctx context.Context, params *GetApiSpamFiltersParams, reqEditors ...RequestEditorFn) (*GetApiSpamFiltersResponse, error)

GetApiSpamFiltersWithResponse request returning *GetApiSpamFiltersResponse

func (*ClientWithResponses) GetApiSyntheticChecksLocationsWithResponse added in v1.6.0

func (c *ClientWithResponses) GetApiSyntheticChecksLocationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiSyntheticChecksLocationsResponse, error)

GetApiSyntheticChecksLocationsWithResponse request returning *GetApiSyntheticChecksLocationsResponse

func (*ClientWithResponses) GetApiSyntheticChecksOriginOrIdWithResponse

func (c *ClientWithResponses) GetApiSyntheticChecksOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSyntheticChecksOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSyntheticChecksOriginOrIdResponse, error)

GetApiSyntheticChecksOriginOrIdWithResponse request returning *GetApiSyntheticChecksOriginOrIdResponse

func (*ClientWithResponses) GetApiSyntheticChecksWithResponse

func (c *ClientWithResponses) GetApiSyntheticChecksWithResponse(ctx context.Context, params *GetApiSyntheticChecksParams, reqEditors ...RequestEditorFn) (*GetApiSyntheticChecksResponse, error)

GetApiSyntheticChecksWithResponse request returning *GetApiSyntheticChecksResponse

func (*ClientWithResponses) GetApiTeamsOriginOrIdWithResponse added in v1.4.0

func (c *ClientWithResponses) GetApiTeamsOriginOrIdWithResponse(ctx context.Context, originOrId string, reqEditors ...RequestEditorFn) (*GetApiTeamsOriginOrIdResponse, error)

GetApiTeamsOriginOrIdWithResponse request returning *GetApiTeamsOriginOrIdResponse

func (*ClientWithResponses) GetApiTeamsWithResponse added in v1.4.0

func (c *ClientWithResponses) GetApiTeamsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiTeamsResponse, error)

GetApiTeamsWithResponse request returning *GetApiTeamsResponse

func (*ClientWithResponses) GetApiTimeSeriesAggregationsOriginOrIdWithResponse added in v1.17.0

func (c *ClientWithResponses) GetApiTimeSeriesAggregationsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiTimeSeriesAggregationsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiTimeSeriesAggregationsOriginOrIdResponse, error)

GetApiTimeSeriesAggregationsOriginOrIdWithResponse request returning *GetApiTimeSeriesAggregationsOriginOrIdResponse

func (*ClientWithResponses) GetApiTimeSeriesAggregationsWithResponse added in v1.17.0

func (c *ClientWithResponses) GetApiTimeSeriesAggregationsWithResponse(ctx context.Context, params *GetApiTimeSeriesAggregationsParams, reqEditors ...RequestEditorFn) (*GetApiTimeSeriesAggregationsResponse, error)

GetApiTimeSeriesAggregationsWithResponse request returning *GetApiTimeSeriesAggregationsResponse

func (*ClientWithResponses) GetApiViewsOriginOrIdWithResponse

func (c *ClientWithResponses) GetApiViewsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiViewsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiViewsOriginOrIdResponse, error)

GetApiViewsOriginOrIdWithResponse request returning *GetApiViewsOriginOrIdResponse

func (*ClientWithResponses) GetApiViewsWithResponse

func (c *ClientWithResponses) GetApiViewsWithResponse(ctx context.Context, params *GetApiViewsParams, reqEditors ...RequestEditorFn) (*GetApiViewsResponse, error)

GetApiViewsWithResponse request returning *GetApiViewsResponse

func (*ClientWithResponses) GetOauthAuthorizeWithResponse added in v1.6.0

func (c *ClientWithResponses) GetOauthAuthorizeWithResponse(ctx context.Context, params *GetOauthAuthorizeParams, reqEditors ...RequestEditorFn) (*GetOauthAuthorizeResponse, error)

GetOauthAuthorizeWithResponse request returning *GetOauthAuthorizeResponse

func (*ClientWithResponses) GetWellKnownOauthAuthorizationServerWithResponse added in v1.6.0

func (c *ClientWithResponses) GetWellKnownOauthAuthorizationServerWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetWellKnownOauthAuthorizationServerResponse, error)

GetWellKnownOauthAuthorizationServerWithResponse request returning *GetWellKnownOauthAuthorizationServerResponse

func (*ClientWithResponses) GetWellKnownOauthProtectedResourceWithResponse added in v1.6.0

func (c *ClientWithResponses) GetWellKnownOauthProtectedResourceWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetWellKnownOauthProtectedResourceResponse, error)

GetWellKnownOauthProtectedResourceWithResponse request returning *GetWellKnownOauthProtectedResourceResponse

func (*ClientWithResponses) PostApiAgenticWorkflowsWithBodyWithResponse added in v1.17.0

func (c *ClientWithResponses) PostApiAgenticWorkflowsWithBodyWithResponse(ctx context.Context, params *PostApiAgenticWorkflowsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiAgenticWorkflowsResponse, error)

PostApiAgenticWorkflowsWithBodyWithResponse request with arbitrary body returning *PostApiAgenticWorkflowsResponse

func (*ClientWithResponses) PostApiAgenticWorkflowsWithResponse added in v1.17.0

func (*ClientWithResponses) PostApiAlertingCheckRulesBulkWithBodyWithResponse added in v1.12.1

func (c *ClientWithResponses) PostApiAlertingCheckRulesBulkWithBodyWithResponse(ctx context.Context, params *PostApiAlertingCheckRulesBulkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiAlertingCheckRulesBulkResponse, error)

PostApiAlertingCheckRulesBulkWithBodyWithResponse request with arbitrary body returning *PostApiAlertingCheckRulesBulkResponse

func (*ClientWithResponses) PostApiAlertingCheckRulesBulkWithResponse added in v1.12.1

func (*ClientWithResponses) PostApiAlertingCheckRulesWithBodyWithResponse

func (c *ClientWithResponses) PostApiAlertingCheckRulesWithBodyWithResponse(ctx context.Context, params *PostApiAlertingCheckRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiAlertingCheckRulesResponse, error)

PostApiAlertingCheckRulesWithBodyWithResponse request with arbitrary body returning *PostApiAlertingCheckRulesResponse

func (*ClientWithResponses) PostApiDashboardsWithBodyWithResponse

func (c *ClientWithResponses) PostApiDashboardsWithBodyWithResponse(ctx context.Context, params *PostApiDashboardsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiDashboardsResponse, error)

PostApiDashboardsWithBodyWithResponse request with arbitrary body returning *PostApiDashboardsResponse

func (*ClientWithResponses) PostApiDashboardsWithResponse

func (*ClientWithResponses) PostApiImportCheckRuleWithBodyWithResponse

func (c *ClientWithResponses) PostApiImportCheckRuleWithBodyWithResponse(ctx context.Context, params *PostApiImportCheckRuleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportCheckRuleResponse, error)

PostApiImportCheckRuleWithBodyWithResponse request with arbitrary body returning *PostApiImportCheckRuleResponse

func (*ClientWithResponses) PostApiImportCheckRuleWithResponse

func (*ClientWithResponses) PostApiImportCheckRulesWithBodyWithResponse added in v1.12.1

func (c *ClientWithResponses) PostApiImportCheckRulesWithBodyWithResponse(ctx context.Context, params *PostApiImportCheckRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportCheckRulesResponse, error)

PostApiImportCheckRulesWithBodyWithResponse request with arbitrary body returning *PostApiImportCheckRulesResponse

func (*ClientWithResponses) PostApiImportCheckRulesWithResponse added in v1.12.1

func (*ClientWithResponses) PostApiImportDashboardWithBodyWithResponse

func (c *ClientWithResponses) PostApiImportDashboardWithBodyWithResponse(ctx context.Context, params *PostApiImportDashboardParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportDashboardResponse, error)

PostApiImportDashboardWithBodyWithResponse request with arbitrary body returning *PostApiImportDashboardResponse

func (*ClientWithResponses) PostApiImportDashboardWithResponse

func (*ClientWithResponses) PostApiImportSyntheticCheckWithBodyWithResponse

func (c *ClientWithResponses) PostApiImportSyntheticCheckWithBodyWithResponse(ctx context.Context, params *PostApiImportSyntheticCheckParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportSyntheticCheckResponse, error)

PostApiImportSyntheticCheckWithBodyWithResponse request with arbitrary body returning *PostApiImportSyntheticCheckResponse

func (*ClientWithResponses) PostApiImportViewWithBodyWithResponse

func (c *ClientWithResponses) PostApiImportViewWithBodyWithResponse(ctx context.Context, params *PostApiImportViewParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportViewResponse, error)

PostApiImportViewWithBodyWithResponse request with arbitrary body returning *PostApiImportViewResponse

func (*ClientWithResponses) PostApiImportViewWithResponse

func (*ClientWithResponses) PostApiLogsDownloadWithBodyWithResponse added in v1.18.1

func (c *ClientWithResponses) PostApiLogsDownloadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiLogsDownloadResponse, error)

PostApiLogsDownloadWithBodyWithResponse request with arbitrary body returning *PostApiLogsDownloadResponse

func (*ClientWithResponses) PostApiLogsDownloadWithResponse added in v1.18.1

func (c *ClientWithResponses) PostApiLogsDownloadWithResponse(ctx context.Context, body PostApiLogsDownloadJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiLogsDownloadResponse, error)

func (*ClientWithResponses) PostApiLogsWithBodyWithResponse

func (c *ClientWithResponses) PostApiLogsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiLogsResponse, error)

PostApiLogsWithBodyWithResponse request with arbitrary body returning *PostApiLogsResponse

func (*ClientWithResponses) PostApiLogsWithResponse

func (c *ClientWithResponses) PostApiLogsWithResponse(ctx context.Context, body PostApiLogsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiLogsResponse, error)

func (*ClientWithResponses) PostApiMembersWithBodyWithResponse added in v1.4.0

func (c *ClientWithResponses) PostApiMembersWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiMembersResponse, error)

PostApiMembersWithBodyWithResponse request with arbitrary body returning *PostApiMembersResponse

func (*ClientWithResponses) PostApiMembersWithResponse added in v1.4.0

func (c *ClientWithResponses) PostApiMembersWithResponse(ctx context.Context, body PostApiMembersJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiMembersResponse, error)

func (*ClientWithResponses) PostApiNotificationChannelsWithBodyWithResponse added in v1.9.0

func (c *ClientWithResponses) PostApiNotificationChannelsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiNotificationChannelsResponse, error)

PostApiNotificationChannelsWithBodyWithResponse request with arbitrary body returning *PostApiNotificationChannelsResponse

func (*ClientWithResponses) PostApiNotificationChannelsWithResponse added in v1.9.0

func (c *ClientWithResponses) PostApiNotificationChannelsWithResponse(ctx context.Context, body PostApiNotificationChannelsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiNotificationChannelsResponse, error)

func (*ClientWithResponses) PostApiPrometheusApiV1FormatQueryWithBodyWithResponse added in v1.13.1

func (c *ClientWithResponses) PostApiPrometheusApiV1FormatQueryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1FormatQueryResponse, error)

PostApiPrometheusApiV1FormatQueryWithBodyWithResponse request with arbitrary body returning *PostApiPrometheusApiV1FormatQueryResponse

func (*ClientWithResponses) PostApiPrometheusApiV1FormatQueryWithResponse added in v1.13.1

func (*ClientWithResponses) PostApiPrometheusApiV1LabelLabelNameValuesWithBodyWithResponse added in v1.13.1

func (c *ClientWithResponses) PostApiPrometheusApiV1LabelLabelNameValuesWithBodyWithResponse(ctx context.Context, labelName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1LabelLabelNameValuesResponse, error)

PostApiPrometheusApiV1LabelLabelNameValuesWithBodyWithResponse request with arbitrary body returning *PostApiPrometheusApiV1LabelLabelNameValuesResponse

func (*ClientWithResponses) PostApiPrometheusApiV1LabelLabelNameValuesWithResponse added in v1.13.1

func (c *ClientWithResponses) PostApiPrometheusApiV1LabelLabelNameValuesWithResponse(ctx context.Context, labelName string, body PostApiPrometheusApiV1LabelLabelNameValuesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1LabelLabelNameValuesResponse, error)

func (*ClientWithResponses) PostApiPrometheusApiV1LabelsWithBodyWithResponse added in v1.13.1

func (c *ClientWithResponses) PostApiPrometheusApiV1LabelsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1LabelsResponse, error)

PostApiPrometheusApiV1LabelsWithBodyWithResponse request with arbitrary body returning *PostApiPrometheusApiV1LabelsResponse

func (*ClientWithResponses) PostApiPrometheusApiV1LabelsWithResponse added in v1.13.1

func (c *ClientWithResponses) PostApiPrometheusApiV1LabelsWithResponse(ctx context.Context, body PostApiPrometheusApiV1LabelsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1LabelsResponse, error)

func (*ClientWithResponses) PostApiPrometheusApiV1MetadataWithBodyWithResponse added in v1.13.1

func (c *ClientWithResponses) PostApiPrometheusApiV1MetadataWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1MetadataResponse, error)

PostApiPrometheusApiV1MetadataWithBodyWithResponse request with arbitrary body returning *PostApiPrometheusApiV1MetadataResponse

func (*ClientWithResponses) PostApiPrometheusApiV1MetadataWithResponse added in v1.13.1

func (c *ClientWithResponses) PostApiPrometheusApiV1MetadataWithResponse(ctx context.Context, body PostApiPrometheusApiV1MetadataJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1MetadataResponse, error)

func (*ClientWithResponses) PostApiPrometheusApiV1QueryRangeWithBodyWithResponse added in v1.13.1

func (c *ClientWithResponses) PostApiPrometheusApiV1QueryRangeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1QueryRangeResponse, error)

PostApiPrometheusApiV1QueryRangeWithBodyWithResponse request with arbitrary body returning *PostApiPrometheusApiV1QueryRangeResponse

func (*ClientWithResponses) PostApiPrometheusApiV1QueryRangeWithResponse added in v1.13.1

func (*ClientWithResponses) PostApiPrometheusApiV1QueryWithBodyWithResponse added in v1.13.1

func (c *ClientWithResponses) PostApiPrometheusApiV1QueryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1QueryResponse, error)

PostApiPrometheusApiV1QueryWithBodyWithResponse request with arbitrary body returning *PostApiPrometheusApiV1QueryResponse

func (*ClientWithResponses) PostApiPrometheusApiV1QueryWithResponse added in v1.13.1

func (c *ClientWithResponses) PostApiPrometheusApiV1QueryWithResponse(ctx context.Context, body PostApiPrometheusApiV1QueryJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1QueryResponse, error)

func (*ClientWithResponses) PostApiPrometheusApiV1SeriesWithBodyWithResponse added in v1.13.1

func (c *ClientWithResponses) PostApiPrometheusApiV1SeriesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1SeriesResponse, error)

PostApiPrometheusApiV1SeriesWithBodyWithResponse request with arbitrary body returning *PostApiPrometheusApiV1SeriesResponse

func (*ClientWithResponses) PostApiPrometheusApiV1SeriesWithResponse added in v1.13.1

func (c *ClientWithResponses) PostApiPrometheusApiV1SeriesWithResponse(ctx context.Context, body PostApiPrometheusApiV1SeriesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1SeriesResponse, error)

func (*ClientWithResponses) PostApiRecordingRulesWithBodyWithResponse added in v1.9.0

func (c *ClientWithResponses) PostApiRecordingRulesWithBodyWithResponse(ctx context.Context, params *PostApiRecordingRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiRecordingRulesResponse, error)

PostApiRecordingRulesWithBodyWithResponse request with arbitrary body returning *PostApiRecordingRulesResponse

func (*ClientWithResponses) PostApiRecordingRulesWithResponse added in v1.9.0

func (*ClientWithResponses) PostApiSamplingRulesWithBodyWithResponse added in v1.1.0

func (c *ClientWithResponses) PostApiSamplingRulesWithBodyWithResponse(ctx context.Context, params *PostApiSamplingRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSamplingRulesResponse, error)

PostApiSamplingRulesWithBodyWithResponse request with arbitrary body returning *PostApiSamplingRulesResponse

func (*ClientWithResponses) PostApiSamplingRulesWithResponse added in v1.1.0

func (*ClientWithResponses) PostApiSignalToMetricsTestWithBodyWithResponse added in v1.12.0

func (c *ClientWithResponses) PostApiSignalToMetricsTestWithBodyWithResponse(ctx context.Context, params *PostApiSignalToMetricsTestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSignalToMetricsTestResponse, error)

PostApiSignalToMetricsTestWithBodyWithResponse request with arbitrary body returning *PostApiSignalToMetricsTestResponse

func (*ClientWithResponses) PostApiSignalToMetricsTestWithResponse added in v1.12.0

func (*ClientWithResponses) PostApiSignalToMetricsWithBodyWithResponse added in v1.9.0

func (c *ClientWithResponses) PostApiSignalToMetricsWithBodyWithResponse(ctx context.Context, params *PostApiSignalToMetricsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSignalToMetricsResponse, error)

PostApiSignalToMetricsWithBodyWithResponse request with arbitrary body returning *PostApiSignalToMetricsResponse

func (*ClientWithResponses) PostApiSignalToMetricsWithResponse added in v1.9.0

func (*ClientWithResponses) PostApiSlosWithBodyWithResponse added in v1.14.0

func (c *ClientWithResponses) PostApiSlosWithBodyWithResponse(ctx context.Context, params *PostApiSlosParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSlosResponse, error)

PostApiSlosWithBodyWithResponse request with arbitrary body returning *PostApiSlosResponse

func (*ClientWithResponses) PostApiSlosWithResponse added in v1.14.0

func (c *ClientWithResponses) PostApiSlosWithResponse(ctx context.Context, params *PostApiSlosParams, body PostApiSlosJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSlosResponse, error)

func (*ClientWithResponses) PostApiSpamFiltersWithBodyWithResponse added in v1.12.0

func (c *ClientWithResponses) PostApiSpamFiltersWithBodyWithResponse(ctx context.Context, params *PostApiSpamFiltersParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSpamFiltersResponse, error)

PostApiSpamFiltersWithBodyWithResponse request with arbitrary body returning *PostApiSpamFiltersResponse

func (*ClientWithResponses) PostApiSpamFiltersWithResponse added in v1.12.0

func (*ClientWithResponses) PostApiSpansDownloadWithBodyWithResponse added in v1.18.1

func (c *ClientWithResponses) PostApiSpansDownloadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSpansDownloadResponse, error)

PostApiSpansDownloadWithBodyWithResponse request with arbitrary body returning *PostApiSpansDownloadResponse

func (*ClientWithResponses) PostApiSpansDownloadWithResponse added in v1.18.1

func (c *ClientWithResponses) PostApiSpansDownloadWithResponse(ctx context.Context, body PostApiSpansDownloadJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSpansDownloadResponse, error)

func (*ClientWithResponses) PostApiSpansWithBodyWithResponse

func (c *ClientWithResponses) PostApiSpansWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSpansResponse, error)

PostApiSpansWithBodyWithResponse request with arbitrary body returning *PostApiSpansResponse

func (*ClientWithResponses) PostApiSpansWithResponse

func (c *ClientWithResponses) PostApiSpansWithResponse(ctx context.Context, body PostApiSpansJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSpansResponse, error)

func (*ClientWithResponses) PostApiSqlWithBodyWithResponse added in v1.6.0

func (c *ClientWithResponses) PostApiSqlWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSqlResponse, error)

PostApiSqlWithBodyWithResponse request with arbitrary body returning *PostApiSqlResponse

func (*ClientWithResponses) PostApiSqlWithResponse added in v1.6.0

func (c *ClientWithResponses) PostApiSqlWithResponse(ctx context.Context, body PostApiSqlJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSqlResponse, error)

func (*ClientWithResponses) PostApiSyntheticChecksTestWithBodyWithResponse added in v1.4.0

func (c *ClientWithResponses) PostApiSyntheticChecksTestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSyntheticChecksTestResponse, error)

PostApiSyntheticChecksTestWithBodyWithResponse request with arbitrary body returning *PostApiSyntheticChecksTestResponse

func (*ClientWithResponses) PostApiSyntheticChecksTestWithResponse added in v1.4.0

func (c *ClientWithResponses) PostApiSyntheticChecksTestWithResponse(ctx context.Context, body PostApiSyntheticChecksTestJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSyntheticChecksTestResponse, error)

func (*ClientWithResponses) PostApiSyntheticChecksWithBodyWithResponse

func (c *ClientWithResponses) PostApiSyntheticChecksWithBodyWithResponse(ctx context.Context, params *PostApiSyntheticChecksParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSyntheticChecksResponse, error)

PostApiSyntheticChecksWithBodyWithResponse request with arbitrary body returning *PostApiSyntheticChecksResponse

func (*ClientWithResponses) PostApiSyntheticChecksWithResponse

func (*ClientWithResponses) PostApiTeamsOriginOrIdMembersWithBodyWithResponse added in v1.4.0

func (c *ClientWithResponses) PostApiTeamsOriginOrIdMembersWithBodyWithResponse(ctx context.Context, originOrId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiTeamsOriginOrIdMembersResponse, error)

PostApiTeamsOriginOrIdMembersWithBodyWithResponse request with arbitrary body returning *PostApiTeamsOriginOrIdMembersResponse

func (*ClientWithResponses) PostApiTeamsOriginOrIdMembersWithResponse added in v1.4.0

func (c *ClientWithResponses) PostApiTeamsOriginOrIdMembersWithResponse(ctx context.Context, originOrId string, body PostApiTeamsOriginOrIdMembersJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiTeamsOriginOrIdMembersResponse, error)

func (*ClientWithResponses) PostApiTeamsWithBodyWithResponse added in v1.4.0

func (c *ClientWithResponses) PostApiTeamsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiTeamsResponse, error)

PostApiTeamsWithBodyWithResponse request with arbitrary body returning *PostApiTeamsResponse

func (*ClientWithResponses) PostApiTeamsWithResponse added in v1.4.0

func (c *ClientWithResponses) PostApiTeamsWithResponse(ctx context.Context, body PostApiTeamsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiTeamsResponse, error)

func (*ClientWithResponses) PostApiTimeSeriesAggregationsWithBodyWithResponse added in v1.17.0

func (c *ClientWithResponses) PostApiTimeSeriesAggregationsWithBodyWithResponse(ctx context.Context, params *PostApiTimeSeriesAggregationsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiTimeSeriesAggregationsResponse, error)

PostApiTimeSeriesAggregationsWithBodyWithResponse request with arbitrary body returning *PostApiTimeSeriesAggregationsResponse

func (*ClientWithResponses) PostApiTimeSeriesAggregationsWithResponse added in v1.17.0

func (*ClientWithResponses) PostApiTraceDetailsWithBodyWithResponse added in v1.12.0

func (c *ClientWithResponses) PostApiTraceDetailsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiTraceDetailsResponse, error)

PostApiTraceDetailsWithBodyWithResponse request with arbitrary body returning *PostApiTraceDetailsResponse

func (*ClientWithResponses) PostApiTraceDetailsWithResponse added in v1.12.0

func (c *ClientWithResponses) PostApiTraceDetailsWithResponse(ctx context.Context, body PostApiTraceDetailsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiTraceDetailsResponse, error)

func (*ClientWithResponses) PostApiTraceIdsWithBodyWithResponse added in v1.12.1

func (c *ClientWithResponses) PostApiTraceIdsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiTraceIdsResponse, error)

PostApiTraceIdsWithBodyWithResponse request with arbitrary body returning *PostApiTraceIdsResponse

func (*ClientWithResponses) PostApiTraceIdsWithResponse added in v1.12.1

func (c *ClientWithResponses) PostApiTraceIdsWithResponse(ctx context.Context, body PostApiTraceIdsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiTraceIdsResponse, error)

func (*ClientWithResponses) PostApiViewsWithBodyWithResponse

func (c *ClientWithResponses) PostApiViewsWithBodyWithResponse(ctx context.Context, params *PostApiViewsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiViewsResponse, error)

PostApiViewsWithBodyWithResponse request with arbitrary body returning *PostApiViewsResponse

func (*ClientWithResponses) PostApiViewsWithResponse

func (c *ClientWithResponses) PostApiViewsWithResponse(ctx context.Context, params *PostApiViewsParams, body PostApiViewsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiViewsResponse, error)

func (*ClientWithResponses) PostApiWebEventsDownloadWithBodyWithResponse added in v1.18.1

func (c *ClientWithResponses) PostApiWebEventsDownloadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiWebEventsDownloadResponse, error)

PostApiWebEventsDownloadWithBodyWithResponse request with arbitrary body returning *PostApiWebEventsDownloadResponse

func (*ClientWithResponses) PostApiWebEventsDownloadWithResponse added in v1.18.1

func (c *ClientWithResponses) PostApiWebEventsDownloadWithResponse(ctx context.Context, body PostApiWebEventsDownloadJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiWebEventsDownloadResponse, error)

func (*ClientWithResponses) PostOauthRegisterWithBodyWithResponse added in v1.6.0

func (c *ClientWithResponses) PostOauthRegisterWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostOauthRegisterResponse, error)

PostOauthRegisterWithBodyWithResponse request with arbitrary body returning *PostOauthRegisterResponse

func (*ClientWithResponses) PostOauthRegisterWithResponse added in v1.6.0

func (c *ClientWithResponses) PostOauthRegisterWithResponse(ctx context.Context, body PostOauthRegisterJSONRequestBody, reqEditors ...RequestEditorFn) (*PostOauthRegisterResponse, error)

func (*ClientWithResponses) PostOauthRevokeWithBodyWithResponse added in v1.6.0

func (c *ClientWithResponses) PostOauthRevokeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostOauthRevokeResponse, error)

PostOauthRevokeWithBodyWithResponse request with arbitrary body returning *PostOauthRevokeResponse

func (*ClientWithResponses) PostOauthRevokeWithFormdataBodyWithResponse added in v1.6.0

func (c *ClientWithResponses) PostOauthRevokeWithFormdataBodyWithResponse(ctx context.Context, body PostOauthRevokeFormdataRequestBody, reqEditors ...RequestEditorFn) (*PostOauthRevokeResponse, error)

func (*ClientWithResponses) PostOauthTokenWithBodyWithResponse added in v1.6.0

func (c *ClientWithResponses) PostOauthTokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostOauthTokenResponse, error)

PostOauthTokenWithBodyWithResponse request with arbitrary body returning *PostOauthTokenResponse

func (*ClientWithResponses) PostOauthTokenWithFormdataBodyWithResponse added in v1.6.0

func (c *ClientWithResponses) PostOauthTokenWithFormdataBodyWithResponse(ctx context.Context, body PostOauthTokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*PostOauthTokenResponse, error)

func (*ClientWithResponses) PutApiAgenticWorkflowsOriginOrIdWithBodyWithResponse added in v1.17.0

func (c *ClientWithResponses) PutApiAgenticWorkflowsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiAgenticWorkflowsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiAgenticWorkflowsOriginOrIdResponse, error)

PutApiAgenticWorkflowsOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiAgenticWorkflowsOriginOrIdResponse

func (*ClientWithResponses) PutApiAgenticWorkflowsOriginOrIdWithResponse added in v1.17.0

func (*ClientWithResponses) PutApiAlertingCheckRulesOriginOrIdWithBodyWithResponse

func (c *ClientWithResponses) PutApiAlertingCheckRulesOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiAlertingCheckRulesOriginOrIdResponse, error)

PutApiAlertingCheckRulesOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiAlertingCheckRulesOriginOrIdResponse

func (*ClientWithResponses) PutApiDashboardsOriginOrIdWithBodyWithResponse

func (c *ClientWithResponses) PutApiDashboardsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiDashboardsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiDashboardsOriginOrIdResponse, error)

PutApiDashboardsOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiDashboardsOriginOrIdResponse

func (*ClientWithResponses) PutApiDashboardsOriginOrIdWithResponse

func (*ClientWithResponses) PutApiImportSignalToMetricsWithBodyWithResponse added in v1.12.3

func (c *ClientWithResponses) PutApiImportSignalToMetricsWithBodyWithResponse(ctx context.Context, params *PutApiImportSignalToMetricsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiImportSignalToMetricsResponse, error)

PutApiImportSignalToMetricsWithBodyWithResponse request with arbitrary body returning *PutApiImportSignalToMetricsResponse

func (*ClientWithResponses) PutApiImportSignalToMetricsWithResponse added in v1.12.3

func (*ClientWithResponses) PutApiNotificationChannelsOriginOrIdWithBodyWithResponse added in v1.9.0

func (c *ClientWithResponses) PutApiNotificationChannelsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiNotificationChannelsOriginOrIdResponse, error)

PutApiNotificationChannelsOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiNotificationChannelsOriginOrIdResponse

func (*ClientWithResponses) PutApiNotificationChannelsOriginOrIdWithResponse added in v1.9.0

func (c *ClientWithResponses) PutApiNotificationChannelsOriginOrIdWithResponse(ctx context.Context, originOrId string, body PutApiNotificationChannelsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiNotificationChannelsOriginOrIdResponse, error)

func (*ClientWithResponses) PutApiRecordingRulesOriginOrIdWithBodyWithResponse added in v1.9.0

func (c *ClientWithResponses) PutApiRecordingRulesOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiRecordingRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiRecordingRulesOriginOrIdResponse, error)

PutApiRecordingRulesOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiRecordingRulesOriginOrIdResponse

func (*ClientWithResponses) PutApiRecordingRulesOriginOrIdWithResponse added in v1.9.0

func (*ClientWithResponses) PutApiSamplingRulesOriginOrIdWithBodyWithResponse added in v1.1.0

func (c *ClientWithResponses) PutApiSamplingRulesOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSamplingRulesOriginOrIdResponse, error)

PutApiSamplingRulesOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiSamplingRulesOriginOrIdResponse

func (*ClientWithResponses) PutApiSamplingRulesOriginOrIdWithResponse added in v1.1.0

func (*ClientWithResponses) PutApiSignalToMetricsOriginOrIdWithBodyWithResponse added in v1.9.0

func (c *ClientWithResponses) PutApiSignalToMetricsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSignalToMetricsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSignalToMetricsOriginOrIdResponse, error)

PutApiSignalToMetricsOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiSignalToMetricsOriginOrIdResponse

func (*ClientWithResponses) PutApiSignalToMetricsOriginOrIdWithResponse added in v1.9.0

func (*ClientWithResponses) PutApiSlosOriginOrIdWithBodyWithResponse added in v1.14.0

func (c *ClientWithResponses) PutApiSlosOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSlosOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSlosOriginOrIdResponse, error)

PutApiSlosOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiSlosOriginOrIdResponse

func (*ClientWithResponses) PutApiSlosOriginOrIdWithResponse added in v1.14.0

func (c *ClientWithResponses) PutApiSlosOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiSlosOriginOrIdParams, body PutApiSlosOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiSlosOriginOrIdResponse, error)

func (*ClientWithResponses) PutApiSpamFiltersOriginOrIdWithBodyWithResponse added in v1.12.0

func (c *ClientWithResponses) PutApiSpamFiltersOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSpamFiltersOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSpamFiltersOriginOrIdResponse, error)

PutApiSpamFiltersOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiSpamFiltersOriginOrIdResponse

func (*ClientWithResponses) PutApiSpamFiltersOriginOrIdWithResponse added in v1.12.0

func (*ClientWithResponses) PutApiSyntheticChecksOriginOrIdWithBodyWithResponse

func (c *ClientWithResponses) PutApiSyntheticChecksOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSyntheticChecksOriginOrIdResponse, error)

PutApiSyntheticChecksOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiSyntheticChecksOriginOrIdResponse

func (*ClientWithResponses) PutApiTeamsOriginOrIdDisplayWithBodyWithResponse added in v1.4.0

func (c *ClientWithResponses) PutApiTeamsOriginOrIdDisplayWithBodyWithResponse(ctx context.Context, originOrId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiTeamsOriginOrIdDisplayResponse, error)

PutApiTeamsOriginOrIdDisplayWithBodyWithResponse request with arbitrary body returning *PutApiTeamsOriginOrIdDisplayResponse

func (*ClientWithResponses) PutApiTeamsOriginOrIdDisplayWithResponse added in v1.4.0

func (c *ClientWithResponses) PutApiTeamsOriginOrIdDisplayWithResponse(ctx context.Context, originOrId string, body PutApiTeamsOriginOrIdDisplayJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiTeamsOriginOrIdDisplayResponse, error)

func (*ClientWithResponses) PutApiTeamsOriginOrIdWithBodyWithResponse added in v1.17.0

func (c *ClientWithResponses) PutApiTeamsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiTeamsOriginOrIdResponse, error)

PutApiTeamsOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiTeamsOriginOrIdResponse

func (*ClientWithResponses) PutApiTeamsOriginOrIdWithResponse added in v1.17.0

func (c *ClientWithResponses) PutApiTeamsOriginOrIdWithResponse(ctx context.Context, originOrId string, body PutApiTeamsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiTeamsOriginOrIdResponse, error)

func (*ClientWithResponses) PutApiTimeSeriesAggregationsOriginOrIdWithBodyWithResponse added in v1.17.0

func (c *ClientWithResponses) PutApiTimeSeriesAggregationsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiTimeSeriesAggregationsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiTimeSeriesAggregationsOriginOrIdResponse, error)

PutApiTimeSeriesAggregationsOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiTimeSeriesAggregationsOriginOrIdResponse

func (*ClientWithResponses) PutApiViewsOriginOrIdWithBodyWithResponse

func (c *ClientWithResponses) PutApiViewsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiViewsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiViewsOriginOrIdResponse, error)

PutApiViewsOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiViewsOriginOrIdResponse

func (*ClientWithResponses) PutApiViewsOriginOrIdWithResponse

func (c *ClientWithResponses) PutApiViewsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiViewsOriginOrIdParams, body PutApiViewsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiViewsOriginOrIdResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetWellKnownOauthAuthorizationServerWithResponse request
	GetWellKnownOauthAuthorizationServerWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetWellKnownOauthAuthorizationServerResponse, error)

	// GetWellKnownOauthProtectedResourceWithResponse request
	GetWellKnownOauthProtectedResourceWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetWellKnownOauthProtectedResourceResponse, error)

	// GetApiAgenticWorkflowsWithResponse request
	GetApiAgenticWorkflowsWithResponse(ctx context.Context, params *GetApiAgenticWorkflowsParams, reqEditors ...RequestEditorFn) (*GetApiAgenticWorkflowsResponse, error)

	// PostApiAgenticWorkflowsWithBodyWithResponse request with any body
	PostApiAgenticWorkflowsWithBodyWithResponse(ctx context.Context, params *PostApiAgenticWorkflowsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiAgenticWorkflowsResponse, error)

	PostApiAgenticWorkflowsWithResponse(ctx context.Context, params *PostApiAgenticWorkflowsParams, body PostApiAgenticWorkflowsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiAgenticWorkflowsResponse, error)

	// DeleteApiAgenticWorkflowsOriginOrIdWithResponse request
	DeleteApiAgenticWorkflowsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiAgenticWorkflowsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiAgenticWorkflowsOriginOrIdResponse, error)

	// GetApiAgenticWorkflowsOriginOrIdWithResponse request
	GetApiAgenticWorkflowsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiAgenticWorkflowsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiAgenticWorkflowsOriginOrIdResponse, error)

	// PutApiAgenticWorkflowsOriginOrIdWithBodyWithResponse request with any body
	PutApiAgenticWorkflowsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiAgenticWorkflowsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiAgenticWorkflowsOriginOrIdResponse, error)

	PutApiAgenticWorkflowsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiAgenticWorkflowsOriginOrIdParams, body PutApiAgenticWorkflowsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiAgenticWorkflowsOriginOrIdResponse, error)

	// GetApiAlertingCheckRulesWithResponse request
	GetApiAlertingCheckRulesWithResponse(ctx context.Context, params *GetApiAlertingCheckRulesParams, reqEditors ...RequestEditorFn) (*GetApiAlertingCheckRulesResponse, error)

	// PostApiAlertingCheckRulesWithBodyWithResponse request with any body
	PostApiAlertingCheckRulesWithBodyWithResponse(ctx context.Context, params *PostApiAlertingCheckRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiAlertingCheckRulesResponse, error)

	PostApiAlertingCheckRulesWithResponse(ctx context.Context, params *PostApiAlertingCheckRulesParams, body PostApiAlertingCheckRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiAlertingCheckRulesResponse, error)

	// PostApiAlertingCheckRulesBulkWithBodyWithResponse request with any body
	PostApiAlertingCheckRulesBulkWithBodyWithResponse(ctx context.Context, params *PostApiAlertingCheckRulesBulkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiAlertingCheckRulesBulkResponse, error)

	PostApiAlertingCheckRulesBulkWithResponse(ctx context.Context, params *PostApiAlertingCheckRulesBulkParams, body PostApiAlertingCheckRulesBulkJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiAlertingCheckRulesBulkResponse, error)

	// DeleteApiAlertingCheckRulesOriginOrIdWithResponse request
	DeleteApiAlertingCheckRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiAlertingCheckRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiAlertingCheckRulesOriginOrIdResponse, error)

	// GetApiAlertingCheckRulesOriginOrIdWithResponse request
	GetApiAlertingCheckRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiAlertingCheckRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiAlertingCheckRulesOriginOrIdResponse, error)

	// PutApiAlertingCheckRulesOriginOrIdWithBodyWithResponse request with any body
	PutApiAlertingCheckRulesOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiAlertingCheckRulesOriginOrIdResponse, error)

	PutApiAlertingCheckRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, body PutApiAlertingCheckRulesOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiAlertingCheckRulesOriginOrIdResponse, error)

	// GetApiDashboardsWithResponse request
	GetApiDashboardsWithResponse(ctx context.Context, params *GetApiDashboardsParams, reqEditors ...RequestEditorFn) (*GetApiDashboardsResponse, error)

	// PostApiDashboardsWithBodyWithResponse request with any body
	PostApiDashboardsWithBodyWithResponse(ctx context.Context, params *PostApiDashboardsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiDashboardsResponse, error)

	PostApiDashboardsWithResponse(ctx context.Context, params *PostApiDashboardsParams, body PostApiDashboardsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiDashboardsResponse, error)

	// DeleteApiDashboardsOriginOrIdWithResponse request
	DeleteApiDashboardsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiDashboardsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiDashboardsOriginOrIdResponse, error)

	// GetApiDashboardsOriginOrIdWithResponse request
	GetApiDashboardsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiDashboardsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiDashboardsOriginOrIdResponse, error)

	// PutApiDashboardsOriginOrIdWithBodyWithResponse request with any body
	PutApiDashboardsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiDashboardsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiDashboardsOriginOrIdResponse, error)

	PutApiDashboardsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiDashboardsOriginOrIdParams, body PutApiDashboardsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiDashboardsOriginOrIdResponse, error)

	// GetApiEdgeSettingsWithResponse request
	GetApiEdgeSettingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiEdgeSettingsResponse, error)

	// PostApiImportCheckRuleWithBodyWithResponse request with any body
	PostApiImportCheckRuleWithBodyWithResponse(ctx context.Context, params *PostApiImportCheckRuleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportCheckRuleResponse, error)

	PostApiImportCheckRuleWithResponse(ctx context.Context, params *PostApiImportCheckRuleParams, body PostApiImportCheckRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiImportCheckRuleResponse, error)

	// PostApiImportCheckRulesWithBodyWithResponse request with any body
	PostApiImportCheckRulesWithBodyWithResponse(ctx context.Context, params *PostApiImportCheckRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportCheckRulesResponse, error)

	PostApiImportCheckRulesWithResponse(ctx context.Context, params *PostApiImportCheckRulesParams, body PostApiImportCheckRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiImportCheckRulesResponse, error)

	// PostApiImportDashboardWithBodyWithResponse request with any body
	PostApiImportDashboardWithBodyWithResponse(ctx context.Context, params *PostApiImportDashboardParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportDashboardResponse, error)

	PostApiImportDashboardWithResponse(ctx context.Context, params *PostApiImportDashboardParams, body PostApiImportDashboardJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiImportDashboardResponse, error)

	// PutApiImportSignalToMetricsWithBodyWithResponse request with any body
	PutApiImportSignalToMetricsWithBodyWithResponse(ctx context.Context, params *PutApiImportSignalToMetricsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiImportSignalToMetricsResponse, error)

	PutApiImportSignalToMetricsWithResponse(ctx context.Context, params *PutApiImportSignalToMetricsParams, body PutApiImportSignalToMetricsJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiImportSignalToMetricsResponse, error)

	// PostApiImportSyntheticCheckWithBodyWithResponse request with any body
	PostApiImportSyntheticCheckWithBodyWithResponse(ctx context.Context, params *PostApiImportSyntheticCheckParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportSyntheticCheckResponse, error)

	PostApiImportSyntheticCheckWithResponse(ctx context.Context, params *PostApiImportSyntheticCheckParams, body PostApiImportSyntheticCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiImportSyntheticCheckResponse, error)

	// PostApiImportViewWithBodyWithResponse request with any body
	PostApiImportViewWithBodyWithResponse(ctx context.Context, params *PostApiImportViewParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportViewResponse, error)

	PostApiImportViewWithResponse(ctx context.Context, params *PostApiImportViewParams, body PostApiImportViewJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiImportViewResponse, error)

	// PostApiLogsWithBodyWithResponse request with any body
	PostApiLogsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiLogsResponse, error)

	PostApiLogsWithResponse(ctx context.Context, body PostApiLogsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiLogsResponse, error)

	// PostApiLogsDownloadWithBodyWithResponse request with any body
	PostApiLogsDownloadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiLogsDownloadResponse, error)

	PostApiLogsDownloadWithResponse(ctx context.Context, body PostApiLogsDownloadJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiLogsDownloadResponse, error)

	// GetApiMembersWithResponse request
	GetApiMembersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiMembersResponse, error)

	// PostApiMembersWithBodyWithResponse request with any body
	PostApiMembersWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiMembersResponse, error)

	PostApiMembersWithResponse(ctx context.Context, body PostApiMembersJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiMembersResponse, error)

	// DeleteApiMembersMemberIDWithResponse request
	DeleteApiMembersMemberIDWithResponse(ctx context.Context, memberID string, reqEditors ...RequestEditorFn) (*DeleteApiMembersMemberIDResponse, error)

	// GetApiNotificationChannelsWithResponse request
	GetApiNotificationChannelsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiNotificationChannelsResponse, error)

	// PostApiNotificationChannelsWithBodyWithResponse request with any body
	PostApiNotificationChannelsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiNotificationChannelsResponse, error)

	PostApiNotificationChannelsWithResponse(ctx context.Context, body PostApiNotificationChannelsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiNotificationChannelsResponse, error)

	// DeleteApiNotificationChannelsOriginOrIdWithResponse request
	DeleteApiNotificationChannelsOriginOrIdWithResponse(ctx context.Context, originOrId string, reqEditors ...RequestEditorFn) (*DeleteApiNotificationChannelsOriginOrIdResponse, error)

	// GetApiNotificationChannelsOriginOrIdWithResponse request
	GetApiNotificationChannelsOriginOrIdWithResponse(ctx context.Context, originOrId string, reqEditors ...RequestEditorFn) (*GetApiNotificationChannelsOriginOrIdResponse, error)

	// PutApiNotificationChannelsOriginOrIdWithBodyWithResponse request with any body
	PutApiNotificationChannelsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiNotificationChannelsOriginOrIdResponse, error)

	PutApiNotificationChannelsOriginOrIdWithResponse(ctx context.Context, originOrId string, body PutApiNotificationChannelsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiNotificationChannelsOriginOrIdResponse, error)

	// GetApiPrometheusApiV1FormatQueryWithResponse request
	GetApiPrometheusApiV1FormatQueryWithResponse(ctx context.Context, params *GetApiPrometheusApiV1FormatQueryParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1FormatQueryResponse, error)

	// PostApiPrometheusApiV1FormatQueryWithBodyWithResponse request with any body
	PostApiPrometheusApiV1FormatQueryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1FormatQueryResponse, error)

	PostApiPrometheusApiV1FormatQueryWithResponse(ctx context.Context, body PostApiPrometheusApiV1FormatQueryJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1FormatQueryResponse, error)

	// GetApiPrometheusApiV1LabelLabelNameValuesWithResponse request
	GetApiPrometheusApiV1LabelLabelNameValuesWithResponse(ctx context.Context, labelName string, params *GetApiPrometheusApiV1LabelLabelNameValuesParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1LabelLabelNameValuesResponse, error)

	// PostApiPrometheusApiV1LabelLabelNameValuesWithBodyWithResponse request with any body
	PostApiPrometheusApiV1LabelLabelNameValuesWithBodyWithResponse(ctx context.Context, labelName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1LabelLabelNameValuesResponse, error)

	PostApiPrometheusApiV1LabelLabelNameValuesWithResponse(ctx context.Context, labelName string, body PostApiPrometheusApiV1LabelLabelNameValuesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1LabelLabelNameValuesResponse, error)

	// GetApiPrometheusApiV1LabelsWithResponse request
	GetApiPrometheusApiV1LabelsWithResponse(ctx context.Context, params *GetApiPrometheusApiV1LabelsParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1LabelsResponse, error)

	// PostApiPrometheusApiV1LabelsWithBodyWithResponse request with any body
	PostApiPrometheusApiV1LabelsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1LabelsResponse, error)

	PostApiPrometheusApiV1LabelsWithResponse(ctx context.Context, body PostApiPrometheusApiV1LabelsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1LabelsResponse, error)

	// GetApiPrometheusApiV1MetadataWithResponse request
	GetApiPrometheusApiV1MetadataWithResponse(ctx context.Context, params *GetApiPrometheusApiV1MetadataParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1MetadataResponse, error)

	// PostApiPrometheusApiV1MetadataWithBodyWithResponse request with any body
	PostApiPrometheusApiV1MetadataWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1MetadataResponse, error)

	PostApiPrometheusApiV1MetadataWithResponse(ctx context.Context, body PostApiPrometheusApiV1MetadataJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1MetadataResponse, error)

	// GetApiPrometheusApiV1QueryWithResponse request
	GetApiPrometheusApiV1QueryWithResponse(ctx context.Context, params *GetApiPrometheusApiV1QueryParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1QueryResponse, error)

	// PostApiPrometheusApiV1QueryWithBodyWithResponse request with any body
	PostApiPrometheusApiV1QueryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1QueryResponse, error)

	PostApiPrometheusApiV1QueryWithResponse(ctx context.Context, body PostApiPrometheusApiV1QueryJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1QueryResponse, error)

	// GetApiPrometheusApiV1QueryRangeWithResponse request
	GetApiPrometheusApiV1QueryRangeWithResponse(ctx context.Context, params *GetApiPrometheusApiV1QueryRangeParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1QueryRangeResponse, error)

	// PostApiPrometheusApiV1QueryRangeWithBodyWithResponse request with any body
	PostApiPrometheusApiV1QueryRangeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1QueryRangeResponse, error)

	PostApiPrometheusApiV1QueryRangeWithResponse(ctx context.Context, body PostApiPrometheusApiV1QueryRangeJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1QueryRangeResponse, error)

	// GetApiPrometheusApiV1SeriesWithResponse request
	GetApiPrometheusApiV1SeriesWithResponse(ctx context.Context, params *GetApiPrometheusApiV1SeriesParams, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1SeriesResponse, error)

	// PostApiPrometheusApiV1SeriesWithBodyWithResponse request with any body
	PostApiPrometheusApiV1SeriesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1SeriesResponse, error)

	PostApiPrometheusApiV1SeriesWithResponse(ctx context.Context, body PostApiPrometheusApiV1SeriesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiPrometheusApiV1SeriesResponse, error)

	// GetApiPrometheusApiV1StatusBuildinfoWithResponse request
	GetApiPrometheusApiV1StatusBuildinfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1StatusBuildinfoResponse, error)

	// GetApiPrometheusApiV1StatusRuntimeinfoWithResponse request
	GetApiPrometheusApiV1StatusRuntimeinfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiPrometheusApiV1StatusRuntimeinfoResponse, error)

	// GetApiRecordingRulesWithResponse request
	GetApiRecordingRulesWithResponse(ctx context.Context, params *GetApiRecordingRulesParams, reqEditors ...RequestEditorFn) (*GetApiRecordingRulesResponse, error)

	// PostApiRecordingRulesWithBodyWithResponse request with any body
	PostApiRecordingRulesWithBodyWithResponse(ctx context.Context, params *PostApiRecordingRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiRecordingRulesResponse, error)

	PostApiRecordingRulesWithResponse(ctx context.Context, params *PostApiRecordingRulesParams, body PostApiRecordingRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiRecordingRulesResponse, error)

	// DeleteApiRecordingRulesOriginOrIdWithResponse request
	DeleteApiRecordingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiRecordingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiRecordingRulesOriginOrIdResponse, error)

	// GetApiRecordingRulesOriginOrIdWithResponse request
	GetApiRecordingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiRecordingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiRecordingRulesOriginOrIdResponse, error)

	// PutApiRecordingRulesOriginOrIdWithBodyWithResponse request with any body
	PutApiRecordingRulesOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiRecordingRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiRecordingRulesOriginOrIdResponse, error)

	PutApiRecordingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiRecordingRulesOriginOrIdParams, body PutApiRecordingRulesOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiRecordingRulesOriginOrIdResponse, error)

	// GetApiSamplingRulesWithResponse request
	GetApiSamplingRulesWithResponse(ctx context.Context, params *GetApiSamplingRulesParams, reqEditors ...RequestEditorFn) (*GetApiSamplingRulesResponse, error)

	// PostApiSamplingRulesWithBodyWithResponse request with any body
	PostApiSamplingRulesWithBodyWithResponse(ctx context.Context, params *PostApiSamplingRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSamplingRulesResponse, error)

	PostApiSamplingRulesWithResponse(ctx context.Context, params *PostApiSamplingRulesParams, body PostApiSamplingRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSamplingRulesResponse, error)

	// DeleteApiSamplingRulesOriginOrIdWithResponse request
	DeleteApiSamplingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSamplingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSamplingRulesOriginOrIdResponse, error)

	// GetApiSamplingRulesOriginOrIdWithResponse request
	GetApiSamplingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSamplingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSamplingRulesOriginOrIdResponse, error)

	// PutApiSamplingRulesOriginOrIdWithBodyWithResponse request with any body
	PutApiSamplingRulesOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSamplingRulesOriginOrIdResponse, error)

	PutApiSamplingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, body PutApiSamplingRulesOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiSamplingRulesOriginOrIdResponse, error)

	// GetApiSignalToMetricsWithResponse request
	GetApiSignalToMetricsWithResponse(ctx context.Context, params *GetApiSignalToMetricsParams, reqEditors ...RequestEditorFn) (*GetApiSignalToMetricsResponse, error)

	// PostApiSignalToMetricsWithBodyWithResponse request with any body
	PostApiSignalToMetricsWithBodyWithResponse(ctx context.Context, params *PostApiSignalToMetricsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSignalToMetricsResponse, error)

	PostApiSignalToMetricsWithResponse(ctx context.Context, params *PostApiSignalToMetricsParams, body PostApiSignalToMetricsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSignalToMetricsResponse, error)

	// PostApiSignalToMetricsTestWithBodyWithResponse request with any body
	PostApiSignalToMetricsTestWithBodyWithResponse(ctx context.Context, params *PostApiSignalToMetricsTestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSignalToMetricsTestResponse, error)

	PostApiSignalToMetricsTestWithResponse(ctx context.Context, params *PostApiSignalToMetricsTestParams, body PostApiSignalToMetricsTestJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSignalToMetricsTestResponse, error)

	// DeleteApiSignalToMetricsOriginOrIdWithResponse request
	DeleteApiSignalToMetricsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSignalToMetricsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSignalToMetricsOriginOrIdResponse, error)

	// GetApiSignalToMetricsOriginOrIdWithResponse request
	GetApiSignalToMetricsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSignalToMetricsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSignalToMetricsOriginOrIdResponse, error)

	// PutApiSignalToMetricsOriginOrIdWithBodyWithResponse request with any body
	PutApiSignalToMetricsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSignalToMetricsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSignalToMetricsOriginOrIdResponse, error)

	PutApiSignalToMetricsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiSignalToMetricsOriginOrIdParams, body PutApiSignalToMetricsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiSignalToMetricsOriginOrIdResponse, error)

	// GetApiSlosWithResponse request
	GetApiSlosWithResponse(ctx context.Context, params *GetApiSlosParams, reqEditors ...RequestEditorFn) (*GetApiSlosResponse, error)

	// PostApiSlosWithBodyWithResponse request with any body
	PostApiSlosWithBodyWithResponse(ctx context.Context, params *PostApiSlosParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSlosResponse, error)

	PostApiSlosWithResponse(ctx context.Context, params *PostApiSlosParams, body PostApiSlosJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSlosResponse, error)

	// DeleteApiSlosOriginOrIdWithResponse request
	DeleteApiSlosOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSlosOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSlosOriginOrIdResponse, error)

	// GetApiSlosOriginOrIdWithResponse request
	GetApiSlosOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSlosOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSlosOriginOrIdResponse, error)

	// PutApiSlosOriginOrIdWithBodyWithResponse request with any body
	PutApiSlosOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSlosOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSlosOriginOrIdResponse, error)

	PutApiSlosOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiSlosOriginOrIdParams, body PutApiSlosOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiSlosOriginOrIdResponse, error)

	// GetApiSpamFiltersWithResponse request
	GetApiSpamFiltersWithResponse(ctx context.Context, params *GetApiSpamFiltersParams, reqEditors ...RequestEditorFn) (*GetApiSpamFiltersResponse, error)

	// PostApiSpamFiltersWithBodyWithResponse request with any body
	PostApiSpamFiltersWithBodyWithResponse(ctx context.Context, params *PostApiSpamFiltersParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSpamFiltersResponse, error)

	PostApiSpamFiltersWithResponse(ctx context.Context, params *PostApiSpamFiltersParams, body PostApiSpamFiltersJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSpamFiltersResponse, error)

	// DeleteApiSpamFiltersOriginOrIdWithResponse request
	DeleteApiSpamFiltersOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSpamFiltersOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSpamFiltersOriginOrIdResponse, error)

	// GetApiSpamFiltersOriginOrIdWithResponse request
	GetApiSpamFiltersOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSpamFiltersOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSpamFiltersOriginOrIdResponse, error)

	// PutApiSpamFiltersOriginOrIdWithBodyWithResponse request with any body
	PutApiSpamFiltersOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSpamFiltersOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSpamFiltersOriginOrIdResponse, error)

	PutApiSpamFiltersOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiSpamFiltersOriginOrIdParams, body PutApiSpamFiltersOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiSpamFiltersOriginOrIdResponse, error)

	// PostApiSpansWithBodyWithResponse request with any body
	PostApiSpansWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSpansResponse, error)

	PostApiSpansWithResponse(ctx context.Context, body PostApiSpansJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSpansResponse, error)

	// PostApiSpansDownloadWithBodyWithResponse request with any body
	PostApiSpansDownloadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSpansDownloadResponse, error)

	PostApiSpansDownloadWithResponse(ctx context.Context, body PostApiSpansDownloadJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSpansDownloadResponse, error)

	// PostApiSqlWithBodyWithResponse request with any body
	PostApiSqlWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSqlResponse, error)

	PostApiSqlWithResponse(ctx context.Context, body PostApiSqlJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSqlResponse, error)

	// GetApiSyntheticChecksWithResponse request
	GetApiSyntheticChecksWithResponse(ctx context.Context, params *GetApiSyntheticChecksParams, reqEditors ...RequestEditorFn) (*GetApiSyntheticChecksResponse, error)

	// PostApiSyntheticChecksWithBodyWithResponse request with any body
	PostApiSyntheticChecksWithBodyWithResponse(ctx context.Context, params *PostApiSyntheticChecksParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSyntheticChecksResponse, error)

	PostApiSyntheticChecksWithResponse(ctx context.Context, params *PostApiSyntheticChecksParams, body PostApiSyntheticChecksJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSyntheticChecksResponse, error)

	// GetApiSyntheticChecksLocationsWithResponse request
	GetApiSyntheticChecksLocationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiSyntheticChecksLocationsResponse, error)

	// PostApiSyntheticChecksTestWithBodyWithResponse request with any body
	PostApiSyntheticChecksTestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSyntheticChecksTestResponse, error)

	PostApiSyntheticChecksTestWithResponse(ctx context.Context, body PostApiSyntheticChecksTestJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSyntheticChecksTestResponse, error)

	// DeleteApiSyntheticChecksOriginOrIdWithResponse request
	DeleteApiSyntheticChecksOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSyntheticChecksOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSyntheticChecksOriginOrIdResponse, error)

	// GetApiSyntheticChecksOriginOrIdWithResponse request
	GetApiSyntheticChecksOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSyntheticChecksOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSyntheticChecksOriginOrIdResponse, error)

	// PutApiSyntheticChecksOriginOrIdWithBodyWithResponse request with any body
	PutApiSyntheticChecksOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSyntheticChecksOriginOrIdResponse, error)

	PutApiSyntheticChecksOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, body PutApiSyntheticChecksOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiSyntheticChecksOriginOrIdResponse, error)

	// GetApiTeamsWithResponse request
	GetApiTeamsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiTeamsResponse, error)

	// PostApiTeamsWithBodyWithResponse request with any body
	PostApiTeamsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiTeamsResponse, error)

	PostApiTeamsWithResponse(ctx context.Context, body PostApiTeamsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiTeamsResponse, error)

	// DeleteApiTeamsOriginOrIdWithResponse request
	DeleteApiTeamsOriginOrIdWithResponse(ctx context.Context, originOrId string, reqEditors ...RequestEditorFn) (*DeleteApiTeamsOriginOrIdResponse, error)

	// GetApiTeamsOriginOrIdWithResponse request
	GetApiTeamsOriginOrIdWithResponse(ctx context.Context, originOrId string, reqEditors ...RequestEditorFn) (*GetApiTeamsOriginOrIdResponse, error)

	// PutApiTeamsOriginOrIdWithBodyWithResponse request with any body
	PutApiTeamsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiTeamsOriginOrIdResponse, error)

	PutApiTeamsOriginOrIdWithResponse(ctx context.Context, originOrId string, body PutApiTeamsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiTeamsOriginOrIdResponse, error)

	// PutApiTeamsOriginOrIdDisplayWithBodyWithResponse request with any body
	PutApiTeamsOriginOrIdDisplayWithBodyWithResponse(ctx context.Context, originOrId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiTeamsOriginOrIdDisplayResponse, error)

	PutApiTeamsOriginOrIdDisplayWithResponse(ctx context.Context, originOrId string, body PutApiTeamsOriginOrIdDisplayJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiTeamsOriginOrIdDisplayResponse, error)

	// PostApiTeamsOriginOrIdMembersWithBodyWithResponse request with any body
	PostApiTeamsOriginOrIdMembersWithBodyWithResponse(ctx context.Context, originOrId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiTeamsOriginOrIdMembersResponse, error)

	PostApiTeamsOriginOrIdMembersWithResponse(ctx context.Context, originOrId string, body PostApiTeamsOriginOrIdMembersJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiTeamsOriginOrIdMembersResponse, error)

	// DeleteApiTeamsOriginOrIdMembersMemberIDWithResponse request
	DeleteApiTeamsOriginOrIdMembersMemberIDWithResponse(ctx context.Context, originOrId string, memberID string, reqEditors ...RequestEditorFn) (*DeleteApiTeamsOriginOrIdMembersMemberIDResponse, error)

	// GetApiTimeSeriesAggregationsWithResponse request
	GetApiTimeSeriesAggregationsWithResponse(ctx context.Context, params *GetApiTimeSeriesAggregationsParams, reqEditors ...RequestEditorFn) (*GetApiTimeSeriesAggregationsResponse, error)

	// PostApiTimeSeriesAggregationsWithBodyWithResponse request with any body
	PostApiTimeSeriesAggregationsWithBodyWithResponse(ctx context.Context, params *PostApiTimeSeriesAggregationsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiTimeSeriesAggregationsResponse, error)

	PostApiTimeSeriesAggregationsWithResponse(ctx context.Context, params *PostApiTimeSeriesAggregationsParams, body PostApiTimeSeriesAggregationsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiTimeSeriesAggregationsResponse, error)

	// DeleteApiTimeSeriesAggregationsOriginOrIdWithResponse request
	DeleteApiTimeSeriesAggregationsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiTimeSeriesAggregationsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiTimeSeriesAggregationsOriginOrIdResponse, error)

	// GetApiTimeSeriesAggregationsOriginOrIdWithResponse request
	GetApiTimeSeriesAggregationsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiTimeSeriesAggregationsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiTimeSeriesAggregationsOriginOrIdResponse, error)

	// PutApiTimeSeriesAggregationsOriginOrIdWithBodyWithResponse request with any body
	PutApiTimeSeriesAggregationsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiTimeSeriesAggregationsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiTimeSeriesAggregationsOriginOrIdResponse, error)

	PutApiTimeSeriesAggregationsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiTimeSeriesAggregationsOriginOrIdParams, body PutApiTimeSeriesAggregationsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiTimeSeriesAggregationsOriginOrIdResponse, error)

	// PostApiTraceDetailsWithBodyWithResponse request with any body
	PostApiTraceDetailsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiTraceDetailsResponse, error)

	PostApiTraceDetailsWithResponse(ctx context.Context, body PostApiTraceDetailsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiTraceDetailsResponse, error)

	// PostApiTraceIdsWithBodyWithResponse request with any body
	PostApiTraceIdsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiTraceIdsResponse, error)

	PostApiTraceIdsWithResponse(ctx context.Context, body PostApiTraceIdsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiTraceIdsResponse, error)

	// GetApiViewsWithResponse request
	GetApiViewsWithResponse(ctx context.Context, params *GetApiViewsParams, reqEditors ...RequestEditorFn) (*GetApiViewsResponse, error)

	// PostApiViewsWithBodyWithResponse request with any body
	PostApiViewsWithBodyWithResponse(ctx context.Context, params *PostApiViewsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiViewsResponse, error)

	PostApiViewsWithResponse(ctx context.Context, params *PostApiViewsParams, body PostApiViewsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiViewsResponse, error)

	// DeleteApiViewsOriginOrIdWithResponse request
	DeleteApiViewsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiViewsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiViewsOriginOrIdResponse, error)

	// GetApiViewsOriginOrIdWithResponse request
	GetApiViewsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiViewsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiViewsOriginOrIdResponse, error)

	// PutApiViewsOriginOrIdWithBodyWithResponse request with any body
	PutApiViewsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiViewsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiViewsOriginOrIdResponse, error)

	PutApiViewsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiViewsOriginOrIdParams, body PutApiViewsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiViewsOriginOrIdResponse, error)

	// PostApiWebEventsDownloadWithBodyWithResponse request with any body
	PostApiWebEventsDownloadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiWebEventsDownloadResponse, error)

	PostApiWebEventsDownloadWithResponse(ctx context.Context, body PostApiWebEventsDownloadJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiWebEventsDownloadResponse, error)

	// GetOauthAuthorizeWithResponse request
	GetOauthAuthorizeWithResponse(ctx context.Context, params *GetOauthAuthorizeParams, reqEditors ...RequestEditorFn) (*GetOauthAuthorizeResponse, error)

	// PostOauthRegisterWithBodyWithResponse request with any body
	PostOauthRegisterWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostOauthRegisterResponse, error)

	PostOauthRegisterWithResponse(ctx context.Context, body PostOauthRegisterJSONRequestBody, reqEditors ...RequestEditorFn) (*PostOauthRegisterResponse, error)

	// PostOauthRevokeWithBodyWithResponse request with any body
	PostOauthRevokeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostOauthRevokeResponse, error)

	PostOauthRevokeWithFormdataBodyWithResponse(ctx context.Context, body PostOauthRevokeFormdataRequestBody, reqEditors ...RequestEditorFn) (*PostOauthRevokeResponse, error)

	// PostOauthTokenWithBodyWithResponse request with any body
	PostOauthTokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostOauthTokenResponse, error)

	PostOauthTokenWithFormdataBodyWithResponse(ctx context.Context, body PostOauthTokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*PostOauthTokenResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CrdSource added in v1.12.0

type CrdSource string

CrdSource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.

  • `ui`: created interactively in the Dash0 UI.
  • `terraform`: managed via the Dash0 Terraform provider.
  • `operator`: managed via the Dash0 Kubernetes operator.
  • `dash0-cli`: managed via the Dash0 CLI.
  • `platform`: owned by Dash0 rather than by anyone in your organization. Covers both resources Dash0 generates from another resource you own (the recording rules an SLO produces) and resources Dash0 ships with the product (the built-in views).
  • `api`: created directly through the API, and the fallback for any origin whose prefix is not recognized.

New values may be added over time. Treat an unrecognized value as `api` rather than rejecting the response.

const (
	Api       CrdSource = "api"
	Dash0Cli  CrdSource = "dash0-cli"
	Operator  CrdSource = "operator"
	Platform  CrdSource = "platform"
	Terraform CrdSource = "terraform"
	Ui        CrdSource = "ui"
)

Defines values for CrdSource.

type Cursor

type Cursor = string

Cursor The cursor to another set of results. The value of this field is opaque to the client and may be used as a parameter to the next request to get the another set of results. Cursors do not implement any ordering.

type CursorPagination

type CursorPagination struct {
	// Cursor The cursor to another set of results. The value of this field is opaque to the
	// client and may be used as a parameter to the next request to get the another set of results.
	// Cursors do not implement any ordering.
	Cursor *Cursor `json:"cursor,omitempty"`

	// Limit The maximum number of results to return. If not set, there is a default limit to the number of results returned.
	Limit *int64 `json:"limit,omitempty"`
}

CursorPagination Cursor pagination is a technique for paging through a result set using a cursor. It is similar to offset pagination except that the cursor is an opaque value that encodes the position within the result set. This allows for fetching the next page of results from the current position without having to skip over a potentially large number of rows.

It is also more resilient against late-arriving data which otherwise would cause issues with offset pagination. For example, if a row is inserted between two pages of results then the second page would contain a duplicate row and the third page would be missing.

type D0QLWarnings added in v1.6.0

type D0QLWarnings = []string

D0QLWarnings defines model for D0QLWarnings.

type DarkplaneConfig added in v1.21.0

type DarkplaneConfig struct {
	// RespectNativeCodingAgentTelemetry Controls whether OpenTelemetry telemetry natively emitted by coding agents
	// (e.g. Claude Code) is processed by Darkplane.
	//
	// - `disabled`: Native coding-agent telemetry is not processed by Darkplane.
	// - `enabled`: Native coding-agent telemetry is processed by Darkplane.
	RespectNativeCodingAgentTelemetry *RespectNativeCodingAgentTelemetry `json:"respectNativeCodingAgentTelemetry,omitempty"`
}

DarkplaneConfig Darkplane-specific opt-ins for this dataset.

type DashboardAnnotations

type DashboardAnnotations struct {
	Dash0ComdeletedAt *time.Time `json:"dash0.com/deleted-at,omitempty"`

	// Dash0ComfolderPath Optional UI folder path for organising groups (e.g. '/infrastructure/hosts'). Nesting is expressed with '/' separators.
	Dash0ComfolderPath *string `json:"dash0.com/folder-path,omitempty"`

	// Dash0Comsharing Comma-separated list of principals to grant read access to. Supported formats: 'team:<team_id>' and 'user:<email>'. Example: 'team:team_01abc,user:alice@example.com'. Sharing is honored only on assets that declare a dash0.com/origin (for example those managed by Terraform, the operator, the CLI, or the API). Setting it on an asset that declares no dash0.com/origin is rejected with a 400 — manage that asset's access via the UI share dialog instead.
	Dash0Comsharing *string `json:"dash0.com/sharing,omitempty"`
}

DashboardAnnotations defines model for DashboardAnnotations.

type DashboardApiListItem

type DashboardApiListItem struct {
	Dataset     string   `json:"dataset"`
	Description *string  `json:"description,omitempty"`
	Id          string   `json:"id"`
	Name        *string  `json:"name,omitempty"`
	Origin      *string  `json:"origin,omitempty"`
	Tags        []string `json:"tags"`
}

DashboardApiListItem defines model for DashboardApiListItem.

type DashboardDefinition

type DashboardDefinition struct {
	Kind     DashboardDefinitionKind `json:"kind"`
	Metadata DashboardMetadata       `json:"metadata"`
	Spec     map[string]interface{}  `json:"spec"`
}

DashboardDefinition A dashboard definition that is compatible with Perses' dashboarding system.

func ConvertPersesDashboardToDashboard added in v1.6.0

func ConvertPersesDashboardToDashboard(perses *PersesDashboard) *DashboardDefinition

ConvertPersesDashboardToDashboard converts a PersesDashboard CRD into a Dash0 DashboardDefinition. It normalizes v1alpha1/v1alpha2 differences (the v1alpha2 CRD wraps the spec in a "config" key) and ensures a display name is set, falling back to metadata.name.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	perses := &dash0.PersesDashboard{
		APIVersion: "perses.dev/v1alpha1",
		Kind:       "PersesDashboard",
		Metadata:   dash0.PersesDashboardMetadata{Name: "my-perses-dashboard"},
		Spec: map[string]any{
			"display": map[string]any{"name": "Perses Dashboard"},
		},
	}
	dashboard := dash0.ConvertPersesDashboardToDashboard(perses)
	fmt.Println(dashboard.Metadata.Name)
}
Output:
Perses Dashboard

type DashboardDefinitionKind

type DashboardDefinitionKind string

DashboardDefinitionKind defines model for DashboardDefinition.Kind.

const (
	Dashboard DashboardDefinitionKind = "Dashboard"
)

Defines values for DashboardDefinitionKind.

type DashboardLabels added in v1.12.3

type DashboardLabels struct {
	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource *CrdSource `json:"dash0.com/source,omitempty"`
}

DashboardLabels defines model for DashboardLabels.

type DashboardMetadata

type DashboardMetadata struct {
	Annotations     *DashboardAnnotations        `json:"annotations,omitempty"`
	CreatedAt       *time.Time                   `json:"createdAt,omitempty"`
	Dash0Extensions *DashboardMetadataExtensions `json:"dash0Extensions,omitempty"`
	Labels          *DashboardLabels             `json:"labels,omitempty"`
	Name            string                       `json:"name"`
	Project         *string                      `json:"project,omitempty"`
	UpdatedAt       *time.Time                   `json:"updatedAt,omitempty"`
	Version         *int64                       `json:"version,omitempty"`
}

DashboardMetadata defines model for DashboardMetadata.

type DashboardMetadataExtensions

type DashboardMetadataExtensions struct {
	// CreatedBy The member ID of the user who created this dashboard or dashboard version.
	CreatedBy *string `json:"createdBy,omitempty"`

	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset `json:"dataset,omitempty"`

	// Id An immutable id field to support automatic dashboard creation based on Kubernetes CRDs. This
	// field essentially acts as an external ID for the dashboard. We support a way to upsert dashboards based
	// on this field.
	Id *string `json:"id,omitempty"`

	// Origin This field is deprecated and is replaced by id field.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Origin *string   `json:"origin,omitempty"`
	Tags   *[]string `json:"tags,omitempty"`
}

DashboardMetadataExtensions defines model for DashboardMetadataExtensions.

type DashboardSource deprecated added in v1.2.0

type DashboardSource = CrdSource

DashboardSource is a deprecated alias for CrdSource.

Deprecated: since v1.12.0. Use CrdSource instead.

type Dataset

type Dataset = string

Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.

type DatasetAction added in v1.12.3

type DatasetAction string

DatasetAction defines model for DatasetAction.

const (
	DatasetCreateAgent0Automation   DatasetAction = "dataset:createAgent0Automation"
	DatasetCreateCheckRule          DatasetAction = "dataset:createCheckRule"
	DatasetCreateRecordingRuleGroup DatasetAction = "dataset:createRecordingRuleGroup"
	DatasetCreateSLO                DatasetAction = "dataset:createSLO"
	DatasetCreateSyntheticCheck     DatasetAction = "dataset:createSyntheticCheck"
	DatasetDelete                   DatasetAction = "dataset:delete"
	DatasetRead                     DatasetAction = "dataset:read"
	DatasetWrite                    DatasetAction = "dataset:write"
)

Defines values for DatasetAction.

type DatasetLoggingSettings added in v1.12.3

type DatasetLoggingSettings struct {
	// Retention The retention class selected for a signal, per dataset. The value is the
	// total retention in days, not an increase on top of a baseline.
	// Customer-selectable signals (logs, spans, web events) expose the full
	// set; non-selectable signals (metrics, profiling) keep their platform
	// defaults.
	//
	// - `30d`: 30 days total (the included baseline).
	// - `60d`: 60 days total.
	// - `90d`: 90 days total.
	// - `120d`: 120 days total.
	// - `210d`: 210 days total.
	// - `390d`: 390 days total.
	Retention RetentionClass `json:"retention"`
}

DatasetLoggingSettings defines model for DatasetLoggingSettings.

type DatasetMetricsSettings added in v1.12.3

type DatasetMetricsSettings struct {
	// Retention The retention class selected for a signal, per dataset. The value is the
	// total retention in days, not an increase on top of a baseline.
	// Customer-selectable signals (logs, spans, web events) expose the full
	// set; non-selectable signals (metrics, profiling) keep their platform
	// defaults.
	//
	// - `30d`: 30 days total (the included baseline).
	// - `60d`: 60 days total.
	// - `90d`: 90 days total.
	// - `120d`: 120 days total.
	// - `210d`: 210 days total.
	// - `390d`: 390 days total.
	Retention RetentionClass `json:"retention"`
}

DatasetMetricsSettings defines model for DatasetMetricsSettings.

type DatasetPermission added in v1.12.3

type DatasetPermission struct {
	Actions []DatasetAction `json:"actions"`
	Role    *string         `json:"role,omitempty"`
	TeamId  *string         `json:"teamId,omitempty"`
	UserId  *string         `json:"userId,omitempty"`
}

DatasetPermission defines model for DatasetPermission.

type DatasetProfilingSettings added in v1.12.3

type DatasetProfilingSettings struct {
	// Retention The retention class selected for a signal, per dataset. The value is the
	// total retention in days, not an increase on top of a baseline.
	// Customer-selectable signals (logs, spans, web events) expose the full
	// set; non-selectable signals (metrics, profiling) keep their platform
	// defaults.
	//
	// - `30d`: 30 days total (the included baseline).
	// - `60d`: 60 days total.
	// - `90d`: 90 days total.
	// - `120d`: 120 days total.
	// - `210d`: 210 days total.
	// - `390d`: 390 days total.
	Retention RetentionClass `json:"retention"`
}

DatasetProfilingSettings defines model for DatasetProfilingSettings.

type DatasetRestriction added in v1.6.0

type DatasetRestriction string

DatasetRestriction defines model for DatasetRestriction.

const (
	Restricted   DatasetRestriction = "restricted"
	Unrestricted DatasetRestriction = "unrestricted"
)

Defines values for DatasetRestriction.

type DatasetSettings added in v1.12.3

type DatasetSettings struct {
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// Darkplane Darkplane-specific opt-ins for this dataset.
	Darkplane *DarkplaneConfig `json:"darkplane,omitempty"`

	// GenAiAttributeRedaction Fine-grained redaction policies for GenAI attributes, applied by the Collector before export.
	// Conversation content, tool-call I/O and tool-call error messages are controlled independently,
	// e.g. to keep conversation content private while still storing tool input/output.
	GenAiAttributeRedaction *GenAIAttributeRedactionSettings `json:"genAiAttributeRedaction,omitempty"`
	GeoLocation             GeoLocationSettings              `json:"geoLocation"`
	IpAddresses             IpAddressesSettings              `json:"ipAddresses"`
	Logging                 DatasetLoggingSettings           `json:"logging"`
	Metrics                 DatasetMetricsSettings           `json:"metrics"`
	Name                    string                           `json:"name"`
	Permissions             *[]DatasetPermission             `json:"permissions,omitempty"`
	PermittedActions        *[]DatasetAction                 `json:"permittedActions,omitempty"`
	Preferred               *bool                            `json:"preferred,omitempty"`
	Profiling               DatasetProfilingSettings         `json:"profiling"`

	// SemanticConventionUpgrades Choose whether or not semantic convention upgrades should be executed. Can be one of:
	//
	// - disabled: No upgrade will be executed
	// - latest: We will always upgrade to the latest and greatest
	// - vX.X.X: A SEMVER version. We will automatically upgrade up to that version (inclusive)
	//
	// Defaults to `latest` for new organizations.
	SemanticConventionUpgrades SemanticConventionUpgrades `json:"semanticConventionUpgrades"`

	// Slug Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Slug             Dataset                  `json:"slug"`
	TelemetryFilters []TelemetryFilter        `json:"telemetryFilters"`
	Tracing          DatasetTracingSettings   `json:"tracing"`
	UpdatedAt        *time.Time               `json:"updatedAt,omitempty"`
	Version          *int                     `json:"version,omitempty"`
	WebEvents        DatasetWebEventsSettings `json:"webEvents"`
}

DatasetSettings defines model for DatasetSettings.

type DatasetTracingSettings added in v1.12.3

type DatasetTracingSettings struct {
	// ConvertSpanEventsToLogRecords When enabled, span events are automatically converted to log records correlated with the parent span
	// via traceId and spanId. This supports the migration away from the deprecated Span Event API towards
	// the unified OTel event model where events are log records with names. Converted log records are tagged
	// with the `dash0.span_event.converted` attribute.
	ConvertSpanEventsToLogRecords *bool `json:"convertSpanEventsToLogRecords,omitempty"`

	// Retention The retention class selected for a signal, per dataset. The value is the
	// total retention in days, not an increase on top of a baseline.
	// Customer-selectable signals (logs, spans, web events) expose the full
	// set; non-selectable signals (metrics, profiling) keep their platform
	// defaults.
	//
	// - `30d`: 30 days total (the included baseline).
	// - `60d`: 60 days total.
	// - `90d`: 90 days total.
	// - `120d`: 120 days total.
	// - `210d`: 210 days total.
	// - `390d`: 390 days total.
	Retention RetentionClass `json:"retention"`
}

DatasetTracingSettings defines model for DatasetTracingSettings.

type DatasetWebEventsSettings added in v1.17.0

type DatasetWebEventsSettings struct {
	// Retention The retention class selected for a signal, per dataset. The value is the
	// total retention in days, not an increase on top of a baseline.
	// Customer-selectable signals (logs, spans, web events) expose the full
	// set; non-selectable signals (metrics, profiling) keep their platform
	// defaults.
	//
	// - `30d`: 30 days total (the included baseline).
	// - `60d`: 60 days total.
	// - `90d`: 90 days total.
	// - `120d`: 120 days total.
	// - `210d`: 210 days total.
	// - `390d`: 390 days total.
	Retention RetentionClass `json:"retention"`
}

DatasetWebEventsSettings defines model for DatasetWebEventsSettings.

type DeeplinkAssetType added in v1.13.0

type DeeplinkAssetType string

DeeplinkAssetType identifies a Dash0 asset type for which a web app deep link can be built.

const (
	DeeplinkAssetTypeDashboard           DeeplinkAssetType = "dashboard"
	DeeplinkAssetTypeCheckRule           DeeplinkAssetType = "check-rule"
	DeeplinkAssetTypeSyntheticCheck      DeeplinkAssetType = "synthetic-check"
	DeeplinkAssetTypeSLO                 DeeplinkAssetType = "slo"
	DeeplinkAssetTypeView                DeeplinkAssetType = "view"
	DeeplinkAssetTypeTeam                DeeplinkAssetType = "team"
	DeeplinkAssetTypeMember              DeeplinkAssetType = "member"
	DeeplinkAssetTypeNotificationChannel DeeplinkAssetType = "notification-channel"
)

Supported deep link asset types.

type DeeplinkFilter added in v1.13.0

type DeeplinkFilter struct {
	Key      string `json:"key"`
	Operator string `json:"operator"`
	Value    string `json:"value,omitempty"`
}

DeeplinkFilter represents a single filter criterion for explorer deep links.

func FiltersToDeeplinkFilters added in v1.13.0

func FiltersToDeeplinkFilters(filters *FilterCriteria) []DeeplinkFilter

FiltersToDeeplinkFilters converts parsed API filter criteria to deep link filter objects suitable for URL serialization. It returns nil when filters is nil.

type DeleteApiAgenticWorkflowsOriginOrIdParams added in v1.17.0

type DeleteApiAgenticWorkflowsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiAgenticWorkflowsOriginOrIdParams defines parameters for DeleteApiAgenticWorkflowsOriginOrId.

type DeleteApiAgenticWorkflowsOriginOrIdResponse added in v1.17.0

type DeleteApiAgenticWorkflowsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiAgenticWorkflowsOriginOrIdResponse added in v1.17.0

func ParseDeleteApiAgenticWorkflowsOriginOrIdResponse(rsp *http.Response) (*DeleteApiAgenticWorkflowsOriginOrIdResponse, error)

ParseDeleteApiAgenticWorkflowsOriginOrIdResponse parses an HTTP response from a DeleteApiAgenticWorkflowsOriginOrIdWithResponse call

func (DeleteApiAgenticWorkflowsOriginOrIdResponse) Status added in v1.17.0

Status returns HTTPResponse.Status

func (DeleteApiAgenticWorkflowsOriginOrIdResponse) StatusCode added in v1.17.0

StatusCode returns HTTPResponse.StatusCode

type DeleteApiAlertingCheckRulesOriginOrIdParams

type DeleteApiAlertingCheckRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiAlertingCheckRulesOriginOrIdParams defines parameters for DeleteApiAlertingCheckRulesOriginOrId.

type DeleteApiAlertingCheckRulesOriginOrIdResponse

type DeleteApiAlertingCheckRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiAlertingCheckRulesOriginOrIdResponse

func ParseDeleteApiAlertingCheckRulesOriginOrIdResponse(rsp *http.Response) (*DeleteApiAlertingCheckRulesOriginOrIdResponse, error)

ParseDeleteApiAlertingCheckRulesOriginOrIdResponse parses an HTTP response from a DeleteApiAlertingCheckRulesOriginOrIdWithResponse call

func (DeleteApiAlertingCheckRulesOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteApiAlertingCheckRulesOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DeleteApiDashboardsOriginOrIdParams

type DeleteApiDashboardsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiDashboardsOriginOrIdParams defines parameters for DeleteApiDashboardsOriginOrId.

type DeleteApiDashboardsOriginOrIdResponse

type DeleteApiDashboardsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiDashboardsOriginOrIdResponse

func ParseDeleteApiDashboardsOriginOrIdResponse(rsp *http.Response) (*DeleteApiDashboardsOriginOrIdResponse, error)

ParseDeleteApiDashboardsOriginOrIdResponse parses an HTTP response from a DeleteApiDashboardsOriginOrIdWithResponse call

func (DeleteApiDashboardsOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteApiDashboardsOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DeleteApiMembersMemberIDResponse added in v1.4.0

type DeleteApiMembersMemberIDResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiMembersMemberIDResponse added in v1.4.0

func ParseDeleteApiMembersMemberIDResponse(rsp *http.Response) (*DeleteApiMembersMemberIDResponse, error)

ParseDeleteApiMembersMemberIDResponse parses an HTTP response from a DeleteApiMembersMemberIDWithResponse call

func (DeleteApiMembersMemberIDResponse) Status added in v1.4.0

Status returns HTTPResponse.Status

func (DeleteApiMembersMemberIDResponse) StatusCode added in v1.4.0

func (r DeleteApiMembersMemberIDResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteApiNotificationChannelsOriginOrIdResponse added in v1.9.0

type DeleteApiNotificationChannelsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiNotificationChannelsOriginOrIdResponse added in v1.9.0

func ParseDeleteApiNotificationChannelsOriginOrIdResponse(rsp *http.Response) (*DeleteApiNotificationChannelsOriginOrIdResponse, error)

ParseDeleteApiNotificationChannelsOriginOrIdResponse parses an HTTP response from a DeleteApiNotificationChannelsOriginOrIdWithResponse call

func (DeleteApiNotificationChannelsOriginOrIdResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (DeleteApiNotificationChannelsOriginOrIdResponse) StatusCode added in v1.9.0

StatusCode returns HTTPResponse.StatusCode

type DeleteApiRecordingRulesOriginOrIdParams added in v1.9.0

type DeleteApiRecordingRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiRecordingRulesOriginOrIdParams defines parameters for DeleteApiRecordingRulesOriginOrId.

type DeleteApiRecordingRulesOriginOrIdResponse added in v1.9.0

type DeleteApiRecordingRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiRecordingRulesOriginOrIdResponse added in v1.9.0

func ParseDeleteApiRecordingRulesOriginOrIdResponse(rsp *http.Response) (*DeleteApiRecordingRulesOriginOrIdResponse, error)

ParseDeleteApiRecordingRulesOriginOrIdResponse parses an HTTP response from a DeleteApiRecordingRulesOriginOrIdWithResponse call

func (DeleteApiRecordingRulesOriginOrIdResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (DeleteApiRecordingRulesOriginOrIdResponse) StatusCode added in v1.9.0

StatusCode returns HTTPResponse.StatusCode

type DeleteApiSamplingRulesOriginOrIdParams added in v1.1.0

type DeleteApiSamplingRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiSamplingRulesOriginOrIdParams defines parameters for DeleteApiSamplingRulesOriginOrId.

type DeleteApiSamplingRulesOriginOrIdResponse added in v1.1.0

type DeleteApiSamplingRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiSamplingRulesOriginOrIdResponse added in v1.1.0

func ParseDeleteApiSamplingRulesOriginOrIdResponse(rsp *http.Response) (*DeleteApiSamplingRulesOriginOrIdResponse, error)

ParseDeleteApiSamplingRulesOriginOrIdResponse parses an HTTP response from a DeleteApiSamplingRulesOriginOrIdWithResponse call

func (DeleteApiSamplingRulesOriginOrIdResponse) Status added in v1.1.0

Status returns HTTPResponse.Status

func (DeleteApiSamplingRulesOriginOrIdResponse) StatusCode added in v1.1.0

StatusCode returns HTTPResponse.StatusCode

type DeleteApiSignalToMetricsOriginOrIdParams added in v1.9.0

type DeleteApiSignalToMetricsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiSignalToMetricsOriginOrIdParams defines parameters for DeleteApiSignalToMetricsOriginOrId.

type DeleteApiSignalToMetricsOriginOrIdResponse added in v1.9.0

type DeleteApiSignalToMetricsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiSignalToMetricsOriginOrIdResponse added in v1.9.0

func ParseDeleteApiSignalToMetricsOriginOrIdResponse(rsp *http.Response) (*DeleteApiSignalToMetricsOriginOrIdResponse, error)

ParseDeleteApiSignalToMetricsOriginOrIdResponse parses an HTTP response from a DeleteApiSignalToMetricsOriginOrIdWithResponse call

func (DeleteApiSignalToMetricsOriginOrIdResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (DeleteApiSignalToMetricsOriginOrIdResponse) StatusCode added in v1.9.0

StatusCode returns HTTPResponse.StatusCode

type DeleteApiSlosOriginOrIdParams added in v1.14.0

type DeleteApiSlosOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiSlosOriginOrIdParams defines parameters for DeleteApiSlosOriginOrId.

type DeleteApiSlosOriginOrIdResponse added in v1.14.0

type DeleteApiSlosOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiSlosOriginOrIdResponse added in v1.14.0

func ParseDeleteApiSlosOriginOrIdResponse(rsp *http.Response) (*DeleteApiSlosOriginOrIdResponse, error)

ParseDeleteApiSlosOriginOrIdResponse parses an HTTP response from a DeleteApiSlosOriginOrIdWithResponse call

func (DeleteApiSlosOriginOrIdResponse) Status added in v1.14.0

Status returns HTTPResponse.Status

func (DeleteApiSlosOriginOrIdResponse) StatusCode added in v1.14.0

func (r DeleteApiSlosOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteApiSpamFiltersOriginOrIdParams added in v1.12.0

type DeleteApiSpamFiltersOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiSpamFiltersOriginOrIdParams defines parameters for DeleteApiSpamFiltersOriginOrId.

type DeleteApiSpamFiltersOriginOrIdResponse added in v1.12.0

type DeleteApiSpamFiltersOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiSpamFiltersOriginOrIdResponse added in v1.12.0

func ParseDeleteApiSpamFiltersOriginOrIdResponse(rsp *http.Response) (*DeleteApiSpamFiltersOriginOrIdResponse, error)

ParseDeleteApiSpamFiltersOriginOrIdResponse parses an HTTP response from a DeleteApiSpamFiltersOriginOrIdWithResponse call

func (DeleteApiSpamFiltersOriginOrIdResponse) Status added in v1.12.0

Status returns HTTPResponse.Status

func (DeleteApiSpamFiltersOriginOrIdResponse) StatusCode added in v1.12.0

StatusCode returns HTTPResponse.StatusCode

type DeleteApiSyntheticChecksOriginOrIdParams

type DeleteApiSyntheticChecksOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiSyntheticChecksOriginOrIdParams defines parameters for DeleteApiSyntheticChecksOriginOrId.

type DeleteApiSyntheticChecksOriginOrIdResponse

type DeleteApiSyntheticChecksOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiSyntheticChecksOriginOrIdResponse

func ParseDeleteApiSyntheticChecksOriginOrIdResponse(rsp *http.Response) (*DeleteApiSyntheticChecksOriginOrIdResponse, error)

ParseDeleteApiSyntheticChecksOriginOrIdResponse parses an HTTP response from a DeleteApiSyntheticChecksOriginOrIdWithResponse call

func (DeleteApiSyntheticChecksOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteApiSyntheticChecksOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DeleteApiTeamsOriginOrIdMembersMemberIDResponse added in v1.4.0

type DeleteApiTeamsOriginOrIdMembersMemberIDResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiTeamsOriginOrIdMembersMemberIDResponse added in v1.4.0

func ParseDeleteApiTeamsOriginOrIdMembersMemberIDResponse(rsp *http.Response) (*DeleteApiTeamsOriginOrIdMembersMemberIDResponse, error)

ParseDeleteApiTeamsOriginOrIdMembersMemberIDResponse parses an HTTP response from a DeleteApiTeamsOriginOrIdMembersMemberIDWithResponse call

func (DeleteApiTeamsOriginOrIdMembersMemberIDResponse) Status added in v1.4.0

Status returns HTTPResponse.Status

func (DeleteApiTeamsOriginOrIdMembersMemberIDResponse) StatusCode added in v1.4.0

StatusCode returns HTTPResponse.StatusCode

type DeleteApiTeamsOriginOrIdResponse added in v1.4.0

type DeleteApiTeamsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiTeamsOriginOrIdResponse added in v1.4.0

func ParseDeleteApiTeamsOriginOrIdResponse(rsp *http.Response) (*DeleteApiTeamsOriginOrIdResponse, error)

ParseDeleteApiTeamsOriginOrIdResponse parses an HTTP response from a DeleteApiTeamsOriginOrIdWithResponse call

func (DeleteApiTeamsOriginOrIdResponse) Status added in v1.4.0

Status returns HTTPResponse.Status

func (DeleteApiTeamsOriginOrIdResponse) StatusCode added in v1.4.0

func (r DeleteApiTeamsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteApiTimeSeriesAggregationsOriginOrIdParams added in v1.17.0

type DeleteApiTimeSeriesAggregationsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiTimeSeriesAggregationsOriginOrIdParams defines parameters for DeleteApiTimeSeriesAggregationsOriginOrId.

type DeleteApiTimeSeriesAggregationsOriginOrIdResponse added in v1.17.0

type DeleteApiTimeSeriesAggregationsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiTimeSeriesAggregationsOriginOrIdResponse added in v1.17.0

func ParseDeleteApiTimeSeriesAggregationsOriginOrIdResponse(rsp *http.Response) (*DeleteApiTimeSeriesAggregationsOriginOrIdResponse, error)

ParseDeleteApiTimeSeriesAggregationsOriginOrIdResponse parses an HTTP response from a DeleteApiTimeSeriesAggregationsOriginOrIdWithResponse call

func (DeleteApiTimeSeriesAggregationsOriginOrIdResponse) Status added in v1.17.0

Status returns HTTPResponse.Status

func (DeleteApiTimeSeriesAggregationsOriginOrIdResponse) StatusCode added in v1.17.0

StatusCode returns HTTPResponse.StatusCode

type DeleteApiViewsOriginOrIdParams

type DeleteApiViewsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiViewsOriginOrIdParams defines parameters for DeleteApiViewsOriginOrId.

type DeleteApiViewsOriginOrIdResponse

type DeleteApiViewsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiViewsOriginOrIdResponse

func ParseDeleteApiViewsOriginOrIdResponse(rsp *http.Response) (*DeleteApiViewsOriginOrIdResponse, error)

ParseDeleteApiViewsOriginOrIdResponse parses an HTTP response from a DeleteApiViewsOriginOrIdWithResponse call

func (DeleteApiViewsOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteApiViewsOriginOrIdResponse) StatusCode

func (r DeleteApiViewsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DiscordWebhookConfig added in v1.9.0

type DiscordWebhookConfig struct {
	Url string `json:"url"`
}

DiscordWebhookConfig defines model for DiscordWebhookConfig.

type Duration

type Duration = string

Duration defines model for Duration.

type EmailConfig added in v1.9.0

type EmailConfig struct {
	Plaintext *bool               `json:"plaintext,omitempty"`
	Recipient openapi_types.Email `json:"recipient"`
}

EmailConfig defines model for EmailConfig.

type EmailV2Config added in v1.9.0

type EmailV2Config struct {
	Plaintext  *bool                 `json:"plaintext,omitempty"`
	Recipients []openapi_types.Email `json:"recipients"`
}

EmailV2Config defines model for EmailV2Config.

type EmptyAgenticWorkflowTriggerSpec added in v1.17.0

type EmptyAgenticWorkflowTriggerSpec = interface{}

EmptyAgenticWorkflowTriggerSpec defines model for EmptyAgenticWorkflowTriggerSpec.

type Error

type Error struct {
	// Code HTTP status code.
	Code int `json:"code"`

	// Message Human-readable description of the error. Safe to display.
	Message string `json:"message"`

	// TraceId Trace ID for the request that produced the error, for correlating with logs and traces.
	TraceId *string `json:"traceId,omitempty"`

	// Type Stable `snake_case` identifier for the kind of error, safe for clients to branch on. Not
	// an enum: treat an unrecognized value the same as an absent one and fall back to `message`,
	// so a new error kind never breaks the contract. Optional — absent means unclassified, not
	// success.
	Type *string `json:"type,omitempty"`
}

Error defines model for Error.

func (*Error) UnmarshalJSON added in v1.12.2

func (e *Error) UnmarshalJSON(data []byte) error

UnmarshalJSON tolerates two wire shapes for the generated Error type that the Dash0 control plane is observed to emit:

{"code": int, "message": string, "traceId": string}   (canonical struct)
"<message>"                                           (bare string)

The bare-string form is lifted into Message; Code stays 0 and TraceId stays nil. Marshal always emits the struct form, regardless of how the value was decoded; consumers that round-trip an Error through JSON will get the canonical shape on the way out.

type ErrorAssertion

type ErrorAssertion struct {
	Kind ErrorAssertionKind `json:"kind"`
	Spec ErrorAssertionSpec `json:"spec"`
}

ErrorAssertion defines model for ErrorAssertion.

type ErrorAssertionKind

type ErrorAssertionKind string

ErrorAssertionKind defines model for ErrorAssertion.Kind.

const (
	ErrorAssertionKindError ErrorAssertionKind = "error"
)

Defines values for ErrorAssertionKind.

type ErrorAssertionSpec

type ErrorAssertionSpec struct {
	Value SyntheticHttpErrorType `json:"value"`
}

ErrorAssertionSpec defines model for ErrorAssertionSpec.

type ErrorResponse

type ErrorResponse struct {
	Error Error `json:"error"`
}

ErrorResponse defines model for ErrorResponse.

type ExecuteSqlRequest added in v1.6.0

type ExecuteSqlRequest struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset `json:"dataset,omitempty"`
	Query   string   `json:"query"`

	// TimeRange A range of time between two time references.
	TimeRange TimeReferenceRange `json:"timeRange"`
}

ExecuteSqlRequest defines model for ExecuteSqlRequest.

type ExecuteSqlResponse added in v1.6.0

type ExecuteSqlResponse struct {
	Error *string `json:"error,omitempty"`

	// ExecutionTime A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	ExecutionTime FixedTime `json:"executionTime"`
	Progress      *Progress `json:"progress,omitempty"`

	// QueryError Structured error information for query errors. Present alongside the error string when the error is related to the user's query (syntax, semantic, or execution errors). Not present for system-level errors (unauthorized access, unexpected failures).
	QueryError *QueryError  `json:"queryError,omitempty"`
	ResultRows *ResultRows  `json:"resultRows,omitempty"`
	TimeRange  TimeRange    `json:"timeRange"`
	Warnings   D0QLWarnings `json:"warnings"`
}

ExecuteSqlResponse defines model for ExecuteSqlResponse.

type FailedCheckAgenticWorkflowTrigger added in v1.17.0

type FailedCheckAgenticWorkflowTrigger struct {
	Kind FailedCheckAgenticWorkflowTriggerKind `json:"kind"`
	Spec FailedCheckAgenticWorkflowTriggerSpec `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

FailedCheckAgenticWorkflowTrigger defines model for FailedCheckAgenticWorkflowTrigger.

type FailedCheckAgenticWorkflowTriggerKind added in v1.17.0

type FailedCheckAgenticWorkflowTriggerKind string

FailedCheckAgenticWorkflowTriggerKind defines model for FailedCheckAgenticWorkflowTrigger.Kind.

const (
	FailedCheckAgenticWorkflowTriggerKindFailedCheckNew                 FailedCheckAgenticWorkflowTriggerKind = "failed_check.new"
	FailedCheckAgenticWorkflowTriggerKindGithubDeployment               FailedCheckAgenticWorkflowTriggerKind = "github.deployment"
	FailedCheckAgenticWorkflowTriggerKindGithubDeploymentStatus         FailedCheckAgenticWorkflowTriggerKind = "github.deployment_status"
	FailedCheckAgenticWorkflowTriggerKindGithubIssueComment             FailedCheckAgenticWorkflowTriggerKind = "github.issue_comment"
	FailedCheckAgenticWorkflowTriggerKindGithubPullRequest              FailedCheckAgenticWorkflowTriggerKind = "github.pull_request"
	FailedCheckAgenticWorkflowTriggerKindGithubPullRequestReview        FailedCheckAgenticWorkflowTriggerKind = "github.pull_request_review"
	FailedCheckAgenticWorkflowTriggerKindGithubPullRequestReviewComment FailedCheckAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	FailedCheckAgenticWorkflowTriggerKindGithubRelease                  FailedCheckAgenticWorkflowTriggerKind = "github.release"
	FailedCheckAgenticWorkflowTriggerKindLinearComment                  FailedCheckAgenticWorkflowTriggerKind = "linear.comment"
	FailedCheckAgenticWorkflowTriggerKindLinearLabelAdded               FailedCheckAgenticWorkflowTriggerKind = "linear.label_added"
	FailedCheckAgenticWorkflowTriggerKindManual                         FailedCheckAgenticWorkflowTriggerKind = "manual"
	FailedCheckAgenticWorkflowTriggerKindSchedule                       FailedCheckAgenticWorkflowTriggerKind = "schedule"
	FailedCheckAgenticWorkflowTriggerKindSlackBotFailedCheckNew         FailedCheckAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	FailedCheckAgenticWorkflowTriggerKindSlackBotMessage                FailedCheckAgenticWorkflowTriggerKind = "slack_bot.message"
	FailedCheckAgenticWorkflowTriggerKindSlackBotReaction               FailedCheckAgenticWorkflowTriggerKind = "slack_bot.reaction"
	FailedCheckAgenticWorkflowTriggerKindWebhook                        FailedCheckAgenticWorkflowTriggerKind = "webhook"
)

Defines values for FailedCheckAgenticWorkflowTriggerKind.

type FailedCheckAgenticWorkflowTriggerSpec added in v1.17.0

type FailedCheckAgenticWorkflowTriggerSpec struct {
	AnnotationFilters *FilterCriteria `json:"annotationFilters,omitempty"`

	// AvailableVariables The trigger-specific variables available as `{{variable.name}}` when this trigger fires.
	// This is in addition to the built-in variables that are always available.
	AvailableVariables *[]FailedCheckTriggerVariableName `json:"availableVariables,omitempty"`

	// CheckRuleIDs Optional list of check rule IDs. When specified, only failed checks
	// whose rule ID matches one of the listed values trigger the automation.
	CheckRuleIDs *[]string       `json:"checkRuleIDs,omitempty"`
	LabelFilters *FilterCriteria `json:"labelFilters,omitempty"`
}

FailedCheckAgenticWorkflowTriggerSpec defines model for FailedCheckAgenticWorkflowTriggerSpec.

type FailedCheckTriggerVariableName added in v1.17.0

type FailedCheckTriggerVariableName string

FailedCheckTriggerVariableName Variables provided by the `failed_check.new` trigger.

- `check.id`: The ID of the check rule that failed. - `check.name`: The name of the check rule that failed. - `issue.identifier`: The specific issue that fired. One rule can have several concurrent issues, so this identifies which one triggered the run. Absent when the dispatching producer predates the field.

const (
	CheckId         FailedCheckTriggerVariableName = "check.id"
	CheckName       FailedCheckTriggerVariableName = "check.name"
	IssueIdentifier FailedCheckTriggerVariableName = "issue.identifier"
)

Defines values for FailedCheckTriggerVariableName.

type FailedHttpCheckAssertion added in v1.4.0

type FailedHttpCheckAssertion struct {
	// ActualValue The actual value that was received in the response
	ActualValue *string            `json:"actualValue,omitempty"`
	Assertion   HttpCheckAssertion `json:"assertion"`

	// Explanation A human-readable message explaining why the assertion failed
	Explanation string `json:"explanation"`
}

FailedHttpCheckAssertion Information about a failed HTTP check assertion

type FilterCriteria

type FilterCriteria = []AttributeFilter

FilterCriteria defines model for FilterCriteria.

type FixedTime

type FixedTime = time.Time

FixedTime A fixed point in time represented as an RFC 3339 date-time string.

**Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)

**Examples**: - `2024-01-15T14:30:00Z` - `2024-01-15T14:30:00+08:00`

type FixedTimeUnix

type FixedTimeUnix = string

FixedTimeUnix The time corresponding to the given unix time in seconds and nanoseconds (as decimal places) since January 1, 1970 UTC.

type GenAIAttributeRedaction added in v1.17.0

type GenAIAttributeRedaction string

GenAIAttributeRedaction Controls whether sensitive GenAI attribute values are redacted by the Collector.

- `disabled`: Preserve GenAI attribute values unchanged. - `redact`: Replace the affected GenAI attribute content with a redacted value.

const (
	GenAIAttributeRedactionDisabled GenAIAttributeRedaction = "disabled"
	GenAIAttributeRedactionRedact   GenAIAttributeRedaction = "redact"
)

Defines values for GenAIAttributeRedaction.

type GenAIAttributeRedactionSettings added in v1.17.0

type GenAIAttributeRedactionSettings struct {
	// Conversation Controls whether sensitive GenAI attribute values are redacted by the Collector.
	//
	// - `disabled`: Preserve GenAI attribute values unchanged.
	// - `redact`: Replace the affected GenAI attribute content with a redacted value.
	Conversation *GenAIAttributeRedaction `json:"conversation,omitempty"`

	// Errors Controls whether sensitive GenAI attribute values are redacted by the Collector.
	//
	// - `disabled`: Preserve GenAI attribute values unchanged.
	// - `redact`: Replace the affected GenAI attribute content with a redacted value.
	Errors *GenAIAttributeRedaction `json:"errors,omitempty"`

	// ToolCalls Controls whether sensitive GenAI attribute values are redacted by the Collector.
	//
	// - `disabled`: Preserve GenAI attribute values unchanged.
	// - `redact`: Replace the affected GenAI attribute content with a redacted value.
	ToolCalls *GenAIAttributeRedaction `json:"toolCalls,omitempty"`
}

GenAIAttributeRedactionSettings Fine-grained redaction policies for GenAI attributes, applied by the Collector before export. Conversation content, tool-call I/O and tool-call error messages are controlled independently, e.g. to keep conversation content private while still storing tool input/output.

type GeoLocationSettings added in v1.12.3

type GeoLocationSettings struct {
	// EndUserGeoLocationStorageStrategy What kind of geolocation information we are allowed to derive and store.
	EndUserGeoLocationStorageStrategy GeoLocationStorageStrategy `json:"endUserGeoLocationStorageStrategy"`
}

GeoLocationSettings defines model for GeoLocationSettings.

type GeoLocationStorageStrategy added in v1.12.3

type GeoLocationStorageStrategy string

GeoLocationStorageStrategy What kind of geolocation information we are allowed to derive and store.

const (
	GeoLocationStorageStrategyDoNotStore  GeoLocationStorageStrategy = "do_not_store"
	GeoLocationStorageStrategyUpToCity    GeoLocationStorageStrategy = "up_to_city"
	GeoLocationStorageStrategyUpToCountry GeoLocationStorageStrategy = "up_to_country"
)

Defines values for GeoLocationStorageStrategy.

type GetAgenticWorkflowsResponse added in v1.17.0

type GetAgenticWorkflowsResponse struct {
	AgenticWorkflows []AgenticWorkflowDefinition `json:"agenticWorkflows"`
}

GetAgenticWorkflowsResponse defines model for GetAgenticWorkflowsResponse.

type GetApiAgenticWorkflowsOriginOrIdParams added in v1.17.0

type GetApiAgenticWorkflowsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiAgenticWorkflowsOriginOrIdParams defines parameters for GetApiAgenticWorkflowsOriginOrId.

type GetApiAgenticWorkflowsOriginOrIdResponse added in v1.17.0

type GetApiAgenticWorkflowsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AgenticWorkflowResponse
	JSONDefault  *ErrorResponse
}

func ParseGetApiAgenticWorkflowsOriginOrIdResponse added in v1.17.0

func ParseGetApiAgenticWorkflowsOriginOrIdResponse(rsp *http.Response) (*GetApiAgenticWorkflowsOriginOrIdResponse, error)

ParseGetApiAgenticWorkflowsOriginOrIdResponse parses an HTTP response from a GetApiAgenticWorkflowsOriginOrIdWithResponse call

func (GetApiAgenticWorkflowsOriginOrIdResponse) Status added in v1.17.0

Status returns HTTPResponse.Status

func (GetApiAgenticWorkflowsOriginOrIdResponse) StatusCode added in v1.17.0

StatusCode returns HTTPResponse.StatusCode

type GetApiAgenticWorkflowsParams added in v1.17.0

type GetApiAgenticWorkflowsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`

	// FolderPath Filter by folder path (exact match on dash0.com/folder-path annotation).
	FolderPath *string `form:"folderPath,omitempty" json:"folderPath,omitempty"`
}

GetApiAgenticWorkflowsParams defines parameters for GetApiAgenticWorkflows.

type GetApiAgenticWorkflowsResponse added in v1.17.0

type GetApiAgenticWorkflowsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetAgenticWorkflowsResponse
	JSONDefault  *ErrorResponse
}

func ParseGetApiAgenticWorkflowsResponse added in v1.17.0

func ParseGetApiAgenticWorkflowsResponse(rsp *http.Response) (*GetApiAgenticWorkflowsResponse, error)

ParseGetApiAgenticWorkflowsResponse parses an HTTP response from a GetApiAgenticWorkflowsWithResponse call

func (GetApiAgenticWorkflowsResponse) Status added in v1.17.0

Status returns HTTPResponse.Status

func (GetApiAgenticWorkflowsResponse) StatusCode added in v1.17.0

func (r GetApiAgenticWorkflowsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiAlertingCheckRulesOriginOrIdParams

type GetApiAlertingCheckRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiAlertingCheckRulesOriginOrIdParams defines parameters for GetApiAlertingCheckRulesOriginOrId.

type GetApiAlertingCheckRulesOriginOrIdResponse

type GetApiAlertingCheckRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusAlertRule
	JSONDefault  *ErrorResponse
}

func ParseGetApiAlertingCheckRulesOriginOrIdResponse

func ParseGetApiAlertingCheckRulesOriginOrIdResponse(rsp *http.Response) (*GetApiAlertingCheckRulesOriginOrIdResponse, error)

ParseGetApiAlertingCheckRulesOriginOrIdResponse parses an HTTP response from a GetApiAlertingCheckRulesOriginOrIdWithResponse call

func (GetApiAlertingCheckRulesOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (GetApiAlertingCheckRulesOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiAlertingCheckRulesParams

type GetApiAlertingCheckRulesParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`

	// IdPrefix If provided, only check rules for which the origin starts with the given string are returned. (deprecated)
	//
	// The `originPrefix` query parameter takes precedence over this parameter if both are provided.
	IdPrefix *string `form:"idPrefix,omitempty" json:"idPrefix,omitempty"`

	// OriginPrefix If provided, only check rules for which the origin starts with the given string are returned.
	OriginPrefix *string `form:"originPrefix,omitempty" json:"originPrefix,omitempty"`
}

GetApiAlertingCheckRulesParams defines parameters for GetApiAlertingCheckRules.

type GetApiAlertingCheckRulesResponse

type GetApiAlertingCheckRulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]PrometheusAlertRuleApiListItem
	JSONDefault  *ErrorResponse
}

func ParseGetApiAlertingCheckRulesResponse

func ParseGetApiAlertingCheckRulesResponse(rsp *http.Response) (*GetApiAlertingCheckRulesResponse, error)

ParseGetApiAlertingCheckRulesResponse parses an HTTP response from a GetApiAlertingCheckRulesWithResponse call

func (GetApiAlertingCheckRulesResponse) Status

Status returns HTTPResponse.Status

func (GetApiAlertingCheckRulesResponse) StatusCode

func (r GetApiAlertingCheckRulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiDashboardsOriginOrIdParams

type GetApiDashboardsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiDashboardsOriginOrIdParams defines parameters for GetApiDashboardsOriginOrId.

type GetApiDashboardsOriginOrIdResponse

type GetApiDashboardsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DashboardDefinition
	JSONDefault  *ErrorResponse
}

func ParseGetApiDashboardsOriginOrIdResponse

func ParseGetApiDashboardsOriginOrIdResponse(rsp *http.Response) (*GetApiDashboardsOriginOrIdResponse, error)

ParseGetApiDashboardsOriginOrIdResponse parses an HTTP response from a GetApiDashboardsOriginOrIdWithResponse call

func (GetApiDashboardsOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (GetApiDashboardsOriginOrIdResponse) StatusCode

func (r GetApiDashboardsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiDashboardsParams

type GetApiDashboardsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiDashboardsParams defines parameters for GetApiDashboards.

type GetApiDashboardsResponse

type GetApiDashboardsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]DashboardApiListItem
	JSONDefault  *ErrorResponse
}

func ParseGetApiDashboardsResponse

func ParseGetApiDashboardsResponse(rsp *http.Response) (*GetApiDashboardsResponse, error)

ParseGetApiDashboardsResponse parses an HTTP response from a GetApiDashboardsWithResponse call

func (GetApiDashboardsResponse) Status

func (r GetApiDashboardsResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiDashboardsResponse) StatusCode

func (r GetApiDashboardsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiEdgeSettingsResponse added in v1.12.3

type GetApiEdgeSettingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SettingsPerOrganizationAndDatasetInfo
	JSONDefault  *ErrorResponse
}

func ParseGetApiEdgeSettingsResponse added in v1.12.3

func ParseGetApiEdgeSettingsResponse(rsp *http.Response) (*GetApiEdgeSettingsResponse, error)

ParseGetApiEdgeSettingsResponse parses an HTTP response from a GetApiEdgeSettingsWithResponse call

func (GetApiEdgeSettingsResponse) Status added in v1.12.3

Status returns HTTPResponse.Status

func (GetApiEdgeSettingsResponse) StatusCode added in v1.12.3

func (r GetApiEdgeSettingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiMembersResponse added in v1.4.0

type GetApiMembersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]MemberDefinition
	JSONDefault  *ErrorResponse
}

func ParseGetApiMembersResponse added in v1.4.0

func ParseGetApiMembersResponse(rsp *http.Response) (*GetApiMembersResponse, error)

ParseGetApiMembersResponse parses an HTTP response from a GetApiMembersWithResponse call

func (GetApiMembersResponse) Status added in v1.4.0

func (r GetApiMembersResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiMembersResponse) StatusCode added in v1.4.0

func (r GetApiMembersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiNotificationChannelsOriginOrIdResponse added in v1.9.0

type GetApiNotificationChannelsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NotificationChannelDefinition
	JSONDefault  *ErrorResponse
}

func ParseGetApiNotificationChannelsOriginOrIdResponse added in v1.9.0

func ParseGetApiNotificationChannelsOriginOrIdResponse(rsp *http.Response) (*GetApiNotificationChannelsOriginOrIdResponse, error)

ParseGetApiNotificationChannelsOriginOrIdResponse parses an HTTP response from a GetApiNotificationChannelsOriginOrIdWithResponse call

func (GetApiNotificationChannelsOriginOrIdResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (GetApiNotificationChannelsOriginOrIdResponse) StatusCode added in v1.9.0

StatusCode returns HTTPResponse.StatusCode

type GetApiNotificationChannelsResponse added in v1.9.0

type GetApiNotificationChannelsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NotificationChannelDefinitions
	JSONDefault  *ErrorResponse
}

func ParseGetApiNotificationChannelsResponse added in v1.9.0

func ParseGetApiNotificationChannelsResponse(rsp *http.Response) (*GetApiNotificationChannelsResponse, error)

ParseGetApiNotificationChannelsResponse parses an HTTP response from a GetApiNotificationChannelsWithResponse call

func (GetApiNotificationChannelsResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (GetApiNotificationChannelsResponse) StatusCode added in v1.9.0

func (r GetApiNotificationChannelsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiPrometheusApiV1FormatQueryParams added in v1.13.1

type GetApiPrometheusApiV1FormatQueryParams struct {
	// Query PromQL expression to validate and pretty-print. The response `data` is the
	// formatted expression. If the query contains Dash0 template variables (e.g.
	// `$__range`, `$__interval`), the original query is returned unmodified.
	Query string `form:"query" json:"query"`
}

GetApiPrometheusApiV1FormatQueryParams defines parameters for GetApiPrometheusApiV1FormatQuery.

type GetApiPrometheusApiV1FormatQueryResponse added in v1.13.1

type GetApiPrometheusApiV1FormatQueryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusFormatQueryResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParseGetApiPrometheusApiV1FormatQueryResponse added in v1.13.1

func ParseGetApiPrometheusApiV1FormatQueryResponse(rsp *http.Response) (*GetApiPrometheusApiV1FormatQueryResponse, error)

ParseGetApiPrometheusApiV1FormatQueryResponse parses an HTTP response from a GetApiPrometheusApiV1FormatQueryWithResponse call

func (GetApiPrometheusApiV1FormatQueryResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (GetApiPrometheusApiV1FormatQueryResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type GetApiPrometheusApiV1LabelLabelNameValuesParams added in v1.13.1

type GetApiPrometheusApiV1LabelLabelNameValuesParams struct {
	// Start Start timestamp to restrict the set of returned label values.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End timestamp to restrict the set of returned label values.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Match Repeated series selector that restricts the label values returned.
	Match *[]string `form:"match[],omitempty" json:"match[],omitempty"`

	// Limit Maximum number of results. Defaults to and is capped at the server-configured maximum.
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// Dataset Dataset to query. Defaults to the organization's default dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiPrometheusApiV1LabelLabelNameValuesParams defines parameters for GetApiPrometheusApiV1LabelLabelNameValues.

type GetApiPrometheusApiV1LabelLabelNameValuesResponse added in v1.13.1

type GetApiPrometheusApiV1LabelLabelNameValuesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusLabelNamesOrValuesResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParseGetApiPrometheusApiV1LabelLabelNameValuesResponse added in v1.13.1

func ParseGetApiPrometheusApiV1LabelLabelNameValuesResponse(rsp *http.Response) (*GetApiPrometheusApiV1LabelLabelNameValuesResponse, error)

ParseGetApiPrometheusApiV1LabelLabelNameValuesResponse parses an HTTP response from a GetApiPrometheusApiV1LabelLabelNameValuesWithResponse call

func (GetApiPrometheusApiV1LabelLabelNameValuesResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (GetApiPrometheusApiV1LabelLabelNameValuesResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type GetApiPrometheusApiV1LabelsParams added in v1.13.1

type GetApiPrometheusApiV1LabelsParams struct {
	// Start Start timestamp to restrict the set of returned label names.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End timestamp to restrict the set of returned label names.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Match Repeated series selector that restricts the label names returned.
	Match *[]string `form:"match[],omitempty" json:"match[],omitempty"`

	// Limit Maximum number of results. Defaults to and is capped at the server-configured maximum.
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// Dataset Dataset to query. Defaults to the organization's default dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiPrometheusApiV1LabelsParams defines parameters for GetApiPrometheusApiV1Labels.

type GetApiPrometheusApiV1LabelsResponse added in v1.13.1

type GetApiPrometheusApiV1LabelsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusLabelNamesOrValuesResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParseGetApiPrometheusApiV1LabelsResponse added in v1.13.1

func ParseGetApiPrometheusApiV1LabelsResponse(rsp *http.Response) (*GetApiPrometheusApiV1LabelsResponse, error)

ParseGetApiPrometheusApiV1LabelsResponse parses an HTTP response from a GetApiPrometheusApiV1LabelsWithResponse call

func (GetApiPrometheusApiV1LabelsResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (GetApiPrometheusApiV1LabelsResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type GetApiPrometheusApiV1MetadataParams added in v1.13.1

type GetApiPrometheusApiV1MetadataParams struct {
	// Limit Maximum number of metrics to return. When omitted, all metrics are returned.
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// LimitPerMetric Maximum number of metadata entries to return per metric.
	LimitPerMetric *int64 `form:"limit_per_metric,omitempty" json:"limit_per_metric,omitempty"`

	// Metric If provided, only metadata for this metric name is returned. When omitted,
	// metadata for all metrics is returned.
	Metric *string `form:"metric,omitempty" json:"metric,omitempty"`

	// Start Start timestamp. Must be provided together with `end`.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End timestamp. Must be provided together with `start`.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Dataset Dataset to query. Defaults to the organization's default dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiPrometheusApiV1MetadataParams defines parameters for GetApiPrometheusApiV1Metadata.

type GetApiPrometheusApiV1MetadataResponse added in v1.13.1

type GetApiPrometheusApiV1MetadataResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusMetadataResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParseGetApiPrometheusApiV1MetadataResponse added in v1.13.1

func ParseGetApiPrometheusApiV1MetadataResponse(rsp *http.Response) (*GetApiPrometheusApiV1MetadataResponse, error)

ParseGetApiPrometheusApiV1MetadataResponse parses an HTTP response from a GetApiPrometheusApiV1MetadataWithResponse call

func (GetApiPrometheusApiV1MetadataResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (GetApiPrometheusApiV1MetadataResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type GetApiPrometheusApiV1QueryParams added in v1.13.1

type GetApiPrometheusApiV1QueryParams struct {
	// Query PromQL expression to evaluate.
	Query string `form:"query" json:"query"`

	// Time Evaluation timestamp. Defaults to the current server time when omitted.
	Time *string `form:"time,omitempty" json:"time,omitempty"`

	// Timeout Per-query timeout, clamped to the server-configured maximum.
	Timeout *string `form:"timeout,omitempty" json:"timeout,omitempty"`

	// Limit Maximum number of returned series. Defaults to and is capped at the
	// server-configured maximum.
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// Dataset Dataset to query. Defaults to the organization's default dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiPrometheusApiV1QueryParams defines parameters for GetApiPrometheusApiV1Query.

type GetApiPrometheusApiV1QueryRangeParams added in v1.13.1

type GetApiPrometheusApiV1QueryRangeParams struct {
	// Query PromQL expression to evaluate.
	Query string `form:"query" json:"query"`

	// Start Start timestamp of the range (inclusive).
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End timestamp of the range (inclusive). Must not be before `start`.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Step Query resolution step width, as a duration or a number of seconds.
	Step string `form:"step" json:"step"`

	// Timeout Per-query timeout, clamped to the server-configured maximum.
	Timeout *string `form:"timeout,omitempty" json:"timeout,omitempty"`

	// Limit Maximum number of returned series. Defaults to and is capped at the
	// server-configured maximum.
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// Dataset Dataset to query. Defaults to the organization's default dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiPrometheusApiV1QueryRangeParams defines parameters for GetApiPrometheusApiV1QueryRange.

type GetApiPrometheusApiV1QueryRangeResponse added in v1.13.1

type GetApiPrometheusApiV1QueryRangeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusQueryResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParseGetApiPrometheusApiV1QueryRangeResponse added in v1.13.1

func ParseGetApiPrometheusApiV1QueryRangeResponse(rsp *http.Response) (*GetApiPrometheusApiV1QueryRangeResponse, error)

ParseGetApiPrometheusApiV1QueryRangeResponse parses an HTTP response from a GetApiPrometheusApiV1QueryRangeWithResponse call

func (GetApiPrometheusApiV1QueryRangeResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (GetApiPrometheusApiV1QueryRangeResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type GetApiPrometheusApiV1QueryResponse added in v1.13.1

type GetApiPrometheusApiV1QueryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusQueryResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParseGetApiPrometheusApiV1QueryResponse added in v1.13.1

func ParseGetApiPrometheusApiV1QueryResponse(rsp *http.Response) (*GetApiPrometheusApiV1QueryResponse, error)

ParseGetApiPrometheusApiV1QueryResponse parses an HTTP response from a GetApiPrometheusApiV1QueryWithResponse call

func (GetApiPrometheusApiV1QueryResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (GetApiPrometheusApiV1QueryResponse) StatusCode added in v1.13.1

func (r GetApiPrometheusApiV1QueryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiPrometheusApiV1SeriesParams added in v1.13.1

type GetApiPrometheusApiV1SeriesParams struct {
	// Start Start timestamp to restrict the set of returned series.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End timestamp to restrict the set of returned series.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Match Repeated series selector that selects the series to return. Upstream
	// Prometheus requires at least one selector.
	Match *[]string `form:"match[],omitempty" json:"match[],omitempty"`

	// Limit Maximum number of results. Defaults to and is capped at the server-configured maximum.
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// Dataset Dataset to query. Defaults to the organization's default dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiPrometheusApiV1SeriesParams defines parameters for GetApiPrometheusApiV1Series.

type GetApiPrometheusApiV1SeriesResponse added in v1.13.1

type GetApiPrometheusApiV1SeriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusSeriesResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParseGetApiPrometheusApiV1SeriesResponse added in v1.13.1

func ParseGetApiPrometheusApiV1SeriesResponse(rsp *http.Response) (*GetApiPrometheusApiV1SeriesResponse, error)

ParseGetApiPrometheusApiV1SeriesResponse parses an HTTP response from a GetApiPrometheusApiV1SeriesWithResponse call

func (GetApiPrometheusApiV1SeriesResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (GetApiPrometheusApiV1SeriesResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type GetApiPrometheusApiV1StatusBuildinfoResponse added in v1.13.1

type GetApiPrometheusApiV1StatusBuildinfoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusBuildInfoResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParseGetApiPrometheusApiV1StatusBuildinfoResponse added in v1.13.1

func ParseGetApiPrometheusApiV1StatusBuildinfoResponse(rsp *http.Response) (*GetApiPrometheusApiV1StatusBuildinfoResponse, error)

ParseGetApiPrometheusApiV1StatusBuildinfoResponse parses an HTTP response from a GetApiPrometheusApiV1StatusBuildinfoWithResponse call

func (GetApiPrometheusApiV1StatusBuildinfoResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (GetApiPrometheusApiV1StatusBuildinfoResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type GetApiPrometheusApiV1StatusRuntimeinfoResponse added in v1.13.1

type GetApiPrometheusApiV1StatusRuntimeinfoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusRuntimeInfoResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParseGetApiPrometheusApiV1StatusRuntimeinfoResponse added in v1.13.1

func ParseGetApiPrometheusApiV1StatusRuntimeinfoResponse(rsp *http.Response) (*GetApiPrometheusApiV1StatusRuntimeinfoResponse, error)

ParseGetApiPrometheusApiV1StatusRuntimeinfoResponse parses an HTTP response from a GetApiPrometheusApiV1StatusRuntimeinfoWithResponse call

func (GetApiPrometheusApiV1StatusRuntimeinfoResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (GetApiPrometheusApiV1StatusRuntimeinfoResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type GetApiRecordingRulesOriginOrIdParams added in v1.9.0

type GetApiRecordingRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiRecordingRulesOriginOrIdParams defines parameters for GetApiRecordingRulesOriginOrId.

type GetApiRecordingRulesOriginOrIdResponse added in v1.9.0

type GetApiRecordingRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *generatedPrometheusRule
	JSONDefault  *ErrorResponse
}

func ParseGetApiRecordingRulesOriginOrIdResponse added in v1.9.0

func ParseGetApiRecordingRulesOriginOrIdResponse(rsp *http.Response) (*GetApiRecordingRulesOriginOrIdResponse, error)

ParseGetApiRecordingRulesOriginOrIdResponse parses an HTTP response from a GetApiRecordingRulesOriginOrIdWithResponse call

func (GetApiRecordingRulesOriginOrIdResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (GetApiRecordingRulesOriginOrIdResponse) StatusCode added in v1.9.0

StatusCode returns HTTPResponse.StatusCode

type GetApiRecordingRulesParams added in v1.9.0

type GetApiRecordingRulesParams struct {
	// Dataset Filter by dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`

	// OriginPrefix Filter by origin prefix.
	OriginPrefix *string `form:"originPrefix,omitempty" json:"originPrefix,omitempty"`
}

GetApiRecordingRulesParams defines parameters for GetApiRecordingRules.

type GetApiRecordingRulesResponse added in v1.9.0

type GetApiRecordingRulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]generatedPrometheusRule
	JSONDefault  *ErrorResponse
}

func ParseGetApiRecordingRulesResponse added in v1.9.0

func ParseGetApiRecordingRulesResponse(rsp *http.Response) (*GetApiRecordingRulesResponse, error)

ParseGetApiRecordingRulesResponse parses an HTTP response from a GetApiRecordingRulesWithResponse call

func (GetApiRecordingRulesResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (GetApiRecordingRulesResponse) StatusCode added in v1.9.0

func (r GetApiRecordingRulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiSamplingRulesOriginOrIdParams added in v1.1.0

type GetApiSamplingRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiSamplingRulesOriginOrIdParams defines parameters for GetApiSamplingRulesOriginOrId.

type GetApiSamplingRulesOriginOrIdResponse added in v1.1.0

type GetApiSamplingRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SamplingRuleResponse
	JSONDefault  *ErrorResponse
}

func ParseGetApiSamplingRulesOriginOrIdResponse added in v1.1.0

func ParseGetApiSamplingRulesOriginOrIdResponse(rsp *http.Response) (*GetApiSamplingRulesOriginOrIdResponse, error)

ParseGetApiSamplingRulesOriginOrIdResponse parses an HTTP response from a GetApiSamplingRulesOriginOrIdWithResponse call

func (GetApiSamplingRulesOriginOrIdResponse) Status added in v1.1.0

Status returns HTTPResponse.Status

func (GetApiSamplingRulesOriginOrIdResponse) StatusCode added in v1.1.0

StatusCode returns HTTPResponse.StatusCode

type GetApiSamplingRulesParams added in v1.1.0

type GetApiSamplingRulesParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiSamplingRulesParams defines parameters for GetApiSamplingRules.

type GetApiSamplingRulesResponse added in v1.1.0

type GetApiSamplingRulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetSamplingRulesResponse
	JSONDefault  *ErrorResponse
}

func ParseGetApiSamplingRulesResponse added in v1.1.0

func ParseGetApiSamplingRulesResponse(rsp *http.Response) (*GetApiSamplingRulesResponse, error)

ParseGetApiSamplingRulesResponse parses an HTTP response from a GetApiSamplingRulesWithResponse call

func (GetApiSamplingRulesResponse) Status added in v1.1.0

Status returns HTTPResponse.Status

func (GetApiSamplingRulesResponse) StatusCode added in v1.1.0

func (r GetApiSamplingRulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiSignalToMetricsOriginOrIdParams added in v1.9.0

type GetApiSignalToMetricsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiSignalToMetricsOriginOrIdParams defines parameters for GetApiSignalToMetricsOriginOrId.

type GetApiSignalToMetricsOriginOrIdResponse added in v1.9.0

type GetApiSignalToMetricsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SignalToMetricsResponse
	JSONDefault  *ErrorResponse
}

func ParseGetApiSignalToMetricsOriginOrIdResponse added in v1.9.0

func ParseGetApiSignalToMetricsOriginOrIdResponse(rsp *http.Response) (*GetApiSignalToMetricsOriginOrIdResponse, error)

ParseGetApiSignalToMetricsOriginOrIdResponse parses an HTTP response from a GetApiSignalToMetricsOriginOrIdWithResponse call

func (GetApiSignalToMetricsOriginOrIdResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (GetApiSignalToMetricsOriginOrIdResponse) StatusCode added in v1.9.0

StatusCode returns HTTPResponse.StatusCode

type GetApiSignalToMetricsParams added in v1.9.0

type GetApiSignalToMetricsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`

	// Limit Maximum number of items to return.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of items to skip.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// OriginPrefix Filter by origin prefix.
	OriginPrefix *string `form:"originPrefix,omitempty" json:"originPrefix,omitempty"`

	// Name Case-insensitive substring search on the rule name.
	Name *string `form:"name,omitempty" json:"name,omitempty"`

	// Signal Filter by signal type.
	Signal *SignalToMetricsSignalType `form:"signal,omitempty" json:"signal,omitempty"`

	// Enabled Filter by enabled state.
	Enabled *bool `form:"enabled,omitempty" json:"enabled,omitempty"`
}

GetApiSignalToMetricsParams defines parameters for GetApiSignalToMetrics.

type GetApiSignalToMetricsResponse added in v1.9.0

type GetApiSignalToMetricsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetSignalToMetricsResponse
	JSONDefault  *ErrorResponse
}

func ParseGetApiSignalToMetricsResponse added in v1.9.0

func ParseGetApiSignalToMetricsResponse(rsp *http.Response) (*GetApiSignalToMetricsResponse, error)

ParseGetApiSignalToMetricsResponse parses an HTTP response from a GetApiSignalToMetricsWithResponse call

func (GetApiSignalToMetricsResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (GetApiSignalToMetricsResponse) StatusCode added in v1.9.0

func (r GetApiSignalToMetricsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiSlosOriginOrIdParams added in v1.14.0

type GetApiSlosOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiSlosOriginOrIdParams defines parameters for GetApiSlosOriginOrId.

type GetApiSlosOriginOrIdResponse added in v1.14.0

type GetApiSlosOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SloDefinition
	JSONDefault  *ErrorResponse
}

func ParseGetApiSlosOriginOrIdResponse added in v1.14.0

func ParseGetApiSlosOriginOrIdResponse(rsp *http.Response) (*GetApiSlosOriginOrIdResponse, error)

ParseGetApiSlosOriginOrIdResponse parses an HTTP response from a GetApiSlosOriginOrIdWithResponse call

func (GetApiSlosOriginOrIdResponse) Status added in v1.14.0

Status returns HTTPResponse.Status

func (GetApiSlosOriginOrIdResponse) StatusCode added in v1.14.0

func (r GetApiSlosOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiSlosParams added in v1.14.0

type GetApiSlosParams struct {
	// Dataset Filter by dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`

	// OriginPrefix Filter by origin prefix.
	OriginPrefix *string `form:"originPrefix,omitempty" json:"originPrefix,omitempty"`
}

GetApiSlosParams defines parameters for GetApiSlos.

type GetApiSlosResponse added in v1.14.0

type GetApiSlosResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]SloDefinition
	JSONDefault  *ErrorResponse
}

func ParseGetApiSlosResponse added in v1.14.0

func ParseGetApiSlosResponse(rsp *http.Response) (*GetApiSlosResponse, error)

ParseGetApiSlosResponse parses an HTTP response from a GetApiSlosWithResponse call

func (GetApiSlosResponse) Status added in v1.14.0

func (r GetApiSlosResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiSlosResponse) StatusCode added in v1.14.0

func (r GetApiSlosResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiSpamFiltersOriginOrIdParams added in v1.12.0

type GetApiSpamFiltersOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiSpamFiltersOriginOrIdParams defines parameters for GetApiSpamFiltersOriginOrId.

type GetApiSpamFiltersOriginOrIdResponse added in v1.12.0

type GetApiSpamFiltersOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SpamFilterResponse
	JSONDefault  *ErrorResponse
}

func ParseGetApiSpamFiltersOriginOrIdResponse added in v1.12.0

func ParseGetApiSpamFiltersOriginOrIdResponse(rsp *http.Response) (*GetApiSpamFiltersOriginOrIdResponse, error)

ParseGetApiSpamFiltersOriginOrIdResponse parses an HTTP response from a GetApiSpamFiltersOriginOrIdWithResponse call

func (GetApiSpamFiltersOriginOrIdResponse) Status added in v1.12.0

Status returns HTTPResponse.Status

func (GetApiSpamFiltersOriginOrIdResponse) StatusCode added in v1.12.0

StatusCode returns HTTPResponse.StatusCode

type GetApiSpamFiltersParams added in v1.12.0

type GetApiSpamFiltersParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiSpamFiltersParams defines parameters for GetApiSpamFilters.

type GetApiSpamFiltersResponse added in v1.12.0

type GetApiSpamFiltersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetSpamFiltersResponse
	JSONDefault  *ErrorResponse
}

func ParseGetApiSpamFiltersResponse added in v1.12.0

func ParseGetApiSpamFiltersResponse(rsp *http.Response) (*GetApiSpamFiltersResponse, error)

ParseGetApiSpamFiltersResponse parses an HTTP response from a GetApiSpamFiltersWithResponse call

func (GetApiSpamFiltersResponse) Status added in v1.12.0

func (r GetApiSpamFiltersResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiSpamFiltersResponse) StatusCode added in v1.12.0

func (r GetApiSpamFiltersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiSyntheticChecksLocationsResponse added in v1.6.0

type GetApiSyntheticChecksLocationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]SyntheticCheckLocation
	JSONDefault  *ErrorResponse
}

func ParseGetApiSyntheticChecksLocationsResponse added in v1.6.0

func ParseGetApiSyntheticChecksLocationsResponse(rsp *http.Response) (*GetApiSyntheticChecksLocationsResponse, error)

ParseGetApiSyntheticChecksLocationsResponse parses an HTTP response from a GetApiSyntheticChecksLocationsWithResponse call

func (GetApiSyntheticChecksLocationsResponse) Status added in v1.6.0

Status returns HTTPResponse.Status

func (GetApiSyntheticChecksLocationsResponse) StatusCode added in v1.6.0

StatusCode returns HTTPResponse.StatusCode

type GetApiSyntheticChecksOriginOrIdParams

type GetApiSyntheticChecksOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiSyntheticChecksOriginOrIdParams defines parameters for GetApiSyntheticChecksOriginOrId.

type GetApiSyntheticChecksOriginOrIdResponse

type GetApiSyntheticChecksOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SyntheticCheckDefinition
	JSONDefault  *ErrorResponse
}

func ParseGetApiSyntheticChecksOriginOrIdResponse

func ParseGetApiSyntheticChecksOriginOrIdResponse(rsp *http.Response) (*GetApiSyntheticChecksOriginOrIdResponse, error)

ParseGetApiSyntheticChecksOriginOrIdResponse parses an HTTP response from a GetApiSyntheticChecksOriginOrIdWithResponse call

func (GetApiSyntheticChecksOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (GetApiSyntheticChecksOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiSyntheticChecksParams

type GetApiSyntheticChecksParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiSyntheticChecksParams defines parameters for GetApiSyntheticChecks.

type GetApiSyntheticChecksResponse

type GetApiSyntheticChecksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]SyntheticChecksApiListItem
	JSONDefault  *ErrorResponse
}

func ParseGetApiSyntheticChecksResponse

func ParseGetApiSyntheticChecksResponse(rsp *http.Response) (*GetApiSyntheticChecksResponse, error)

ParseGetApiSyntheticChecksResponse parses an HTTP response from a GetApiSyntheticChecksWithResponse call

func (GetApiSyntheticChecksResponse) Status

Status returns HTTPResponse.Status

func (GetApiSyntheticChecksResponse) StatusCode

func (r GetApiSyntheticChecksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiTeamsOriginOrIdResponse added in v1.4.0

type GetApiTeamsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetTeamResponse
	JSONDefault  *ErrorResponse
}

func ParseGetApiTeamsOriginOrIdResponse added in v1.4.0

func ParseGetApiTeamsOriginOrIdResponse(rsp *http.Response) (*GetApiTeamsOriginOrIdResponse, error)

ParseGetApiTeamsOriginOrIdResponse parses an HTTP response from a GetApiTeamsOriginOrIdWithResponse call

func (GetApiTeamsOriginOrIdResponse) Status added in v1.4.0

Status returns HTTPResponse.Status

func (GetApiTeamsOriginOrIdResponse) StatusCode added in v1.4.0

func (r GetApiTeamsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiTeamsResponse added in v1.4.0

type GetApiTeamsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]TeamsListItem
	JSONDefault  *ErrorResponse
}

func ParseGetApiTeamsResponse added in v1.4.0

func ParseGetApiTeamsResponse(rsp *http.Response) (*GetApiTeamsResponse, error)

ParseGetApiTeamsResponse parses an HTTP response from a GetApiTeamsWithResponse call

func (GetApiTeamsResponse) Status added in v1.4.0

func (r GetApiTeamsResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiTeamsResponse) StatusCode added in v1.4.0

func (r GetApiTeamsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiTimeSeriesAggregationsOriginOrIdParams added in v1.17.0

type GetApiTimeSeriesAggregationsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiTimeSeriesAggregationsOriginOrIdParams defines parameters for GetApiTimeSeriesAggregationsOriginOrId.

type GetApiTimeSeriesAggregationsOriginOrIdResponse added in v1.17.0

type GetApiTimeSeriesAggregationsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TimeSeriesAggregationDefinition
	JSONDefault  *ErrorResponse
}

func ParseGetApiTimeSeriesAggregationsOriginOrIdResponse added in v1.17.0

func ParseGetApiTimeSeriesAggregationsOriginOrIdResponse(rsp *http.Response) (*GetApiTimeSeriesAggregationsOriginOrIdResponse, error)

ParseGetApiTimeSeriesAggregationsOriginOrIdResponse parses an HTTP response from a GetApiTimeSeriesAggregationsOriginOrIdWithResponse call

func (GetApiTimeSeriesAggregationsOriginOrIdResponse) Status added in v1.17.0

Status returns HTTPResponse.Status

func (GetApiTimeSeriesAggregationsOriginOrIdResponse) StatusCode added in v1.17.0

StatusCode returns HTTPResponse.StatusCode

type GetApiTimeSeriesAggregationsParams added in v1.17.0

type GetApiTimeSeriesAggregationsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiTimeSeriesAggregationsParams defines parameters for GetApiTimeSeriesAggregations.

type GetApiTimeSeriesAggregationsResponse added in v1.17.0

type GetApiTimeSeriesAggregationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TimeSeriesAggregationListResponse
	JSONDefault  *ErrorResponse
}

func ParseGetApiTimeSeriesAggregationsResponse added in v1.17.0

func ParseGetApiTimeSeriesAggregationsResponse(rsp *http.Response) (*GetApiTimeSeriesAggregationsResponse, error)

ParseGetApiTimeSeriesAggregationsResponse parses an HTTP response from a GetApiTimeSeriesAggregationsWithResponse call

func (GetApiTimeSeriesAggregationsResponse) Status added in v1.17.0

Status returns HTTPResponse.Status

func (GetApiTimeSeriesAggregationsResponse) StatusCode added in v1.17.0

StatusCode returns HTTPResponse.StatusCode

type GetApiViewsOriginOrIdParams

type GetApiViewsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiViewsOriginOrIdParams defines parameters for GetApiViewsOriginOrId.

type GetApiViewsOriginOrIdResponse

type GetApiViewsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ViewDefinition
	JSONDefault  *ErrorResponse
}

func ParseGetApiViewsOriginOrIdResponse

func ParseGetApiViewsOriginOrIdResponse(rsp *http.Response) (*GetApiViewsOriginOrIdResponse, error)

ParseGetApiViewsOriginOrIdResponse parses an HTTP response from a GetApiViewsOriginOrIdWithResponse call

func (GetApiViewsOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (GetApiViewsOriginOrIdResponse) StatusCode

func (r GetApiViewsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiViewsParams

type GetApiViewsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiViewsParams defines parameters for GetApiViews.

type GetApiViewsResponse

type GetApiViewsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]ViewApiListItem
	JSONDefault  *ErrorResponse
}

func ParseGetApiViewsResponse

func ParseGetApiViewsResponse(rsp *http.Response) (*GetApiViewsResponse, error)

ParseGetApiViewsResponse parses an HTTP response from a GetApiViewsWithResponse call

func (GetApiViewsResponse) Status

func (r GetApiViewsResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiViewsResponse) StatusCode

func (r GetApiViewsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFailedChecksRequest added in v1.16.0

type GetFailedChecksRequest struct {
	// Dataset selects the dataset to query.
	// When nil, the organization's default dataset is used.
	Dataset *Dataset `json:"dataset,omitempty"`

	// Filter narrows the results to issues matching the criteria.
	Filter *FilterCriteria `json:"filter,omitempty"`

	// Ordering controls the result order.
	// Defaults to descending start time when nil.
	Ordering *OrderingCriteria `json:"ordering,omitempty"`

	// Pagination controls cursor-based paging.
	Pagination *CursorPagination `json:"pagination,omitempty"`

	// TimeRange is the time range to query.
	TimeRange TimeReferenceRange `json:"timeRange"`
}

GetFailedChecksRequest is the request body for Client.GetFailedChecks.

type GetFailedChecksResponse added in v1.16.0

type GetFailedChecksResponse struct {
	// Cursors carries the pagination cursors for fetching adjacent result pages.
	Cursors *NextCursors `json:"cursors,omitempty"`

	// ExecutionTime is the server-side execution timestamp of the request.
	ExecutionTime *FixedTime `json:"executionTime,omitempty"`

	// Issues holds the failed-check instances matching the request.
	Issues []Issue `json:"issues"`

	// TimeRange is the resolved time range for the response.
	TimeRange *TimeRange `json:"timeRange,omitempty"`
}

GetFailedChecksResponse is the response of Client.GetFailedChecks.

type GetLogRecordsRequest

type GetLogRecordsRequest struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset        `json:"dataset,omitempty"`
	Filter  *FilterCriteria `json:"filter,omitempty"`

	// Ordering Any supported attribute keys to order by.
	Ordering *OrderingCriteria `json:"ordering,omitempty"`

	// Pagination Cursor pagination is a technique for paging through a result set using a cursor. It is
	// similar to offset pagination except that the cursor is an opaque value that encodes the
	// position within the result set. This allows for fetching the next page of results from
	// the current position without having to skip over a potentially large number of rows.
	//
	// It is also more resilient against late-arriving data which otherwise would cause issues
	// with offset pagination. For example, if a row is inserted between two pages of results
	// then the second page would contain a duplicate row and the third page would be missing.
	Pagination *CursorPagination `json:"pagination,omitempty"`
	Sampling   *Sampling         `json:"sampling,omitempty"`

	// TimeRange A range of time between two time references.
	TimeRange TimeReferenceRange `json:"timeRange"`
}

GetLogRecordsRequest defines model for GetLogRecordsRequest.

type GetLogRecordsResponse

type GetLogRecordsResponse struct {
	Cursors *NextCursors `json:"cursors,omitempty"`

	// ExecutionTime A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	ExecutionTime *FixedTime `json:"executionTime,omitempty"`

	// ResourceLogs There is one `ResourceLogs` per resource. This is aligned to the data most OTLP batching algorithms would
	// produce, where there is one `ResourceLogs` per resource. This is done to aid compatibility with existing
	// OTLP consumers.
	//
	// `ResourceLogs` are **NOT** sorted. There is no guarantee that `ResourceLogs` are sorted or that
	// `LogRecord`s within them are sorted. However, it is guaranteed that all data is sorted across paged
	// requests.
	//
	// Clients are advised to implement sorting within a page descending by the `LogRecord`'s `timeUnixNano`,
	// `observedTimeUnixNano` and then `id`.
	ResourceLogs []ResourceLogs `json:"resourceLogs"`
	TimeRange    *TimeRange     `json:"timeRange,omitempty"`
}

GetLogRecordsResponse Response for the `GetLogRecords` API. The response contains the log records that match the request.

This API deliberately reuses the full OTLP JSON format for logs. This is done to aid compatibility with existing OTLP consumers.

type GetOauthAuthorizeParams added in v1.6.0

type GetOauthAuthorizeParams struct {
	// ResponseType Must be "code" for the authorization code flow.
	ResponseType string `form:"response_type" json:"response_type"`

	// ClientId The client identifier obtained during registration.
	ClientId string `form:"client_id" json:"client_id"`

	// RedirectUri Must match one of the client's registered redirect URIs.
	RedirectUri string `form:"redirect_uri" json:"redirect_uri"`

	// Scope Space-separated list of requested scopes.
	Scope *string `form:"scope,omitempty" json:"scope,omitempty"`

	// State Opaque value for CSRF protection, returned unchanged in the redirect.
	State *string `form:"state,omitempty" json:"state,omitempty"`

	// CodeChallenge PKCE code challenge (RFC 7636).
	CodeChallenge string `form:"code_challenge" json:"code_challenge"`

	// CodeChallengeMethod Must be "S256".
	CodeChallengeMethod string `form:"code_challenge_method" json:"code_challenge_method"`

	// Prompt Space-separated list of prompt directives. Supported value: "consent".
	Prompt *string `form:"prompt,omitempty" json:"prompt,omitempty"`
}

GetOauthAuthorizeParams defines parameters for GetOauthAuthorize.

type GetOauthAuthorizeResponse added in v1.6.0

type GetOauthAuthorizeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseGetOauthAuthorizeResponse added in v1.6.0

func ParseGetOauthAuthorizeResponse(rsp *http.Response) (*GetOauthAuthorizeResponse, error)

ParseGetOauthAuthorizeResponse parses an HTTP response from a GetOauthAuthorizeWithResponse call

func (GetOauthAuthorizeResponse) Status added in v1.6.0

func (r GetOauthAuthorizeResponse) Status() string

Status returns HTTPResponse.Status

func (GetOauthAuthorizeResponse) StatusCode added in v1.6.0

func (r GetOauthAuthorizeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSamplingRulesResponse added in v1.1.0

type GetSamplingRulesResponse struct {
	SamplingRules []SamplingDefinition `json:"samplingRules"`
}

GetSamplingRulesResponse defines model for GetSamplingRulesResponse.

type GetSignalToMetricsResponse added in v1.9.0

type GetSignalToMetricsResponse struct {
	Counts *SignalToMetricsCounts `json:"counts,omitempty"`

	// HasMore Whether there are more results beyond the current page. Only present when pagination is used.
	HasMore         *bool                       `json:"hasMore,omitempty"`
	SignalToMetrics []SignalToMetricsDefinition `json:"signalToMetrics"`

	// Total Total number of rules matching the request filters, ignoring pagination.
	Total *int `json:"total,omitempty"`
}

GetSignalToMetricsResponse defines model for GetSignalToMetricsResponse.

type GetSpamFiltersResponse added in v1.12.0

type GetSpamFiltersResponse struct {
	SpamFilters []SpamFilterDefinition `json:"spamFilters"`
}

GetSpamFiltersResponse defines model for GetSpamFiltersResponse.

type GetSpansRequest

type GetSpansRequest struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset        `json:"dataset,omitempty"`
	Filter  *FilterCriteria `json:"filter,omitempty"`

	// Ordering Any supported attribute keys to order by.
	Ordering *OrderingCriteria `json:"ordering,omitempty"`

	// Pagination Cursor pagination is a technique for paging through a result set using a cursor. It is
	// similar to offset pagination except that the cursor is an opaque value that encodes the
	// position within the result set. This allows for fetching the next page of results from
	// the current position without having to skip over a potentially large number of rows.
	//
	// It is also more resilient against late-arriving data which otherwise would cause issues
	// with offset pagination. For example, if a row is inserted between two pages of results
	// then the second page would contain a duplicate row and the third page would be missing.
	Pagination *CursorPagination `json:"pagination,omitempty"`
	Sampling   *Sampling         `json:"sampling,omitempty"`

	// TimeRange A range of time between two time references.
	TimeRange TimeReferenceRange `json:"timeRange"`
}

GetSpansRequest defines model for GetSpansRequest.

type GetSpansResponse

type GetSpansResponse struct {
	Cursors *NextCursors `json:"cursors,omitempty"`

	// ExecutionTime A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	ExecutionTime *FixedTime `json:"executionTime,omitempty"`

	// ResourceSpans There is one `ResourceSpan` per resource. This is aligned to the data most OTLP batching algorithms would
	// produce, where there is one `ResourceSpan` per resource. This is done to aid compatibility with existing
	// OTLP consumers.
	//
	// `Spans` nested in `ResourceSpans` are **ONLY** sorted if an explicit ordering has been defined. However,
	// it is guaranteed that all data is sorted across paged requests.
	ResourceSpans []ResourceSpans `json:"resourceSpans"`
	TimeRange     *TimeRange      `json:"timeRange,omitempty"`
}

GetSpansResponse Response for the `GetSpans` API. The response contains the spans that match the request.

This API deliberately reuses the full OTLP JSON format for spans. This is done to aid compatibility with existing OTLP consumers.

type GetTeamResponse added in v1.4.0

type GetTeamResponse struct {
	CheckRules      []AccessibleAsset  `json:"checkRules"`
	Dashboards      []AccessibleAsset  `json:"dashboards"`
	Datasets        []AccessibleAsset  `json:"datasets"`
	Members         []MemberDefinition `json:"members"`
	SyntheticChecks []AccessibleAsset  `json:"syntheticChecks"`

	// Team v1alpha1 team definition. `metadata.name` is the team's technical name
	// (used e.g. as the CRD name in an operator manifest or a Terraform
	// resource ID), `spec.display` carries the human-facing attributes
	// (name, description, color) and `spec.members` is the declarative list
	// of member IDs that make up the team. `metadata.name` and
	// `spec.display.name` are persisted independently.
	Team  TeamDefinitionV1Alpha1 `json:"team"`
	Views []AccessibleAsset      `json:"views"`
}

GetTeamResponse defines model for GetTeamResponse.

type GetTraceIdsRequest added in v1.12.1

type GetTraceIdsRequest struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset        `json:"dataset,omitempty"`
	Filter  *FilterCriteria `json:"filter,omitempty"`

	// Ordering Any supported attribute keys to order by.
	Ordering *OrderingCriteria `json:"ordering,omitempty"`

	// Pagination Cursor pagination is a technique for paging through a result set using a cursor. It is
	// similar to offset pagination except that the cursor is an opaque value that encodes the
	// position within the result set. This allows for fetching the next page of results from
	// the current position without having to skip over a potentially large number of rows.
	//
	// It is also more resilient against late-arriving data which otherwise would cause issues
	// with offset pagination. For example, if a row is inserted between two pages of results
	// then the second page would contain a duplicate row and the third page would be missing.
	Pagination *CursorPagination `json:"pagination,omitempty"`
	Sampling   *Sampling         `json:"sampling,omitempty"`

	// TimeRange A range of time between two time references.
	TimeRange TimeReferenceRange `json:"timeRange"`
}

GetTraceIdsRequest Request to retrieve unique trace IDs of traces that contain at least one span matching the given filters. This is a lightweight alternative to `GetSpans` for two-step workflows where only trace IDs are needed first, and full trace details are subsequently retrieved via `GetTrace` (`POST /api/trace/details`).

type GetTraceIdsResponse added in v1.12.1

type GetTraceIdsResponse struct {
	Cursors *NextCursors `json:"cursors,omitempty"`

	// TraceIds Array of unique trace IDs as hex-encoded strings, ordered by the timestamp of each
	// trace's earliest matching span (descending).
	TraceIds []string `json:"traceIds"`
}

GetTraceIdsResponse Response for the `GetTraceIds` API. Contains an array of unique trace IDs that match the request filters, ordered by the timestamp of their earliest matching span (descending).

type GetTraceRequest added in v1.12.0

type GetTraceRequest struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset `json:"dataset,omitempty"`

	// IncludeLinkedTraces If true, recursively fetches all traces referenced via forward links (dash0ForwardLinks)
	// and returns them in `additionalResourceSpans`. Implies includeOTLPSchemaExtensions=true.
	IncludeLinkedTraces *bool `json:"includeLinkedTraces,omitempty"`

	// TimeRange A range of time between two time references.
	TimeRange *TimeReferenceRange `json:"timeRange,omitempty"`
	TraceId   string              `json:"traceId"`
}

GetTraceRequest defines model for GetTraceRequest.

type GetTraceResponse added in v1.12.0

type GetTraceResponse struct {
	// AdditionalResourceSpans Resource spans from linked traces. Only populated when includeLinkedTraces=true.
	AdditionalResourceSpans      *[]ResourceSpans              `json:"additionalResourceSpans,omitempty"`
	ResourceLogs                 []ResourceLogs                `json:"resourceLogs"`
	ResourceSpans                []ResourceSpans               `json:"resourceSpans"`
	SyntheticCheckAttemptDetails *SyntheticCheckAttemptDetails `json:"syntheticCheckAttemptDetails,omitempty"`
	WebEvents                    []ResourceLogs                `json:"webEvents"`
}

GetTraceResponse Response for the `GetTrace` API. The response contains the spans and logs that match the request.

This API deliberately reuses the full OTLP JSON format for spans and logs. This is done to aid compatibility with existing OTLP consumers.

type GetWellKnownOauthAuthorizationServerResponse added in v1.6.0

type GetWellKnownOauthAuthorizationServerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OAuthAuthorizationServerMetadata
	JSONDefault  *ErrorResponse
}

func ParseGetWellKnownOauthAuthorizationServerResponse added in v1.6.0

func ParseGetWellKnownOauthAuthorizationServerResponse(rsp *http.Response) (*GetWellKnownOauthAuthorizationServerResponse, error)

ParseGetWellKnownOauthAuthorizationServerResponse parses an HTTP response from a GetWellKnownOauthAuthorizationServerWithResponse call

func (GetWellKnownOauthAuthorizationServerResponse) Status added in v1.6.0

Status returns HTTPResponse.Status

func (GetWellKnownOauthAuthorizationServerResponse) StatusCode added in v1.6.0

StatusCode returns HTTPResponse.StatusCode

type GetWellKnownOauthProtectedResourceResponse added in v1.6.0

type GetWellKnownOauthProtectedResourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OAuthProtectedResourceMetadata
	JSONDefault  *ErrorResponse
}

func ParseGetWellKnownOauthProtectedResourceResponse added in v1.6.0

func ParseGetWellKnownOauthProtectedResourceResponse(rsp *http.Response) (*GetWellKnownOauthProtectedResourceResponse, error)

ParseGetWellKnownOauthProtectedResourceResponse parses an HTTP response from a GetWellKnownOauthProtectedResourceWithResponse call

func (GetWellKnownOauthProtectedResourceResponse) Status added in v1.6.0

Status returns HTTPResponse.Status

func (GetWellKnownOauthProtectedResourceResponse) StatusCode added in v1.6.0

StatusCode returns HTTPResponse.StatusCode

type GitHubAgenticWorkflowTriggerSpec added in v1.17.0

type GitHubAgenticWorkflowTriggerSpec struct {
	// Accounts Deprecated: use `organizations` instead. Kept for backwards compatibility; reads
	// mirror the value of `organizations` and writes are folded into it.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Accounts *[]string `json:"accounts,omitempty"`

	// Actions Optional list of GitHub event actions to filter on.
	// When specified, only events with a matching action trigger the workflow.
	// When omitted, events with any action match.
	//
	// Note: `github.deployment` and `github.deployment_status` fire no action field; this filter has no effect for those trigger kinds. `github.deployment_status` filters on `states` instead.
	//
	// Valid values per trigger kind:
	// - `github.pull_request`: `assigned`, `auto_merge_disabled`, `auto_merge_enabled`, `closed`, `converted_to_draft`, `demilestoned`, `dequeued`, `edited`, `enqueued`, `labeled`, `locked`, `milestoned`, `opened`, `ready_for_review`, `reopened`, `review_request_removed`, `review_requested`, `synchronize`, `unassigned`, `unlabeled`, `unlocked`
	// - `github.pull_request_review`: `dismissed`, `edited`, `submitted`
	// - `github.pull_request_review_comment`: `created`, `deleted`, `edited`
	// - `github.issue_comment`: `created`, `deleted`, `edited`, `pinned`, `unpinned`
	// - `github.release`: `created`, `deleted`, `edited`, `prereleased`, `published`, `released`, `unpublished`
	Actions *[]string `json:"actions,omitempty"`

	// AllAccounts Deprecated: use `allOrganizations` instead. Kept for backwards compatibility; reads
	// mirror the value of `allOrganizations` and writes are folded into it.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	AllAccounts *bool `json:"allAccounts,omitempty"`

	// AllOrganizations When true, the automation deliberately matches events from every organization, now and
	// in the future. Mutually exclusive with a non-empty `organizations` list. This flag
	// exists to distinguish an explicit "all organizations" choice from an unconfigured
	// trigger: a GitHub trigger with no `organizations`, no `allOrganizations`, no
	// `repositories`, no `allRepositories`, and (for comment kinds) no `keyword` is rejected
	// on write as an accidental match-everything catch-all.
	//
	// `organizations`/`allOrganizations` and `repositories`/`allRepositories` are independent
	// alternatives, not nested: an event matching either the organization filter or the
	// repository filter triggers the automation.
	//
	// Replaces the deprecated `allAccounts` field. When both are set, they must carry the
	// same value; requests where they contradict each other are rejected.
	AllOrganizations *bool `json:"allOrganizations,omitempty"`

	// AllRepositories When true, the automation deliberately matches events from every repository, now and
	// in the future. Mutually exclusive with a non-empty `repositories` list. This flag
	// exists to distinguish an explicit "all repositories" choice from an unconfigured
	// trigger, mirroring `allOrganizations`.
	AllRepositories *bool `json:"allRepositories,omitempty"`

	// AvailableVariables The trigger-specific variables available as `{{variable.name}}` when this trigger fires.
	// This is in addition to the built-in variables that are always available.
	AvailableVariables *[]GitHubTriggerVariableName `json:"availableVariables,omitempty"`

	// CheckRunStatuses Optional list of check run statuses to filter on. Only `github.deployment_status` uses this
	// filter; it has no effect for other trigger kinds. The `deployment_status` event payload may
	// carry an associated `check_run`; when specified, only events whose `check_run.status` matches
	// trigger the automation. When omitted, any check run status (or none) matches.
	//
	// Valid values: `queued`, `in_progress`, `completed`, `waiting`, `pending`.
	CheckRunStatuses *[]string `json:"checkRunStatuses,omitempty"`

	// Organizations Optional list of GitHub organization logins to filter on (e.g., `my-org`). An
	// "organization" here is the account the Dash0 GitHub App is installed on — usually a
	// GitHub organization, but a personal account for personal installations.
	// When specified, only events from these organizations trigger the automation.
	// When omitted, events from any organization match.
	//
	// Replaces the deprecated `accounts` field. When both are set, they must carry the
	// same values; requests where they contradict each other are rejected.
	Organizations *[]string `json:"organizations,omitempty"`

	// Repositories Optional list of repository full names to filter on (e.g., `owner/repo`).
	// When specified, only events from these repositories trigger the automation.
	// When omitted, events from any repository match.
	Repositories *[]string `json:"repositories,omitempty"`

	// States Optional list of deployment statuses to filter on. Only `github.deployment_status` uses
	// this filter; it has no effect for other trigger kinds. When specified, only
	// deployment-status events whose `state` matches trigger the automation. When omitted, any
	// status matches.
	//
	// Valid values: `error`, `failure`, `inactive`, `pending`, `success`, `queued`, `in_progress`.
	States *[]string `json:"states,omitempty"`
}

GitHubAgenticWorkflowTriggerSpec defines model for GitHubAgenticWorkflowTriggerSpec.

type GitHubCommentAgenticWorkflowTriggerSpec added in v1.17.0

type GitHubCommentAgenticWorkflowTriggerSpec struct {
	// Accounts Deprecated: use `organizations` instead. Kept for backwards compatibility; reads
	// mirror the value of `organizations` and writes are folded into it.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Accounts *[]string `json:"accounts,omitempty"`

	// Actions Optional list of GitHub event actions to filter on.
	// When specified, only events with a matching action trigger the workflow.
	// When omitted, events with any action match.
	//
	// Note: `github.deployment` and `github.deployment_status` fire no action field; this filter has no effect for those trigger kinds. `github.deployment_status` filters on `states` instead.
	//
	// Valid values per trigger kind:
	// - `github.pull_request`: `assigned`, `auto_merge_disabled`, `auto_merge_enabled`, `closed`, `converted_to_draft`, `demilestoned`, `dequeued`, `edited`, `enqueued`, `labeled`, `locked`, `milestoned`, `opened`, `ready_for_review`, `reopened`, `review_request_removed`, `review_requested`, `synchronize`, `unassigned`, `unlabeled`, `unlocked`
	// - `github.pull_request_review`: `dismissed`, `edited`, `submitted`
	// - `github.pull_request_review_comment`: `created`, `deleted`, `edited`
	// - `github.issue_comment`: `created`, `deleted`, `edited`, `pinned`, `unpinned`
	// - `github.release`: `created`, `deleted`, `edited`, `prereleased`, `published`, `released`, `unpublished`
	Actions *[]string `json:"actions,omitempty"`

	// AllAccounts Deprecated: use `allOrganizations` instead. Kept for backwards compatibility; reads
	// mirror the value of `allOrganizations` and writes are folded into it.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	AllAccounts *bool `json:"allAccounts,omitempty"`

	// AllOrganizations When true, the automation deliberately matches events from every organization, now and
	// in the future. Mutually exclusive with a non-empty `organizations` list. This flag
	// exists to distinguish an explicit "all organizations" choice from an unconfigured
	// trigger: a GitHub trigger with no `organizations`, no `allOrganizations`, no
	// `repositories`, no `allRepositories`, and (for comment kinds) no `keyword` is rejected
	// on write as an accidental match-everything catch-all.
	//
	// `organizations`/`allOrganizations` and `repositories`/`allRepositories` are independent
	// alternatives, not nested: an event matching either the organization filter or the
	// repository filter triggers the automation.
	//
	// Replaces the deprecated `allAccounts` field. When both are set, they must carry the
	// same value; requests where they contradict each other are rejected.
	AllOrganizations *bool `json:"allOrganizations,omitempty"`

	// AllRepositories When true, the automation deliberately matches events from every repository, now and
	// in the future. Mutually exclusive with a non-empty `repositories` list. This flag
	// exists to distinguish an explicit "all repositories" choice from an unconfigured
	// trigger, mirroring `allOrganizations`.
	AllRepositories *bool `json:"allRepositories,omitempty"`

	// AvailableVariables The trigger-specific variables available as `{{variable.name}}` when this trigger fires.
	// This is in addition to the built-in variables that are always available.
	AvailableVariables *[]GitHubTriggerVariableName `json:"availableVariables,omitempty"`

	// CheckRunStatuses Optional list of check run statuses to filter on. Only `github.deployment_status` uses this
	// filter; it has no effect for other trigger kinds. The `deployment_status` event payload may
	// carry an associated `check_run`; when specified, only events whose `check_run.status` matches
	// trigger the automation. When omitted, any check run status (or none) matches.
	//
	// Valid values: `queued`, `in_progress`, `completed`, `waiting`, `pending`.
	CheckRunStatuses *[]string `json:"checkRunStatuses,omitempty"`

	// Keyword Optional keyword the comment body must contain. Evaluated as a
	// case-insensitive substring match (e.g., "investigate" matches any
	// comment containing "investigate"). When absent or empty, any comment
	// fires the automation.
	Keyword *string `json:"keyword,omitempty"`

	// Organizations Optional list of GitHub organization logins to filter on (e.g., `my-org`). An
	// "organization" here is the account the Dash0 GitHub App is installed on — usually a
	// GitHub organization, but a personal account for personal installations.
	// When specified, only events from these organizations trigger the automation.
	// When omitted, events from any organization match.
	//
	// Replaces the deprecated `accounts` field. When both are set, they must carry the
	// same values; requests where they contradict each other are rejected.
	Organizations *[]string `json:"organizations,omitempty"`

	// Repositories Optional list of repository full names to filter on (e.g., `owner/repo`).
	// When specified, only events from these repositories trigger the automation.
	// When omitted, events from any repository match.
	Repositories *[]string `json:"repositories,omitempty"`

	// States Optional list of deployment statuses to filter on. Only `github.deployment_status` uses
	// this filter; it has no effect for other trigger kinds. When specified, only
	// deployment-status events whose `state` matches trigger the automation. When omitted, any
	// status matches.
	//
	// Valid values: `error`, `failure`, `inactive`, `pending`, `success`, `queued`, `in_progress`.
	States *[]string `json:"states,omitempty"`
}

GitHubCommentAgenticWorkflowTriggerSpec defines model for GitHubCommentAgenticWorkflowTriggerSpec.

type GitHubDeploymentAgenticWorkflowTrigger added in v1.17.0

type GitHubDeploymentAgenticWorkflowTrigger struct {
	// Delivery How a trigger delivers its event to an agent. An automation is the agent definition;
	// triggers are the pipes into it, and each pipe is configured independently.
	//
	// - `spawn`: Start a new agent thread for this event. This is today's behavior.
	// - `continue`: Route the event into the existing agent thread that owns the matching
	//   entity, falling back to spawning a fresh thread when none is active
	//   (resume-or-spawn). Only valid on continuation-capable triggers that carry an entity
	//   ref to route by; spawn-only triggers (e.g. `schedule`, `webhook`,
	//   `failed_check.new`) must not set it.
	Delivery *AgenticWorkflowTriggerDelivery            `json:"delivery,omitempty"`
	Kind     GitHubDeploymentAgenticWorkflowTriggerKind `json:"kind"`
	Spec     GitHubAgenticWorkflowTriggerSpec           `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

GitHubDeploymentAgenticWorkflowTrigger defines model for GitHubDeploymentAgenticWorkflowTrigger.

type GitHubDeploymentAgenticWorkflowTriggerKind added in v1.17.0

type GitHubDeploymentAgenticWorkflowTriggerKind string

GitHubDeploymentAgenticWorkflowTriggerKind defines model for GitHubDeploymentAgenticWorkflowTrigger.Kind.

const (
	GitHubDeploymentAgenticWorkflowTriggerKindFailedCheckNew                 GitHubDeploymentAgenticWorkflowTriggerKind = "failed_check.new"
	GitHubDeploymentAgenticWorkflowTriggerKindGithubDeployment               GitHubDeploymentAgenticWorkflowTriggerKind = "github.deployment"
	GitHubDeploymentAgenticWorkflowTriggerKindGithubDeploymentStatus         GitHubDeploymentAgenticWorkflowTriggerKind = "github.deployment_status"
	GitHubDeploymentAgenticWorkflowTriggerKindGithubIssueComment             GitHubDeploymentAgenticWorkflowTriggerKind = "github.issue_comment"
	GitHubDeploymentAgenticWorkflowTriggerKindGithubPullRequest              GitHubDeploymentAgenticWorkflowTriggerKind = "github.pull_request"
	GitHubDeploymentAgenticWorkflowTriggerKindGithubPullRequestReview        GitHubDeploymentAgenticWorkflowTriggerKind = "github.pull_request_review"
	GitHubDeploymentAgenticWorkflowTriggerKindGithubPullRequestReviewComment GitHubDeploymentAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	GitHubDeploymentAgenticWorkflowTriggerKindGithubRelease                  GitHubDeploymentAgenticWorkflowTriggerKind = "github.release"
	GitHubDeploymentAgenticWorkflowTriggerKindLinearComment                  GitHubDeploymentAgenticWorkflowTriggerKind = "linear.comment"
	GitHubDeploymentAgenticWorkflowTriggerKindLinearLabelAdded               GitHubDeploymentAgenticWorkflowTriggerKind = "linear.label_added"
	GitHubDeploymentAgenticWorkflowTriggerKindManual                         GitHubDeploymentAgenticWorkflowTriggerKind = "manual"
	GitHubDeploymentAgenticWorkflowTriggerKindSchedule                       GitHubDeploymentAgenticWorkflowTriggerKind = "schedule"
	GitHubDeploymentAgenticWorkflowTriggerKindSlackBotFailedCheckNew         GitHubDeploymentAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	GitHubDeploymentAgenticWorkflowTriggerKindSlackBotMessage                GitHubDeploymentAgenticWorkflowTriggerKind = "slack_bot.message"
	GitHubDeploymentAgenticWorkflowTriggerKindSlackBotReaction               GitHubDeploymentAgenticWorkflowTriggerKind = "slack_bot.reaction"
	GitHubDeploymentAgenticWorkflowTriggerKindWebhook                        GitHubDeploymentAgenticWorkflowTriggerKind = "webhook"
)

Defines values for GitHubDeploymentAgenticWorkflowTriggerKind.

type GitHubDeploymentStatusAgenticWorkflowTrigger added in v1.17.0

type GitHubDeploymentStatusAgenticWorkflowTrigger struct {
	// Delivery How a trigger delivers its event to an agent. An automation is the agent definition;
	// triggers are the pipes into it, and each pipe is configured independently.
	//
	// - `spawn`: Start a new agent thread for this event. This is today's behavior.
	// - `continue`: Route the event into the existing agent thread that owns the matching
	//   entity, falling back to spawning a fresh thread when none is active
	//   (resume-or-spawn). Only valid on continuation-capable triggers that carry an entity
	//   ref to route by; spawn-only triggers (e.g. `schedule`, `webhook`,
	//   `failed_check.new`) must not set it.
	Delivery *AgenticWorkflowTriggerDelivery                  `json:"delivery,omitempty"`
	Kind     GitHubDeploymentStatusAgenticWorkflowTriggerKind `json:"kind"`
	Spec     GitHubAgenticWorkflowTriggerSpec                 `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

GitHubDeploymentStatusAgenticWorkflowTrigger defines model for GitHubDeploymentStatusAgenticWorkflowTrigger.

type GitHubDeploymentStatusAgenticWorkflowTriggerKind added in v1.17.0

type GitHubDeploymentStatusAgenticWorkflowTriggerKind string

GitHubDeploymentStatusAgenticWorkflowTriggerKind defines model for GitHubDeploymentStatusAgenticWorkflowTrigger.Kind.

const (
	GitHubDeploymentStatusAgenticWorkflowTriggerKindFailedCheckNew                 GitHubDeploymentStatusAgenticWorkflowTriggerKind = "failed_check.new"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindGithubDeployment               GitHubDeploymentStatusAgenticWorkflowTriggerKind = "github.deployment"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindGithubDeploymentStatus         GitHubDeploymentStatusAgenticWorkflowTriggerKind = "github.deployment_status"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindGithubIssueComment             GitHubDeploymentStatusAgenticWorkflowTriggerKind = "github.issue_comment"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindGithubPullRequest              GitHubDeploymentStatusAgenticWorkflowTriggerKind = "github.pull_request"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindGithubPullRequestReview        GitHubDeploymentStatusAgenticWorkflowTriggerKind = "github.pull_request_review"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindGithubPullRequestReviewComment GitHubDeploymentStatusAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindGithubRelease                  GitHubDeploymentStatusAgenticWorkflowTriggerKind = "github.release"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindLinearComment                  GitHubDeploymentStatusAgenticWorkflowTriggerKind = "linear.comment"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindLinearLabelAdded               GitHubDeploymentStatusAgenticWorkflowTriggerKind = "linear.label_added"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindManual                         GitHubDeploymentStatusAgenticWorkflowTriggerKind = "manual"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindSchedule                       GitHubDeploymentStatusAgenticWorkflowTriggerKind = "schedule"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindSlackBotFailedCheckNew         GitHubDeploymentStatusAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindSlackBotMessage                GitHubDeploymentStatusAgenticWorkflowTriggerKind = "slack_bot.message"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindSlackBotReaction               GitHubDeploymentStatusAgenticWorkflowTriggerKind = "slack_bot.reaction"
	GitHubDeploymentStatusAgenticWorkflowTriggerKindWebhook                        GitHubDeploymentStatusAgenticWorkflowTriggerKind = "webhook"
)

Defines values for GitHubDeploymentStatusAgenticWorkflowTriggerKind.

type GitHubIssueCommentAgenticWorkflowTrigger added in v1.17.0

type GitHubIssueCommentAgenticWorkflowTrigger struct {
	// Delivery How a trigger delivers its event to an agent. An automation is the agent definition;
	// triggers are the pipes into it, and each pipe is configured independently.
	//
	// - `spawn`: Start a new agent thread for this event. This is today's behavior.
	// - `continue`: Route the event into the existing agent thread that owns the matching
	//   entity, falling back to spawning a fresh thread when none is active
	//   (resume-or-spawn). Only valid on continuation-capable triggers that carry an entity
	//   ref to route by; spawn-only triggers (e.g. `schedule`, `webhook`,
	//   `failed_check.new`) must not set it.
	Delivery *AgenticWorkflowTriggerDelivery              `json:"delivery,omitempty"`
	Kind     GitHubIssueCommentAgenticWorkflowTriggerKind `json:"kind"`
	Spec     GitHubCommentAgenticWorkflowTriggerSpec      `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

GitHubIssueCommentAgenticWorkflowTrigger defines model for GitHubIssueCommentAgenticWorkflowTrigger.

type GitHubIssueCommentAgenticWorkflowTriggerKind added in v1.17.0

type GitHubIssueCommentAgenticWorkflowTriggerKind string

GitHubIssueCommentAgenticWorkflowTriggerKind defines model for GitHubIssueCommentAgenticWorkflowTrigger.Kind.

const (
	GitHubIssueCommentAgenticWorkflowTriggerKindFailedCheckNew                 GitHubIssueCommentAgenticWorkflowTriggerKind = "failed_check.new"
	GitHubIssueCommentAgenticWorkflowTriggerKindGithubDeployment               GitHubIssueCommentAgenticWorkflowTriggerKind = "github.deployment"
	GitHubIssueCommentAgenticWorkflowTriggerKindGithubDeploymentStatus         GitHubIssueCommentAgenticWorkflowTriggerKind = "github.deployment_status"
	GitHubIssueCommentAgenticWorkflowTriggerKindGithubIssueComment             GitHubIssueCommentAgenticWorkflowTriggerKind = "github.issue_comment"
	GitHubIssueCommentAgenticWorkflowTriggerKindGithubPullRequest              GitHubIssueCommentAgenticWorkflowTriggerKind = "github.pull_request"
	GitHubIssueCommentAgenticWorkflowTriggerKindGithubPullRequestReview        GitHubIssueCommentAgenticWorkflowTriggerKind = "github.pull_request_review"
	GitHubIssueCommentAgenticWorkflowTriggerKindGithubPullRequestReviewComment GitHubIssueCommentAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	GitHubIssueCommentAgenticWorkflowTriggerKindGithubRelease                  GitHubIssueCommentAgenticWorkflowTriggerKind = "github.release"
	GitHubIssueCommentAgenticWorkflowTriggerKindLinearComment                  GitHubIssueCommentAgenticWorkflowTriggerKind = "linear.comment"
	GitHubIssueCommentAgenticWorkflowTriggerKindLinearLabelAdded               GitHubIssueCommentAgenticWorkflowTriggerKind = "linear.label_added"
	GitHubIssueCommentAgenticWorkflowTriggerKindManual                         GitHubIssueCommentAgenticWorkflowTriggerKind = "manual"
	GitHubIssueCommentAgenticWorkflowTriggerKindSchedule                       GitHubIssueCommentAgenticWorkflowTriggerKind = "schedule"
	GitHubIssueCommentAgenticWorkflowTriggerKindSlackBotFailedCheckNew         GitHubIssueCommentAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	GitHubIssueCommentAgenticWorkflowTriggerKindSlackBotMessage                GitHubIssueCommentAgenticWorkflowTriggerKind = "slack_bot.message"
	GitHubIssueCommentAgenticWorkflowTriggerKindSlackBotReaction               GitHubIssueCommentAgenticWorkflowTriggerKind = "slack_bot.reaction"
	GitHubIssueCommentAgenticWorkflowTriggerKindWebhook                        GitHubIssueCommentAgenticWorkflowTriggerKind = "webhook"
)

Defines values for GitHubIssueCommentAgenticWorkflowTriggerKind.

type GitHubPullRequestAgenticWorkflowTrigger added in v1.17.0

type GitHubPullRequestAgenticWorkflowTrigger struct {
	// Delivery How a trigger delivers its event to an agent. An automation is the agent definition;
	// triggers are the pipes into it, and each pipe is configured independently.
	//
	// - `spawn`: Start a new agent thread for this event. This is today's behavior.
	// - `continue`: Route the event into the existing agent thread that owns the matching
	//   entity, falling back to spawning a fresh thread when none is active
	//   (resume-or-spawn). Only valid on continuation-capable triggers that carry an entity
	//   ref to route by; spawn-only triggers (e.g. `schedule`, `webhook`,
	//   `failed_check.new`) must not set it.
	Delivery *AgenticWorkflowTriggerDelivery             `json:"delivery,omitempty"`
	Kind     GitHubPullRequestAgenticWorkflowTriggerKind `json:"kind"`
	Spec     GitHubAgenticWorkflowTriggerSpec            `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

GitHubPullRequestAgenticWorkflowTrigger defines model for GitHubPullRequestAgenticWorkflowTrigger.

type GitHubPullRequestAgenticWorkflowTriggerKind added in v1.17.0

type GitHubPullRequestAgenticWorkflowTriggerKind string

GitHubPullRequestAgenticWorkflowTriggerKind defines model for GitHubPullRequestAgenticWorkflowTrigger.Kind.

const (
	GitHubPullRequestAgenticWorkflowTriggerKindFailedCheckNew                 GitHubPullRequestAgenticWorkflowTriggerKind = "failed_check.new"
	GitHubPullRequestAgenticWorkflowTriggerKindGithubDeployment               GitHubPullRequestAgenticWorkflowTriggerKind = "github.deployment"
	GitHubPullRequestAgenticWorkflowTriggerKindGithubDeploymentStatus         GitHubPullRequestAgenticWorkflowTriggerKind = "github.deployment_status"
	GitHubPullRequestAgenticWorkflowTriggerKindGithubIssueComment             GitHubPullRequestAgenticWorkflowTriggerKind = "github.issue_comment"
	GitHubPullRequestAgenticWorkflowTriggerKindGithubPullRequest              GitHubPullRequestAgenticWorkflowTriggerKind = "github.pull_request"
	GitHubPullRequestAgenticWorkflowTriggerKindGithubPullRequestReview        GitHubPullRequestAgenticWorkflowTriggerKind = "github.pull_request_review"
	GitHubPullRequestAgenticWorkflowTriggerKindGithubPullRequestReviewComment GitHubPullRequestAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	GitHubPullRequestAgenticWorkflowTriggerKindGithubRelease                  GitHubPullRequestAgenticWorkflowTriggerKind = "github.release"
	GitHubPullRequestAgenticWorkflowTriggerKindLinearComment                  GitHubPullRequestAgenticWorkflowTriggerKind = "linear.comment"
	GitHubPullRequestAgenticWorkflowTriggerKindLinearLabelAdded               GitHubPullRequestAgenticWorkflowTriggerKind = "linear.label_added"
	GitHubPullRequestAgenticWorkflowTriggerKindManual                         GitHubPullRequestAgenticWorkflowTriggerKind = "manual"
	GitHubPullRequestAgenticWorkflowTriggerKindSchedule                       GitHubPullRequestAgenticWorkflowTriggerKind = "schedule"
	GitHubPullRequestAgenticWorkflowTriggerKindSlackBotFailedCheckNew         GitHubPullRequestAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	GitHubPullRequestAgenticWorkflowTriggerKindSlackBotMessage                GitHubPullRequestAgenticWorkflowTriggerKind = "slack_bot.message"
	GitHubPullRequestAgenticWorkflowTriggerKindSlackBotReaction               GitHubPullRequestAgenticWorkflowTriggerKind = "slack_bot.reaction"
	GitHubPullRequestAgenticWorkflowTriggerKindWebhook                        GitHubPullRequestAgenticWorkflowTriggerKind = "webhook"
)

Defines values for GitHubPullRequestAgenticWorkflowTriggerKind.

type GitHubPullRequestReviewAgenticWorkflowTrigger added in v1.17.0

type GitHubPullRequestReviewAgenticWorkflowTrigger struct {
	// Delivery How a trigger delivers its event to an agent. An automation is the agent definition;
	// triggers are the pipes into it, and each pipe is configured independently.
	//
	// - `spawn`: Start a new agent thread for this event. This is today's behavior.
	// - `continue`: Route the event into the existing agent thread that owns the matching
	//   entity, falling back to spawning a fresh thread when none is active
	//   (resume-or-spawn). Only valid on continuation-capable triggers that carry an entity
	//   ref to route by; spawn-only triggers (e.g. `schedule`, `webhook`,
	//   `failed_check.new`) must not set it.
	Delivery *AgenticWorkflowTriggerDelivery                   `json:"delivery,omitempty"`
	Kind     GitHubPullRequestReviewAgenticWorkflowTriggerKind `json:"kind"`
	Spec     GitHubAgenticWorkflowTriggerSpec                  `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

GitHubPullRequestReviewAgenticWorkflowTrigger defines model for GitHubPullRequestReviewAgenticWorkflowTrigger.

type GitHubPullRequestReviewAgenticWorkflowTriggerKind added in v1.17.0

type GitHubPullRequestReviewAgenticWorkflowTriggerKind string

GitHubPullRequestReviewAgenticWorkflowTriggerKind defines model for GitHubPullRequestReviewAgenticWorkflowTrigger.Kind.

const (
	GitHubPullRequestReviewAgenticWorkflowTriggerKindFailedCheckNew                 GitHubPullRequestReviewAgenticWorkflowTriggerKind = "failed_check.new"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindGithubDeployment               GitHubPullRequestReviewAgenticWorkflowTriggerKind = "github.deployment"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindGithubDeploymentStatus         GitHubPullRequestReviewAgenticWorkflowTriggerKind = "github.deployment_status"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindGithubIssueComment             GitHubPullRequestReviewAgenticWorkflowTriggerKind = "github.issue_comment"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindGithubPullRequest              GitHubPullRequestReviewAgenticWorkflowTriggerKind = "github.pull_request"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindGithubPullRequestReview        GitHubPullRequestReviewAgenticWorkflowTriggerKind = "github.pull_request_review"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindGithubPullRequestReviewComment GitHubPullRequestReviewAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindGithubRelease                  GitHubPullRequestReviewAgenticWorkflowTriggerKind = "github.release"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindLinearComment                  GitHubPullRequestReviewAgenticWorkflowTriggerKind = "linear.comment"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindLinearLabelAdded               GitHubPullRequestReviewAgenticWorkflowTriggerKind = "linear.label_added"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindManual                         GitHubPullRequestReviewAgenticWorkflowTriggerKind = "manual"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindSchedule                       GitHubPullRequestReviewAgenticWorkflowTriggerKind = "schedule"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindSlackBotFailedCheckNew         GitHubPullRequestReviewAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindSlackBotMessage                GitHubPullRequestReviewAgenticWorkflowTriggerKind = "slack_bot.message"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindSlackBotReaction               GitHubPullRequestReviewAgenticWorkflowTriggerKind = "slack_bot.reaction"
	GitHubPullRequestReviewAgenticWorkflowTriggerKindWebhook                        GitHubPullRequestReviewAgenticWorkflowTriggerKind = "webhook"
)

Defines values for GitHubPullRequestReviewAgenticWorkflowTriggerKind.

type GitHubPullRequestReviewCommentAgenticWorkflowTrigger added in v1.17.0

type GitHubPullRequestReviewCommentAgenticWorkflowTrigger struct {
	// Delivery How a trigger delivers its event to an agent. An automation is the agent definition;
	// triggers are the pipes into it, and each pipe is configured independently.
	//
	// - `spawn`: Start a new agent thread for this event. This is today's behavior.
	// - `continue`: Route the event into the existing agent thread that owns the matching
	//   entity, falling back to spawning a fresh thread when none is active
	//   (resume-or-spawn). Only valid on continuation-capable triggers that carry an entity
	//   ref to route by; spawn-only triggers (e.g. `schedule`, `webhook`,
	//   `failed_check.new`) must not set it.
	Delivery *AgenticWorkflowTriggerDelivery                          `json:"delivery,omitempty"`
	Kind     GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind `json:"kind"`
	Spec     GitHubCommentAgenticWorkflowTriggerSpec                  `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

GitHubPullRequestReviewCommentAgenticWorkflowTrigger defines model for GitHubPullRequestReviewCommentAgenticWorkflowTrigger.

type GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind added in v1.17.0

type GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind string

GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind defines model for GitHubPullRequestReviewCommentAgenticWorkflowTrigger.Kind.

const (
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindFailedCheckNew                 GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "failed_check.new"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindGithubDeployment               GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "github.deployment"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindGithubDeploymentStatus         GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "github.deployment_status"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindGithubIssueComment             GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "github.issue_comment"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindGithubPullRequest              GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "github.pull_request"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindGithubPullRequestReview        GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "github.pull_request_review"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindGithubPullRequestReviewComment GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindGithubRelease                  GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "github.release"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindLinearComment                  GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "linear.comment"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindLinearLabelAdded               GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "linear.label_added"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindManual                         GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "manual"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindSchedule                       GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "schedule"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindSlackBotFailedCheckNew         GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindSlackBotMessage                GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "slack_bot.message"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindSlackBotReaction               GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "slack_bot.reaction"
	GitHubPullRequestReviewCommentAgenticWorkflowTriggerKindWebhook                        GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind = "webhook"
)

Defines values for GitHubPullRequestReviewCommentAgenticWorkflowTriggerKind.

type GitHubReleaseAgenticWorkflowTrigger added in v1.17.0

type GitHubReleaseAgenticWorkflowTrigger struct {
	// Delivery How a trigger delivers its event to an agent. An automation is the agent definition;
	// triggers are the pipes into it, and each pipe is configured independently.
	//
	// - `spawn`: Start a new agent thread for this event. This is today's behavior.
	// - `continue`: Route the event into the existing agent thread that owns the matching
	//   entity, falling back to spawning a fresh thread when none is active
	//   (resume-or-spawn). Only valid on continuation-capable triggers that carry an entity
	//   ref to route by; spawn-only triggers (e.g. `schedule`, `webhook`,
	//   `failed_check.new`) must not set it.
	Delivery *AgenticWorkflowTriggerDelivery         `json:"delivery,omitempty"`
	Kind     GitHubReleaseAgenticWorkflowTriggerKind `json:"kind"`
	Spec     GitHubAgenticWorkflowTriggerSpec        `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

GitHubReleaseAgenticWorkflowTrigger defines model for GitHubReleaseAgenticWorkflowTrigger.

type GitHubReleaseAgenticWorkflowTriggerKind added in v1.17.0

type GitHubReleaseAgenticWorkflowTriggerKind string

GitHubReleaseAgenticWorkflowTriggerKind defines model for GitHubReleaseAgenticWorkflowTrigger.Kind.

const (
	GitHubReleaseAgenticWorkflowTriggerKindFailedCheckNew                 GitHubReleaseAgenticWorkflowTriggerKind = "failed_check.new"
	GitHubReleaseAgenticWorkflowTriggerKindGithubDeployment               GitHubReleaseAgenticWorkflowTriggerKind = "github.deployment"
	GitHubReleaseAgenticWorkflowTriggerKindGithubDeploymentStatus         GitHubReleaseAgenticWorkflowTriggerKind = "github.deployment_status"
	GitHubReleaseAgenticWorkflowTriggerKindGithubIssueComment             GitHubReleaseAgenticWorkflowTriggerKind = "github.issue_comment"
	GitHubReleaseAgenticWorkflowTriggerKindGithubPullRequest              GitHubReleaseAgenticWorkflowTriggerKind = "github.pull_request"
	GitHubReleaseAgenticWorkflowTriggerKindGithubPullRequestReview        GitHubReleaseAgenticWorkflowTriggerKind = "github.pull_request_review"
	GitHubReleaseAgenticWorkflowTriggerKindGithubPullRequestReviewComment GitHubReleaseAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	GitHubReleaseAgenticWorkflowTriggerKindGithubRelease                  GitHubReleaseAgenticWorkflowTriggerKind = "github.release"
	GitHubReleaseAgenticWorkflowTriggerKindLinearComment                  GitHubReleaseAgenticWorkflowTriggerKind = "linear.comment"
	GitHubReleaseAgenticWorkflowTriggerKindLinearLabelAdded               GitHubReleaseAgenticWorkflowTriggerKind = "linear.label_added"
	GitHubReleaseAgenticWorkflowTriggerKindManual                         GitHubReleaseAgenticWorkflowTriggerKind = "manual"
	GitHubReleaseAgenticWorkflowTriggerKindSchedule                       GitHubReleaseAgenticWorkflowTriggerKind = "schedule"
	GitHubReleaseAgenticWorkflowTriggerKindSlackBotFailedCheckNew         GitHubReleaseAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	GitHubReleaseAgenticWorkflowTriggerKindSlackBotMessage                GitHubReleaseAgenticWorkflowTriggerKind = "slack_bot.message"
	GitHubReleaseAgenticWorkflowTriggerKindSlackBotReaction               GitHubReleaseAgenticWorkflowTriggerKind = "slack_bot.reaction"
	GitHubReleaseAgenticWorkflowTriggerKindWebhook                        GitHubReleaseAgenticWorkflowTriggerKind = "webhook"
)

Defines values for GitHubReleaseAgenticWorkflowTriggerKind.

type GitHubTriggerVariableName added in v1.17.0

type GitHubTriggerVariableName string

GitHubTriggerVariableName Variables provided by all GitHub-based triggers.

  • `github.action`: The GitHub event action (e.g., `opened`, `created`, `completed`).
  • `github.account`: The GitHub account login (organization or user).
  • `github.repository`: Full repository name (e.g., `owner/repo`).
  • `github.installation.id`: The GitHub App installation id the event came from.
  • `github.pull_request.number`: The pull request number. Present on pull-request, review, review-comment, and issue-comment triggers (when the comment is on a PR; these are the triggers that can continue an agent by PR).
  • `github.deployment.id`: The deployment id. Present on deployment and deployment-status triggers; routes "continue" triggers back to the agent thread owning the deployment.
  • `github.deployment.environment`: The deployment environment (e.g., `production`). Present on deployment and deployment-status triggers.
  • `github.deployment_status.state`: The deployment status state (e.g., `success`, `failure`, `pending`). Present on deployment-status triggers only.
  • `github.check_run.status`: The check run status (e.g., `completed`, `in_progress`). Present on deployment-status triggers when a check run accompanies the event.
  • `github.release.tag`: The release tag name (e.g., `v1.2.3`). Present on release triggers; routes "continue" triggers back to the agent thread owning the release.
  • `github.comment.body`: The body text of the comment. Present on `github.pull_request_review_comment` and `github.issue_comment` triggers only.
const (
	GithubAccount               GitHubTriggerVariableName = "github.account"
	GithubAction                GitHubTriggerVariableName = "github.action"
	GithubCheckRunStatus        GitHubTriggerVariableName = "github.check_run.status"
	GithubCommentBody           GitHubTriggerVariableName = "github.comment.body"
	GithubDeploymentEnvironment GitHubTriggerVariableName = "github.deployment.environment"
	GithubDeploymentId          GitHubTriggerVariableName = "github.deployment.id"
	GithubDeploymentStatusState GitHubTriggerVariableName = "github.deployment_status.state"
	GithubInstallationId        GitHubTriggerVariableName = "github.installation.id"
	GithubPullRequestNumber     GitHubTriggerVariableName = "github.pull_request.number"
	GithubReleaseTag            GitHubTriggerVariableName = "github.release.tag"
	GithubRepository            GitHubTriggerVariableName = "github.repository"
)

Defines values for GitHubTriggerVariableName.

type GoogleChatWebhookConfig added in v1.9.0

type GoogleChatWebhookConfig struct {
	Url string `json:"url"`
}

GoogleChatWebhookConfig defines model for GoogleChatWebhookConfig.

type Gradient added in v1.4.0

type Gradient struct {
	From string `json:"from"`
	To   string `json:"to"`
}

Gradient A color gradient from one color to another.

type HttpBasicAuthentication

type HttpBasicAuthentication struct {
	Password string `json:"password"`
	Username string `json:"username"`
}

HttpBasicAuthentication defines model for HttpBasicAuthentication.

type HttpCheckAssertion

type HttpCheckAssertion struct {
	// contains filtered or unexported fields
}

HttpCheckAssertion defines model for HttpCheckAssertion.

func (HttpCheckAssertion) AsErrorAssertion

func (t HttpCheckAssertion) AsErrorAssertion() (ErrorAssertion, error)

AsErrorAssertion returns the union data inside the HttpCheckAssertion as a ErrorAssertion

func (HttpCheckAssertion) AsHttpResponseHeaderAssertion

func (t HttpCheckAssertion) AsHttpResponseHeaderAssertion() (HttpResponseHeaderAssertion, error)

AsHttpResponseHeaderAssertion returns the union data inside the HttpCheckAssertion as a HttpResponseHeaderAssertion

func (HttpCheckAssertion) AsHttpResponseJsonBodyAssertion

func (t HttpCheckAssertion) AsHttpResponseJsonBodyAssertion() (HttpResponseJsonBodyAssertion, error)

AsHttpResponseJsonBodyAssertion returns the union data inside the HttpCheckAssertion as a HttpResponseJsonBodyAssertion

func (HttpCheckAssertion) AsHttpResponseStatusCodeAssertion

func (t HttpCheckAssertion) AsHttpResponseStatusCodeAssertion() (HttpResponseStatusCodeAssertion, error)

AsHttpResponseStatusCodeAssertion returns the union data inside the HttpCheckAssertion as a HttpResponseStatusCodeAssertion

func (HttpCheckAssertion) AsHttpResponseTextBodyAssertion

func (t HttpCheckAssertion) AsHttpResponseTextBodyAssertion() (HttpResponseTextBodyAssertion, error)

AsHttpResponseTextBodyAssertion returns the union data inside the HttpCheckAssertion as a HttpResponseTextBodyAssertion

func (HttpCheckAssertion) AsSslCertificateAssertion

func (t HttpCheckAssertion) AsSslCertificateAssertion() (SslCertificateAssertion, error)

AsSslCertificateAssertion returns the union data inside the HttpCheckAssertion as a SslCertificateAssertion

func (HttpCheckAssertion) AsTimingAssertion

func (t HttpCheckAssertion) AsTimingAssertion() (TimingAssertion, error)

AsTimingAssertion returns the union data inside the HttpCheckAssertion as a TimingAssertion

func (*HttpCheckAssertion) FromErrorAssertion

func (t *HttpCheckAssertion) FromErrorAssertion(v ErrorAssertion) error

FromErrorAssertion overwrites any union data inside the HttpCheckAssertion as the provided ErrorAssertion

func (*HttpCheckAssertion) FromHttpResponseHeaderAssertion

func (t *HttpCheckAssertion) FromHttpResponseHeaderAssertion(v HttpResponseHeaderAssertion) error

FromHttpResponseHeaderAssertion overwrites any union data inside the HttpCheckAssertion as the provided HttpResponseHeaderAssertion

func (*HttpCheckAssertion) FromHttpResponseJsonBodyAssertion

func (t *HttpCheckAssertion) FromHttpResponseJsonBodyAssertion(v HttpResponseJsonBodyAssertion) error

FromHttpResponseJsonBodyAssertion overwrites any union data inside the HttpCheckAssertion as the provided HttpResponseJsonBodyAssertion

func (*HttpCheckAssertion) FromHttpResponseStatusCodeAssertion

func (t *HttpCheckAssertion) FromHttpResponseStatusCodeAssertion(v HttpResponseStatusCodeAssertion) error

FromHttpResponseStatusCodeAssertion overwrites any union data inside the HttpCheckAssertion as the provided HttpResponseStatusCodeAssertion

func (*HttpCheckAssertion) FromHttpResponseTextBodyAssertion

func (t *HttpCheckAssertion) FromHttpResponseTextBodyAssertion(v HttpResponseTextBodyAssertion) error

FromHttpResponseTextBodyAssertion overwrites any union data inside the HttpCheckAssertion as the provided HttpResponseTextBodyAssertion

func (*HttpCheckAssertion) FromSslCertificateAssertion

func (t *HttpCheckAssertion) FromSslCertificateAssertion(v SslCertificateAssertion) error

FromSslCertificateAssertion overwrites any union data inside the HttpCheckAssertion as the provided SslCertificateAssertion

func (*HttpCheckAssertion) FromTimingAssertion

func (t *HttpCheckAssertion) FromTimingAssertion(v TimingAssertion) error

FromTimingAssertion overwrites any union data inside the HttpCheckAssertion as the provided TimingAssertion

func (HttpCheckAssertion) MarshalJSON

func (t HttpCheckAssertion) MarshalJSON() ([]byte, error)

func (*HttpCheckAssertion) MergeErrorAssertion

func (t *HttpCheckAssertion) MergeErrorAssertion(v ErrorAssertion) error

MergeErrorAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided ErrorAssertion

func (*HttpCheckAssertion) MergeHttpResponseHeaderAssertion

func (t *HttpCheckAssertion) MergeHttpResponseHeaderAssertion(v HttpResponseHeaderAssertion) error

MergeHttpResponseHeaderAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided HttpResponseHeaderAssertion

func (*HttpCheckAssertion) MergeHttpResponseJsonBodyAssertion

func (t *HttpCheckAssertion) MergeHttpResponseJsonBodyAssertion(v HttpResponseJsonBodyAssertion) error

MergeHttpResponseJsonBodyAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided HttpResponseJsonBodyAssertion

func (*HttpCheckAssertion) MergeHttpResponseStatusCodeAssertion

func (t *HttpCheckAssertion) MergeHttpResponseStatusCodeAssertion(v HttpResponseStatusCodeAssertion) error

MergeHttpResponseStatusCodeAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided HttpResponseStatusCodeAssertion

func (*HttpCheckAssertion) MergeHttpResponseTextBodyAssertion

func (t *HttpCheckAssertion) MergeHttpResponseTextBodyAssertion(v HttpResponseTextBodyAssertion) error

MergeHttpResponseTextBodyAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided HttpResponseTextBodyAssertion

func (*HttpCheckAssertion) MergeSslCertificateAssertion

func (t *HttpCheckAssertion) MergeSslCertificateAssertion(v SslCertificateAssertion) error

MergeSslCertificateAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided SslCertificateAssertion

func (*HttpCheckAssertion) MergeTimingAssertion

func (t *HttpCheckAssertion) MergeTimingAssertion(v TimingAssertion) error

MergeTimingAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided TimingAssertion

func (*HttpCheckAssertion) UnmarshalJSON

func (t *HttpCheckAssertion) UnmarshalJSON(b []byte) error

type HttpCheckAssertions

type HttpCheckAssertions = []HttpCheckAssertion

HttpCheckAssertions defines model for HttpCheckAssertions.

type HttpHeaders

type HttpHeaders = []NameValuePair

HttpHeaders defines model for HttpHeaders.

type HttpQueryParameters

type HttpQueryParameters = []NameValuePair

HttpQueryParameters defines model for HttpQueryParameters.

type HttpRedirects

type HttpRedirects string

HttpRedirects defines model for HttpRedirects.

const (
	HttpRedirectsDisabled HttpRedirects = "disabled"
	HttpRedirectsFollow   HttpRedirects = "follow"
)

Defines values for HttpRedirects.

type HttpRequestBody

type HttpRequestBody struct {
	Kind HttpRequestBodyKind `json:"kind"`
	Spec struct {
		Content string `json:"content"`
	} `json:"spec"`
}

HttpRequestBody defines model for HttpRequestBody.

type HttpRequestBodyKind

type HttpRequestBodyKind string

HttpRequestBodyKind defines model for HttpRequestBodyKind.

const (
	Form    HttpRequestBodyKind = "form"
	Graphql HttpRequestBodyKind = "graphql"
	Json    HttpRequestBodyKind = "json"
	Raw     HttpRequestBodyKind = "raw"
)

Defines values for HttpRequestBodyKind.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type HttpRequestMethod

type HttpRequestMethod string

HttpRequestMethod defines model for HttpRequestMethod.

const (
	Delete HttpRequestMethod = "delete"
	Get    HttpRequestMethod = "get"
	Head   HttpRequestMethod = "head"
	Patch  HttpRequestMethod = "patch"
	Post   HttpRequestMethod = "post"
	Put    HttpRequestMethod = "put"
)

Defines values for HttpRequestMethod.

type HttpRequestSpec

type HttpRequestSpec struct {
	BasicAuthentication *HttpBasicAuthentication `json:"basicAuthentication,omitempty"`
	Body                *HttpRequestBody         `json:"body,omitempty"`
	Headers             HttpHeaders              `json:"headers"`
	Method              HttpRequestMethod        `json:"method"`
	QueryParameters     HttpQueryParameters      `json:"queryParameters"`
	Redirects           HttpRedirects            `json:"redirects"`
	Tls                 TlsSettings              `json:"tls"`
	Tracing             TracingSettings          `json:"tracing"`
	Url                 string                   `json:"url"`
}

HttpRequestSpec defines model for HttpRequestSpec.

type HttpResponseHeaderAssertion

type HttpResponseHeaderAssertion struct {
	Kind HttpResponseHeaderAssertionKind `json:"kind"`
	Spec HttpResponseHeaderAssertionSpec `json:"spec"`
}

HttpResponseHeaderAssertion defines model for HttpResponseHeaderAssertion.

type HttpResponseHeaderAssertionKind

type HttpResponseHeaderAssertionKind string

HttpResponseHeaderAssertionKind defines model for HttpResponseHeaderAssertion.Kind.

const (
	ResponseHeader HttpResponseHeaderAssertionKind = "response_header"
)

Defines values for HttpResponseHeaderAssertionKind.

type HttpResponseHeaderAssertionSpec

type HttpResponseHeaderAssertionSpec struct {
	Key      string                  `json:"key"`
	Operator StringAssertionOperator `json:"operator"`
	Value    string                  `json:"value"`
}

HttpResponseHeaderAssertionSpec defines model for HttpResponseHeaderAssertionSpec.

type HttpResponseJsonBodyAssertion

type HttpResponseJsonBodyAssertion struct {
	Kind HttpResponseJsonBodyAssertionKind `json:"kind"`
	Spec HttpResponseJsonBodyAssertionSpec `json:"spec"`
}

HttpResponseJsonBodyAssertion defines model for HttpResponseJsonBodyAssertion.

type HttpResponseJsonBodyAssertionKind

type HttpResponseJsonBodyAssertionKind string

HttpResponseJsonBodyAssertionKind defines model for HttpResponseJsonBodyAssertion.Kind.

const (
	JsonBody HttpResponseJsonBodyAssertionKind = "json_body"
)

Defines values for HttpResponseJsonBodyAssertionKind.

type HttpResponseJsonBodyAssertionSpec

type HttpResponseJsonBodyAssertionSpec struct {
	JsonPath string                  `json:"jsonPath"`
	Operator StringAssertionOperator `json:"operator"`
	Value    string                  `json:"value"`
}

HttpResponseJsonBodyAssertionSpec defines model for HttpResponseJsonBodyAssertionSpec.

type HttpResponseStatusCodeAssertion

type HttpResponseStatusCodeAssertion struct {
	Kind HttpResponseStatusCodeAssertionKind `json:"kind"`
	Spec HttpResponseStatusCodeAssertionSpec `json:"spec"`
}

HttpResponseStatusCodeAssertion defines model for HttpResponseStatusCodeAssertion.

type HttpResponseStatusCodeAssertionKind

type HttpResponseStatusCodeAssertionKind string

HttpResponseStatusCodeAssertionKind defines model for HttpResponseStatusCodeAssertion.Kind.

const (
	StatusCode HttpResponseStatusCodeAssertionKind = "status_code"
)

Defines values for HttpResponseStatusCodeAssertionKind.

type HttpResponseStatusCodeAssertionSpec

type HttpResponseStatusCodeAssertionSpec struct {
	Operator NumericAssertionOperator `json:"operator"`
	Value    string                   `json:"value"`
}

HttpResponseStatusCodeAssertionSpec defines model for HttpResponseStatusCodeAssertionSpec.

type HttpResponseTextBodyAssertion

type HttpResponseTextBodyAssertion struct {
	Kind HttpResponseTextBodyAssertionKind `json:"kind"`
	Spec HttpResponseTextBodyAssertionSpec `json:"spec"`
}

HttpResponseTextBodyAssertion defines model for HttpResponseTextBodyAssertion.

type HttpResponseTextBodyAssertionKind

type HttpResponseTextBodyAssertionKind string

HttpResponseTextBodyAssertionKind defines model for HttpResponseTextBodyAssertion.Kind.

const (
	TextBody HttpResponseTextBodyAssertionKind = "text_body"
)

Defines values for HttpResponseTextBodyAssertionKind.

type HttpResponseTextBodyAssertionSpec

type HttpResponseTextBodyAssertionSpec struct {
	Operator StringAssertionOperator `json:"operator"`
	Value    string                  `json:"value"`
}

HttpResponseTextBodyAssertionSpec defines model for HttpResponseTextBodyAssertionSpec.

type IlertConfig added in v1.9.0

type IlertConfig struct {
	Url string `json:"url"`
}

IlertConfig defines model for IlertConfig.

type IncidentIOConfig added in v1.9.0

type IncidentIOConfig struct {
	Headers string `json:"headers"`
	Url     string `json:"url"`
}

IncidentIOConfig defines model for IncidentIOConfig.

type InstrumentationScope

type InstrumentationScope struct {
	// Attributes Additional attributes that describe the scope. [Optional]. Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).
	Attributes             []KeyValue `json:"attributes"`
	DroppedAttributesCount *int64     `json:"droppedAttributesCount,omitempty"`

	// Name An empty instrumentation scope name means the name is unknown.
	Name    *string `json:"name,omitempty"`
	Version *string `json:"version,omitempty"`
}

InstrumentationScope InstrumentationScope is a message representing the instrumentation scope information such as the fully qualified name and version.

type InviteMemberRequest added in v1.4.0

type InviteMemberRequest struct {
	EmailAddress string `json:"emailAddress"`
	Role         string `json:"role"`
}

InviteMemberRequest defines model for InviteMemberRequest.

type IpAddressStorageStrategy added in v1.12.3

type IpAddressStorageStrategy string

IpAddressStorageStrategy defines model for IpAddressStorageStrategy.

const (
	IpAddressStorageStrategyAnonymize  IpAddressStorageStrategy = "anonymize"
	IpAddressStorageStrategyDoNotStore IpAddressStorageStrategy = "do_not_store"
)

Defines values for IpAddressStorageStrategy.

type IpAddressesSettings added in v1.12.3

type IpAddressesSettings struct {
	EndUserIpAddressStorageStrategy IpAddressStorageStrategy `json:"endUserIpAddressStorageStrategy"`
}

IpAddressesSettings defines model for IpAddressesSettings.

type Issue added in v1.16.0

type Issue struct {
	// Id is the server-assigned identifier of this issue instance.
	Id string `json:"id"`

	// CheckRule is the check rule that raised this issue.
	CheckRule IssueCheckRule `json:"checkRule"`

	// InstanceStatus is the current lifecycle status of the issue.
	InstanceStatus IssueInstanceStatus `json:"instanceStatus"`

	// Summary is the rendered summary for this issue.
	Summary string `json:"summary"`

	// Description is the rendered description for this issue.
	Description string `json:"description"`

	// Start is the time the issue was first raised, as an RFC 3339 timestamp.
	Start string `json:"start"`

	// End is the time the issue was resolved, as an RFC 3339 timestamp.
	// The zero value `1970-01-01T00:00:00Z` indicates that the issue is still active.
	End string `json:"end"`

	// Labels are the rendered label set attached to the issue.
	Labels []KeyValue `json:"labels"`

	// EarliestEvaluatedTime is the earliest time the check rule was evaluated against this issue.
	EarliestEvaluatedTime string `json:"earliestEvaluatedTime,omitempty"`

	// IssueIdentifier is the deduplication identifier of the issue.
	IssueIdentifier string `json:"issueIdentifier,omitempty"`

	// AffectedResourceSummaries describes resources affected by the issue.
	AffectedResourceSummaries []map[string]any `json:"affectedResourceSummaries,omitempty"`

	// Annotations are the rendered annotations attached to the issue.
	Annotations []map[string]any `json:"annotations,omitempty"`
}

Issue represents an active or historical failed-check instance raised by a check rule.

type IssueCheckRule added in v1.16.0

type IssueCheckRule struct {
	Id                  string   `json:"id"`
	Name                string   `json:"name"`
	Version             int      `json:"version"`
	Modes               []string `json:"modes,omitempty"`
	SummaryTemplate     string   `json:"summaryTemplate,omitempty"`
	DescriptionTemplate string   `json:"descriptionTemplate,omitempty"`
}

IssueCheckRule is the subset of check-rule fields returned alongside each failed-check instance.

type IssueInstanceStatus added in v1.16.0

type IssueInstanceStatus string

IssueInstanceStatus is the lifecycle status of a failed-check instance.

const (
	// IssueInstanceStatusCritical indicates the issue is currently breaching its alerting threshold.
	IssueInstanceStatusCritical IssueInstanceStatus = "critical"

	// IssueInstanceStatusDegraded indicates the issue is currently breaching a degraded threshold.
	IssueInstanceStatusDegraded IssueInstanceStatus = "degraded"

	// IssueInstanceStatusHealthy indicates the issue has recovered and is no longer breaching any threshold.
	IssueInstanceStatusHealthy IssueInstanceStatus = "healthy"

	// IssueInstanceStatusInactive indicates the issue has been resolved.
	IssueInstanceStatusInactive IssueInstanceStatus = "inactive"

	// IssueInstanceStatusPending indicates the issue has been raised but not yet evaluated against its `for` duration.
	IssueInstanceStatusPending IssueInstanceStatus = "pending"
)

type Iter

type Iter[T any] struct {
	// contains filtered or unexported fields
}

Iter provides iteration over paginated API results. Use Next() to advance, Current() to get the item, and Err() to check for errors.

Example:

iter := client.GetSpansIter(ctx, request)
for iter.Next() {
    span := iter.Current()
    // process span
}
if err := iter.Err(); err != nil {
    // handle error
}

Iterators are not thread-safe. Do not share an iterator across goroutines.

func (*Iter[T]) Current

func (it *Iter[T]) Current() *T

Current returns the current item in the iteration. Returns nil if Next() has not been called or returned false.

func (*Iter[T]) Err

func (it *Iter[T]) Err() error

Err returns any error that occurred during iteration. Should be checked after Next() returns false.

func (*Iter[T]) Next

func (it *Iter[T]) Next() bool

Next advances the iterator to the next item. Returns true if there is a next item, false if iteration is complete or an error occurred.

type KeyValue

type KeyValue struct {
	Key string `json:"key"`

	// Value AnyValue is used to represent any type of attribute value. AnyValue may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.
	Value AnyValue `json:"value"`
}

KeyValue KeyValue is a key-value pair that is used to store Span attributes, Link attributes, etc.

type LinearCommentAgenticWorkflowTrigger added in v1.17.0

type LinearCommentAgenticWorkflowTrigger struct {
	// Delivery How a trigger delivers its event to an agent. An automation is the agent definition;
	// triggers are the pipes into it, and each pipe is configured independently.
	//
	// - `spawn`: Start a new agent thread for this event. This is today's behavior.
	// - `continue`: Route the event into the existing agent thread that owns the matching
	//   entity, falling back to spawning a fresh thread when none is active
	//   (resume-or-spawn). Only valid on continuation-capable triggers that carry an entity
	//   ref to route by; spawn-only triggers (e.g. `schedule`, `webhook`,
	//   `failed_check.new`) must not set it.
	Delivery *AgenticWorkflowTriggerDelivery         `json:"delivery,omitempty"`
	Kind     LinearCommentAgenticWorkflowTriggerKind `json:"kind"`
	Spec     LinearCommentAgenticWorkflowTriggerSpec `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

LinearCommentAgenticWorkflowTrigger defines model for LinearCommentAgenticWorkflowTrigger.

type LinearCommentAgenticWorkflowTriggerKind added in v1.17.0

type LinearCommentAgenticWorkflowTriggerKind string

LinearCommentAgenticWorkflowTriggerKind defines model for LinearCommentAgenticWorkflowTrigger.Kind.

const (
	LinearCommentAgenticWorkflowTriggerKindFailedCheckNew                 LinearCommentAgenticWorkflowTriggerKind = "failed_check.new"
	LinearCommentAgenticWorkflowTriggerKindGithubDeployment               LinearCommentAgenticWorkflowTriggerKind = "github.deployment"
	LinearCommentAgenticWorkflowTriggerKindGithubDeploymentStatus         LinearCommentAgenticWorkflowTriggerKind = "github.deployment_status"
	LinearCommentAgenticWorkflowTriggerKindGithubIssueComment             LinearCommentAgenticWorkflowTriggerKind = "github.issue_comment"
	LinearCommentAgenticWorkflowTriggerKindGithubPullRequest              LinearCommentAgenticWorkflowTriggerKind = "github.pull_request"
	LinearCommentAgenticWorkflowTriggerKindGithubPullRequestReview        LinearCommentAgenticWorkflowTriggerKind = "github.pull_request_review"
	LinearCommentAgenticWorkflowTriggerKindGithubPullRequestReviewComment LinearCommentAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	LinearCommentAgenticWorkflowTriggerKindGithubRelease                  LinearCommentAgenticWorkflowTriggerKind = "github.release"
	LinearCommentAgenticWorkflowTriggerKindLinearComment                  LinearCommentAgenticWorkflowTriggerKind = "linear.comment"
	LinearCommentAgenticWorkflowTriggerKindLinearLabelAdded               LinearCommentAgenticWorkflowTriggerKind = "linear.label_added"
	LinearCommentAgenticWorkflowTriggerKindManual                         LinearCommentAgenticWorkflowTriggerKind = "manual"
	LinearCommentAgenticWorkflowTriggerKindSchedule                       LinearCommentAgenticWorkflowTriggerKind = "schedule"
	LinearCommentAgenticWorkflowTriggerKindSlackBotFailedCheckNew         LinearCommentAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	LinearCommentAgenticWorkflowTriggerKindSlackBotMessage                LinearCommentAgenticWorkflowTriggerKind = "slack_bot.message"
	LinearCommentAgenticWorkflowTriggerKindSlackBotReaction               LinearCommentAgenticWorkflowTriggerKind = "slack_bot.reaction"
	LinearCommentAgenticWorkflowTriggerKindWebhook                        LinearCommentAgenticWorkflowTriggerKind = "webhook"
)

Defines values for LinearCommentAgenticWorkflowTriggerKind.

type LinearCommentAgenticWorkflowTriggerSpec added in v1.17.0

type LinearCommentAgenticWorkflowTriggerSpec struct {
	// AvailableVariables The trigger-specific variables available as `{{variable.name}}` when this trigger fires.
	// This is in addition to the built-in variables that are always available.
	AvailableVariables *[]LinearCommentTriggerVariableName `json:"availableVariables,omitempty"`

	// Keyword A command or keyword that the Linear comment must contain. Evaluated as a
	// case-insensitive substring match (e.g., `investigate` matches any comment
	// containing "investigate"). The trigger fires only when the Dash0 agent is
	// @mentioned or delegated on the issue and the comment contains this keyword;
	// mentions without the keyword fall through to the normal Agent0 chat reply.
	Keyword string `json:"keyword"`
}

LinearCommentAgenticWorkflowTriggerSpec defines model for LinearCommentAgenticWorkflowTriggerSpec.

type LinearCommentTriggerVariableName added in v1.17.0

type LinearCommentTriggerVariableName string

LinearCommentTriggerVariableName Variables provided by the `linear.comment` trigger.

- `linear.issue.id`: The Linear issue identifier (e.g., `ENG-123`). - `linear.issue.title`: Title of the Linear issue. - `linear.issue.url`: URL of the Linear issue. - `linear.comment.body`: Body text of the comment that triggered the automation. - `linear.comment.user`: Display name of the user who left the comment.

const (
	LinearCommentTriggerVariableNameLinearCommentBody LinearCommentTriggerVariableName = "linear.comment.body"
	LinearCommentTriggerVariableNameLinearCommentUser LinearCommentTriggerVariableName = "linear.comment.user"
	LinearCommentTriggerVariableNameLinearIssueId     LinearCommentTriggerVariableName = "linear.issue.id"
	LinearCommentTriggerVariableNameLinearIssueTitle  LinearCommentTriggerVariableName = "linear.issue.title"
	LinearCommentTriggerVariableNameLinearIssueUrl    LinearCommentTriggerVariableName = "linear.issue.url"
)

Defines values for LinearCommentTriggerVariableName.

type LinearLabelAddedAgenticWorkflowTrigger added in v1.17.0

type LinearLabelAddedAgenticWorkflowTrigger struct {
	Kind LinearLabelAddedAgenticWorkflowTriggerKind `json:"kind"`
	Spec LinearLabelAddedAgenticWorkflowTriggerSpec `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

LinearLabelAddedAgenticWorkflowTrigger defines model for LinearLabelAddedAgenticWorkflowTrigger.

type LinearLabelAddedAgenticWorkflowTriggerKind added in v1.17.0

type LinearLabelAddedAgenticWorkflowTriggerKind string

LinearLabelAddedAgenticWorkflowTriggerKind defines model for LinearLabelAddedAgenticWorkflowTrigger.Kind.

const (
	LinearLabelAddedAgenticWorkflowTriggerKindFailedCheckNew                 LinearLabelAddedAgenticWorkflowTriggerKind = "failed_check.new"
	LinearLabelAddedAgenticWorkflowTriggerKindGithubDeployment               LinearLabelAddedAgenticWorkflowTriggerKind = "github.deployment"
	LinearLabelAddedAgenticWorkflowTriggerKindGithubDeploymentStatus         LinearLabelAddedAgenticWorkflowTriggerKind = "github.deployment_status"
	LinearLabelAddedAgenticWorkflowTriggerKindGithubIssueComment             LinearLabelAddedAgenticWorkflowTriggerKind = "github.issue_comment"
	LinearLabelAddedAgenticWorkflowTriggerKindGithubPullRequest              LinearLabelAddedAgenticWorkflowTriggerKind = "github.pull_request"
	LinearLabelAddedAgenticWorkflowTriggerKindGithubPullRequestReview        LinearLabelAddedAgenticWorkflowTriggerKind = "github.pull_request_review"
	LinearLabelAddedAgenticWorkflowTriggerKindGithubPullRequestReviewComment LinearLabelAddedAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	LinearLabelAddedAgenticWorkflowTriggerKindGithubRelease                  LinearLabelAddedAgenticWorkflowTriggerKind = "github.release"
	LinearLabelAddedAgenticWorkflowTriggerKindLinearComment                  LinearLabelAddedAgenticWorkflowTriggerKind = "linear.comment"
	LinearLabelAddedAgenticWorkflowTriggerKindLinearLabelAdded               LinearLabelAddedAgenticWorkflowTriggerKind = "linear.label_added"
	LinearLabelAddedAgenticWorkflowTriggerKindManual                         LinearLabelAddedAgenticWorkflowTriggerKind = "manual"
	LinearLabelAddedAgenticWorkflowTriggerKindSchedule                       LinearLabelAddedAgenticWorkflowTriggerKind = "schedule"
	LinearLabelAddedAgenticWorkflowTriggerKindSlackBotFailedCheckNew         LinearLabelAddedAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	LinearLabelAddedAgenticWorkflowTriggerKindSlackBotMessage                LinearLabelAddedAgenticWorkflowTriggerKind = "slack_bot.message"
	LinearLabelAddedAgenticWorkflowTriggerKindSlackBotReaction               LinearLabelAddedAgenticWorkflowTriggerKind = "slack_bot.reaction"
	LinearLabelAddedAgenticWorkflowTriggerKindWebhook                        LinearLabelAddedAgenticWorkflowTriggerKind = "webhook"
)

Defines values for LinearLabelAddedAgenticWorkflowTriggerKind.

type LinearLabelAddedAgenticWorkflowTriggerSpec added in v1.17.0

type LinearLabelAddedAgenticWorkflowTriggerSpec struct {
	// AllTeams When true, the automation deliberately matches the configured label added to issues
	// in every team of the connected Linear workspace, now and in the future. Mutually
	// exclusive with a non-empty `teamIds` list. This flag exists to distinguish an
	// explicit "all teams" choice from an unconfigured trigger: a Linear label-added
	// trigger with neither `allTeams` nor `teamIds` set is rejected on write as an
	// accidental match-everything catch-all, mirroring `allOrganizations` on GitHub
	// triggers.
	AllTeams *bool `json:"allTeams,omitempty"`

	// AvailableVariables The trigger-specific variables available as `{{variable.name}}` when this trigger fires.
	// This is in addition to the built-in variables that are always available.
	AvailableVariables *[]LinearLabelAddedTriggerVariableName `json:"availableVariables,omitempty"`

	// LabelId The Linear label UUID that must be added to an issue for the trigger to fire. This is
	// the sole matching key — matched case-insensitively against the label ID reported on
	// the webhook event. If a label is re-created in Linear (new UUID, same name), update
	// this field to re-point the trigger at the new label.
	LabelId string `json:"labelId"`

	// LabelName Optional Linear label name corresponding to `labelId`, stored for UI display and
	// exposed to prompts as the `linear.label.name` template variable. Does not
	// participate in matching — the trigger fires on `labelId` only, so a same-named
	// label in a different team never hijacks a trigger scoped to a specific label.
	// Clients that already know the name at write time (the workflow editor, Terraform
	// authors) should send it so the workflow-list view renders a human-readable label;
	// programmatic API callers may omit it and get a UUID-only display until the field is
	// populated.
	LabelName *string `json:"labelName,omitempty"`

	// TeamIds List of Linear team UUIDs to scope the trigger to. When non-empty, the trigger fires
	// only for issues whose team ID is in this list. Mutually exclusive with `allTeams`; a
	// request that sets both, or that leaves both `teamIds` and `allTeams` empty/unset, is
	// rejected on write as an accidental match-everything catch-all.
	TeamIds *[]string `json:"teamIds,omitempty"`
}

LinearLabelAddedAgenticWorkflowTriggerSpec defines model for LinearLabelAddedAgenticWorkflowTriggerSpec.

type LinearLabelAddedTriggerVariableName added in v1.17.0

type LinearLabelAddedTriggerVariableName string

LinearLabelAddedTriggerVariableName Variables provided by the `linear.label_added` trigger.

- `linear.issue.id`: The Linear issue identifier (e.g., `ENG-123`). - `linear.issue.title`: Title of the Linear issue. - `linear.issue.url`: URL of the Linear issue. - `linear.issue.team_id`: UUID of the Linear team that owns the issue. - `linear.issue.team_key`: Short key of the Linear team (e.g., `ENG`). - `linear.issue.team_name`: Display name of the Linear team. - `linear.label.id`: UUID of the label that was added. - `linear.label.name`: Name of the label that was added. - `linear.label.color`: Hex color of the label that was added. - `linear.actor.name`: Display name of the user who added the label, when known.

const (
	LinearLabelAddedTriggerVariableNameLinearActorName     LinearLabelAddedTriggerVariableName = "linear.actor.name"
	LinearLabelAddedTriggerVariableNameLinearIssueId       LinearLabelAddedTriggerVariableName = "linear.issue.id"
	LinearLabelAddedTriggerVariableNameLinearIssueTeamId   LinearLabelAddedTriggerVariableName = "linear.issue.team_id"
	LinearLabelAddedTriggerVariableNameLinearIssueTeamKey  LinearLabelAddedTriggerVariableName = "linear.issue.team_key"
	LinearLabelAddedTriggerVariableNameLinearIssueTeamName LinearLabelAddedTriggerVariableName = "linear.issue.team_name"
	LinearLabelAddedTriggerVariableNameLinearIssueTitle    LinearLabelAddedTriggerVariableName = "linear.issue.title"
	LinearLabelAddedTriggerVariableNameLinearIssueUrl      LinearLabelAddedTriggerVariableName = "linear.issue.url"
	LinearLabelAddedTriggerVariableNameLinearLabelColor    LinearLabelAddedTriggerVariableName = "linear.label.color"
	LinearLabelAddedTriggerVariableNameLinearLabelId       LinearLabelAddedTriggerVariableName = "linear.label.id"
	LinearLabelAddedTriggerVariableNameLinearLabelName     LinearLabelAddedTriggerVariableName = "linear.label.name"
)

Defines values for LinearLabelAddedTriggerVariableName.

type LogRecord

type LogRecord struct {
	Attributes []KeyValue `json:"attributes"`

	// Body AnyValue is used to represent any type of attribute value. AnyValue may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.
	Body *AnyValue `json:"body,omitempty"`

	// Dash0EventId The ID of the log record. This is a non-standard OTLP field. The property is only included when
	// `includeOTLPSchemaExtensions` is `true`.
	Dash0EventId           *string `json:"dash0EventId,omitempty"`
	DroppedAttributesCount *int64  `json:"droppedAttributesCount,omitempty"`
	EventName              *string `json:"eventName,omitempty"`
	Flags                  *int64  `json:"flags,omitempty"`

	// Id The ID of the log record. This is a non-standard OTLP field. The property is only included when
	// `includeOTLPSchemaExtensions` is `true`.
	Id                   *string `json:"id,omitempty"`
	ObservedTimeUnixNano string  `json:"observedTimeUnixNano"`

	// SeverityNumber SEVERITY_NUMBER_UNSPECIFIED = 0;
	// SEVERITY_NUMBER_TRACE  = 1;
	// SEVERITY_NUMBER_TRACE2 = 2;
	// SEVERITY_NUMBER_TRACE3 = 3;
	// SEVERITY_NUMBER_TRACE4 = 4;
	// SEVERITY_NUMBER_DEBUG  = 5;
	// SEVERITY_NUMBER_DEBUG2 = 6;
	// SEVERITY_NUMBER_DEBUG3 = 7;
	// SEVERITY_NUMBER_DEBUG4 = 8;
	// SEVERITY_NUMBER_INFO   = 9;
	// SEVERITY_NUMBER_INFO2  = 10;
	// SEVERITY_NUMBER_INFO3  = 11;
	// SEVERITY_NUMBER_INFO4  = 12;
	// SEVERITY_NUMBER_WARN   = 13;
	// SEVERITY_NUMBER_WARN2  = 14;
	// SEVERITY_NUMBER_WARN3  = 15;
	// SEVERITY_NUMBER_WARN4  = 16;
	// SEVERITY_NUMBER_ERROR  = 17;
	// SEVERITY_NUMBER_ERROR2 = 18;
	// SEVERITY_NUMBER_ERROR3 = 19;
	// SEVERITY_NUMBER_ERROR4 = 20;
	// SEVERITY_NUMBER_FATAL  = 21;
	// SEVERITY_NUMBER_FATAL2 = 22;
	// SEVERITY_NUMBER_FATAL3 = 23;
	// SEVERITY_NUMBER_FATAL4 = 24;
	SeverityNumber *SeverityNumber `json:"severityNumber,omitempty"`
	SeverityText   *string         `json:"severityText,omitempty"`
	SpanId         *[]byte         `json:"spanId,omitempty"`
	TimeUnixNano   string          `json:"timeUnixNano"`
	TraceId        *[]byte         `json:"traceId,omitempty"`
}

LogRecord defines model for LogRecord.

type LogRecordExportFormat added in v1.18.1

type LogRecordExportFormat string

LogRecordExportFormat The serialization format of the exported file.

  • `txt`: One rendered log line per record, carrying a fixed field set of timestamp, severity, resource, body and trace ID. Ignores `columns`.
  • `ndjson`: One OTLP JSON payload per line, each carrying a single log record inside the same `resourceLogs` envelope `GetLogRecords` returns, so each line is independently parseable by any OTLP JSON consumer.
  • `yaml`: The same per-record OTLP payloads as `ndjson`, as a multi-document YAML stream with documents separated by `---`.
  • `csv`: A header row plus one row per record, flattened to the requested `columns`.
const (
	LogRecordExportFormatCsv    LogRecordExportFormat = "csv"
	LogRecordExportFormatNdjson LogRecordExportFormat = "ndjson"
	LogRecordExportFormatTxt    LogRecordExportFormat = "txt"
	LogRecordExportFormatYaml   LogRecordExportFormat = "yaml"
)

Defines values for LogRecordExportFormat.

type LogRecordsDownloadRequest added in v1.18.1

type LogRecordsDownloadRequest struct {
	// Columns Attribute keys to emit as columns, in order, for the `csv` format — resource,
	// scope, or log record attributes (e.g. `service.name`, `otel.log.body`). Ignored by
	// the other formats, which have a fixed field set.
	Columns *[]string `json:"columns,omitempty"`

	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset        `json:"dataset,omitempty"`
	Filter  *FilterCriteria `json:"filter,omitempty"`

	// Format The serialization format of the exported file.
	// - `txt`: One rendered log line per record, carrying a fixed field set of timestamp,
	//   severity, resource, body and trace ID. Ignores `columns`.
	// - `ndjson`: One OTLP JSON payload per line, each carrying a single log record inside
	//   the same `resourceLogs` envelope `GetLogRecords` returns, so each line is
	//   independently parseable by any OTLP JSON consumer.
	// - `yaml`: The same per-record OTLP payloads as `ndjson`, as a multi-document YAML
	//   stream with documents separated by `---`.
	// - `csv`: A header row plus one row per record, flattened to the requested `columns`.
	Format LogRecordExportFormat `json:"format"`

	// Limit The maximum number of log records to export. Defaults to, and is capped at, 5000.
	// A larger value is rejected rather than silently clamped. Use the Dash0 CLI
	// (`dash0 logs query`) to export volumes beyond this cap.
	Limit *int64 `json:"limit,omitempty"`

	// Ordering Any supported attribute keys to order by.
	Ordering *OrderingCriteria `json:"ordering,omitempty"`

	// TimeRange A range of time between two time references.
	TimeRange TimeReferenceRange `json:"timeRange"`
}

LogRecordsDownloadRequest Request for the `LogRecordsDownload` API. Accepts the same query as `GetLogRecords` (`filter`, `timeRange`, `dataset`, `ordering`) and returns the matching records serialized as a downloadable file rather than as a JSON page.

The response is streamed, so the export is not paginated: a single request returns up to `limit` records, capped at 5000. Adaptive sampling is always disabled for exports, so an exported file is never a sample.

type ManualAgenticWorkflowTrigger added in v1.17.0

type ManualAgenticWorkflowTrigger struct {
	Kind ManualAgenticWorkflowTriggerKind `json:"kind"`
	Spec EmptyAgenticWorkflowTriggerSpec  `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

ManualAgenticWorkflowTrigger defines model for ManualAgenticWorkflowTrigger.

type ManualAgenticWorkflowTriggerKind added in v1.17.0

type ManualAgenticWorkflowTriggerKind string

ManualAgenticWorkflowTriggerKind defines model for ManualAgenticWorkflowTrigger.Kind.

const (
	ManualAgenticWorkflowTriggerKindFailedCheckNew                 ManualAgenticWorkflowTriggerKind = "failed_check.new"
	ManualAgenticWorkflowTriggerKindGithubDeployment               ManualAgenticWorkflowTriggerKind = "github.deployment"
	ManualAgenticWorkflowTriggerKindGithubDeploymentStatus         ManualAgenticWorkflowTriggerKind = "github.deployment_status"
	ManualAgenticWorkflowTriggerKindGithubIssueComment             ManualAgenticWorkflowTriggerKind = "github.issue_comment"
	ManualAgenticWorkflowTriggerKindGithubPullRequest              ManualAgenticWorkflowTriggerKind = "github.pull_request"
	ManualAgenticWorkflowTriggerKindGithubPullRequestReview        ManualAgenticWorkflowTriggerKind = "github.pull_request_review"
	ManualAgenticWorkflowTriggerKindGithubPullRequestReviewComment ManualAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	ManualAgenticWorkflowTriggerKindGithubRelease                  ManualAgenticWorkflowTriggerKind = "github.release"
	ManualAgenticWorkflowTriggerKindLinearComment                  ManualAgenticWorkflowTriggerKind = "linear.comment"
	ManualAgenticWorkflowTriggerKindLinearLabelAdded               ManualAgenticWorkflowTriggerKind = "linear.label_added"
	ManualAgenticWorkflowTriggerKindManual                         ManualAgenticWorkflowTriggerKind = "manual"
	ManualAgenticWorkflowTriggerKindSchedule                       ManualAgenticWorkflowTriggerKind = "schedule"
	ManualAgenticWorkflowTriggerKindSlackBotFailedCheckNew         ManualAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	ManualAgenticWorkflowTriggerKindSlackBotMessage                ManualAgenticWorkflowTriggerKind = "slack_bot.message"
	ManualAgenticWorkflowTriggerKindSlackBotReaction               ManualAgenticWorkflowTriggerKind = "slack_bot.reaction"
	ManualAgenticWorkflowTriggerKindWebhook                        ManualAgenticWorkflowTriggerKind = "webhook"
)

Defines values for ManualAgenticWorkflowTriggerKind.

type Matcher added in v1.9.0

type Matcher struct {
	// Operator The match operation for filtering attributes.
	//
	// #### Equality Operators
	// - `is` - equals (attribute exists and has a matching value)
	// - `is_not` - not equals (attribute exists and has a different value)
	//
	// #### Existence Operators
	// - `is_set` - is set (attribute exists)
	// - `is_not_set` - is not set (attribute does not exist)
	//
	// #### Multiple Value Operators
	// - `is_one_of` - is any of (attribute exists and has a value that is in the specified values)
	// - `is_not_one_of` - is not any of (attribute exists and has a value that is not in the specified values)
	//
	// #### Comparison Operators
	// - `gt` - greater than
	// - `lt` - less than
	// - `gte` - greater than or equal
	// - `lte` - less than or equal
	//
	// #### Pattern Matching Operators
	// - `matches` - match regex expression (attribute exists and matches the regular expression)
	// - `does_not_match` - does not match regex expression (attribute exists and does not match the regular expression)
	//
	// #### String Operators
	// - `contains` - contains (attribute exists and contains the specified value)
	// - `does_not_contain` - does not contain (attribute exists and does not contain the specified value)
	// - `starts_with` - starts with (attribute exists and starts with the specified value)
	// - `does_not_start_with` - does not start with (attribute exists and does not start with the specified value)
	// - `ends_with` - ends with (attribute exists and ends with the specified value)
	// - `does_not_end_with` - does not end with (attribute exists and does not end with the specified value)
	//
	// #### Special Operators
	// - `is_any` - matches any value, ignoring whether the key exists or not
	Operator AttributeFilterOperator `json:"operator"`
	Value    *Matcher_Value          `json:"value,omitempty"`

	// Values List of values to match against. This parameter is mandatory for the is_one_of and is_not_one_of operators.
	Values *[]Matcher_Values_Item `json:"values,omitempty"`
}

Matcher defines model for Matcher.

type Matcher_Value added in v1.9.0

type Matcher_Value struct {
	// contains filtered or unexported fields
}

Matcher_Value defines model for Matcher.Value.

func (Matcher_Value) AsAttributeFilterAnyValue added in v1.9.0

func (t Matcher_Value) AsAttributeFilterAnyValue() (AttributeFilterAnyValue, error)

AsAttributeFilterAnyValue returns the union data inside the Matcher_Value as a AttributeFilterAnyValue

func (Matcher_Value) AsAttributeFilterStringValue added in v1.9.0

func (t Matcher_Value) AsAttributeFilterStringValue() (AttributeFilterStringValue, error)

AsAttributeFilterStringValue returns the union data inside the Matcher_Value as a AttributeFilterStringValue

func (*Matcher_Value) FromAttributeFilterAnyValue added in v1.9.0

func (t *Matcher_Value) FromAttributeFilterAnyValue(v AttributeFilterAnyValue) error

FromAttributeFilterAnyValue overwrites any union data inside the Matcher_Value as the provided AttributeFilterAnyValue

func (*Matcher_Value) FromAttributeFilterStringValue added in v1.9.0

func (t *Matcher_Value) FromAttributeFilterStringValue(v AttributeFilterStringValue) error

FromAttributeFilterStringValue overwrites any union data inside the Matcher_Value as the provided AttributeFilterStringValue

func (Matcher_Value) MarshalJSON added in v1.9.0

func (t Matcher_Value) MarshalJSON() ([]byte, error)

func (*Matcher_Value) MergeAttributeFilterAnyValue added in v1.9.0

func (t *Matcher_Value) MergeAttributeFilterAnyValue(v AttributeFilterAnyValue) error

MergeAttributeFilterAnyValue performs a merge with any union data inside the Matcher_Value, using the provided AttributeFilterAnyValue

func (*Matcher_Value) MergeAttributeFilterStringValue added in v1.9.0

func (t *Matcher_Value) MergeAttributeFilterStringValue(v AttributeFilterStringValue) error

MergeAttributeFilterStringValue performs a merge with any union data inside the Matcher_Value, using the provided AttributeFilterStringValue

func (*Matcher_Value) UnmarshalJSON added in v1.9.0

func (t *Matcher_Value) UnmarshalJSON(b []byte) error

type Matcher_Values_Item added in v1.9.0

type Matcher_Values_Item struct {
	// contains filtered or unexported fields
}

Matcher_Values_Item defines model for Matcher.values.Item.

func (Matcher_Values_Item) AsAttributeFilterAnyValue added in v1.9.0

func (t Matcher_Values_Item) AsAttributeFilterAnyValue() (AttributeFilterAnyValue, error)

AsAttributeFilterAnyValue returns the union data inside the Matcher_Values_Item as a AttributeFilterAnyValue

func (Matcher_Values_Item) AsAttributeFilterStringValue added in v1.9.0

func (t Matcher_Values_Item) AsAttributeFilterStringValue() (AttributeFilterStringValue, error)

AsAttributeFilterStringValue returns the union data inside the Matcher_Values_Item as a AttributeFilterStringValue

func (*Matcher_Values_Item) FromAttributeFilterAnyValue added in v1.9.0

func (t *Matcher_Values_Item) FromAttributeFilterAnyValue(v AttributeFilterAnyValue) error

FromAttributeFilterAnyValue overwrites any union data inside the Matcher_Values_Item as the provided AttributeFilterAnyValue

func (*Matcher_Values_Item) FromAttributeFilterStringValue added in v1.9.0

func (t *Matcher_Values_Item) FromAttributeFilterStringValue(v AttributeFilterStringValue) error

FromAttributeFilterStringValue overwrites any union data inside the Matcher_Values_Item as the provided AttributeFilterStringValue

func (Matcher_Values_Item) MarshalJSON added in v1.9.0

func (t Matcher_Values_Item) MarshalJSON() ([]byte, error)

func (*Matcher_Values_Item) MergeAttributeFilterAnyValue added in v1.9.0

func (t *Matcher_Values_Item) MergeAttributeFilterAnyValue(v AttributeFilterAnyValue) error

MergeAttributeFilterAnyValue performs a merge with any union data inside the Matcher_Values_Item, using the provided AttributeFilterAnyValue

func (*Matcher_Values_Item) MergeAttributeFilterStringValue added in v1.9.0

func (t *Matcher_Values_Item) MergeAttributeFilterStringValue(v AttributeFilterStringValue) error

MergeAttributeFilterStringValue performs a merge with any union data inside the Matcher_Values_Item, using the provided AttributeFilterStringValue

func (*Matcher_Values_Item) UnmarshalJSON added in v1.9.0

func (t *Matcher_Values_Item) UnmarshalJSON(b []byte) error

type MemberDefinition added in v1.4.0

type MemberDefinition struct {
	Kind     MemberDefinitionKind `json:"kind"`
	Metadata MemberMetadata       `json:"metadata"`
	Spec     MemberSpec           `json:"spec"`
}

MemberDefinition defines model for MemberDefinition.

type MemberDefinitionKind added in v1.4.0

type MemberDefinitionKind string

MemberDefinitionKind defines model for MemberDefinition.Kind.

const (
	Dash0Member MemberDefinitionKind = "Dash0Member"
)

Defines values for MemberDefinitionKind.

type MemberDisplay added in v1.4.0

type MemberDisplay struct {
	Email     *string `json:"email,omitempty"`
	FirstName *string `json:"firstName,omitempty"`
	ImageUrl  *string `json:"imageUrl,omitempty"`
	LastName  *string `json:"lastName,omitempty"`
}

MemberDisplay defines model for MemberDisplay.

type MemberLabels added in v1.4.0

type MemberLabels struct {
	Dash0Comid       *string    `json:"dash0.com/id,omitempty"`
	Dash0ComjoinedAt *time.Time `json:"dash0.com/joinedAt,omitempty"`
}

MemberLabels defines model for MemberLabels.

type MemberMetadata added in v1.4.0

type MemberMetadata struct {
	Labels *MemberLabels `json:"labels,omitempty"`
	Name   string        `json:"name"`
}

MemberMetadata defines model for MemberMetadata.

type MemberSpec added in v1.4.0

type MemberSpec struct {
	Display MemberDisplay `json:"display"`
}

MemberSpec defines model for MemberSpec.

type MetricSample added in v1.13.1

type MetricSample = []interface{}

MetricSample defines model for MetricSample.

type MetricSamples added in v1.13.1

type MetricSamples = []MetricSample

MetricSamples defines model for MetricSamples.

type NameValuePair

type NameValuePair struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

NameValuePair defines model for NameValuePair.

type NetworkLevel added in v1.17.0

type NetworkLevel string

NetworkLevel Controls outbound network access for the sandbox running this thread. - `no_network`: Block all outbound network access. - `trusted_only`: Allow outbound access only to a curated list of trusted addresses. - `full`: No network restrictions.

const (
	Full        NetworkLevel = "full"
	NoNetwork   NetworkLevel = "no_network"
	TrustedOnly NetworkLevel = "trusted_only"
)

Defines values for NetworkLevel.

type NextCursors

type NextCursors struct {
	// After The cursor to another set of results. The value of this field is opaque to the
	// client and may be used as a parameter to the next request to get the another set of results.
	// Cursors do not implement any ordering.
	After *Cursor `json:"after,omitempty"`

	// Before The cursor to another set of results. The value of this field is opaque to the
	// client and may be used as a parameter to the next request to get the another set of results.
	// Cursors do not implement any ordering.
	Before *Cursor `json:"before,omitempty"`
}

NextCursors defines model for NextCursors.

type NotificationChannelAnnotations added in v1.9.0

type NotificationChannelAnnotations struct {
	// Dash0ComcreatedAt Timestamp when the notification channel was created. Set by the server; read-only.
	Dash0ComcreatedAt *time.Time `json:"dash0.com/created-at,omitempty"`

	// Dash0ComupdatedAt Timestamp of the last update. Set by the server; read-only.
	Dash0ComupdatedAt *time.Time `json:"dash0.com/updated-at,omitempty"`
}

NotificationChannelAnnotations defines model for NotificationChannelAnnotations.

type NotificationChannelDefinition added in v1.9.0

type NotificationChannelDefinition struct {
	Kind     NotificationChannelDefinitionKind `json:"kind"`
	Metadata NotificationChannelMetadata       `json:"metadata"`
	Spec     NotificationChannelSpec           `json:"spec"`
}

NotificationChannelDefinition A notification channel configuration wrapped in a CRD-like envelope. Follows the Dash0 resource convention with kind/metadata/spec structure.

type NotificationChannelDefinitionKind added in v1.9.0

type NotificationChannelDefinitionKind string

NotificationChannelDefinitionKind defines model for NotificationChannelDefinition.Kind.

const (
	Dash0NotificationChannel NotificationChannelDefinitionKind = "Dash0NotificationChannel"
)

Defines values for NotificationChannelDefinitionKind.

type NotificationChannelDefinitions added in v1.9.0

type NotificationChannelDefinitions = []NotificationChannelDefinition

NotificationChannelDefinitions defines model for NotificationChannelDefinitions.

type NotificationChannelLabels added in v1.9.0

type NotificationChannelLabels struct {
	// Dash0Comid Unique internal ID of the notification channel. Set by the server on creation; do not set manually.
	Dash0Comid *string `json:"dash0.com/id,omitempty"`

	// Dash0Comorigin External identifier for API-managed resources (e.g. the CRD name from an operator or Terraform resource ID). Empty for user-created channels; non-empty for channels created via the internal API.
	Dash0Comorigin *string `json:"dash0.com/origin,omitempty"`

	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource *CrdSource `json:"dash0.com/source,omitempty"`
}

NotificationChannelLabels defines model for NotificationChannelLabels.

type NotificationChannelMetadata added in v1.9.0

type NotificationChannelMetadata struct {
	Annotations *NotificationChannelAnnotations `json:"annotations,omitempty"`
	Labels      *NotificationChannelLabels      `json:"labels,omitempty"`

	// Name Display name of the notification channel.
	Name string `json:"name"`
}

NotificationChannelMetadata defines model for NotificationChannelMetadata.

type NotificationChannelRouting added in v1.9.0

type NotificationChannelRouting struct {
	// Assets **Read-only.** The check rules and synthetic checks that are bound to this channel — a back-reference derived by the server; any value supplied on a write is ignored. To bind a check rule to this channel, set the `dash0.com/notification-channel-ids` annotation on the check rule; to bind a synthetic check, set `spec.notifications.channels` on the synthetic check. A channel bound to a check rule or synthetic check receives every notification for it, regardless of `filters`.
	Assets []NotificationChannelRoutingAsset `json:"assets"`

	// Filters Routing conditions: the channel is notified for any failed check matching at least one condition (conditions are OR-ed; the criteria within one condition are AND-ed). Conditions are evaluated organization-wide — they are not scoped to the assets listed above, and they do not restrict notifications delivered through a direct binding.
	Filters []FilterCriteria `json:"filters"`
}

NotificationChannelRouting defines model for NotificationChannelRouting.

type NotificationChannelRoutingAsset added in v1.9.0

type NotificationChannelRoutingAsset struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset Dataset `json:"dataset"`

	// Id The bound asset's UUID. Populated by the server.
	Id string `json:"id"`

	// Kind - `check_rule`: the channel is bound to a check rule (via the check rule's `dash0.com/notification-channel-ids` annotation).
	// - `synthetic_check`: the channel is bound to a synthetic check (via the synthetic check's `spec.notifications.channels`).
	Kind NotificationChannelRoutingAssetKind `json:"kind"`

	// Name The bound asset's display name. Populated by the server.
	Name string `json:"name"`
}

NotificationChannelRoutingAsset A check rule or synthetic check that is bound to this notification channel. Populated by the server; see `NotificationChannelRouting.assets`.

type NotificationChannelRoutingAssetKind added in v1.9.0

type NotificationChannelRoutingAssetKind string

NotificationChannelRoutingAssetKind - `check_rule`: the channel is bound to a check rule (via the check rule's `dash0.com/notification-channel-ids` annotation). - `synthetic_check`: the channel is bound to a synthetic check (via the synthetic check's `spec.notifications.channels`).

const (
	CheckRule      NotificationChannelRoutingAssetKind = "check_rule"
	SyntheticCheck NotificationChannelRoutingAssetKind = "synthetic_check"
)

Defines values for NotificationChannelRoutingAssetKind.

type NotificationChannelSpec added in v1.9.0

type NotificationChannelSpec struct {
	Config    NotificationChannelSpec_Config `json:"config"`
	Frequency *Duration                      `json:"frequency,omitempty"`
	Routing   *NotificationChannelRouting    `json:"routing,omitempty"`

	// Type The type of notification channel integration.
	Type NotificationChannelType `json:"type"`
}

NotificationChannelSpec defines model for NotificationChannelSpec.

type NotificationChannelSpec_Config added in v1.9.0

type NotificationChannelSpec_Config struct {
	// contains filtered or unexported fields
}

NotificationChannelSpec_Config defines model for NotificationChannelSpec.Config.

func (NotificationChannelSpec_Config) AsAllQuietConfig added in v1.9.0

func (t NotificationChannelSpec_Config) AsAllQuietConfig() (AllQuietConfig, error)

AsAllQuietConfig returns the union data inside the NotificationChannelSpec_Config as a AllQuietConfig

func (NotificationChannelSpec_Config) AsDiscordWebhookConfig added in v1.9.0

func (t NotificationChannelSpec_Config) AsDiscordWebhookConfig() (DiscordWebhookConfig, error)

AsDiscordWebhookConfig returns the union data inside the NotificationChannelSpec_Config as a DiscordWebhookConfig

func (NotificationChannelSpec_Config) AsEmailConfig added in v1.9.0

func (t NotificationChannelSpec_Config) AsEmailConfig() (EmailConfig, error)

AsEmailConfig returns the union data inside the NotificationChannelSpec_Config as a EmailConfig

func (NotificationChannelSpec_Config) AsEmailV2Config added in v1.9.0

func (t NotificationChannelSpec_Config) AsEmailV2Config() (EmailV2Config, error)

AsEmailV2Config returns the union data inside the NotificationChannelSpec_Config as a EmailV2Config

func (NotificationChannelSpec_Config) AsGoogleChatWebhookConfig added in v1.9.0

func (t NotificationChannelSpec_Config) AsGoogleChatWebhookConfig() (GoogleChatWebhookConfig, error)

AsGoogleChatWebhookConfig returns the union data inside the NotificationChannelSpec_Config as a GoogleChatWebhookConfig

func (NotificationChannelSpec_Config) AsIlertConfig added in v1.9.0

func (t NotificationChannelSpec_Config) AsIlertConfig() (IlertConfig, error)

AsIlertConfig returns the union data inside the NotificationChannelSpec_Config as a IlertConfig

func (NotificationChannelSpec_Config) AsIncidentIOConfig added in v1.9.0

func (t NotificationChannelSpec_Config) AsIncidentIOConfig() (IncidentIOConfig, error)

AsIncidentIOConfig returns the union data inside the NotificationChannelSpec_Config as a IncidentIOConfig

func (NotificationChannelSpec_Config) AsOpsgenieConfig added in v1.9.0

func (t NotificationChannelSpec_Config) AsOpsgenieConfig() (OpsgenieConfig, error)

AsOpsgenieConfig returns the union data inside the NotificationChannelSpec_Config as a OpsgenieConfig

func (NotificationChannelSpec_Config) AsPagerDutyConfig added in v1.9.0

func (t NotificationChannelSpec_Config) AsPagerDutyConfig() (PagerDutyConfig, error)

AsPagerDutyConfig returns the union data inside the NotificationChannelSpec_Config as a PagerDutyConfig

func (NotificationChannelSpec_Config) AsSlackBotConfig added in v1.9.0

func (t NotificationChannelSpec_Config) AsSlackBotConfig() (SlackBotConfig, error)

AsSlackBotConfig returns the union data inside the NotificationChannelSpec_Config as a SlackBotConfig

func (NotificationChannelSpec_Config) AsSlackConfig added in v1.9.0

func (t NotificationChannelSpec_Config) AsSlackConfig() (SlackConfig, error)

AsSlackConfig returns the union data inside the NotificationChannelSpec_Config as a SlackConfig

func (NotificationChannelSpec_Config) AsTeamsWebhookConfig added in v1.9.0

func (t NotificationChannelSpec_Config) AsTeamsWebhookConfig() (TeamsWebhookConfig, error)

AsTeamsWebhookConfig returns the union data inside the NotificationChannelSpec_Config as a TeamsWebhookConfig

func (NotificationChannelSpec_Config) AsWebhookConfig added in v1.9.0

func (t NotificationChannelSpec_Config) AsWebhookConfig() (WebhookConfig, error)

AsWebhookConfig returns the union data inside the NotificationChannelSpec_Config as a WebhookConfig

func (*NotificationChannelSpec_Config) FromAllQuietConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) FromAllQuietConfig(v AllQuietConfig) error

FromAllQuietConfig overwrites any union data inside the NotificationChannelSpec_Config as the provided AllQuietConfig

func (*NotificationChannelSpec_Config) FromDiscordWebhookConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) FromDiscordWebhookConfig(v DiscordWebhookConfig) error

FromDiscordWebhookConfig overwrites any union data inside the NotificationChannelSpec_Config as the provided DiscordWebhookConfig

func (*NotificationChannelSpec_Config) FromEmailConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) FromEmailConfig(v EmailConfig) error

FromEmailConfig overwrites any union data inside the NotificationChannelSpec_Config as the provided EmailConfig

func (*NotificationChannelSpec_Config) FromEmailV2Config added in v1.9.0

func (t *NotificationChannelSpec_Config) FromEmailV2Config(v EmailV2Config) error

FromEmailV2Config overwrites any union data inside the NotificationChannelSpec_Config as the provided EmailV2Config

func (*NotificationChannelSpec_Config) FromGoogleChatWebhookConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) FromGoogleChatWebhookConfig(v GoogleChatWebhookConfig) error

FromGoogleChatWebhookConfig overwrites any union data inside the NotificationChannelSpec_Config as the provided GoogleChatWebhookConfig

func (*NotificationChannelSpec_Config) FromIlertConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) FromIlertConfig(v IlertConfig) error

FromIlertConfig overwrites any union data inside the NotificationChannelSpec_Config as the provided IlertConfig

func (*NotificationChannelSpec_Config) FromIncidentIOConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) FromIncidentIOConfig(v IncidentIOConfig) error

FromIncidentIOConfig overwrites any union data inside the NotificationChannelSpec_Config as the provided IncidentIOConfig

func (*NotificationChannelSpec_Config) FromOpsgenieConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) FromOpsgenieConfig(v OpsgenieConfig) error

FromOpsgenieConfig overwrites any union data inside the NotificationChannelSpec_Config as the provided OpsgenieConfig

func (*NotificationChannelSpec_Config) FromPagerDutyConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) FromPagerDutyConfig(v PagerDutyConfig) error

FromPagerDutyConfig overwrites any union data inside the NotificationChannelSpec_Config as the provided PagerDutyConfig

func (*NotificationChannelSpec_Config) FromSlackBotConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) FromSlackBotConfig(v SlackBotConfig) error

FromSlackBotConfig overwrites any union data inside the NotificationChannelSpec_Config as the provided SlackBotConfig

func (*NotificationChannelSpec_Config) FromSlackConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) FromSlackConfig(v SlackConfig) error

FromSlackConfig overwrites any union data inside the NotificationChannelSpec_Config as the provided SlackConfig

func (*NotificationChannelSpec_Config) FromTeamsWebhookConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) FromTeamsWebhookConfig(v TeamsWebhookConfig) error

FromTeamsWebhookConfig overwrites any union data inside the NotificationChannelSpec_Config as the provided TeamsWebhookConfig

func (*NotificationChannelSpec_Config) FromWebhookConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) FromWebhookConfig(v WebhookConfig) error

FromWebhookConfig overwrites any union data inside the NotificationChannelSpec_Config as the provided WebhookConfig

func (NotificationChannelSpec_Config) MarshalJSON added in v1.9.0

func (t NotificationChannelSpec_Config) MarshalJSON() ([]byte, error)

func (*NotificationChannelSpec_Config) MergeAllQuietConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) MergeAllQuietConfig(v AllQuietConfig) error

MergeAllQuietConfig performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided AllQuietConfig

func (*NotificationChannelSpec_Config) MergeDiscordWebhookConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) MergeDiscordWebhookConfig(v DiscordWebhookConfig) error

MergeDiscordWebhookConfig performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided DiscordWebhookConfig

func (*NotificationChannelSpec_Config) MergeEmailConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) MergeEmailConfig(v EmailConfig) error

MergeEmailConfig performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided EmailConfig

func (*NotificationChannelSpec_Config) MergeEmailV2Config added in v1.9.0

func (t *NotificationChannelSpec_Config) MergeEmailV2Config(v EmailV2Config) error

MergeEmailV2Config performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided EmailV2Config

func (*NotificationChannelSpec_Config) MergeGoogleChatWebhookConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) MergeGoogleChatWebhookConfig(v GoogleChatWebhookConfig) error

MergeGoogleChatWebhookConfig performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided GoogleChatWebhookConfig

func (*NotificationChannelSpec_Config) MergeIlertConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) MergeIlertConfig(v IlertConfig) error

MergeIlertConfig performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided IlertConfig

func (*NotificationChannelSpec_Config) MergeIncidentIOConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) MergeIncidentIOConfig(v IncidentIOConfig) error

MergeIncidentIOConfig performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided IncidentIOConfig

func (*NotificationChannelSpec_Config) MergeOpsgenieConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) MergeOpsgenieConfig(v OpsgenieConfig) error

MergeOpsgenieConfig performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided OpsgenieConfig

func (*NotificationChannelSpec_Config) MergePagerDutyConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) MergePagerDutyConfig(v PagerDutyConfig) error

MergePagerDutyConfig performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided PagerDutyConfig

func (*NotificationChannelSpec_Config) MergeSlackBotConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) MergeSlackBotConfig(v SlackBotConfig) error

MergeSlackBotConfig performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided SlackBotConfig

func (*NotificationChannelSpec_Config) MergeSlackConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) MergeSlackConfig(v SlackConfig) error

MergeSlackConfig performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided SlackConfig

func (*NotificationChannelSpec_Config) MergeTeamsWebhookConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) MergeTeamsWebhookConfig(v TeamsWebhookConfig) error

MergeTeamsWebhookConfig performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided TeamsWebhookConfig

func (*NotificationChannelSpec_Config) MergeWebhookConfig added in v1.9.0

func (t *NotificationChannelSpec_Config) MergeWebhookConfig(v WebhookConfig) error

MergeWebhookConfig performs a merge with any union data inside the NotificationChannelSpec_Config, using the provided WebhookConfig

func (*NotificationChannelSpec_Config) UnmarshalJSON added in v1.9.0

func (t *NotificationChannelSpec_Config) UnmarshalJSON(b []byte) error

type NotificationChannelType added in v1.9.0

type NotificationChannelType string

NotificationChannelType The type of notification channel integration.

const (
	NotificationChannelTypeAllQuiet                 NotificationChannelType = "all_quiet"
	NotificationChannelTypeBetterstack              NotificationChannelType = "betterstack"
	NotificationChannelTypeDiscordWebhook           NotificationChannelType = "discord_webhook"
	NotificationChannelTypeEmail                    NotificationChannelType = "email"
	NotificationChannelTypeEmailV2                  NotificationChannelType = "email_v2"
	NotificationChannelTypeGoogleChatWebhook        NotificationChannelType = "google_chat_webhook"
	NotificationChannelTypeIlert                    NotificationChannelType = "ilert"
	NotificationChannelTypeIncidentio               NotificationChannelType = "incidentio"
	NotificationChannelTypeJiraServiceManagementOps NotificationChannelType = "jira_service_management_ops"
	NotificationChannelTypeOpsgenie                 NotificationChannelType = "opsgenie"
	NotificationChannelTypePagerduty                NotificationChannelType = "pagerduty"
	NotificationChannelTypePrometheusAlertmanager   NotificationChannelType = "prometheus_alertmanager"
	NotificationChannelTypePrometheusWebhook        NotificationChannelType = "prometheus_webhook"
	NotificationChannelTypeSlack                    NotificationChannelType = "slack"
	NotificationChannelTypeSlackBot                 NotificationChannelType = "slack_bot"
	NotificationChannelTypeTeamsWebhook             NotificationChannelType = "teams_webhook"
	NotificationChannelTypeWebhook                  NotificationChannelType = "webhook"
)

Defines values for NotificationChannelType.

type NumericAssertionOperator

type NumericAssertionOperator string

NumericAssertionOperator defines model for NumericAssertionOperator.

const (
	NumericAssertionOperatorGt         NumericAssertionOperator = "gt"
	NumericAssertionOperatorGte        NumericAssertionOperator = "gte"
	NumericAssertionOperatorIs         NumericAssertionOperator = "is"
	NumericAssertionOperatorIsNot      NumericAssertionOperator = "is_not"
	NumericAssertionOperatorIsNotOneOf NumericAssertionOperator = "is_not_one_of"
	NumericAssertionOperatorIsOneOf    NumericAssertionOperator = "is_one_of"
	NumericAssertionOperatorLt         NumericAssertionOperator = "lt"
	NumericAssertionOperatorLte        NumericAssertionOperator = "lte"
)

Defines values for NumericAssertionOperator.

type OAuthAuthorizationServerMetadata added in v1.6.0

type OAuthAuthorizationServerMetadata struct {
	// AuthorizationEndpoint URL of the authorization endpoint.
	AuthorizationEndpoint string `json:"authorization_endpoint"`

	// CodeChallengeMethodsSupported List of supported PKCE code challenge methods.
	CodeChallengeMethodsSupported *[]OAuthCodeChallengeMethod `json:"code_challenge_methods_supported,omitempty"`

	// GrantTypesSupported List of supported grant types.
	GrantTypesSupported *[]OAuthGrantType `json:"grant_types_supported,omitempty"`

	// IntrospectionEndpoint URL of the token introspection endpoint.
	IntrospectionEndpoint *string `json:"introspection_endpoint,omitempty"`

	// Issuer The authorization server's issuer identifier (URL).
	Issuer string `json:"issuer"`

	// RegistrationEndpoint URL of the dynamic client registration endpoint.
	RegistrationEndpoint *string `json:"registration_endpoint,omitempty"`

	// ResponseTypesSupported List of supported response types.
	ResponseTypesSupported []OAuthResponseType `json:"response_types_supported"`

	// RevocationEndpoint URL of the token revocation endpoint.
	RevocationEndpoint *string `json:"revocation_endpoint,omitempty"`

	// ScopesSupported List of scopes supported by the authorization server.
	ScopesSupported *[]string `json:"scopes_supported,omitempty"`

	// TokenEndpoint URL of the token endpoint.
	TokenEndpoint string `json:"token_endpoint"`

	// TokenEndpointAuthMethodsSupported List of supported token endpoint authentication methods.
	TokenEndpointAuthMethodsSupported *[]OAuthTokenEndpointAuthMethod `json:"token_endpoint_auth_methods_supported,omitempty"`

	// UserinfoEndpoint URL of the UserInfo endpoint (OIDC Core § 5.3).
	UserinfoEndpoint *string `json:"userinfo_endpoint,omitempty"`
}

OAuthAuthorizationServerMetadata defines model for OAuthAuthorizationServerMetadata.

type OAuthClient added in v1.15.0

type OAuthClient interface {
	// GetAuthorizationServerMetadata retrieves the OAuth 2.0 authorization
	// server metadata (RFC 8414) from the well-known endpoint.
	GetAuthorizationServerMetadata(ctx context.Context) (*OAuthAuthorizationServerMetadata, error)

	// GetProtectedResourceMetadata retrieves the OAuth 2.0 protected resource
	// metadata (RFC 9728) from the well-known endpoint.
	GetProtectedResourceMetadata(ctx context.Context) (*OAuthProtectedResourceMetadata, error)

	// AuthorizeURL builds the OAuth 2.0 authorization URL for the
	// authorization code flow with PKCE.
	// This method does not make an HTTP call; it constructs the URL from the
	// given parameters and the client's API URL.
	AuthorizeURL(params *AuthorizeURLParams) (string, error)

	// RegisterClient performs OAuth 2.0 dynamic client registration (RFC 7591).
	RegisterClient(ctx context.Context, request *OAuthClientRegistrationRequest) (*OAuthClientRegistrationResponse, error)

	// ExchangeToken exchanges an authorization code or refresh token for an
	// access token at the OAuth 2.0 token endpoint.
	// Set [OAuthTokenRequest].GrantType to select the grant type.
	// On a 400 response the error is an [*OAuthTokenError] with the structured
	// OAuth error fields.
	ExchangeToken(ctx context.Context, request *OAuthTokenRequest) (*OAuthTokenResponse, error)

	// RevokeToken revokes an access or refresh token (RFC 7009).
	RevokeToken(ctx context.Context, request *OAuthRevocationRequest) error

	// Close releases resources associated with the client.
	// Implementations should at minimum drop idle HTTP connections held by
	// the underlying transport; the ctx is reserved for future
	// graceful-shutdown work and is currently unused.
	Close(ctx context.Context) error
}

OAuthClient provides methods for the Dash0 OAuth 2.0 authorization flow. These endpoints do not require API key authentication. Use NewOAuthClient to create an instance.

For the inputs to OAuthClient.AuthorizeURL and OAuthClient.ExchangeToken, the recommended way to obtain them is:

func NewOAuthClient added in v1.15.0

func NewOAuthClient(opts ...ClientOption) (OAuthClient, error)

NewOAuthClient creates a new OAuth client for the Dash0 API. It accepts a subset of the ClientOption functions used by NewClient; only WithApiUrl, WithHTTPClient, WithTimeout, and WithUserAgent are supported. WithApiUrl is required. Passing any other option (notably WithAuthToken, retry/concurrency tuning, WithTransport, or WithOtlpEndpoint) returns an error so the caller does not silently rely on a no-op.

Example:

client, err := dash0.NewOAuthClient(
    dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
)
Example
package main

import (
	"context"
	"fmt"
	"log"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	client, err := dash0.NewOAuthClient(
		dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
	)
	if err != nil {
		log.Fatal(err)
	}
	defer func() { _ = client.Close(context.Background()) }()
	fmt.Println(client != nil)
}
Output:
true

type OAuthClientRegistrationRequest added in v1.6.0

type OAuthClientRegistrationRequest struct {
	// ClientName Human-readable name of the client.
	ClientName string `json:"client_name"`

	// ClientUri URL of the client's home page.
	ClientUri *string `json:"client_uri,omitempty"`

	// GrantTypes Grant types the client intends to use.
	GrantTypes *[]OAuthGrantType `json:"grant_types,omitempty"`

	// LogoUri URL of the client's logo image.
	LogoUri *string `json:"logo_uri,omitempty"`

	// RedirectUris Array of allowed redirect URIs.
	RedirectUris []string `json:"redirect_uris"`

	// ResponseTypes Response types the client intends to use.
	ResponseTypes *[]OAuthResponseType `json:"response_types,omitempty"`

	// Scope Space-separated list of scopes the client is requesting.
	Scope *string `json:"scope,omitempty"`

	// TokenEndpointAuthMethod - `none`: Public client, no client authentication (used by CLI/MCP clients).
	// Only public clients are supported. This deviates from RFC 7591 which defaults
	// to `client_secret_basic` when omitted.
	TokenEndpointAuthMethod *OAuthTokenEndpointAuthMethod `json:"token_endpoint_auth_method,omitempty"`
}

OAuthClientRegistrationRequest defines model for OAuthClientRegistrationRequest.

type OAuthClientRegistrationResponse added in v1.6.0

type OAuthClientRegistrationResponse struct {
	// ClientId Unique client identifier issued by the authorization server.
	ClientId string `json:"client_id"`

	// ClientName Human-readable name of the client.
	ClientName string `json:"client_name"`

	// ClientUri URL of the client's home page.
	ClientUri *string `json:"client_uri,omitempty"`

	// GrantTypes Grant types the client is registered for.
	GrantTypes *[]OAuthGrantType `json:"grant_types,omitempty"`

	// LogoUri URL of the client's logo image.
	LogoUri *string `json:"logo_uri,omitempty"`

	// RedirectUris Array of allowed redirect URIs.
	RedirectUris []string `json:"redirect_uris"`

	// RegistrationAccessToken Token for managing this client registration (RFC 7592).
	RegistrationAccessToken string `json:"registration_access_token"`

	// ResponseTypes Response types the client is registered for.
	ResponseTypes *[]OAuthResponseType `json:"response_types,omitempty"`

	// Scope Space-separated list of scopes the client is registered for.
	Scope *string `json:"scope,omitempty"`

	// TokenEndpointAuthMethod - `none`: Public client, no client authentication (used by CLI/MCP clients).
	// Only public clients are supported. This deviates from RFC 7591 which defaults
	// to `client_secret_basic` when omitted.
	TokenEndpointAuthMethod *OAuthTokenEndpointAuthMethod `json:"token_endpoint_auth_method,omitempty"`
}

OAuthClientRegistrationResponse defines model for OAuthClientRegistrationResponse.

type OAuthCodeChallengeMethod added in v1.6.0

type OAuthCodeChallengeMethod string

OAuthCodeChallengeMethod - `S256`: SHA-256 based code challenge method for PKCE (RFC 7636 section 4.2).

const (
	S256 OAuthCodeChallengeMethod = "S256"
)

Defines values for OAuthCodeChallengeMethod.

type OAuthGrantType added in v1.6.0

type OAuthGrantType string

OAuthGrantType - `authorization_code`: The standard authorization code grant (RFC 6749 section 4.1). - `refresh_token`: Exchange a refresh token for new tokens (RFC 6749 section 6).

const (
	OAuthGrantTypeAuthorizationCode OAuthGrantType = "authorization_code"
	OAuthGrantTypeRefreshToken      OAuthGrantType = "refresh_token"
)

Defines values for OAuthGrantType.

type OAuthProtectedResourceMetadata added in v1.6.0

type OAuthProtectedResourceMetadata struct {
	// AuthorizationServers Array of authorization server issuer identifiers that can issue tokens accepted by this resource.
	AuthorizationServers []string `json:"authorization_servers"`

	// BearerMethodsSupported Methods supported for sending bearer tokens to this resource (e.g., "header").
	BearerMethodsSupported *[]string `json:"bearer_methods_supported,omitempty"`

	// Resource The resource server's resource identifier (its canonical URI).
	Resource string `json:"resource"`

	// ResourceDocumentation URL of documentation for this protected resource.
	ResourceDocumentation *string `json:"resource_documentation,omitempty"`

	// ScopesSupported List of scopes supported by this resource server.
	ScopesSupported *[]string `json:"scopes_supported,omitempty"`
}

OAuthProtectedResourceMetadata defines model for OAuthProtectedResourceMetadata.

type OAuthResponseType added in v1.6.0

type OAuthResponseType string

OAuthResponseType - `code`: The authorization code response type (RFC 6749 section 4.1.1).

const (
	Code OAuthResponseType = "code"
)

Defines values for OAuthResponseType.

type OAuthRevocationRequest added in v1.6.0

type OAuthRevocationRequest struct {
	// ClientId The identifier of the client the token was issued to. RFC 7009 section 2.1 requires the
	// revocation request to be authenticated as that client, so a token issued to a different
	// client is left untouched (the response is still 200).
	ClientId string `json:"client_id,omitempty"`

	// Token The token to be revoked.
	Token string `json:"token"`

	// TokenTypeHint - `access_token`: An OAuth 2.0 access token.
	// - `refresh_token`: An OAuth 2.0 refresh token.
	TokenTypeHint *OAuthTokenType `json:"token_type_hint,omitempty"`
}

OAuthRevocationRequest defines model for OAuthRevocationRequest.

type OAuthTokenEndpointAuthMethod added in v1.6.0

type OAuthTokenEndpointAuthMethod string

OAuthTokenEndpointAuthMethod - `none`: Public client, no client authentication (used by CLI/MCP clients). Only public clients are supported. This deviates from RFC 7591 which defaults to `client_secret_basic` when omitted.

const (
	None OAuthTokenEndpointAuthMethod = "none"
)

Defines values for OAuthTokenEndpointAuthMethod.

type OAuthTokenError added in v1.15.0

type OAuthTokenError struct {
	// StatusCode is the HTTP status code (typically 400).
	StatusCode int

	// Code is the OAuth 2.0 error code (e.g., "invalid_grant",
	// "invalid_request").
	Code string

	// Description is the optional human-readable error description, supplied
	// verbatim by the authorization server.
	// See the type-level security note.
	Description string

	// URI is the optional URI identifying a human-readable web page with
	// error information, supplied verbatim by the authorization server.
	// See the type-level security note.
	URI string
}

OAuthTokenError represents an OAuth 2.0 token endpoint error response (RFC 6749 section 5.2). The token endpoint returns a structured error body with an error code, optional description, and optional URI, rather than the generic JSON error format used by other API endpoints.

Security note: the Description and URI fields are returned verbatim by the authorization server and may carry attacker-influenced content if the IdP itself is compromised or operates a relay. Surfaces that auto-render the URI (CLI hyperlinks, log scrapers that follow links) should treat it as untrusted; surfaces that log OAuthTokenError.Error should escape control characters in the description before display.

func (*OAuthTokenError) Error added in v1.15.0

func (e *OAuthTokenError) Error() string

Error implements the error interface. The format is "dash0 oauth error: <code>[: <description>] (status: <code>)[ (see: <uri>)]", preserving the RFC 6749 §5.2 error_uri field when the IdP provides one.

type OAuthTokenErrorResponse added in v1.6.0

type OAuthTokenErrorResponse struct {
	// Error A single ASCII error code. Standard values include:
	// invalid_request, invalid_client, invalid_grant, unauthorized_client,
	// unsupported_grant_type, invalid_scope.
	Error string `json:"error"`

	// ErrorDescription Human-readable description providing additional information.
	ErrorDescription *string `json:"error_description,omitempty"`

	// ErrorUri URI identifying a human-readable web page with error information.
	ErrorUri *string `json:"error_uri,omitempty"`
}

OAuthTokenErrorResponse defines model for OAuthTokenErrorResponse.

type OAuthTokenRequest added in v1.6.0

type OAuthTokenRequest struct {
	// ClientId The client identifier.
	ClientId *string `json:"client_id,omitempty"`

	// Code The authorization code (required for authorization_code grant).
	Code *string `json:"code,omitempty"`

	// CodeVerifier PKCE code verifier (required for authorization_code grant). All public clients must use PKCE (RFC 7636).
	CodeVerifier *string `json:"code_verifier,omitempty"`

	// GrantType - `authorization_code`: The standard authorization code grant (RFC 6749 section 4.1).
	// - `refresh_token`: Exchange a refresh token for new tokens (RFC 6749 section 6).
	GrantType OAuthGrantType `json:"grant_type"`

	// RedirectUri Must match the redirect_uri used in the authorization request (required for authorization_code grant).
	RedirectUri *string `json:"redirect_uri,omitempty"`

	// RefreshToken The refresh token (required for refresh_token grant).
	RefreshToken *string `json:"refresh_token,omitempty"`

	// Scope Space-separated list of requested scopes. For refresh_token grant, must be equal to or a subset of the originally granted scopes.
	Scope *string `json:"scope,omitempty"`
}

OAuthTokenRequest defines model for OAuthTokenRequest.

type OAuthTokenResponse added in v1.6.0

type OAuthTokenResponse struct {
	// AccessToken The access token issued by the authorization server.
	AccessToken        string              `json:"access_token"`
	DatasetRestriction *DatasetRestriction `json:"dataset_restriction,omitempty"`
	Datasets           *[]string           `json:"datasets,omitempty"`

	// ExpiresIn Lifetime of the access token in seconds.
	ExpiresIn int64 `json:"expires_in"`

	// RefreshToken The refresh token for obtaining new access tokens.
	RefreshToken *string `json:"refresh_token,omitempty"`

	// Scope Space-separated list of granted scopes.
	Scope *string `json:"scope,omitempty"`

	// TokenType The type of token issued (always "Bearer").
	TokenType string `json:"token_type"`
}

OAuthTokenResponse defines model for OAuthTokenResponse.

type OAuthTokenType added in v1.6.0

type OAuthTokenType string

OAuthTokenType - `access_token`: An OAuth 2.0 access token. - `refresh_token`: An OAuth 2.0 refresh token.

const (
	OAuthTokenTypeAccessToken  OAuthTokenType = "access_token"
	OAuthTokenTypeRefreshToken OAuthTokenType = "refresh_token"
)

Defines values for OAuthTokenType.

type OTTLCondition added in v1.12.3

type OTTLCondition = string

OTTLCondition The OpenTelemetry Transformation Language (OTTL) is a small, domain-specific programming language intended to process data with OpenTelemetry-native concepts and constructs. An OTTL *Condition* is a boolean expression determining a certain behavior.

OTTL conditions are only valid for specific evaluation contexts: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/ottl/README.md#getting-started

Examples:

  • Within the context of telemetry filtering, a condition evaluating to true means that the data should be dropped.

type OTTLConditions added in v1.12.3

type OTTLConditions = []OTTLCondition

OTTLConditions defines model for OTTLConditions.

type OTTLStatement added in v1.12.3

type OTTLStatement = string

OTTLStatement The OpenTelemetry Transformation Language (OTTL) is a small, domain-specific programming language intended to process data with OpenTelemetry-native concepts and constructs. An OTTL *Statement* is an expression that performs an action on telemetry data, such as setting, deleting, or transforming attributes.

OTTL statements are used by the OpenTelemetry Transform Processor to modify telemetry data as it passes through the collector pipeline: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/transformprocessor/README.md

Statements are only valid for specific evaluation contexts: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/ottl/README.md#getting-started

Examples:

  • `set(attributes["http.request.method"], "GET")` sets an attribute value.
  • `delete_key(attributes, "http.request.header.authorization")` removes a sensitive attribute.
  • `truncate_all(attributes, 100)` truncates all attribute values to 100 characters.

type OTTLStatements added in v1.12.3

type OTTLStatements = []OTTLStatement

OTTLStatements defines model for OTTLStatements.

type ObservedPatternEntry added in v1.12.3

type ObservedPatternEntry struct {
	Dataset       string `json:"dataset"`
	ExtractorType string `json:"extractorType"`
	ScopeKey      string `json:"scopeKey"`
	Template      string `json:"template"`
}

ObservedPatternEntry defines model for ObservedPatternEntry.

type OpsgenieConfig added in v1.9.0

type OpsgenieConfig struct {
	ApiKey   string                 `json:"apiKey"`
	Instance OpsgenieConfigInstance `json:"instance"`
}

OpsgenieConfig defines model for OpsgenieConfig.

type OpsgenieConfigInstance added in v1.9.0

type OpsgenieConfigInstance string

OpsgenieConfigInstance defines model for OpsgenieConfig.Instance.

const (
	Eu OpsgenieConfigInstance = "eu"
	Us OpsgenieConfigInstance = "us"
)

Defines values for OpsgenieConfigInstance.

type OrderingCriteria

type OrderingCriteria = []OrderingCriterion

OrderingCriteria Any supported attribute keys to order by.

type OrderingCriterion

type OrderingCriterion struct {
	Direction OrderingDirection `json:"direction"`

	// Key Any attribute key to order by.
	Key OrderingKey `json:"key"`
}

OrderingCriterion Any combination of a supported key to order by and a direction.

type OrderingDirection

type OrderingDirection string

OrderingDirection defines model for OrderingDirection.

const (
	Ascending  OrderingDirection = "ascending"
	Descending OrderingDirection = "descending"
)

Defines values for OrderingDirection.

type OrderingKey

type OrderingKey = string

OrderingKey Any attribute key to order by.

type OtlpEncoding added in v1.2.0

type OtlpEncoding string

OtlpEncoding specifies the wire format for OTLP data.

const (
	// OtlpEncodingJson is the OTLP/JSON encoding over HTTP.
	OtlpEncodingJson OtlpEncoding = "otlp/json"
)

type PKCEPair added in v1.15.0

type PKCEPair struct {
	Verifier  string // pass back to ExchangeToken as CodeVerifier
	Challenge string // pass to AuthorizeURL as CodeChallenge with method S256
}

PKCEPair is a freshly-generated PKCE code verifier and the matching S256 code challenge, suitable for an OAuth 2.0 authorization-code-with-PKCE flow (RFC 7636).

func GeneratePKCEPair added in v1.15.0

func GeneratePKCEPair() (PKCEPair, error)

GeneratePKCEPair returns a fresh verifier and its S256 challenge per RFC 7636. The verifier is base64url(32 random bytes) — 43 characters, no padding.

Example
package main

import (
	"fmt"
	"log"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	pair, err := dash0.GeneratePKCEPair()
	if err != nil {
		log.Fatal(err)
	}
	// The verifier is base64url(32 random bytes) without padding — 43 chars.
	// The S256 challenge is base64url(SHA-256(verifier)) — also 43 chars.
	fmt.Println(len(pair.Verifier), len(pair.Challenge))
}
Output:
43 43

type PagerDutyConfig added in v1.9.0

type PagerDutyConfig struct {
	Key string `json:"key"`
	Url string `json:"url"`
}

PagerDutyConfig defines model for PagerDutyConfig.

type PersesDashboard added in v1.6.0

type PersesDashboard struct {
	APIVersion string                  `json:"apiVersion"`
	Kind       string                  `json:"kind"`
	Metadata   PersesDashboardMetadata `json:"metadata"`
	Spec       map[string]interface{}  `json:"spec"`
}

PersesDashboard represents the Perses Operator PersesDashboard CRD (perses.dev/v1alpha1 and perses.dev/v1alpha2).

type PersesDashboardMetadata added in v1.6.0

type PersesDashboardMetadata struct {
	Name        string            `json:"name,omitempty"`
	Namespace   string            `json:"namespace,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	Annotations map[string]string `json:"annotations,omitempty"`
}

PersesDashboardMetadata contains metadata for a PersesDashboard.

type PostApiAgenticWorkflowsJSONRequestBody added in v1.17.0

type PostApiAgenticWorkflowsJSONRequestBody = AgenticWorkflowCreateRequest

PostApiAgenticWorkflowsJSONRequestBody defines body for PostApiAgenticWorkflows for application/json ContentType.

type PostApiAgenticWorkflowsParams added in v1.17.0

type PostApiAgenticWorkflowsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiAgenticWorkflowsParams defines parameters for PostApiAgenticWorkflows.

type PostApiAgenticWorkflowsResponse added in v1.17.0

type PostApiAgenticWorkflowsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AgenticWorkflowResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiAgenticWorkflowsResponse added in v1.17.0

func ParsePostApiAgenticWorkflowsResponse(rsp *http.Response) (*PostApiAgenticWorkflowsResponse, error)

ParsePostApiAgenticWorkflowsResponse parses an HTTP response from a PostApiAgenticWorkflowsWithResponse call

func (PostApiAgenticWorkflowsResponse) Status added in v1.17.0

Status returns HTTPResponse.Status

func (PostApiAgenticWorkflowsResponse) StatusCode added in v1.17.0

func (r PostApiAgenticWorkflowsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiAlertingCheckRulesBulkJSONRequestBody added in v1.12.1

type PostApiAlertingCheckRulesBulkJSONRequestBody = PrometheusAlertRuleBulkCreateRequest

PostApiAlertingCheckRulesBulkJSONRequestBody defines body for PostApiAlertingCheckRulesBulk for application/json ContentType.

type PostApiAlertingCheckRulesBulkParams added in v1.12.1

type PostApiAlertingCheckRulesBulkParams struct {
	// Dataset The dataset to deploy rules into. Required to prevent accidental deployment to the wrong dataset.
	Dataset Dataset `form:"dataset" json:"dataset"`
}

PostApiAlertingCheckRulesBulkParams defines parameters for PostApiAlertingCheckRulesBulk.

type PostApiAlertingCheckRulesBulkResponse added in v1.12.1

type PostApiAlertingCheckRulesBulkResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusAlertRuleBulkCreateResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiAlertingCheckRulesBulkResponse added in v1.12.1

func ParsePostApiAlertingCheckRulesBulkResponse(rsp *http.Response) (*PostApiAlertingCheckRulesBulkResponse, error)

ParsePostApiAlertingCheckRulesBulkResponse parses an HTTP response from a PostApiAlertingCheckRulesBulkWithResponse call

func (PostApiAlertingCheckRulesBulkResponse) Status added in v1.12.1

Status returns HTTPResponse.Status

func (PostApiAlertingCheckRulesBulkResponse) StatusCode added in v1.12.1

StatusCode returns HTTPResponse.StatusCode

type PostApiAlertingCheckRulesJSONRequestBody

type PostApiAlertingCheckRulesJSONRequestBody = PrometheusAlertRule

PostApiAlertingCheckRulesJSONRequestBody defines body for PostApiAlertingCheckRules for application/json ContentType.

type PostApiAlertingCheckRulesParams

type PostApiAlertingCheckRulesParams struct {
	// Dataset The associated dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiAlertingCheckRulesParams defines parameters for PostApiAlertingCheckRules.

type PostApiAlertingCheckRulesResponse

type PostApiAlertingCheckRulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusAlertRule
	JSONDefault  *ErrorResponse
}

func ParsePostApiAlertingCheckRulesResponse

func ParsePostApiAlertingCheckRulesResponse(rsp *http.Response) (*PostApiAlertingCheckRulesResponse, error)

ParsePostApiAlertingCheckRulesResponse parses an HTTP response from a PostApiAlertingCheckRulesWithResponse call

func (PostApiAlertingCheckRulesResponse) Status

Status returns HTTPResponse.Status

func (PostApiAlertingCheckRulesResponse) StatusCode

func (r PostApiAlertingCheckRulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiDashboardsJSONRequestBody

type PostApiDashboardsJSONRequestBody = DashboardDefinition

PostApiDashboardsJSONRequestBody defines body for PostApiDashboards for application/json ContentType.

type PostApiDashboardsParams

type PostApiDashboardsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiDashboardsParams defines parameters for PostApiDashboards.

type PostApiDashboardsResponse

type PostApiDashboardsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DashboardDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiDashboardsResponse

func ParsePostApiDashboardsResponse(rsp *http.Response) (*PostApiDashboardsResponse, error)

ParsePostApiDashboardsResponse parses an HTTP response from a PostApiDashboardsWithResponse call

func (PostApiDashboardsResponse) Status

func (r PostApiDashboardsResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiDashboardsResponse) StatusCode

func (r PostApiDashboardsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiImportCheckRuleJSONRequestBody

type PostApiImportCheckRuleJSONRequestBody = PrometheusAlertRule

PostApiImportCheckRuleJSONRequestBody defines body for PostApiImportCheckRule for application/json ContentType.

type PostApiImportCheckRuleParams

type PostApiImportCheckRuleParams struct {
	// Dataset The associated dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiImportCheckRuleParams defines parameters for PostApiImportCheckRule.

type PostApiImportCheckRuleResponse

type PostApiImportCheckRuleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusAlertRule
	JSONDefault  *ErrorResponse
}

func ParsePostApiImportCheckRuleResponse

func ParsePostApiImportCheckRuleResponse(rsp *http.Response) (*PostApiImportCheckRuleResponse, error)

ParsePostApiImportCheckRuleResponse parses an HTTP response from a PostApiImportCheckRuleWithResponse call

func (PostApiImportCheckRuleResponse) Status

Status returns HTTPResponse.Status

func (PostApiImportCheckRuleResponse) StatusCode

func (r PostApiImportCheckRuleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiImportCheckRulesJSONRequestBody added in v1.12.1

type PostApiImportCheckRulesJSONRequestBody = PrometheusAlertRuleBulkCreateRequest

PostApiImportCheckRulesJSONRequestBody defines body for PostApiImportCheckRules for application/json ContentType.

type PostApiImportCheckRulesParams added in v1.12.1

type PostApiImportCheckRulesParams struct {
	// Dataset The associated dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiImportCheckRulesParams defines parameters for PostApiImportCheckRules.

type PostApiImportCheckRulesResponse added in v1.12.1

type PostApiImportCheckRulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusAlertRuleBulkCreateResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiImportCheckRulesResponse added in v1.12.1

func ParsePostApiImportCheckRulesResponse(rsp *http.Response) (*PostApiImportCheckRulesResponse, error)

ParsePostApiImportCheckRulesResponse parses an HTTP response from a PostApiImportCheckRulesWithResponse call

func (PostApiImportCheckRulesResponse) Status added in v1.12.1

Status returns HTTPResponse.Status

func (PostApiImportCheckRulesResponse) StatusCode added in v1.12.1

func (r PostApiImportCheckRulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiImportDashboardJSONRequestBody

type PostApiImportDashboardJSONRequestBody = DashboardDefinition

PostApiImportDashboardJSONRequestBody defines body for PostApiImportDashboard for application/json ContentType.

type PostApiImportDashboardParams

type PostApiImportDashboardParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiImportDashboardParams defines parameters for PostApiImportDashboard.

type PostApiImportDashboardResponse

type PostApiImportDashboardResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DashboardDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiImportDashboardResponse

func ParsePostApiImportDashboardResponse(rsp *http.Response) (*PostApiImportDashboardResponse, error)

ParsePostApiImportDashboardResponse parses an HTTP response from a PostApiImportDashboardWithResponse call

func (PostApiImportDashboardResponse) Status

Status returns HTTPResponse.Status

func (PostApiImportDashboardResponse) StatusCode

func (r PostApiImportDashboardResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiImportSyntheticCheckJSONRequestBody

type PostApiImportSyntheticCheckJSONRequestBody = SyntheticCheckDefinition

PostApiImportSyntheticCheckJSONRequestBody defines body for PostApiImportSyntheticCheck for application/json ContentType.

type PostApiImportSyntheticCheckParams

type PostApiImportSyntheticCheckParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiImportSyntheticCheckParams defines parameters for PostApiImportSyntheticCheck.

type PostApiImportSyntheticCheckResponse

type PostApiImportSyntheticCheckResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SyntheticCheckDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiImportSyntheticCheckResponse

func ParsePostApiImportSyntheticCheckResponse(rsp *http.Response) (*PostApiImportSyntheticCheckResponse, error)

ParsePostApiImportSyntheticCheckResponse parses an HTTP response from a PostApiImportSyntheticCheckWithResponse call

func (PostApiImportSyntheticCheckResponse) Status

Status returns HTTPResponse.Status

func (PostApiImportSyntheticCheckResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PostApiImportViewJSONRequestBody

type PostApiImportViewJSONRequestBody = ViewDefinition

PostApiImportViewJSONRequestBody defines body for PostApiImportView for application/json ContentType.

type PostApiImportViewParams

type PostApiImportViewParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiImportViewParams defines parameters for PostApiImportView.

type PostApiImportViewResponse

type PostApiImportViewResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ViewDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiImportViewResponse

func ParsePostApiImportViewResponse(rsp *http.Response) (*PostApiImportViewResponse, error)

ParsePostApiImportViewResponse parses an HTTP response from a PostApiImportViewWithResponse call

func (PostApiImportViewResponse) Status

func (r PostApiImportViewResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiImportViewResponse) StatusCode

func (r PostApiImportViewResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiLogsDownloadJSONRequestBody added in v1.18.1

type PostApiLogsDownloadJSONRequestBody = LogRecordsDownloadRequest

PostApiLogsDownloadJSONRequestBody defines body for PostApiLogsDownload for application/json ContentType.

type PostApiLogsDownloadResponse added in v1.18.1

type PostApiLogsDownloadResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *ErrorResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiLogsDownloadResponse added in v1.18.1

func ParsePostApiLogsDownloadResponse(rsp *http.Response) (*PostApiLogsDownloadResponse, error)

ParsePostApiLogsDownloadResponse parses an HTTP response from a PostApiLogsDownloadWithResponse call

func (PostApiLogsDownloadResponse) Status added in v1.18.1

Status returns HTTPResponse.Status

func (PostApiLogsDownloadResponse) StatusCode added in v1.18.1

func (r PostApiLogsDownloadResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiLogsJSONRequestBody

type PostApiLogsJSONRequestBody = GetLogRecordsRequest

PostApiLogsJSONRequestBody defines body for PostApiLogs for application/json ContentType.

type PostApiLogsResponse

type PostApiLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetLogRecordsResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiLogsResponse

func ParsePostApiLogsResponse(rsp *http.Response) (*PostApiLogsResponse, error)

ParsePostApiLogsResponse parses an HTTP response from a PostApiLogsWithResponse call

func (PostApiLogsResponse) Status

func (r PostApiLogsResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiLogsResponse) StatusCode

func (r PostApiLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiMembersJSONRequestBody added in v1.4.0

type PostApiMembersJSONRequestBody = InviteMemberRequest

PostApiMembersJSONRequestBody defines body for PostApiMembers for application/json ContentType.

type PostApiMembersResponse added in v1.4.0

type PostApiMembersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParsePostApiMembersResponse added in v1.4.0

func ParsePostApiMembersResponse(rsp *http.Response) (*PostApiMembersResponse, error)

ParsePostApiMembersResponse parses an HTTP response from a PostApiMembersWithResponse call

func (PostApiMembersResponse) Status added in v1.4.0

func (r PostApiMembersResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiMembersResponse) StatusCode added in v1.4.0

func (r PostApiMembersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiNotificationChannelsJSONRequestBody added in v1.9.0

type PostApiNotificationChannelsJSONRequestBody = NotificationChannelDefinition

PostApiNotificationChannelsJSONRequestBody defines body for PostApiNotificationChannels for application/json ContentType.

type PostApiNotificationChannelsResponse added in v1.9.0

type PostApiNotificationChannelsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NotificationChannelDefinition
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiNotificationChannelsResponse added in v1.9.0

func ParsePostApiNotificationChannelsResponse(rsp *http.Response) (*PostApiNotificationChannelsResponse, error)

ParsePostApiNotificationChannelsResponse parses an HTTP response from a PostApiNotificationChannelsWithResponse call

func (PostApiNotificationChannelsResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (PostApiNotificationChannelsResponse) StatusCode added in v1.9.0

StatusCode returns HTTPResponse.StatusCode

type PostApiPrometheusApiV1FormatQueryJSONRequestBody added in v1.13.1

type PostApiPrometheusApiV1FormatQueryJSONRequestBody = PrometheusFormatQueryRequest

PostApiPrometheusApiV1FormatQueryJSONRequestBody defines body for PostApiPrometheusApiV1FormatQuery for application/json ContentType.

type PostApiPrometheusApiV1FormatQueryResponse added in v1.13.1

type PostApiPrometheusApiV1FormatQueryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusFormatQueryResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParsePostApiPrometheusApiV1FormatQueryResponse added in v1.13.1

func ParsePostApiPrometheusApiV1FormatQueryResponse(rsp *http.Response) (*PostApiPrometheusApiV1FormatQueryResponse, error)

ParsePostApiPrometheusApiV1FormatQueryResponse parses an HTTP response from a PostApiPrometheusApiV1FormatQueryWithResponse call

func (PostApiPrometheusApiV1FormatQueryResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (PostApiPrometheusApiV1FormatQueryResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type PostApiPrometheusApiV1LabelLabelNameValuesJSONRequestBody added in v1.13.1

type PostApiPrometheusApiV1LabelLabelNameValuesJSONRequestBody = PrometheusLabelNamesOrValuesRequest

PostApiPrometheusApiV1LabelLabelNameValuesJSONRequestBody defines body for PostApiPrometheusApiV1LabelLabelNameValues for application/json ContentType.

type PostApiPrometheusApiV1LabelLabelNameValuesResponse added in v1.13.1

type PostApiPrometheusApiV1LabelLabelNameValuesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusLabelNamesOrValuesResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParsePostApiPrometheusApiV1LabelLabelNameValuesResponse added in v1.13.1

func ParsePostApiPrometheusApiV1LabelLabelNameValuesResponse(rsp *http.Response) (*PostApiPrometheusApiV1LabelLabelNameValuesResponse, error)

ParsePostApiPrometheusApiV1LabelLabelNameValuesResponse parses an HTTP response from a PostApiPrometheusApiV1LabelLabelNameValuesWithResponse call

func (PostApiPrometheusApiV1LabelLabelNameValuesResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (PostApiPrometheusApiV1LabelLabelNameValuesResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type PostApiPrometheusApiV1LabelsJSONRequestBody added in v1.13.1

type PostApiPrometheusApiV1LabelsJSONRequestBody = PrometheusLabelNamesOrValuesRequest

PostApiPrometheusApiV1LabelsJSONRequestBody defines body for PostApiPrometheusApiV1Labels for application/json ContentType.

type PostApiPrometheusApiV1LabelsResponse added in v1.13.1

type PostApiPrometheusApiV1LabelsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusLabelNamesOrValuesResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParsePostApiPrometheusApiV1LabelsResponse added in v1.13.1

func ParsePostApiPrometheusApiV1LabelsResponse(rsp *http.Response) (*PostApiPrometheusApiV1LabelsResponse, error)

ParsePostApiPrometheusApiV1LabelsResponse parses an HTTP response from a PostApiPrometheusApiV1LabelsWithResponse call

func (PostApiPrometheusApiV1LabelsResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (PostApiPrometheusApiV1LabelsResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type PostApiPrometheusApiV1MetadataJSONRequestBody added in v1.13.1

type PostApiPrometheusApiV1MetadataJSONRequestBody = PrometheusMetadataRequest

PostApiPrometheusApiV1MetadataJSONRequestBody defines body for PostApiPrometheusApiV1Metadata for application/json ContentType.

type PostApiPrometheusApiV1MetadataResponse added in v1.13.1

type PostApiPrometheusApiV1MetadataResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusMetadataResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParsePostApiPrometheusApiV1MetadataResponse added in v1.13.1

func ParsePostApiPrometheusApiV1MetadataResponse(rsp *http.Response) (*PostApiPrometheusApiV1MetadataResponse, error)

ParsePostApiPrometheusApiV1MetadataResponse parses an HTTP response from a PostApiPrometheusApiV1MetadataWithResponse call

func (PostApiPrometheusApiV1MetadataResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (PostApiPrometheusApiV1MetadataResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type PostApiPrometheusApiV1QueryJSONRequestBody added in v1.13.1

type PostApiPrometheusApiV1QueryJSONRequestBody = PrometheusQueryRequest

PostApiPrometheusApiV1QueryJSONRequestBody defines body for PostApiPrometheusApiV1Query for application/json ContentType.

type PostApiPrometheusApiV1QueryRangeJSONRequestBody added in v1.13.1

type PostApiPrometheusApiV1QueryRangeJSONRequestBody = PrometheusQueryRangeRequest

PostApiPrometheusApiV1QueryRangeJSONRequestBody defines body for PostApiPrometheusApiV1QueryRange for application/json ContentType.

type PostApiPrometheusApiV1QueryRangeResponse added in v1.13.1

type PostApiPrometheusApiV1QueryRangeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusQueryResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParsePostApiPrometheusApiV1QueryRangeResponse added in v1.13.1

func ParsePostApiPrometheusApiV1QueryRangeResponse(rsp *http.Response) (*PostApiPrometheusApiV1QueryRangeResponse, error)

ParsePostApiPrometheusApiV1QueryRangeResponse parses an HTTP response from a PostApiPrometheusApiV1QueryRangeWithResponse call

func (PostApiPrometheusApiV1QueryRangeResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (PostApiPrometheusApiV1QueryRangeResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type PostApiPrometheusApiV1QueryResponse added in v1.13.1

type PostApiPrometheusApiV1QueryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusQueryResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParsePostApiPrometheusApiV1QueryResponse added in v1.13.1

func ParsePostApiPrometheusApiV1QueryResponse(rsp *http.Response) (*PostApiPrometheusApiV1QueryResponse, error)

ParsePostApiPrometheusApiV1QueryResponse parses an HTTP response from a PostApiPrometheusApiV1QueryWithResponse call

func (PostApiPrometheusApiV1QueryResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (PostApiPrometheusApiV1QueryResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type PostApiPrometheusApiV1SeriesJSONRequestBody added in v1.13.1

type PostApiPrometheusApiV1SeriesJSONRequestBody = PrometheusLabelNamesOrValuesRequest

PostApiPrometheusApiV1SeriesJSONRequestBody defines body for PostApiPrometheusApiV1Series for application/json ContentType.

type PostApiPrometheusApiV1SeriesResponse added in v1.13.1

type PostApiPrometheusApiV1SeriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusSeriesResponse
	JSONDefault  *PrometheusErrorResponse
}

func ParsePostApiPrometheusApiV1SeriesResponse added in v1.13.1

func ParsePostApiPrometheusApiV1SeriesResponse(rsp *http.Response) (*PostApiPrometheusApiV1SeriesResponse, error)

ParsePostApiPrometheusApiV1SeriesResponse parses an HTTP response from a PostApiPrometheusApiV1SeriesWithResponse call

func (PostApiPrometheusApiV1SeriesResponse) Status added in v1.13.1

Status returns HTTPResponse.Status

func (PostApiPrometheusApiV1SeriesResponse) StatusCode added in v1.13.1

StatusCode returns HTTPResponse.StatusCode

type PostApiRecordingRulesJSONRequestBody added in v1.9.0

type PostApiRecordingRulesJSONRequestBody = generatedPrometheusRule

PostApiRecordingRulesJSONRequestBody defines body for PostApiRecordingRules for application/json ContentType.

type PostApiRecordingRulesParams added in v1.11.1

type PostApiRecordingRulesParams struct {
	// Dataset Target dataset. Overrides dash0.com/dataset in metadata.labels if both are provided.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiRecordingRulesParams defines parameters for PostApiRecordingRules.

type PostApiRecordingRulesResponse added in v1.9.0

type PostApiRecordingRulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *generatedPrometheusRule
	JSONDefault  *ErrorResponse
}

func ParsePostApiRecordingRulesResponse added in v1.9.0

func ParsePostApiRecordingRulesResponse(rsp *http.Response) (*PostApiRecordingRulesResponse, error)

ParsePostApiRecordingRulesResponse parses an HTTP response from a PostApiRecordingRulesWithResponse call

func (PostApiRecordingRulesResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (PostApiRecordingRulesResponse) StatusCode added in v1.9.0

func (r PostApiRecordingRulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSamplingRulesJSONRequestBody added in v1.1.0

type PostApiSamplingRulesJSONRequestBody = SamplingRuleCreateRequest

PostApiSamplingRulesJSONRequestBody defines body for PostApiSamplingRules for application/json ContentType.

type PostApiSamplingRulesParams added in v1.1.0

type PostApiSamplingRulesParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiSamplingRulesParams defines parameters for PostApiSamplingRules.

type PostApiSamplingRulesResponse added in v1.1.0

type PostApiSamplingRulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SamplingRuleResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiSamplingRulesResponse added in v1.1.0

func ParsePostApiSamplingRulesResponse(rsp *http.Response) (*PostApiSamplingRulesResponse, error)

ParsePostApiSamplingRulesResponse parses an HTTP response from a PostApiSamplingRulesWithResponse call

func (PostApiSamplingRulesResponse) Status added in v1.1.0

Status returns HTTPResponse.Status

func (PostApiSamplingRulesResponse) StatusCode added in v1.1.0

func (r PostApiSamplingRulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSignalToMetricsJSONRequestBody added in v1.9.0

type PostApiSignalToMetricsJSONRequestBody = SignalToMetricsCreateRequest

PostApiSignalToMetricsJSONRequestBody defines body for PostApiSignalToMetrics for application/json ContentType.

type PostApiSignalToMetricsParams added in v1.9.0

type PostApiSignalToMetricsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiSignalToMetricsParams defines parameters for PostApiSignalToMetrics.

type PostApiSignalToMetricsResponse added in v1.9.0

type PostApiSignalToMetricsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SignalToMetricsResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiSignalToMetricsResponse added in v1.9.0

func ParsePostApiSignalToMetricsResponse(rsp *http.Response) (*PostApiSignalToMetricsResponse, error)

ParsePostApiSignalToMetricsResponse parses an HTTP response from a PostApiSignalToMetricsWithResponse call

func (PostApiSignalToMetricsResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (PostApiSignalToMetricsResponse) StatusCode added in v1.9.0

func (r PostApiSignalToMetricsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSignalToMetricsTestJSONRequestBody added in v1.12.0

type PostApiSignalToMetricsTestJSONRequestBody = SignalToMetricsTestRequest

PostApiSignalToMetricsTestJSONRequestBody defines body for PostApiSignalToMetricsTest for application/json ContentType.

type PostApiSignalToMetricsTestParams added in v1.12.0

type PostApiSignalToMetricsTestParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiSignalToMetricsTestParams defines parameters for PostApiSignalToMetricsTest.

type PostApiSignalToMetricsTestResponse added in v1.12.0

type PostApiSignalToMetricsTestResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SignalToMetricsTestResponse
	JSON400      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiSignalToMetricsTestResponse added in v1.12.0

func ParsePostApiSignalToMetricsTestResponse(rsp *http.Response) (*PostApiSignalToMetricsTestResponse, error)

ParsePostApiSignalToMetricsTestResponse parses an HTTP response from a PostApiSignalToMetricsTestWithResponse call

func (PostApiSignalToMetricsTestResponse) Status added in v1.12.0

Status returns HTTPResponse.Status

func (PostApiSignalToMetricsTestResponse) StatusCode added in v1.12.0

func (r PostApiSignalToMetricsTestResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSlosJSONRequestBody added in v1.14.0

type PostApiSlosJSONRequestBody = SloDefinition

PostApiSlosJSONRequestBody defines body for PostApiSlos for application/json ContentType.

type PostApiSlosParams added in v1.14.0

type PostApiSlosParams struct {
	// Dataset Target dataset. Overrides dash0.com/dataset in metadata.labels if both are provided.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiSlosParams defines parameters for PostApiSlos.

type PostApiSlosResponse added in v1.14.0

type PostApiSlosResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SloDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiSlosResponse added in v1.14.0

func ParsePostApiSlosResponse(rsp *http.Response) (*PostApiSlosResponse, error)

ParsePostApiSlosResponse parses an HTTP response from a PostApiSlosWithResponse call

func (PostApiSlosResponse) Status added in v1.14.0

func (r PostApiSlosResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiSlosResponse) StatusCode added in v1.14.0

func (r PostApiSlosResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSpamFiltersJSONRequestBody added in v1.12.0

type PostApiSpamFiltersJSONRequestBody = SpamFilterCreateRequest

PostApiSpamFiltersJSONRequestBody defines body for PostApiSpamFilters for application/json ContentType.

type PostApiSpamFiltersParams added in v1.12.0

type PostApiSpamFiltersParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiSpamFiltersParams defines parameters for PostApiSpamFilters.

type PostApiSpamFiltersResponse added in v1.12.0

type PostApiSpamFiltersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SpamFilterResponse
	JSON400      *ErrorResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiSpamFiltersResponse added in v1.12.0

func ParsePostApiSpamFiltersResponse(rsp *http.Response) (*PostApiSpamFiltersResponse, error)

ParsePostApiSpamFiltersResponse parses an HTTP response from a PostApiSpamFiltersWithResponse call

func (PostApiSpamFiltersResponse) Status added in v1.12.0

Status returns HTTPResponse.Status

func (PostApiSpamFiltersResponse) StatusCode added in v1.12.0

func (r PostApiSpamFiltersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSpansDownloadJSONRequestBody added in v1.18.1

type PostApiSpansDownloadJSONRequestBody = SpansDownloadRequest

PostApiSpansDownloadJSONRequestBody defines body for PostApiSpansDownload for application/json ContentType.

type PostApiSpansDownloadResponse added in v1.18.1

type PostApiSpansDownloadResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *ErrorResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiSpansDownloadResponse added in v1.18.1

func ParsePostApiSpansDownloadResponse(rsp *http.Response) (*PostApiSpansDownloadResponse, error)

ParsePostApiSpansDownloadResponse parses an HTTP response from a PostApiSpansDownloadWithResponse call

func (PostApiSpansDownloadResponse) Status added in v1.18.1

Status returns HTTPResponse.Status

func (PostApiSpansDownloadResponse) StatusCode added in v1.18.1

func (r PostApiSpansDownloadResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSpansJSONRequestBody

type PostApiSpansJSONRequestBody = GetSpansRequest

PostApiSpansJSONRequestBody defines body for PostApiSpans for application/json ContentType.

type PostApiSpansResponse

type PostApiSpansResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetSpansResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiSpansResponse

func ParsePostApiSpansResponse(rsp *http.Response) (*PostApiSpansResponse, error)

ParsePostApiSpansResponse parses an HTTP response from a PostApiSpansWithResponse call

func (PostApiSpansResponse) Status

func (r PostApiSpansResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiSpansResponse) StatusCode

func (r PostApiSpansResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSqlJSONRequestBody added in v1.6.0

type PostApiSqlJSONRequestBody = ExecuteSqlRequest

PostApiSqlJSONRequestBody defines body for PostApiSql for application/json ContentType.

type PostApiSqlResponse added in v1.6.0

type PostApiSqlResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ExecuteSqlResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiSqlResponse added in v1.6.0

func ParsePostApiSqlResponse(rsp *http.Response) (*PostApiSqlResponse, error)

ParsePostApiSqlResponse parses an HTTP response from a PostApiSqlWithResponse call

func (PostApiSqlResponse) Status added in v1.6.0

func (r PostApiSqlResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiSqlResponse) StatusCode added in v1.6.0

func (r PostApiSqlResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSyntheticChecksJSONRequestBody

type PostApiSyntheticChecksJSONRequestBody = SyntheticCheckDefinition

PostApiSyntheticChecksJSONRequestBody defines body for PostApiSyntheticChecks for application/json ContentType.

type PostApiSyntheticChecksParams

type PostApiSyntheticChecksParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiSyntheticChecksParams defines parameters for PostApiSyntheticChecks.

type PostApiSyntheticChecksResponse

type PostApiSyntheticChecksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SyntheticCheckDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiSyntheticChecksResponse

func ParsePostApiSyntheticChecksResponse(rsp *http.Response) (*PostApiSyntheticChecksResponse, error)

ParsePostApiSyntheticChecksResponse parses an HTTP response from a PostApiSyntheticChecksWithResponse call

func (PostApiSyntheticChecksResponse) Status

Status returns HTTPResponse.Status

func (PostApiSyntheticChecksResponse) StatusCode

func (r PostApiSyntheticChecksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSyntheticChecksTestJSONRequestBody added in v1.4.0

type PostApiSyntheticChecksTestJSONRequestBody = TestSyntheticCheckRequest

PostApiSyntheticChecksTestJSONRequestBody defines body for PostApiSyntheticChecksTest for application/json ContentType.

type PostApiSyntheticChecksTestResponse added in v1.4.0

type PostApiSyntheticChecksTestResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TestSyntheticCheckResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiSyntheticChecksTestResponse added in v1.4.0

func ParsePostApiSyntheticChecksTestResponse(rsp *http.Response) (*PostApiSyntheticChecksTestResponse, error)

ParsePostApiSyntheticChecksTestResponse parses an HTTP response from a PostApiSyntheticChecksTestWithResponse call

func (PostApiSyntheticChecksTestResponse) Status added in v1.4.0

Status returns HTTPResponse.Status

func (PostApiSyntheticChecksTestResponse) StatusCode added in v1.4.0

func (r PostApiSyntheticChecksTestResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiTeamsJSONRequestBody added in v1.4.0

type PostApiTeamsJSONRequestBody = TeamDefinitionV1Alpha1

PostApiTeamsJSONRequestBody defines body for PostApiTeams for application/json ContentType.

type PostApiTeamsOriginOrIdMembersJSONRequestBody added in v1.4.0

type PostApiTeamsOriginOrIdMembersJSONRequestBody = AddTeamMembersRequest

PostApiTeamsOriginOrIdMembersJSONRequestBody defines body for PostApiTeamsOriginOrIdMembers for application/json ContentType.

type PostApiTeamsOriginOrIdMembersResponse added in v1.4.0

type PostApiTeamsOriginOrIdMembersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParsePostApiTeamsOriginOrIdMembersResponse added in v1.4.0

func ParsePostApiTeamsOriginOrIdMembersResponse(rsp *http.Response) (*PostApiTeamsOriginOrIdMembersResponse, error)

ParsePostApiTeamsOriginOrIdMembersResponse parses an HTTP response from a PostApiTeamsOriginOrIdMembersWithResponse call

func (PostApiTeamsOriginOrIdMembersResponse) Status added in v1.4.0

Status returns HTTPResponse.Status

func (PostApiTeamsOriginOrIdMembersResponse) StatusCode added in v1.4.0

StatusCode returns HTTPResponse.StatusCode

type PostApiTeamsResponse added in v1.4.0

type PostApiTeamsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TeamDefinitionV1Alpha1
	JSONDefault  *ErrorResponse
}

func ParsePostApiTeamsResponse added in v1.4.0

func ParsePostApiTeamsResponse(rsp *http.Response) (*PostApiTeamsResponse, error)

ParsePostApiTeamsResponse parses an HTTP response from a PostApiTeamsWithResponse call

func (PostApiTeamsResponse) Status added in v1.4.0

func (r PostApiTeamsResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiTeamsResponse) StatusCode added in v1.4.0

func (r PostApiTeamsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiTimeSeriesAggregationsJSONRequestBody added in v1.17.0

type PostApiTimeSeriesAggregationsJSONRequestBody = TimeSeriesAggregationDefinition

PostApiTimeSeriesAggregationsJSONRequestBody defines body for PostApiTimeSeriesAggregations for application/json ContentType.

type PostApiTimeSeriesAggregationsParams added in v1.17.0

type PostApiTimeSeriesAggregationsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiTimeSeriesAggregationsParams defines parameters for PostApiTimeSeriesAggregations.

type PostApiTimeSeriesAggregationsResponse added in v1.17.0

type PostApiTimeSeriesAggregationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TimeSeriesAggregationDefinition
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiTimeSeriesAggregationsResponse added in v1.17.0

func ParsePostApiTimeSeriesAggregationsResponse(rsp *http.Response) (*PostApiTimeSeriesAggregationsResponse, error)

ParsePostApiTimeSeriesAggregationsResponse parses an HTTP response from a PostApiTimeSeriesAggregationsWithResponse call

func (PostApiTimeSeriesAggregationsResponse) Status added in v1.17.0

Status returns HTTPResponse.Status

func (PostApiTimeSeriesAggregationsResponse) StatusCode added in v1.17.0

StatusCode returns HTTPResponse.StatusCode

type PostApiTraceDetailsJSONRequestBody added in v1.12.0

type PostApiTraceDetailsJSONRequestBody = GetTraceRequest

PostApiTraceDetailsJSONRequestBody defines body for PostApiTraceDetails for application/json ContentType.

type PostApiTraceDetailsResponse added in v1.12.0

type PostApiTraceDetailsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetTraceResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiTraceDetailsResponse added in v1.12.0

func ParsePostApiTraceDetailsResponse(rsp *http.Response) (*PostApiTraceDetailsResponse, error)

ParsePostApiTraceDetailsResponse parses an HTTP response from a PostApiTraceDetailsWithResponse call

func (PostApiTraceDetailsResponse) Status added in v1.12.0

Status returns HTTPResponse.Status

func (PostApiTraceDetailsResponse) StatusCode added in v1.12.0

func (r PostApiTraceDetailsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiTraceIdsJSONRequestBody added in v1.12.1

type PostApiTraceIdsJSONRequestBody = GetTraceIdsRequest

PostApiTraceIdsJSONRequestBody defines body for PostApiTraceIds for application/json ContentType.

type PostApiTraceIdsResponse added in v1.12.1

type PostApiTraceIdsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetTraceIdsResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiTraceIdsResponse added in v1.12.1

func ParsePostApiTraceIdsResponse(rsp *http.Response) (*PostApiTraceIdsResponse, error)

ParsePostApiTraceIdsResponse parses an HTTP response from a PostApiTraceIdsWithResponse call

func (PostApiTraceIdsResponse) Status added in v1.12.1

func (r PostApiTraceIdsResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiTraceIdsResponse) StatusCode added in v1.12.1

func (r PostApiTraceIdsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiViewsJSONRequestBody

type PostApiViewsJSONRequestBody = ViewDefinition

PostApiViewsJSONRequestBody defines body for PostApiViews for application/json ContentType.

type PostApiViewsParams

type PostApiViewsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiViewsParams defines parameters for PostApiViews.

type PostApiViewsResponse

type PostApiViewsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ViewDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiViewsResponse

func ParsePostApiViewsResponse(rsp *http.Response) (*PostApiViewsResponse, error)

ParsePostApiViewsResponse parses an HTTP response from a PostApiViewsWithResponse call

func (PostApiViewsResponse) Status

func (r PostApiViewsResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiViewsResponse) StatusCode

func (r PostApiViewsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiWebEventsDownloadJSONRequestBody added in v1.18.1

type PostApiWebEventsDownloadJSONRequestBody = WebEventsDownloadRequest

PostApiWebEventsDownloadJSONRequestBody defines body for PostApiWebEventsDownload for application/json ContentType.

type PostApiWebEventsDownloadResponse added in v1.18.1

type PostApiWebEventsDownloadResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *ErrorResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiWebEventsDownloadResponse added in v1.18.1

func ParsePostApiWebEventsDownloadResponse(rsp *http.Response) (*PostApiWebEventsDownloadResponse, error)

ParsePostApiWebEventsDownloadResponse parses an HTTP response from a PostApiWebEventsDownloadWithResponse call

func (PostApiWebEventsDownloadResponse) Status added in v1.18.1

Status returns HTTPResponse.Status

func (PostApiWebEventsDownloadResponse) StatusCode added in v1.18.1

func (r PostApiWebEventsDownloadResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostOauthRegisterJSONRequestBody added in v1.6.0

type PostOauthRegisterJSONRequestBody = OAuthClientRegistrationRequest

PostOauthRegisterJSONRequestBody defines body for PostOauthRegister for application/json ContentType.

type PostOauthRegisterResponse added in v1.6.0

type PostOauthRegisterResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *OAuthClientRegistrationResponse
	JSONDefault  *ErrorResponse
}

func ParsePostOauthRegisterResponse added in v1.6.0

func ParsePostOauthRegisterResponse(rsp *http.Response) (*PostOauthRegisterResponse, error)

ParsePostOauthRegisterResponse parses an HTTP response from a PostOauthRegisterWithResponse call

func (PostOauthRegisterResponse) Status added in v1.6.0

func (r PostOauthRegisterResponse) Status() string

Status returns HTTPResponse.Status

func (PostOauthRegisterResponse) StatusCode added in v1.6.0

func (r PostOauthRegisterResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostOauthRevokeFormdataRequestBody added in v1.6.0

type PostOauthRevokeFormdataRequestBody = OAuthRevocationRequest

PostOauthRevokeFormdataRequestBody defines body for PostOauthRevoke for application/x-www-form-urlencoded ContentType.

type PostOauthRevokeResponse added in v1.6.0

type PostOauthRevokeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *OAuthTokenErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostOauthRevokeResponse added in v1.6.0

func ParsePostOauthRevokeResponse(rsp *http.Response) (*PostOauthRevokeResponse, error)

ParsePostOauthRevokeResponse parses an HTTP response from a PostOauthRevokeWithResponse call

func (PostOauthRevokeResponse) Status added in v1.6.0

func (r PostOauthRevokeResponse) Status() string

Status returns HTTPResponse.Status

func (PostOauthRevokeResponse) StatusCode added in v1.6.0

func (r PostOauthRevokeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostOauthTokenFormdataRequestBody added in v1.6.0

type PostOauthTokenFormdataRequestBody = OAuthTokenRequest

PostOauthTokenFormdataRequestBody defines body for PostOauthToken for application/x-www-form-urlencoded ContentType.

type PostOauthTokenResponse added in v1.6.0

type PostOauthTokenResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OAuthTokenResponse
	JSON400      *OAuthTokenErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostOauthTokenResponse added in v1.6.0

func ParsePostOauthTokenResponse(rsp *http.Response) (*PostOauthTokenResponse, error)

ParsePostOauthTokenResponse parses an HTTP response from a PostOauthTokenWithResponse call

func (PostOauthTokenResponse) Status added in v1.6.0

func (r PostOauthTokenResponse) Status() string

Status returns HTTPResponse.Status

func (PostOauthTokenResponse) StatusCode added in v1.6.0

func (r PostOauthTokenResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Progress added in v1.6.0

type Progress struct {
	BytesRead           uint64 `json:"bytesRead"`
	ExecutionTimeMillis uint64 `json:"executionTimeMillis"`
	RowsRead            uint64 `json:"rowsRead"`
	TotalRowsToRead     uint64 `json:"totalRowsToRead"`
}

Progress defines model for Progress.

type PrometheusAlertRule

type PrometheusAlertRule struct {
	// Annotations Annotations are key-value pairs that can be used to add additional metadata to a check. They map
	// to Prometheus alerting rules' "annotations" field.
	//
	// The "summary" and "description" annotations are expected and are used as the human-readable
	// summary and description of the check rule.
	Annotations *PrometheusAlertRule_Annotations `json:"annotations,omitempty"`

	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset `json:"dataset,omitempty"`

	// Enabled A boolean flag to enable or disable the check rule. When a check rule is disabled, it will not be
	// evaluated, and no check evaluations will be created. This field is optional and defaults to true.
	Enabled *bool `json:"enabled,omitempty"`

	// Expression An editable PromQL expression that can leverage the complete Dash0 Query Language. It furthermore
	// supports a variable called $__threshold.
	//
	// - `$__threshold` can be used as a placeholder for both the degraded and failed thresholds. The
	//   thresholds are defined in the thresholds field. When `$__threshold` is used in the expression,
	//   the `thresholds` field is required and at least one of the thresholds must be defined.
	//
	//   Usage of `$__threshold` implies that the PromQL expression may have to be evaluated up to two
	//   times using the degraded threshold and critical threshold respectively.
	//
	// - Top-level AND statements are treated as enablement conditions that specify when the check should
	//   "be running", i.e., is active. The use-cases for enablement conditions are several, e.g., requiring
	//   a minimum amount of requests being served before triggering due to errors rates,
	//   maintenance windows or muted timeframes.
	Expression string    `json:"expression"`
	For        *Duration `json:"for,omitempty"`

	// Id User defined id for getting/updating/deleting the alert rule through the API.
	Id       *string   `json:"id,omitempty"`
	Interval *Duration `json:"interval,omitempty"`

	KeepFiringFor *Duration `json:"keep_firing_for,omitempty"`

	// Labels Label are key-value pairs that can be used to add additional metadata to a check. They map
	// to Prometheus alerting rules' "labels" field.
	Labels *map[string]string `json:"labels,omitempty"`

	// Metadata Server-populated metadata for the alert rule. Read-only on responses; ignored on write.
	Metadata *PrometheusAlertRuleMetadata `json:"metadata,omitempty"`

	// Name Human-readable and templatable name for the check. In Prometheus alerting rules this is called "alert".
	Name string `json:"name"`

	// Thresholds Thresholds to use for the `$__threshold` variable in the expression field.
	Thresholds *CheckThresholds `json:"thresholds,omitempty"`
}

PrometheusAlertRule Check rules represent a periodically evaluated expression to determine the health of a resource. The result of the evaluation are zero or more CheckEvaluations.

func ConvertPrometheusRuleToPrometheusAlertRule added in v1.6.0

func ConvertPrometheusRuleToPrometheusAlertRule(rule *PrometheusRule, groupInterval time.Duration, ruleID string) (*PrometheusAlertRule, error)

ConvertPrometheusRuleToPrometheusAlertRule converts a Prometheus alerting rule to a Dash0 CheckRule. It extracts Dash0-specific annotations (thresholds, enabled flag) from the rule annotations and maps them to dedicated fields on the returned rule. It returns an error if a threshold annotation value is non-numeric.

type PrometheusAlertRuleApiListItem

type PrometheusAlertRuleApiListItem struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset Dataset `json:"dataset"`

	// Id The unique identifier of the check rule.
	//
	// For backward compatibility, this field is also filled with the origin, if it exists.
	// However in a future version, this field will only return the actual check rule ID.
	Id string `json:"id"`

	// Name Human-readable and templatable name for the check. In Prometheus alerting rules this is called "alert".
	Name *string `json:"name,omitempty"`

	// Origin User defined origin for getting/updating/deleting the alert rule through the API.
	Origin *string `json:"origin,omitempty"`

	// Source Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Source *CrdSource `json:"source,omitempty"`
}

PrometheusAlertRuleApiListItem The ID, origin, dataset, and the name of a check rule.

type PrometheusAlertRuleBulkCreateRequest added in v1.12.1

type PrometheusAlertRuleBulkCreateRequest struct {
	Items []PrometheusAlertRule `json:"items"`
}

PrometheusAlertRuleBulkCreateRequest defines model for PrometheusAlertRuleBulkCreateRequest.

type PrometheusAlertRuleBulkCreateResponse added in v1.12.1

type PrometheusAlertRuleBulkCreateResponse struct {
	// Created Number of check rules that were newly created.
	Created int `json:"created"`
}

PrometheusAlertRuleBulkCreateResponse defines model for PrometheusAlertRuleBulkCreateResponse.

type PrometheusAlertRuleMetadata added in v1.12.0

type PrometheusAlertRuleMetadata struct {
	// Labels Server-derived labels that apply to the alert-rule resource itself, not to the
	// emitted alert. Currently includes `dash0.com/source` when the origin is known; see
	// the `CrdSource` enum for the values it can take.
	Labels *PrometheusAlertRuleMetadataLabels `json:"labels,omitempty"`
}

PrometheusAlertRuleMetadata Server-populated metadata for the alert rule. Read-only on responses; ignored on write.

type PrometheusAlertRuleMetadataLabels added in v1.12.0

type PrometheusAlertRuleMetadataLabels struct {
	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource *CrdSource `json:"dash0.com/source,omitempty"`
}

PrometheusAlertRuleMetadataLabels Server-derived labels that apply to the alert-rule resource itself, not to the emitted alert. Currently includes `dash0.com/source` when the origin is known; see the `CrdSource` enum for the values it can take.

type PrometheusAlertRule_Annotations added in v1.6.0

type PrometheusAlertRule_Annotations struct {
	// Description Human-readable and templatable description for the check that allows you to customize the way the
	// rationale of the check is textually described in the Dash0 UI, in notifications, etc. This will
	// be optimized in the design for long form viewing.
	Description *string `json:"description,omitempty"`

	// FolderPath Optional UI folder path for organising groups (e.g. '/infrastructure/hosts'). Nesting is expressed with '/' separators.
	FolderPath *string `json:"folderPath,omitempty"`

	// Sharing Comma-separated list of principals to grant read and delete access to. Supported formats: 'team:<team_id>' and 'user:<email>'. Example: 'team:team_01abc,user:alice@example.com'. Sharing is honored only on check rules that declare a dash0.com/origin (for example those managed by Terraform, the operator, the CLI, or the API). Setting it on a check rule that declares no dash0.com/origin is rejected with a 400 — manage that rule's access via the UI share dialog instead.
	Sharing *string `json:"sharing,omitempty"`

	// Summary Human-readable and templatable summary for the check that allows you to customize the way the check
	// is textually described in short form in the Dash0 UI, in notifications, etc.
	Summary              *string           `json:"summary,omitempty"`
	AdditionalProperties map[string]string `json:"-"`
}

PrometheusAlertRule_Annotations Annotations are key-value pairs that can be used to add additional metadata to a check. They map to Prometheus alerting rules' "annotations" field.

The "summary" and "description" annotations are expected and are used as the human-readable summary and description of the check rule.

func (PrometheusAlertRule_Annotations) Get added in v1.6.0

func (a PrometheusAlertRule_Annotations) Get(fieldName string) (value string, found bool)

Getter for additional properties for PrometheusAlertRule_Annotations. Returns the specified element and whether it was found

func (PrometheusAlertRule_Annotations) MarshalJSON added in v1.6.0

func (a PrometheusAlertRule_Annotations) MarshalJSON() ([]byte, error)

Override default JSON handling for PrometheusAlertRule_Annotations to handle AdditionalProperties

func (*PrometheusAlertRule_Annotations) Set added in v1.6.0

func (a *PrometheusAlertRule_Annotations) Set(fieldName string, value string)

Setter for additional properties for PrometheusAlertRule_Annotations

func (*PrometheusAlertRule_Annotations) UnmarshalJSON added in v1.6.0

func (a *PrometheusAlertRule_Annotations) UnmarshalJSON(b []byte) error

Override default JSON handling for PrometheusAlertRule_Annotations to handle AdditionalProperties

type PrometheusBuildInfo added in v1.13.1

type PrometheusBuildInfo struct {
	// Branch Not exposed by Dash0; always empty.
	Branch *string `json:"branch,omitempty"`

	// BuildDate Not exposed by Dash0; always empty.
	BuildDate *string `json:"buildDate,omitempty"`

	// BuildUser Not exposed by Dash0; always empty.
	BuildUser *string `json:"buildUser,omitempty"`

	// GoVersion Not exposed by Dash0; always empty.
	GoVersion *string `json:"goVersion,omitempty"`

	// Revision Not exposed by Dash0; always empty.
	Revision *string `json:"revision,omitempty"`

	// Version The upstream Prometheus version Dash0 is compatible with.
	Version *string `json:"version,omitempty"`
}

PrometheusBuildInfo Build information about the Prometheus-compatible server. Only `version` is populated — with the upstream Prometheus version Dash0 is compatible with, for client feature detection. The remaining fields are retained for upstream API compatibility but are always empty; Dash0 does not expose build internals.

type PrometheusBuildInfoResponse added in v1.13.1

type PrometheusBuildInfoResponse struct {
	// Data Build information about the Prometheus-compatible server. Only `version` is populated —
	// with the upstream Prometheus version Dash0 is compatible with, for client feature
	// detection. The remaining fields are retained for upstream API compatibility but are
	// always empty; Dash0 does not expose build internals.
	Data     *PrometheusBuildInfo `json:"data,omitempty"`
	Status   string               `json:"status"`
	Warnings *[]string            `json:"warnings,omitempty"`
}

PrometheusBuildInfoResponse defines model for PrometheusBuildInfoResponse.

type PrometheusErrorResponse added in v1.13.1

type PrometheusErrorResponse struct {
	Error     string `json:"error"`
	ErrorType string `json:"errorType"`

	// Infos Info-level annotations produced while evaluating the query (Prometheus 3.0+).
	// Only populated by the instant and range query endpoints.
	Infos    *[]string `json:"infos,omitempty"`
	Status   string    `json:"status"`
	Warnings *[]string `json:"warnings,omitempty"`
}

PrometheusErrorResponse defines model for PrometheusErrorResponse.

type PrometheusFormatQueryRequest added in v1.13.1

type PrometheusFormatQueryRequest struct {
	Query string `json:"query"`
}

PrometheusFormatQueryRequest defines model for PrometheusFormatQueryRequest.

type PrometheusFormatQueryResponse added in v1.13.1

type PrometheusFormatQueryResponse struct {
	Data     *string   `json:"data,omitempty"`
	Status   string    `json:"status"`
	Warnings *[]string `json:"warnings,omitempty"`
}

PrometheusFormatQueryResponse defines model for PrometheusFormatQueryResponse.

type PrometheusLabelNamesOrValuesRequest added in v1.13.1

type PrometheusLabelNamesOrValuesRequest struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset  `json:"dataset,omitempty"`
	End     *string   `json:"end,omitempty"`
	Limit   *int64    `json:"limit,omitempty"`
	Match   *[]string `json:"match[],omitempty"`
	Start   *string   `json:"start,omitempty"`
}

PrometheusLabelNamesOrValuesRequest defines model for PrometheusLabelNamesOrValuesRequest.

type PrometheusLabelNamesOrValuesResponse added in v1.13.1

type PrometheusLabelNamesOrValuesResponse struct {
	Data     *[]string `json:"data,omitempty"`
	Status   string    `json:"status"`
	Warnings *[]string `json:"warnings,omitempty"`
}

PrometheusLabelNamesOrValuesResponse defines model for PrometheusLabelNamesOrValuesResponse.

type PrometheusMatrixResult added in v1.13.1

type PrometheusMatrixResult = []PrometheusMatrixSampleResult

PrometheusMatrixResult defines model for PrometheusMatrixResult.

type PrometheusMatrixSampleResult added in v1.13.1

type PrometheusMatrixSampleResult struct {
	Metric PrometheusMetric `json:"metric"`
	Values MetricSamples    `json:"values"`
}

PrometheusMatrixSampleResult defines model for PrometheusMatrixSampleResult.

type PrometheusMetadataRequest added in v1.13.1

type PrometheusMetadataRequest struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset        *Dataset `json:"dataset,omitempty"`
	End            *string  `json:"end,omitempty"`
	Limit          *int64   `json:"limit,omitempty"`
	LimitPerMetric *int64   `json:"limit_per_metric,omitempty"`
	Metric         *string  `json:"metric,omitempty"`
	Start          *string  `json:"start,omitempty"`
}

PrometheusMetadataRequest defines model for PrometheusMetadataRequest.

type PrometheusMetadataResponse added in v1.13.1

type PrometheusMetadataResponse struct {
	// Data Metric metadata keyed by metric name. Each metric maps to a list of metadata entries.
	Data     *map[string][]PrometheusMetricMetadata `json:"data,omitempty"`
	Status   string                                 `json:"status"`
	Warnings *[]string                              `json:"warnings,omitempty"`
}

PrometheusMetadataResponse defines model for PrometheusMetadataResponse.

type PrometheusMetric added in v1.13.1

type PrometheusMetric map[string]string

PrometheusMetric defines model for PrometheusMetric.

type PrometheusMetricMetadata added in v1.13.1

type PrometheusMetricMetadata struct {
	// Help A human-readable description of the metric.
	Help *string `json:"help,omitempty"`

	// Type The metric type as reported by the source. One of `counter`, `gauge`,
	// `histogram`, `gaugehistogram`, `summary`, `info`, `stateset`, or `unknown`.
	Type *string `json:"type,omitempty"`

	// Unit The metric unit, if known.
	Unit *string `json:"unit,omitempty"`
}

PrometheusMetricMetadata defines model for PrometheusMetricMetadata.

type PrometheusQueryRangeRequest added in v1.13.1

type PrometheusQueryRangeRequest struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset `json:"dataset,omitempty"`
	End     *string  `json:"end,omitempty"`
	Limit   *int64   `json:"limit,omitempty"`
	Query   string   `json:"query"`
	Start   *string  `json:"start,omitempty"`
	Step    string   `json:"step"`
	Timeout *string  `json:"timeout,omitempty"`
}

PrometheusQueryRangeRequest defines model for PrometheusQueryRangeRequest.

type PrometheusQueryRequest added in v1.13.1

type PrometheusQueryRequest struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset `json:"dataset,omitempty"`
	Limit   *int64   `json:"limit,omitempty"`
	Query   string   `json:"query"`
	Time    *string  `json:"time,omitempty"`
	Timeout *string  `json:"timeout,omitempty"`
}

PrometheusQueryRequest defines model for PrometheusQueryRequest.

type PrometheusQueryResponse added in v1.13.1

type PrometheusQueryResponse struct {
	Data *PrometheusQueryResult `json:"data,omitempty"`

	// Infos Info-level annotations produced while evaluating the query (Prometheus 3.0+),
	// kept separate from `warnings`.
	Infos    *[]string `json:"infos,omitempty"`
	Status   string    `json:"status"`
	Warnings *[]string `json:"warnings,omitempty"`
}

PrometheusQueryResponse defines model for PrometheusQueryResponse.

type PrometheusQueryResult added in v1.13.1

type PrometheusQueryResult struct {
	Result PrometheusQueryResult_Result `json:"result"`

	// ResultType The shape of the `result` field, mirroring Prometheus:
	// - `vector`: instant-vector result (array of samples), returned by instant queries.
	// - `matrix`: range-vector result (array of series with value ranges), returned by range queries.
	// - `scalar`: a single scalar value.
	// - `string`: a single string value.
	ResultType PrometheusResultType `json:"resultType"`
}

PrometheusQueryResult defines model for PrometheusQueryResult.

type PrometheusQueryResult_Result added in v1.13.1

type PrometheusQueryResult_Result struct {
	// contains filtered or unexported fields
}

PrometheusQueryResult_Result defines model for PrometheusQueryResult.Result.

func (PrometheusQueryResult_Result) AsPrometheusMatrixResult added in v1.13.1

func (t PrometheusQueryResult_Result) AsPrometheusMatrixResult() (PrometheusMatrixResult, error)

AsPrometheusMatrixResult returns the union data inside the PrometheusQueryResult_Result as a PrometheusMatrixResult

func (PrometheusQueryResult_Result) AsPrometheusScalarResult added in v1.13.1

func (t PrometheusQueryResult_Result) AsPrometheusScalarResult() (PrometheusScalarResult, error)

AsPrometheusScalarResult returns the union data inside the PrometheusQueryResult_Result as a PrometheusScalarResult

func (PrometheusQueryResult_Result) AsPrometheusStringResult added in v1.13.1

func (t PrometheusQueryResult_Result) AsPrometheusStringResult() (PrometheusStringResult, error)

AsPrometheusStringResult returns the union data inside the PrometheusQueryResult_Result as a PrometheusStringResult

func (PrometheusQueryResult_Result) AsPrometheusVectorResult added in v1.13.1

func (t PrometheusQueryResult_Result) AsPrometheusVectorResult() (PrometheusVectorResult, error)

AsPrometheusVectorResult returns the union data inside the PrometheusQueryResult_Result as a PrometheusVectorResult

func (*PrometheusQueryResult_Result) FromPrometheusMatrixResult added in v1.13.1

func (t *PrometheusQueryResult_Result) FromPrometheusMatrixResult(v PrometheusMatrixResult) error

FromPrometheusMatrixResult overwrites any union data inside the PrometheusQueryResult_Result as the provided PrometheusMatrixResult

func (*PrometheusQueryResult_Result) FromPrometheusScalarResult added in v1.13.1

func (t *PrometheusQueryResult_Result) FromPrometheusScalarResult(v PrometheusScalarResult) error

FromPrometheusScalarResult overwrites any union data inside the PrometheusQueryResult_Result as the provided PrometheusScalarResult

func (*PrometheusQueryResult_Result) FromPrometheusStringResult added in v1.13.1

func (t *PrometheusQueryResult_Result) FromPrometheusStringResult(v PrometheusStringResult) error

FromPrometheusStringResult overwrites any union data inside the PrometheusQueryResult_Result as the provided PrometheusStringResult

func (*PrometheusQueryResult_Result) FromPrometheusVectorResult added in v1.13.1

func (t *PrometheusQueryResult_Result) FromPrometheusVectorResult(v PrometheusVectorResult) error

FromPrometheusVectorResult overwrites any union data inside the PrometheusQueryResult_Result as the provided PrometheusVectorResult

func (PrometheusQueryResult_Result) MarshalJSON added in v1.13.1

func (t PrometheusQueryResult_Result) MarshalJSON() ([]byte, error)

func (*PrometheusQueryResult_Result) MergePrometheusMatrixResult added in v1.13.1

func (t *PrometheusQueryResult_Result) MergePrometheusMatrixResult(v PrometheusMatrixResult) error

MergePrometheusMatrixResult performs a merge with any union data inside the PrometheusQueryResult_Result, using the provided PrometheusMatrixResult

func (*PrometheusQueryResult_Result) MergePrometheusScalarResult added in v1.13.1

func (t *PrometheusQueryResult_Result) MergePrometheusScalarResult(v PrometheusScalarResult) error

MergePrometheusScalarResult performs a merge with any union data inside the PrometheusQueryResult_Result, using the provided PrometheusScalarResult

func (*PrometheusQueryResult_Result) MergePrometheusStringResult added in v1.13.1

func (t *PrometheusQueryResult_Result) MergePrometheusStringResult(v PrometheusStringResult) error

MergePrometheusStringResult performs a merge with any union data inside the PrometheusQueryResult_Result, using the provided PrometheusStringResult

func (*PrometheusQueryResult_Result) MergePrometheusVectorResult added in v1.13.1

func (t *PrometheusQueryResult_Result) MergePrometheusVectorResult(v PrometheusVectorResult) error

MergePrometheusVectorResult performs a merge with any union data inside the PrometheusQueryResult_Result, using the provided PrometheusVectorResult

func (*PrometheusQueryResult_Result) UnmarshalJSON added in v1.13.1

func (t *PrometheusQueryResult_Result) UnmarshalJSON(b []byte) error

type PrometheusResultType added in v1.13.1

type PrometheusResultType string

PrometheusResultType The shape of the `result` field, mirroring Prometheus: - `vector`: instant-vector result (array of samples), returned by instant queries. - `matrix`: range-vector result (array of series with value ranges), returned by range queries. - `scalar`: a single scalar value. - `string`: a single string value.

const (
	Matrix                     PrometheusResultType = "matrix"
	Scalar                     PrometheusResultType = "scalar"
	PrometheusResultTypeString PrometheusResultType = "string"
	Vector                     PrometheusResultType = "vector"
)

Defines values for PrometheusResultType.

type PrometheusRule added in v1.6.0

type PrometheusRule struct {
	Alert         string            `json:"alert"`
	Expr          string            `json:"expr"`
	For           time.Duration     `json:"for,omitempty"`
	KeepFiringFor time.Duration     `json:"keep_firing_for,omitempty"`
	Annotations   map[string]string `json:"annotations"`
	Labels        map[string]string `json:"labels"`
}

PrometheusRule represents a single alerting rule in Prometheus format.

type PrometheusRuleApiVersion added in v1.9.0

type PrometheusRuleApiVersion string

PrometheusRuleApiVersion API version of the PrometheusRule CRD.

const (
	MonitoringCoreosComv1 PrometheusRuleApiVersion = "monitoring.coreos.com/v1"
)

Defines values for PrometheusRuleApiVersion.

type PrometheusRuleDefinition added in v1.9.0

type PrometheusRuleDefinition struct {
	// Alert Name of the alert for an alerting rule.
	// Mutually exclusive with `record`.
	Alert *string `json:"alert,omitempty"`

	// Annotations Annotations to attach to alerts. Only applicable to alerting rules.
	// Commonly used keys include `summary` and `description`.
	//
	// Dash0 also recognizes:
	// - `dash0.com/notification-channel-ids`: Comma-separated list of notification channel UUIDs to notify when the alert fires.
	Annotations *map[string]string `json:"annotations,omitempty"`

	// Expr PromQL expression to evaluate.
	//
	// For **recording rules**, the expression must satisfy these constraints
	// (alerting rules are not subject to them):
	// - **Maximum query window**: the longest matrix-selector range (or subquery
	//   range, plus `lookbackDelta`) may not exceed 30 days + 15 minutes.
	// - **Minimum evaluation interval** depends on the query window — see the
	//   band table on the group's `interval` field, including the RR-over-RR carve-out.
	// - **At most 7 distinct metric names** may be referenced (only enforced when
	//   the query window exceeds 1h+10m).
	// - **Each matrix selector** must be bounded — at least one non-`__name__`
	//   label matcher, an enclosing range function (`rate`, `*_over_time`, …),
	//   an enclosing `by`/`without` aggregation, or the inner metric must itself
	//   be an active recording-rule output in the same (organization, dataset).
	// - **At most 10 `or` arms** (only enforced when the query window exceeds 1h+10m).
	// - **Self-reference is rejected**: the rule's own `record` may not appear
	//   in its own expression.
	// - **Vector matching must resolve to a clean, aligned match**: a binary
	//   operation matched with `on()` and an empty label set is rejected when the
	//   one-side operand is not statically a single series (an unaggregated selector
	//   there fails at evaluation with a duplicate-series error). Aggregate the
	//   one-side to a single series (e.g. `sum(...)`) or match on explicit labels
	//   with `on(<labels>)`.
	Expr string `json:"expr"`

	// For Duration for which the expression must be continuously satisfied before an alert fires.
	// Only applicable to alerting rules (e.g., "5m", "10m").
	For *string `json:"for,omitempty"`

	// KeepFiringFor Duration for which an alert continues firing after the expression is no longer satisfied.
	// Only applicable to alerting rules (e.g., "5m").
	KeepFiringFor *string `json:"keep_firing_for,omitempty"`

	// Labels Additional labels to attach to the resulting metrics or alerts.
	Labels *map[string]string `json:"labels,omitempty"`

	// Record Name of the output metric for a recording rule. Must be a valid Prometheus metric name.
	// Mutually exclusive with `alert`.
	Record *string `json:"record,omitempty"`
}

PrometheusRuleDefinition An individual rule within a group. A rule is either a recording rule (has `record`) or an alerting rule (has `alert`). Exactly one of `record` or `alert` must be set.

Recording rules pre-compute a PromQL expression and store the result as a new metric. Alerting rules evaluate a PromQL expression and fire alerts when the result is non-empty.

type PrometheusRuleGroup added in v1.9.0

type PrometheusRuleGroup struct {
	// Interval Evaluation interval for all rules in the group.
	// Applies to every rule in the group; individual rules cannot override it.
	// Defaults to "1m" if not specified.
	//
	// For **recording rules**, the minimum interval depends on the longest
	// matrix-selector range in the rule's PromQL expression (the "query window"):
	//
	// | Query window           | Minimum interval                                                     |
	// |------------------------|----------------------------------------------------------------------|
	// | ≤ 1h+10m               | 1m (absolute floor)                                                  |
	// | (1h+10m, 8h+10m]       | 5m                                                                   |
	// | (8h+10m, 24h+10m]      | 10m — relaxed to **5m** for RR-over-RR                               |
	// | (24h+10m, 30d+15m]     | 1h — relaxed to **5m** for RR-over-RR                                |
	// | > 30d+15m              | rejected                                                             |
	//
	// "RR-over-RR" means every metric referenced by the recording rule's
	// expression is itself an active recording-rule output in the same
	// (organization, dataset). In that case the relaxed 5m floor applies for
	// query windows above 8h+10m — the inner recording rule's own validation
	// already bounded the per-eval cost.
	//
	// Alerting rules are not subject to these interval constraints.
	Interval *string `json:"interval,omitempty"`

	// Labels Labels to apply to all rules in the group. These are merged with rule-level labels;
	// rule-level labels take precedence in case of conflict.
	Labels *map[string]string `json:"labels,omitempty"`

	// Name Display name for the rule group.
	Name string `json:"name"`

	// QueryOffset Shifts the timestamp at which rules in the group query their data backwards
	// by this duration (e.g. "5m"). Output series points are stamped at the shifted
	// moment, allowing late-arriving data to settle before being counted.
	// Maximum 1h. Defaults to 0 if omitted (no shift).
	QueryOffset *string `json:"query_offset,omitempty"`

	// Rules List of rules in this group.
	Rules []PrometheusRuleDefinition `json:"rules"`
}

PrometheusRuleGroup A group of rules evaluated together at a common interval. Follows the Prometheus rule group concept (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/).

Note: The upstream RuleGroup fields `partial_response_strategy` and `limit` are intentionally omitted as they are not supported by the Dash0 evaluation engine.

Caveat for synthetic metrics: when a rule reads from a synthetic metric (one computed on demand from underlying signals at query time, rather than pre-computed during ingestion), evaluation near the leading edge of available data may under-count, since late-arriving signals may not yet have been processed. Two rules within the same group can therefore disagree even when their queries share a strict subset/superset relationship — a ratio of the two values may briefly exceed 1.0 at some timestamps. Use `query_offset` to delay evaluation enough for the underlying data to settle.

type PrometheusRuleKind added in v1.9.0

type PrometheusRuleKind string

PrometheusRuleKind Kind of the PrometheusRule CRD.

const (
	PrometheusRuleKindPrometheusRule PrometheusRuleKind = "PrometheusRule"
)

Defines values for PrometheusRuleKind.

type PrometheusRuleMetadata added in v1.9.0

type PrometheusRuleMetadata struct {
	// Annotations Key-value annotations for the resource. Dash0 recognizes the following annotations:
	//
	// - `dash0.com/enabled`: Set to "false" to disable evaluation. Defaults to "true" when absent.
	// - `dash0.com/folder-path`: UI folder path for organising resources (e.g., "/infrastructure/hosts"). Nesting is expressed with "/" separators.
	// - `dash0.com/sharing`: Comma-separated list of principals to grant read access to. Supported formats: "team:<team_id>" and "user:<email>". Honored only on rules that declare a dash0.com/origin (for example those managed by Terraform, the operator, the CLI, or the API); setting it on a rule that declares no dash0.com/origin is rejected with a 400.
	// - `dash0.com/created-at`: Creation timestamp (read-only, server-set).
	// - `dash0.com/updated-at`: Last update timestamp (read-only, server-set).
	// - `dash0.com/deleted-at`: Soft-delete timestamp (read-only, server-set).
	// - `dash0.com/first-evaluation-at`: First evaluation timestamp (recording rules only, read-only, server-set).
	// - `dash0.com/runtime-disabled-at`: Timestamp when the recorder took the group out of evaluation because a rule was too expensive (it exceeded the query sample limit). Recording rules only, read-only, server-set. Independent of `dash0.com/enabled`. Cleared only when a cost-determining field changes (the rules or the interval) — a `dash0.com/enabled` toggle, a cosmetic edit, or a blind re-apply of the identical manifest does not re-enable the group.
	// - `dash0.com/runtime-disabled-reason`: Why the recorder runtime-disabled the group (currently only "max_samples"). Recording rules only, read-only, server-set.
	Annotations *map[string]string `json:"annotations,omitempty"`

	// Labels Key-value labels for the resource. Dash0 recognizes the following labels:
	//
	// - `dash0.com/id`: Internal ID (read-only, server-set).
	// - `dash0.com/origin`: External identifier for API-managed resources.
	// - `dash0.com/version`: Version for optimistic concurrency (required on update, server-set on create).
	// - `dash0.com/dataset`: Dataset this resource belongs to (defaults to the default dataset).
	// - `dash0.com/source`: Origin source — "ui", "terraform", "operator", "dash0-cli", "platform", or "api" (read-only, derived from origin).
	Labels *map[string]string `json:"labels,omitempty"`

	// Name Resource name.
	Name string `json:"name"`
}

PrometheusRuleMetadata Metadata for the PrometheusRule resource, following Kubernetes metadata conventions.

type PrometheusRuleSpec added in v1.9.0

type PrometheusRuleSpec struct {
	// Groups Rule groups. Each group is evaluated independently at its own interval.
	// Unlike the upstream PrometheusRule CRD, this field is required and must contain exactly one group.
	Groups []PrometheusRuleGroup `json:"groups"`
}

PrometheusRuleSpec Spec of the PrometheusRule resource containing rule groups.

type PrometheusRules added in v1.6.0

type PrometheusRules struct {
	APIVersion string                  `json:"apiVersion"`
	Kind       string                  `json:"kind"`
	Metadata   PrometheusRulesMetadata `json:"metadata"`
	Spec       PrometheusRulesSpec     `json:"spec"`
}

PrometheusRules represents the Kubernetes Prometheus Operator PrometheusRule CRD document. This is the user-facing format used by the Terraform provider and Kubernetes operator.

type PrometheusRulesGroup added in v1.6.0

type PrometheusRulesGroup struct {
	Name     string           `json:"name"`
	Interval time.Duration    `json:"interval,omitempty"`
	Rules    []PrometheusRule `json:"rules"`
}

PrometheusRulesGroup represents a single rule group in Prometheus format.

type PrometheusRulesMetadata added in v1.6.0

type PrometheusRulesMetadata struct {
	Name        string            `json:"name,omitempty"`
	Namespace   string            `json:"namespace,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	Annotations map[string]string `json:"annotations,omitempty"`
}

PrometheusRulesMetadata contains Kubernetes-style metadata for a PrometheusRules document.

type PrometheusRulesSpec added in v1.6.0

type PrometheusRulesSpec struct {
	Groups []PrometheusRulesGroup `json:"groups"`
}

PrometheusRulesSpec contains the groups of rules.

type PrometheusRuntimeInfo added in v1.13.1

type PrometheusRuntimeInfo struct {
	// CWD Not exposed by Dash0; always empty.
	CWD *string `json:"CWD,omitempty"`

	// GODEBUG Not exposed by Dash0; always empty.
	GODEBUG *string `json:"GODEBUG,omitempty"`

	// GOGC Not exposed by Dash0; always empty.
	GOGC *string `json:"GOGC,omitempty"`

	// GOMAXPROCS Not exposed by Dash0; always 0.
	GOMAXPROCS *int `json:"GOMAXPROCS,omitempty"`

	// GOMEMLIMIT Not exposed by Dash0; always 0.
	GOMEMLIMIT *int64 `json:"GOMEMLIMIT,omitempty"`

	// CorruptionCount Not exposed by Dash0; always 0.
	CorruptionCount *int64 `json:"corruptionCount,omitempty"`

	// GoroutineCount Not exposed by Dash0; always 0.
	GoroutineCount *int `json:"goroutineCount,omitempty"`

	// Hostname Not exposed by Dash0; always empty.
	Hostname *string `json:"hostname,omitempty"`

	// LastConfigTime Not exposed by Dash0; always the zero time.
	LastConfigTime *time.Time `json:"lastConfigTime,omitempty"`

	// ReloadConfigSuccess Always `true`.
	ReloadConfigSuccess *bool `json:"reloadConfigSuccess,omitempty"`

	// ServerTime Not exposed by Dash0; always the zero time.
	ServerTime *time.Time `json:"serverTime,omitempty"`

	// StartTime Not exposed by Dash0; always the zero time.
	StartTime *time.Time `json:"startTime,omitempty"`

	// StorageRetention The data retention period.
	StorageRetention *string `json:"storageRetention,omitempty"`
}

PrometheusRuntimeInfo Runtime information about the Prometheus-compatible server. Dash0 is not a single Prometheus process, so most of the upstream runtime fields are not applicable: only `reloadConfigSuccess` and `storageRetention` carry meaning. The remaining fields are retained for upstream API compatibility but are always empty/zero — Dash0 does not expose process, Go-runtime, or filesystem internals.

type PrometheusRuntimeInfoResponse added in v1.13.1

type PrometheusRuntimeInfoResponse struct {
	// Data Runtime information about the Prometheus-compatible server. Dash0 is not a single
	// Prometheus process, so most of the upstream runtime fields are not applicable: only
	// `reloadConfigSuccess` and `storageRetention` carry meaning. The remaining fields are
	// retained for upstream API compatibility but are always empty/zero — Dash0 does not
	// expose process, Go-runtime, or filesystem internals.
	Data     *PrometheusRuntimeInfo `json:"data,omitempty"`
	Status   string                 `json:"status"`
	Warnings *[]string              `json:"warnings,omitempty"`
}

PrometheusRuntimeInfoResponse defines model for PrometheusRuntimeInfoResponse.

type PrometheusScalarResult added in v1.13.1

type PrometheusScalarResult = MetricSample

PrometheusScalarResult defines model for PrometheusScalarResult.

type PrometheusSeriesResponse added in v1.13.1

type PrometheusSeriesResponse struct {
	Data     *[]PrometheusMetric `json:"data,omitempty"`
	Status   string              `json:"status"`
	Warnings *[]string           `json:"warnings,omitempty"`
}

PrometheusSeriesResponse defines model for PrometheusSeriesResponse.

type PrometheusStringResult added in v1.13.1

type PrometheusStringResult = MetricSample

PrometheusStringResult defines model for PrometheusStringResult.

type PrometheusVectorResult added in v1.13.1

type PrometheusVectorResult = []PrometheusVectorSampleResult

PrometheusVectorResult defines model for PrometheusVectorResult.

type PrometheusVectorSampleResult added in v1.13.1

type PrometheusVectorSampleResult struct {
	Metric PrometheusMetric `json:"metric"`
	Value  MetricSample     `json:"value"`
}

PrometheusVectorSampleResult defines model for PrometheusVectorSampleResult.

type PutApiAgenticWorkflowsOriginOrIdJSONRequestBody added in v1.17.0

type PutApiAgenticWorkflowsOriginOrIdJSONRequestBody = AgenticWorkflowResponse

PutApiAgenticWorkflowsOriginOrIdJSONRequestBody defines body for PutApiAgenticWorkflowsOriginOrId for application/json ContentType.

type PutApiAgenticWorkflowsOriginOrIdParams added in v1.17.0

type PutApiAgenticWorkflowsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiAgenticWorkflowsOriginOrIdParams defines parameters for PutApiAgenticWorkflowsOriginOrId.

type PutApiAgenticWorkflowsOriginOrIdResponse added in v1.17.0

type PutApiAgenticWorkflowsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AgenticWorkflowResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePutApiAgenticWorkflowsOriginOrIdResponse added in v1.17.0

func ParsePutApiAgenticWorkflowsOriginOrIdResponse(rsp *http.Response) (*PutApiAgenticWorkflowsOriginOrIdResponse, error)

ParsePutApiAgenticWorkflowsOriginOrIdResponse parses an HTTP response from a PutApiAgenticWorkflowsOriginOrIdWithResponse call

func (PutApiAgenticWorkflowsOriginOrIdResponse) Status added in v1.17.0

Status returns HTTPResponse.Status

func (PutApiAgenticWorkflowsOriginOrIdResponse) StatusCode added in v1.17.0

StatusCode returns HTTPResponse.StatusCode

type PutApiAlertingCheckRulesOriginOrIdJSONRequestBody

type PutApiAlertingCheckRulesOriginOrIdJSONRequestBody = PrometheusAlertRule

PutApiAlertingCheckRulesOriginOrIdJSONRequestBody defines body for PutApiAlertingCheckRulesOriginOrId for application/json ContentType.

type PutApiAlertingCheckRulesOriginOrIdParams

type PutApiAlertingCheckRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiAlertingCheckRulesOriginOrIdParams defines parameters for PutApiAlertingCheckRulesOriginOrId.

type PutApiAlertingCheckRulesOriginOrIdResponse

type PutApiAlertingCheckRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusAlertRule
	JSONDefault  *ErrorResponse
}

func ParsePutApiAlertingCheckRulesOriginOrIdResponse

func ParsePutApiAlertingCheckRulesOriginOrIdResponse(rsp *http.Response) (*PutApiAlertingCheckRulesOriginOrIdResponse, error)

ParsePutApiAlertingCheckRulesOriginOrIdResponse parses an HTTP response from a PutApiAlertingCheckRulesOriginOrIdWithResponse call

func (PutApiAlertingCheckRulesOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (PutApiAlertingCheckRulesOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PutApiDashboardsOriginOrIdJSONRequestBody

type PutApiDashboardsOriginOrIdJSONRequestBody = DashboardDefinition

PutApiDashboardsOriginOrIdJSONRequestBody defines body for PutApiDashboardsOriginOrId for application/json ContentType.

type PutApiDashboardsOriginOrIdParams

type PutApiDashboardsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiDashboardsOriginOrIdParams defines parameters for PutApiDashboardsOriginOrId.

type PutApiDashboardsOriginOrIdResponse

type PutApiDashboardsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DashboardDefinition
	JSONDefault  *ErrorResponse
}

func ParsePutApiDashboardsOriginOrIdResponse

func ParsePutApiDashboardsOriginOrIdResponse(rsp *http.Response) (*PutApiDashboardsOriginOrIdResponse, error)

ParsePutApiDashboardsOriginOrIdResponse parses an HTTP response from a PutApiDashboardsOriginOrIdWithResponse call

func (PutApiDashboardsOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (PutApiDashboardsOriginOrIdResponse) StatusCode

func (r PutApiDashboardsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutApiImportSignalToMetricsJSONRequestBody added in v1.12.3

type PutApiImportSignalToMetricsJSONRequestBody = SignalToMetricsBulkUpsertRequest

PutApiImportSignalToMetricsJSONRequestBody defines body for PutApiImportSignalToMetrics for application/json ContentType.

type PutApiImportSignalToMetricsParams added in v1.12.3

type PutApiImportSignalToMetricsParams struct {
	// Dataset The dataset to deploy rules into. Required to prevent accidental deployment to the wrong dataset.
	Dataset Dataset `form:"dataset" json:"dataset"`
}

PutApiImportSignalToMetricsParams defines parameters for PutApiImportSignalToMetrics.

type PutApiImportSignalToMetricsResponse added in v1.12.3

type PutApiImportSignalToMetricsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SignalToMetricsBulkUpsertResponse
	JSONDefault  *ErrorResponse
}

func ParsePutApiImportSignalToMetricsResponse added in v1.12.3

func ParsePutApiImportSignalToMetricsResponse(rsp *http.Response) (*PutApiImportSignalToMetricsResponse, error)

ParsePutApiImportSignalToMetricsResponse parses an HTTP response from a PutApiImportSignalToMetricsWithResponse call

func (PutApiImportSignalToMetricsResponse) Status added in v1.12.3

Status returns HTTPResponse.Status

func (PutApiImportSignalToMetricsResponse) StatusCode added in v1.12.3

StatusCode returns HTTPResponse.StatusCode

type PutApiNotificationChannelsOriginOrIdJSONRequestBody added in v1.9.0

type PutApiNotificationChannelsOriginOrIdJSONRequestBody = NotificationChannelDefinition

PutApiNotificationChannelsOriginOrIdJSONRequestBody defines body for PutApiNotificationChannelsOriginOrId for application/json ContentType.

type PutApiNotificationChannelsOriginOrIdResponse added in v1.9.0

type PutApiNotificationChannelsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NotificationChannelDefinition
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePutApiNotificationChannelsOriginOrIdResponse added in v1.9.0

func ParsePutApiNotificationChannelsOriginOrIdResponse(rsp *http.Response) (*PutApiNotificationChannelsOriginOrIdResponse, error)

ParsePutApiNotificationChannelsOriginOrIdResponse parses an HTTP response from a PutApiNotificationChannelsOriginOrIdWithResponse call

func (PutApiNotificationChannelsOriginOrIdResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (PutApiNotificationChannelsOriginOrIdResponse) StatusCode added in v1.9.0

StatusCode returns HTTPResponse.StatusCode

type PutApiRecordingRulesOriginOrIdJSONRequestBody added in v1.9.0

type PutApiRecordingRulesOriginOrIdJSONRequestBody = generatedPrometheusRule

PutApiRecordingRulesOriginOrIdJSONRequestBody defines body for PutApiRecordingRulesOriginOrId for application/json ContentType.

type PutApiRecordingRulesOriginOrIdParams added in v1.11.1

type PutApiRecordingRulesOriginOrIdParams struct {
	// Dataset Target dataset. Overrides dash0.com/dataset in metadata.labels if both are provided.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiRecordingRulesOriginOrIdParams defines parameters for PutApiRecordingRulesOriginOrId.

type PutApiRecordingRulesOriginOrIdResponse added in v1.9.0

type PutApiRecordingRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *generatedPrometheusRule
	JSONDefault  *ErrorResponse
}

func ParsePutApiRecordingRulesOriginOrIdResponse added in v1.9.0

func ParsePutApiRecordingRulesOriginOrIdResponse(rsp *http.Response) (*PutApiRecordingRulesOriginOrIdResponse, error)

ParsePutApiRecordingRulesOriginOrIdResponse parses an HTTP response from a PutApiRecordingRulesOriginOrIdWithResponse call

func (PutApiRecordingRulesOriginOrIdResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (PutApiRecordingRulesOriginOrIdResponse) StatusCode added in v1.9.0

StatusCode returns HTTPResponse.StatusCode

type PutApiSamplingRulesOriginOrIdJSONRequestBody added in v1.1.0

type PutApiSamplingRulesOriginOrIdJSONRequestBody = SamplingRuleResponse

PutApiSamplingRulesOriginOrIdJSONRequestBody defines body for PutApiSamplingRulesOriginOrId for application/json ContentType.

type PutApiSamplingRulesOriginOrIdParams added in v1.1.0

type PutApiSamplingRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiSamplingRulesOriginOrIdParams defines parameters for PutApiSamplingRulesOriginOrId.

type PutApiSamplingRulesOriginOrIdResponse added in v1.1.0

type PutApiSamplingRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SamplingRuleResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePutApiSamplingRulesOriginOrIdResponse added in v1.1.0

func ParsePutApiSamplingRulesOriginOrIdResponse(rsp *http.Response) (*PutApiSamplingRulesOriginOrIdResponse, error)

ParsePutApiSamplingRulesOriginOrIdResponse parses an HTTP response from a PutApiSamplingRulesOriginOrIdWithResponse call

func (PutApiSamplingRulesOriginOrIdResponse) Status added in v1.1.0

Status returns HTTPResponse.Status

func (PutApiSamplingRulesOriginOrIdResponse) StatusCode added in v1.1.0

StatusCode returns HTTPResponse.StatusCode

type PutApiSignalToMetricsOriginOrIdJSONRequestBody added in v1.9.0

type PutApiSignalToMetricsOriginOrIdJSONRequestBody = SignalToMetricsResponse

PutApiSignalToMetricsOriginOrIdJSONRequestBody defines body for PutApiSignalToMetricsOriginOrId for application/json ContentType.

type PutApiSignalToMetricsOriginOrIdParams added in v1.9.0

type PutApiSignalToMetricsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiSignalToMetricsOriginOrIdParams defines parameters for PutApiSignalToMetricsOriginOrId.

type PutApiSignalToMetricsOriginOrIdResponse added in v1.9.0

type PutApiSignalToMetricsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SignalToMetricsResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePutApiSignalToMetricsOriginOrIdResponse added in v1.9.0

func ParsePutApiSignalToMetricsOriginOrIdResponse(rsp *http.Response) (*PutApiSignalToMetricsOriginOrIdResponse, error)

ParsePutApiSignalToMetricsOriginOrIdResponse parses an HTTP response from a PutApiSignalToMetricsOriginOrIdWithResponse call

func (PutApiSignalToMetricsOriginOrIdResponse) Status added in v1.9.0

Status returns HTTPResponse.Status

func (PutApiSignalToMetricsOriginOrIdResponse) StatusCode added in v1.9.0

StatusCode returns HTTPResponse.StatusCode

type PutApiSlosOriginOrIdJSONRequestBody added in v1.14.0

type PutApiSlosOriginOrIdJSONRequestBody = SloDefinition

PutApiSlosOriginOrIdJSONRequestBody defines body for PutApiSlosOriginOrId for application/json ContentType.

type PutApiSlosOriginOrIdParams added in v1.14.0

type PutApiSlosOriginOrIdParams struct {
	// Dataset Target dataset. Overrides dash0.com/dataset in metadata.labels if both are provided.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiSlosOriginOrIdParams defines parameters for PutApiSlosOriginOrId.

type PutApiSlosOriginOrIdResponse added in v1.14.0

type PutApiSlosOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SloDefinition
	JSONDefault  *ErrorResponse
}

func ParsePutApiSlosOriginOrIdResponse added in v1.14.0

func ParsePutApiSlosOriginOrIdResponse(rsp *http.Response) (*PutApiSlosOriginOrIdResponse, error)

ParsePutApiSlosOriginOrIdResponse parses an HTTP response from a PutApiSlosOriginOrIdWithResponse call

func (PutApiSlosOriginOrIdResponse) Status added in v1.14.0

Status returns HTTPResponse.Status

func (PutApiSlosOriginOrIdResponse) StatusCode added in v1.14.0

func (r PutApiSlosOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutApiSpamFiltersOriginOrIdJSONRequestBody added in v1.12.0

type PutApiSpamFiltersOriginOrIdJSONRequestBody = SpamFilterResponse

PutApiSpamFiltersOriginOrIdJSONRequestBody defines body for PutApiSpamFiltersOriginOrId for application/json ContentType.

type PutApiSpamFiltersOriginOrIdParams added in v1.12.0

type PutApiSpamFiltersOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiSpamFiltersOriginOrIdParams defines parameters for PutApiSpamFiltersOriginOrId.

type PutApiSpamFiltersOriginOrIdResponse added in v1.12.0

type PutApiSpamFiltersOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SpamFilterResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePutApiSpamFiltersOriginOrIdResponse added in v1.12.0

func ParsePutApiSpamFiltersOriginOrIdResponse(rsp *http.Response) (*PutApiSpamFiltersOriginOrIdResponse, error)

ParsePutApiSpamFiltersOriginOrIdResponse parses an HTTP response from a PutApiSpamFiltersOriginOrIdWithResponse call

func (PutApiSpamFiltersOriginOrIdResponse) Status added in v1.12.0

Status returns HTTPResponse.Status

func (PutApiSpamFiltersOriginOrIdResponse) StatusCode added in v1.12.0

StatusCode returns HTTPResponse.StatusCode

type PutApiSyntheticChecksOriginOrIdJSONRequestBody

type PutApiSyntheticChecksOriginOrIdJSONRequestBody = SyntheticCheckDefinition

PutApiSyntheticChecksOriginOrIdJSONRequestBody defines body for PutApiSyntheticChecksOriginOrId for application/json ContentType.

type PutApiSyntheticChecksOriginOrIdParams

type PutApiSyntheticChecksOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiSyntheticChecksOriginOrIdParams defines parameters for PutApiSyntheticChecksOriginOrId.

type PutApiSyntheticChecksOriginOrIdResponse

type PutApiSyntheticChecksOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SyntheticCheckDefinition
	JSONDefault  *ErrorResponse
}

func ParsePutApiSyntheticChecksOriginOrIdResponse

func ParsePutApiSyntheticChecksOriginOrIdResponse(rsp *http.Response) (*PutApiSyntheticChecksOriginOrIdResponse, error)

ParsePutApiSyntheticChecksOriginOrIdResponse parses an HTTP response from a PutApiSyntheticChecksOriginOrIdWithResponse call

func (PutApiSyntheticChecksOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (PutApiSyntheticChecksOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PutApiTeamsOriginOrIdDisplayJSONRequestBody added in v1.4.0

type PutApiTeamsOriginOrIdDisplayJSONRequestBody = TeamDisplay

PutApiTeamsOriginOrIdDisplayJSONRequestBody defines body for PutApiTeamsOriginOrIdDisplay for application/json ContentType.

type PutApiTeamsOriginOrIdDisplayResponse added in v1.4.0

type PutApiTeamsOriginOrIdDisplayResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParsePutApiTeamsOriginOrIdDisplayResponse added in v1.4.0

func ParsePutApiTeamsOriginOrIdDisplayResponse(rsp *http.Response) (*PutApiTeamsOriginOrIdDisplayResponse, error)

ParsePutApiTeamsOriginOrIdDisplayResponse parses an HTTP response from a PutApiTeamsOriginOrIdDisplayWithResponse call

func (PutApiTeamsOriginOrIdDisplayResponse) Status added in v1.4.0

Status returns HTTPResponse.Status

func (PutApiTeamsOriginOrIdDisplayResponse) StatusCode added in v1.4.0

StatusCode returns HTTPResponse.StatusCode

type PutApiTeamsOriginOrIdJSONRequestBody added in v1.17.0

type PutApiTeamsOriginOrIdJSONRequestBody = TeamDefinitionV1Alpha1

PutApiTeamsOriginOrIdJSONRequestBody defines body for PutApiTeamsOriginOrId for application/json ContentType.

type PutApiTeamsOriginOrIdResponse added in v1.17.0

type PutApiTeamsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TeamDefinitionV1Alpha1
	JSONDefault  *ErrorResponse
}

func ParsePutApiTeamsOriginOrIdResponse added in v1.17.0

func ParsePutApiTeamsOriginOrIdResponse(rsp *http.Response) (*PutApiTeamsOriginOrIdResponse, error)

ParsePutApiTeamsOriginOrIdResponse parses an HTTP response from a PutApiTeamsOriginOrIdWithResponse call

func (PutApiTeamsOriginOrIdResponse) Status added in v1.17.0

Status returns HTTPResponse.Status

func (PutApiTeamsOriginOrIdResponse) StatusCode added in v1.17.0

func (r PutApiTeamsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutApiTimeSeriesAggregationsOriginOrIdJSONRequestBody added in v1.17.0

type PutApiTimeSeriesAggregationsOriginOrIdJSONRequestBody = TimeSeriesAggregationDefinition

PutApiTimeSeriesAggregationsOriginOrIdJSONRequestBody defines body for PutApiTimeSeriesAggregationsOriginOrId for application/json ContentType.

type PutApiTimeSeriesAggregationsOriginOrIdParams added in v1.17.0

type PutApiTimeSeriesAggregationsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiTimeSeriesAggregationsOriginOrIdParams defines parameters for PutApiTimeSeriesAggregationsOriginOrId.

type PutApiTimeSeriesAggregationsOriginOrIdResponse added in v1.17.0

type PutApiTimeSeriesAggregationsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TimeSeriesAggregationDefinition
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePutApiTimeSeriesAggregationsOriginOrIdResponse added in v1.17.0

func ParsePutApiTimeSeriesAggregationsOriginOrIdResponse(rsp *http.Response) (*PutApiTimeSeriesAggregationsOriginOrIdResponse, error)

ParsePutApiTimeSeriesAggregationsOriginOrIdResponse parses an HTTP response from a PutApiTimeSeriesAggregationsOriginOrIdWithResponse call

func (PutApiTimeSeriesAggregationsOriginOrIdResponse) Status added in v1.17.0

Status returns HTTPResponse.Status

func (PutApiTimeSeriesAggregationsOriginOrIdResponse) StatusCode added in v1.17.0

StatusCode returns HTTPResponse.StatusCode

type PutApiViewsOriginOrIdJSONRequestBody

type PutApiViewsOriginOrIdJSONRequestBody = ViewDefinition

PutApiViewsOriginOrIdJSONRequestBody defines body for PutApiViewsOriginOrId for application/json ContentType.

type PutApiViewsOriginOrIdParams

type PutApiViewsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiViewsOriginOrIdParams defines parameters for PutApiViewsOriginOrId.

type PutApiViewsOriginOrIdResponse

type PutApiViewsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ViewDefinition
	JSONDefault  *ErrorResponse
}

func ParsePutApiViewsOriginOrIdResponse

func ParsePutApiViewsOriginOrIdResponse(rsp *http.Response) (*PutApiViewsOriginOrIdResponse, error)

ParsePutApiViewsOriginOrIdResponse parses an HTTP response from a PutApiViewsOriginOrIdWithResponse call

func (PutApiViewsOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (PutApiViewsOriginOrIdResponse) StatusCode

func (r PutApiViewsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type QueryError added in v1.9.0

type QueryError struct {
	// CorrectedQuery Validated and formatted corrected SQL query. Only present when an AI-suggested correction is available and passes validation.
	CorrectedQuery *string `json:"correctedQuery,omitempty"`

	// Description Human-readable explanation of what went wrong and how to fix it. May contain markdown (inline code, bold, lists).
	Description string `json:"description"`

	// Title Short error title in plain text (no markdown), e.g. Syntax error - Invalid LIMIT clause
	Title string `json:"title"`
}

QueryError Structured error information for query errors. Present alongside the error string when the error is related to the user's query (syntax, semantic, or execution errors). Not present for system-level errors (unauthorized access, unexpected failures).

type RecordingRule added in v1.6.0

type RecordingRule = generatedPrometheusRule

RecordingRule is a PrometheusRule CRD document containing recording rule groups.

type RefreshingAuthTokenProvider added in v1.21.0

type RefreshingAuthTokenProvider interface {
	AuthTokenProvider

	// ForceRefreshAuthToken returns a token to replace staleAuthToken, which the
	// server has just rejected.
	//
	// staleAuthToken lets an implementation tell "nobody has replaced this yet,
	// mint a new one" from "a concurrent caller already replaced it, hand that
	// result back". Without it, a single revocation 401s every request in
	// flight and each one mints again; for an OAuth provider that means one
	// refresh-token rotation per in-flight request, and every extra rotation is
	// another chance to land on invalid_grant and force an interactive login.
	//
	// Returning staleAuthToken unchanged is allowed and signals that no fresher
	// credential is available.
	ForceRefreshAuthToken(ctx context.Context, staleAuthToken string) (string, error)
}

RefreshingAuthTokenProvider is an AuthTokenProvider that can discard its current token and mint a replacement on demand.

The client calls RefreshingAuthTokenProvider.ForceRefreshAuthToken after a request comes back 401, which recovers from a token the server stopped accepting earlier than its stated expiry — clock skew between the client and the authorization server, or a revocation performed elsewhere. Providers that hold an immutable token (see StaticAuthTokenProvider) do not implement this interface, and the client then surfaces the 401 unchanged.

type RelativeTime

type RelativeTime = string

RelativeTime A relative time reference based on the current time ("now").

**Format**: `now[+/-duration]`

**Examples**: - `now` - current time - `now-30m` - 30 minutes ago - `now-1h` - 1 hour ago - `now-1d` - 1 day ago

**Duration Units**: - `s` - seconds - `m` - minutes - `h` - hours - `d` - days - `w` - weeks - `M` - months

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type Resource

type Resource struct {
	Attributes             []KeyValue                      `json:"attributes"`
	Clouds                 *ResourceClouds                 `json:"clouds,omitempty"`
	DeploymentEnvironments *ResourceDeploymentEnvironments `json:"deploymentEnvironments,omitempty"`
	DroppedAttributesCount *int64                          `json:"droppedAttributesCount,omitempty"`

	// FirstSeenUnixNano The property is only included when `includeOTLPSchemaExtensions` is `true`.
	FirstSeenUnixNano *string            `json:"firstSeenUnixNano,omitempty"`
	Languages         *ResourceLanguages `json:"languages,omitempty"`

	// LastSeenUnixNano The property is only included when `includeOTLPSchemaExtensions` is `true`.
	LastSeenUnixNano *string `json:"lastSeenUnixNano,omitempty"`

	// OperationTypes The property is only included when `includeOTLPSchemaExtensions` is `true`.
	OperationTypes *[]string               `json:"operationTypes,omitempty"`
	Orchestrations *ResourceOrchestrations `json:"orchestrations,omitempty"`
}

Resource defines model for Resource.

type ResourceCloud

type ResourceCloud = string

ResourceCloud Resource cloud identified based on the `cloud.provider` resource attribute. Some sample values: - alibaba_cloud - aws - azure - gcp - heroku - ibm_cloud - tencent_cloud

type ResourceClouds

type ResourceClouds = []ResourceCloud

ResourceClouds defines model for ResourceClouds.

type ResourceDeploymentEnvironment

type ResourceDeploymentEnvironment = string

ResourceDeploymentEnvironment The value of the `deployment.environment.name` (or `deployment.environment` pre v1.27 semconvs)

type ResourceDeploymentEnvironments

type ResourceDeploymentEnvironments = []ResourceDeploymentEnvironment

ResourceDeploymentEnvironments defines model for ResourceDeploymentEnvironments.

type ResourceLanguage

type ResourceLanguage = string

ResourceLanguage Resource language identified based on the `telemetry.sdk.language` resource attribute. Some sample values: - cpp - dotnet - erlang - go - java - nodejs - php - python - ruby - rust - swift - webjs

type ResourceLanguages

type ResourceLanguages = []ResourceLanguage

ResourceLanguages defines model for ResourceLanguages.

type ResourceLogs

type ResourceLogs struct {
	Resource  Resource    `json:"resource"`
	SchemaUrl *string     `json:"schemaUrl,omitempty"`
	ScopeLogs []ScopeLogs `json:"scopeLogs"`
}

ResourceLogs defines model for ResourceLogs.

type ResourceOrchestration

type ResourceOrchestration string

ResourceOrchestration Resource orchestration identified based on orchestration related resource attributes, e.g., existence of `k8s.*` resource attribute.

const (
	Kubernetes ResourceOrchestration = "kubernetes"
)

Defines values for ResourceOrchestration.

type ResourceOrchestrations

type ResourceOrchestrations = []ResourceOrchestration

ResourceOrchestrations defines model for ResourceOrchestrations.

type ResourceSpans

type ResourceSpans struct {
	Resource   Resource     `json:"resource"`
	SchemaUrl  *string      `json:"schemaUrl,omitempty"`
	ScopeSpans []ScopeSpans `json:"scopeSpans"`
}

ResourceSpans defines model for ResourceSpans.

type RespectNativeCodingAgentTelemetry added in v1.21.0

type RespectNativeCodingAgentTelemetry string

RespectNativeCodingAgentTelemetry Controls whether OpenTelemetry telemetry natively emitted by coding agents (e.g. Claude Code) is processed by Darkplane.

- `disabled`: Native coding-agent telemetry is not processed by Darkplane. - `enabled`: Native coding-agent telemetry is processed by Darkplane.

const (
	RespectNativeCodingAgentTelemetryDisabled RespectNativeCodingAgentTelemetry = "disabled"
	RespectNativeCodingAgentTelemetryEnabled  RespectNativeCodingAgentTelemetry = "enabled"
)

Defines values for RespectNativeCodingAgentTelemetry.

type ResultRow added in v1.6.0

type ResultRow struct {
	Values []KeyValue `json:"values"`
}

ResultRow defines model for ResultRow.

type ResultRows added in v1.6.0

type ResultRows = []ResultRow

ResultRows defines model for ResultRows.

type RetentionClass added in v1.12.3

type RetentionClass string

RetentionClass The retention class selected for a signal, per dataset. The value is the total retention in days, not an increase on top of a baseline. Customer-selectable signals (logs, spans, web events) expose the full set; non-selectable signals (metrics, profiling) keep their platform defaults.

- `30d`: 30 days total (the included baseline). - `60d`: 60 days total. - `90d`: 90 days total. - `120d`: 120 days total. - `210d`: 210 days total. - `390d`: 390 days total.

const (
	N120d RetentionClass = "120d"
	N210d RetentionClass = "210d"
	N30d  RetentionClass = "30d"
	N390d RetentionClass = "390d"
	N60d  RetentionClass = "60d"
	N90d  RetentionClass = "90d"
)

Defines values for RetentionClass.

type Sampling

type Sampling struct {
	Mode SamplingMode `json:"mode"`

	// TimeRange A range of time between two time references.
	TimeRange TimeReferenceRange `json:"timeRange"`
}

Sampling defines model for Sampling.

type SamplingCondition added in v1.1.0

type SamplingCondition struct {
	// contains filtered or unexported fields
}

SamplingCondition defines model for SamplingCondition.

func (SamplingCondition) AsSamplingConditionAnd added in v1.1.0

func (t SamplingCondition) AsSamplingConditionAnd() (SamplingConditionAnd, error)

AsSamplingConditionAnd returns the union data inside the SamplingCondition as a SamplingConditionAnd

func (SamplingCondition) AsSamplingConditionError added in v1.1.0

func (t SamplingCondition) AsSamplingConditionError() (SamplingConditionError, error)

AsSamplingConditionError returns the union data inside the SamplingCondition as a SamplingConditionError

func (SamplingCondition) AsSamplingConditionOttl added in v1.1.0

func (t SamplingCondition) AsSamplingConditionOttl() (SamplingConditionOttl, error)

AsSamplingConditionOttl returns the union data inside the SamplingCondition as a SamplingConditionOttl

func (SamplingCondition) AsSamplingConditionProbabilistic added in v1.1.0

func (t SamplingCondition) AsSamplingConditionProbabilistic() (SamplingConditionProbabilistic, error)

AsSamplingConditionProbabilistic returns the union data inside the SamplingCondition as a SamplingConditionProbabilistic

func (*SamplingCondition) FromSamplingConditionAnd added in v1.1.0

func (t *SamplingCondition) FromSamplingConditionAnd(v SamplingConditionAnd) error

FromSamplingConditionAnd overwrites any union data inside the SamplingCondition as the provided SamplingConditionAnd

func (*SamplingCondition) FromSamplingConditionError added in v1.1.0

func (t *SamplingCondition) FromSamplingConditionError(v SamplingConditionError) error

FromSamplingConditionError overwrites any union data inside the SamplingCondition as the provided SamplingConditionError

func (*SamplingCondition) FromSamplingConditionOttl added in v1.1.0

func (t *SamplingCondition) FromSamplingConditionOttl(v SamplingConditionOttl) error

FromSamplingConditionOttl overwrites any union data inside the SamplingCondition as the provided SamplingConditionOttl

func (*SamplingCondition) FromSamplingConditionProbabilistic added in v1.1.0

func (t *SamplingCondition) FromSamplingConditionProbabilistic(v SamplingConditionProbabilistic) error

FromSamplingConditionProbabilistic overwrites any union data inside the SamplingCondition as the provided SamplingConditionProbabilistic

func (SamplingCondition) MarshalJSON added in v1.1.0

func (t SamplingCondition) MarshalJSON() ([]byte, error)

func (*SamplingCondition) MergeSamplingConditionAnd added in v1.1.0

func (t *SamplingCondition) MergeSamplingConditionAnd(v SamplingConditionAnd) error

MergeSamplingConditionAnd performs a merge with any union data inside the SamplingCondition, using the provided SamplingConditionAnd

func (*SamplingCondition) MergeSamplingConditionError added in v1.1.0

func (t *SamplingCondition) MergeSamplingConditionError(v SamplingConditionError) error

MergeSamplingConditionError performs a merge with any union data inside the SamplingCondition, using the provided SamplingConditionError

func (*SamplingCondition) MergeSamplingConditionOttl added in v1.1.0

func (t *SamplingCondition) MergeSamplingConditionOttl(v SamplingConditionOttl) error

MergeSamplingConditionOttl performs a merge with any union data inside the SamplingCondition, using the provided SamplingConditionOttl

func (*SamplingCondition) MergeSamplingConditionProbabilistic added in v1.1.0

func (t *SamplingCondition) MergeSamplingConditionProbabilistic(v SamplingConditionProbabilistic) error

MergeSamplingConditionProbabilistic performs a merge with any union data inside the SamplingCondition, using the provided SamplingConditionProbabilistic

func (*SamplingCondition) UnmarshalJSON added in v1.1.0

func (t *SamplingCondition) UnmarshalJSON(b []byte) error

type SamplingConditionAnd added in v1.1.0

type SamplingConditionAnd struct {
	Kind SamplingConditionAndKind `json:"kind"`
	Spec SamplingConditionAndSpec `json:"spec"`
}

SamplingConditionAnd defines model for SamplingConditionAnd.

type SamplingConditionAndKind added in v1.1.0

type SamplingConditionAndKind string

SamplingConditionAndKind defines model for SamplingConditionAnd.Kind.

const (
	And SamplingConditionAndKind = "and"
)

Defines values for SamplingConditionAndKind.

type SamplingConditionAndSpec added in v1.1.0

type SamplingConditionAndSpec struct {
	Conditions []SamplingCondition `json:"conditions"`
}

SamplingConditionAndSpec defines model for SamplingConditionAndSpec.

type SamplingConditionError added in v1.1.0

type SamplingConditionError struct {
	Kind SamplingConditionErrorKind `json:"kind"`
	Spec SamplingConditionErrorSpec `json:"spec"`
}

SamplingConditionError Matches spans that have the have `otel.span.status.code=ERROR`

type SamplingConditionErrorKind added in v1.1.0

type SamplingConditionErrorKind string

SamplingConditionErrorKind defines model for SamplingConditionError.Kind.

const (
	SamplingConditionErrorKindError SamplingConditionErrorKind = "error"
)

Defines values for SamplingConditionErrorKind.

type SamplingConditionErrorSpec added in v1.1.0

type SamplingConditionErrorSpec = interface{}

SamplingConditionErrorSpec defines model for SamplingConditionErrorSpec.

type SamplingConditionOttl added in v1.1.0

type SamplingConditionOttl struct {
	Kind SamplingConditionOttlKind `json:"kind"`
	Spec SamplingConditionOttlSpec `json:"spec"`
}

SamplingConditionOttl defines model for SamplingConditionOttl.

type SamplingConditionOttlKind added in v1.1.0

type SamplingConditionOttlKind string

SamplingConditionOttlKind defines model for SamplingConditionOttl.Kind.

const (
	Ottl SamplingConditionOttlKind = "ottl"
)

Defines values for SamplingConditionOttlKind.

type SamplingConditionOttlSpec added in v1.1.0

type SamplingConditionOttlSpec struct {
	Ottl string `json:"ottl"`
}

SamplingConditionOttlSpec defines model for SamplingConditionOttlSpec.

type SamplingConditionProbabilistic added in v1.1.0

type SamplingConditionProbabilistic struct {
	Kind SamplingConditionProbabilisticKind `json:"kind"`
	Spec SamplingConditionProbabilisticSpec `json:"spec"`
}

SamplingConditionProbabilistic defines model for SamplingConditionProbabilistic.

type SamplingConditionProbabilisticKind added in v1.1.0

type SamplingConditionProbabilisticKind string

SamplingConditionProbabilisticKind defines model for SamplingConditionProbabilistic.Kind.

const (
	Probabilistic SamplingConditionProbabilisticKind = "probabilistic"
)

Defines values for SamplingConditionProbabilisticKind.

type SamplingConditionProbabilisticSpec added in v1.1.0

type SamplingConditionProbabilisticSpec struct {
	// Rate A value between 0 and 1 reflecting the percentage of traces that should be sampled probabilistically.
	// This sampling decision is made deterministically by inspecting the trace ID.
	Rate float32 `json:"rate"`
}

SamplingConditionProbabilisticSpec defines model for SamplingConditionProbabilisticSpec.

type SamplingDefinition added in v1.1.0

type SamplingDefinition struct {
	Kind     SamplingDefinitionKind `json:"kind"`
	Metadata SamplingMetadata       `json:"metadata"`
	Spec     SamplingSpec           `json:"spec"`
}

SamplingDefinition defines model for SamplingDefinition.

type SamplingDefinitionKind added in v1.1.0

type SamplingDefinitionKind string

SamplingDefinitionKind defines model for SamplingDefinition.Kind.

const (
	Dash0Sampling SamplingDefinitionKind = "Dash0Sampling"
)

Defines values for SamplingDefinitionKind.

type SamplingDisplay added in v1.1.0

type SamplingDisplay struct {
	// Name Short-form name for the view to be shown prominently within the view list and atop
	// the screen when the view is selected.
	Name string `json:"name"`
}

SamplingDisplay defines model for SamplingDisplay.

type SamplingLabels added in v1.1.0

type SamplingLabels struct {
	Custom          *map[string]string `json:"custom,omitempty"`
	Dash0Comdataset *string            `json:"dash0.com/dataset,omitempty"`
	Dash0Comid      *string            `json:"dash0.com/id,omitempty"`
	Dash0Comorigin  *string            `json:"dash0.com/origin,omitempty"`

	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource  *CrdSource `json:"dash0.com/source,omitempty"`
	Dash0Comversion *string    `json:"dash0.com/version,omitempty"`
}

SamplingLabels defines model for SamplingLabels.

type SamplingMetadata added in v1.1.0

type SamplingMetadata struct {
	Labels *SamplingLabels `json:"labels,omitempty"`
	Name   string          `json:"name"`
}

SamplingMetadata defines model for SamplingMetadata.

type SamplingMode

type SamplingMode string

SamplingMode defines model for SamplingMode.

const (
	SamplingModeAdaptive SamplingMode = "adaptive"
	SamplingModeDisabled SamplingMode = "disabled"
)

Defines values for SamplingMode.

type SamplingRateLimit added in v1.1.0

type SamplingRateLimit struct {
	// Rate The maximum number of traces per minute that should be allowed for this sampling rule. Dash0 will make every
	// effort not to exceed this rate. However, there is also no guarantee that Dash0 will match exactly this rate.
	// Dash0 is attempting to hit a rate that is lower than or equal to the configured rate.
	//
	// Dash0 cannot guarantee that very low rate limits (<=16) are upheld.
	Rate int `json:"rate"`
}

SamplingRateLimit Rate limit is helpful to avoid ingesting extremely large amounts of spans when the sampling conditions are triggering much more frequently than expected. For example, when the tail sampling rule is configured to match every error, then a system-wide outage can result in a huge amount of spans being ingested.

Note: Probabilistic-only sampling rules do not support rate limiting.

type SamplingRuleCreateRequest added in v1.1.0

type SamplingRuleCreateRequest = SamplingDefinition

SamplingRuleCreateRequest defines model for SamplingRuleCreateRequest.

type SamplingRuleResponse added in v1.1.0

type SamplingRuleResponse = SamplingDefinition

SamplingRuleResponse defines model for SamplingRuleResponse.

type SamplingSpec added in v1.1.0

type SamplingSpec struct {
	Conditions SamplingCondition `json:"conditions"`
	Display    *SamplingDisplay  `json:"display,omitempty"`
	Enabled    bool              `json:"enabled"`

	// RateLimit Rate limit is helpful to avoid ingesting extremely large amounts of spans when the sampling conditions are
	// triggering much more frequently than expected. For example, when the tail sampling rule is configured to match
	// every error, then a system-wide outage can result in a huge amount of spans being ingested.
	//
	// Note: Probabilistic-only sampling rules do not support rate limiting.
	RateLimit *SamplingRateLimit `json:"rateLimit,omitempty"`
}

SamplingSpec defines model for SamplingSpec.

type ScheduleTriggerVariableName added in v1.17.0

type ScheduleTriggerVariableName string

ScheduleTriggerVariableName Variables provided by the `schedule` trigger.

- `cron`: The cron expression that fired.

const (
	Cron ScheduleTriggerVariableName = "cron"
)

Defines values for ScheduleTriggerVariableName.

type ScheduledAgenticWorkflowTrigger added in v1.17.0

type ScheduledAgenticWorkflowTrigger struct {
	Kind ScheduledAgenticWorkflowTriggerKind `json:"kind"`
	Spec ScheduledAgenticWorkflowTriggerSpec `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

ScheduledAgenticWorkflowTrigger defines model for ScheduledAgenticWorkflowTrigger.

type ScheduledAgenticWorkflowTriggerKind added in v1.17.0

type ScheduledAgenticWorkflowTriggerKind string

ScheduledAgenticWorkflowTriggerKind defines model for ScheduledAgenticWorkflowTrigger.Kind.

const (
	ScheduledAgenticWorkflowTriggerKindFailedCheckNew                 ScheduledAgenticWorkflowTriggerKind = "failed_check.new"
	ScheduledAgenticWorkflowTriggerKindGithubDeployment               ScheduledAgenticWorkflowTriggerKind = "github.deployment"
	ScheduledAgenticWorkflowTriggerKindGithubDeploymentStatus         ScheduledAgenticWorkflowTriggerKind = "github.deployment_status"
	ScheduledAgenticWorkflowTriggerKindGithubIssueComment             ScheduledAgenticWorkflowTriggerKind = "github.issue_comment"
	ScheduledAgenticWorkflowTriggerKindGithubPullRequest              ScheduledAgenticWorkflowTriggerKind = "github.pull_request"
	ScheduledAgenticWorkflowTriggerKindGithubPullRequestReview        ScheduledAgenticWorkflowTriggerKind = "github.pull_request_review"
	ScheduledAgenticWorkflowTriggerKindGithubPullRequestReviewComment ScheduledAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	ScheduledAgenticWorkflowTriggerKindGithubRelease                  ScheduledAgenticWorkflowTriggerKind = "github.release"
	ScheduledAgenticWorkflowTriggerKindLinearComment                  ScheduledAgenticWorkflowTriggerKind = "linear.comment"
	ScheduledAgenticWorkflowTriggerKindLinearLabelAdded               ScheduledAgenticWorkflowTriggerKind = "linear.label_added"
	ScheduledAgenticWorkflowTriggerKindManual                         ScheduledAgenticWorkflowTriggerKind = "manual"
	ScheduledAgenticWorkflowTriggerKindSchedule                       ScheduledAgenticWorkflowTriggerKind = "schedule"
	ScheduledAgenticWorkflowTriggerKindSlackBotFailedCheckNew         ScheduledAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	ScheduledAgenticWorkflowTriggerKindSlackBotMessage                ScheduledAgenticWorkflowTriggerKind = "slack_bot.message"
	ScheduledAgenticWorkflowTriggerKindSlackBotReaction               ScheduledAgenticWorkflowTriggerKind = "slack_bot.reaction"
	ScheduledAgenticWorkflowTriggerKindWebhook                        ScheduledAgenticWorkflowTriggerKind = "webhook"
)

Defines values for ScheduledAgenticWorkflowTriggerKind.

type ScheduledAgenticWorkflowTriggerSpec added in v1.17.0

type ScheduledAgenticWorkflowTriggerSpec struct {
	// AvailableVariables The trigger-specific variables available as `{{variable.name}}` when this trigger fires.
	// This is in addition to the built-in variables that are always available.
	AvailableVariables *[]ScheduleTriggerVariableName `json:"availableVariables,omitempty"`

	// Cron Crontab-notation to express when the automation is supposed to run.
	//
	// “`
	// {minute} {hour} {day} {month} {weekday}
	// “`
	//
	// For example, `0 12 * * MON-WED,FRI` is every M/Tu/W/F at noon.
	//
	// Predefined schedules are also supported:
	//
	// - `@yearly` (or `@annually`): Run once a year at midnight on January 1st.
	// - `@monthly`: Run once a month at midnight on the first day.
	// - `@weekly`: Run once a week at midnight on Sunday.
	// - `@daily` (or `@midnight`): Run once a day at midnight.
	// - `@hourly`: Run once an hour at the beginning of the hour.
	// - `@every <duration>`: Run at fixed intervals, e.g. `@every 1h30m` or `@every 5m`.
	Cron string `json:"cron"`
}

ScheduledAgenticWorkflowTriggerSpec defines model for ScheduledAgenticWorkflowTriggerSpec.

type ScopeLogs

type ScopeLogs struct {
	LogRecords []LogRecord `json:"logRecords"`
	SchemaUrl  *string     `json:"schemaUrl,omitempty"`

	// Scope InstrumentationScope is a message representing the instrumentation scope information such as the fully qualified name and version.
	Scope *InstrumentationScope `json:"scope,omitempty"`
}

ScopeLogs defines model for ScopeLogs.

type ScopeSpans

type ScopeSpans struct {
	SchemaUrl *string `json:"schemaUrl,omitempty"`

	// Scope InstrumentationScope is a message representing the instrumentation scope information such as the fully qualified name and version.
	Scope *InstrumentationScope `json:"scope,omitempty"`
	Spans []Span                `json:"spans"`
}

ScopeSpans defines model for ScopeSpans.

type SecretRef added in v1.12.3

type SecretRef struct {
	// Hash The hash is computed as follows:
	// 1. Parse the secrets JSON into a generic structure
	// 2. Recursively sort all object keys alphabetically (Unicode code point order)
	// 3. Re-serialize to compact JSON (no whitespace between tokens)
	// 4. Compute SHA-256 hash of the UTF-8 encoded JSON bytes
	// 5. Encode the hash as lowercase hexadecimal string
	//
	// This ensures the hash is stable and reproducible across different implementations.
	Hash string `json:"hash"`

	// Id Opaque identifier of the encrypted secret.
	Id string `json:"id"`
}

SecretRef defines model for SecretRef.

type SemanticConventionUpgrades added in v1.12.3

type SemanticConventionUpgrades = string

SemanticConventionUpgrades Choose whether or not semantic convention upgrades should be executed. Can be one of:

- disabled: No upgrade will be executed - latest: We will always upgrade to the latest and greatest - vX.X.X: A SEMVER version. We will automatically upgrade up to that version (inclusive)

Defaults to `latest` for new organizations.

type SettingsPerOrganizationAndDatasetInfo added in v1.12.3

type SettingsPerOrganizationAndDatasetInfo struct {
	DatasetSettings  []DatasetSettings       `json:"datasetSettings"`
	ObservedPatterns *[]ObservedPatternEntry `json:"observedPatterns,omitempty"`
	SamplingSettings []SamplingDefinition    `json:"samplingSettings"`

	// SignalControlEdge Per-organization SignalControl *edge* configuration (the edge facet of SignalControl).
	// Extensible — additional edge sub-settings will be added here over time. Other facets
	// (e.g. SaaS-side) are modelled as their own schemas under sibling endpoints, not as
	// fields here.
	SignalControlEdge SignalControlEdgeSettings `json:"signalControlEdge"`

	// SignalControlMetering Per-organization control over edge billing metering enforcement. Set centrally by Dash0
	// and not customer-configurable.
	//
	// Deliberately a sibling of `signalControlEdge` rather than a field inside it: that object
	// is a pre-release entitlement gate that goes away at GA, and enforcement has to outlive it.
	//
	// Every field is optional, and absence is meaningful — see `enforce`.
	SignalControlMetering               *SignalControlMeteringSettings          `json:"signalControlMetering,omitempty"`
	SignalToMetricsSettings             []SignalToMetricsDefinition             `json:"signalToMetricsSettings"`
	SourceMapSettings                   []SourceMapIntegration                  `json:"sourceMapSettings"`
	TechnicalID                         string                                  `json:"technicalID"`
	TelemetryTransformationRuleSettings []TelemetryTransformationRuleDefinition `json:"telemetryTransformationRuleSettings"`
	TimeSeriesAggregationSettings       []TimeSeriesAggregationDefinition       `json:"timeSeriesAggregationSettings"`
}

SettingsPerOrganizationAndDatasetInfo defines model for SettingsPerOrganizationAndDatasetInfo.

type SeverityNumber

type SeverityNumber = int32

SeverityNumber SEVERITY_NUMBER_UNSPECIFIED = 0; SEVERITY_NUMBER_TRACE = 1; SEVERITY_NUMBER_TRACE2 = 2; SEVERITY_NUMBER_TRACE3 = 3; SEVERITY_NUMBER_TRACE4 = 4; SEVERITY_NUMBER_DEBUG = 5; SEVERITY_NUMBER_DEBUG2 = 6; SEVERITY_NUMBER_DEBUG3 = 7; SEVERITY_NUMBER_DEBUG4 = 8; SEVERITY_NUMBER_INFO = 9; SEVERITY_NUMBER_INFO2 = 10; SEVERITY_NUMBER_INFO3 = 11; SEVERITY_NUMBER_INFO4 = 12; SEVERITY_NUMBER_WARN = 13; SEVERITY_NUMBER_WARN2 = 14; SEVERITY_NUMBER_WARN3 = 15; SEVERITY_NUMBER_WARN4 = 16; SEVERITY_NUMBER_ERROR = 17; SEVERITY_NUMBER_ERROR2 = 18; SEVERITY_NUMBER_ERROR3 = 19; SEVERITY_NUMBER_ERROR4 = 20; SEVERITY_NUMBER_FATAL = 21; SEVERITY_NUMBER_FATAL2 = 22; SEVERITY_NUMBER_FATAL3 = 23; SEVERITY_NUMBER_FATAL4 = 24;

type SignalControlEdgeSettings added in v1.17.0

type SignalControlEdgeSettings struct {
	// Enabled Whether the organization is entitled to use SignalControl features.
	Enabled bool `json:"enabled"`
}

SignalControlEdgeSettings Per-organization SignalControl *edge* configuration (the edge facet of SignalControl). Extensible — additional edge sub-settings will be added here over time. Other facets (e.g. SaaS-side) are modelled as their own schemas under sibling endpoints, not as fields here.

type SignalControlMeteringSettings added in v1.21.0

type SignalControlMeteringSettings struct {
	// Enforce Whether edge collectors enforce billing metering for this organization.
	//
	// `true` enforces: Signal Control components on edge stop acting on telemetry that no
	// metering processor marked, so a capability cannot run on usage nothing metered.
	//
	// `false` and an absent field both mean warn mode: the capabilities keep working on
	// unmarked telemetry and the misconfiguration is only logged and reported. The two
	// negatives are collapsed on purpose, so an organization can be returned to warn mode by
	// writing `false` rather than by deleting a key, and an organization nobody has touched
	// behaves identically to one explicitly parked.
	//
	// The collector's compiled-in default is warn, permanently — enforcement is only ever
	// something the server turns on. A collector that has never synced never enforces, but
	// one that has been told to enforce keeps enforcing if it later loses contact.
	Enforce *bool `json:"enforce,omitempty"`
}

SignalControlMeteringSettings Per-organization control over edge billing metering enforcement. Set centrally by Dash0 and not customer-configurable.

Deliberately a sibling of `signalControlEdge` rather than a field inside it: that object is a pre-release entitlement gate that goes away at GA, and enforcement has to outlive it.

Every field is optional, and absence is meaningful — see `enforce`.

type SignalToMetricsBulkUpsertRequest added in v1.12.3

type SignalToMetricsBulkUpsertRequest struct {
	Items []SignalToMetricsDefinition `json:"items"`
}

SignalToMetricsBulkUpsertRequest defines model for SignalToMetricsBulkUpsertRequest.

type SignalToMetricsBulkUpsertResponse added in v1.12.3

type SignalToMetricsBulkUpsertResponse struct {
	// Created Number of rules that were newly created.
	Created int `json:"created"`

	// Updated Number of rules that were updated.
	Updated int `json:"updated"`
}

SignalToMetricsBulkUpsertResponse defines model for SignalToMetricsBulkUpsertResponse.

type SignalToMetricsCounts added in v1.21.0

type SignalToMetricsCounts struct {
	Logs  SignalToMetricsSignalCounts `json:"logs"`
	Spans SignalToMetricsSignalCounts `json:"spans"`
}

SignalToMetricsCounts defines model for SignalToMetricsCounts.

type SignalToMetricsCreateRequest added in v1.9.0

type SignalToMetricsCreateRequest = SignalToMetricsDefinition

SignalToMetricsCreateRequest defines model for SignalToMetricsCreateRequest.

type SignalToMetricsDefinition added in v1.9.0

type SignalToMetricsDefinition struct {
	Kind     SignalToMetricsDefinitionKind `json:"kind"`
	Metadata SignalToMetricsMetadata       `json:"metadata"`
	Spec     SignalToMetricsSpec           `json:"spec"`
}

SignalToMetricsDefinition defines model for SignalToMetricsDefinition.

type SignalToMetricsDefinitionKind added in v1.9.0

type SignalToMetricsDefinitionKind string

SignalToMetricsDefinitionKind defines model for SignalToMetricsDefinition.Kind.

const (
	Dash0SignalToMetrics SignalToMetricsDefinitionKind = "Dash0SignalToMetrics"
)

Defines values for SignalToMetricsDefinitionKind.

type SignalToMetricsDisplay added in v1.9.0

type SignalToMetricsDisplay struct {
	Name string `json:"name"`
}

SignalToMetricsDisplay defines model for SignalToMetricsDisplay.

type SignalToMetricsGroupAnnotations added in v1.12.1

type SignalToMetricsGroupAnnotations struct {
	// Dash0ComcreatedAt Timestamp when the rule was created. Set by the server; read-only.
	Dash0ComcreatedAt *time.Time `json:"dash0.com/created-at,omitempty"`

	// Dash0ComdeletedAt Soft-delete timestamp. Present when the rule has been deleted but not yet purged. Set by the server; read-only.
	Dash0ComdeletedAt *time.Time `json:"dash0.com/deleted-at,omitempty"`

	// Dash0ComfolderPath Optional UI folder path for organising groups (e.g. '/infrastructure/hosts'). Nesting is expressed with '/' separators.
	Dash0ComfolderPath *string `json:"dash0.com/folder-path,omitempty"`

	// Dash0Comsharing Comma-separated list of principals to grant read access to. Supported formats: 'team:<team_id>' and 'user:<email>'. Example: 'team:team_01abc,user:alice@example.com'. Note: this resource type does not currently enforce sharing; the field is accepted but has no effect on access.
	Dash0Comsharing *string `json:"dash0.com/sharing,omitempty"`

	// Dash0ComupdatedAt Timestamp of the last update. Set by the server; read-only.
	Dash0ComupdatedAt *time.Time `json:"dash0.com/updated-at,omitempty"`
}

SignalToMetricsGroupAnnotations defines model for SignalToMetricsGroupAnnotations.

type SignalToMetricsLabels added in v1.9.0

type SignalToMetricsLabels struct {
	// Dash0Comdataset Dataset this rule belongs to. Defaults to the default dataset when absent.
	Dash0Comdataset *string `json:"dash0.com/dataset,omitempty"`

	// Dash0Comid Unique internal ID of the signal-to-metrics rule. Set by the server on creation; do not set manually.
	Dash0Comid *string `json:"dash0.com/id,omitempty"`

	// Dash0Comorigin External identifier for API-managed resources (e.g. the CRD name from an operator or Terraform resource ID). Empty for user-created rules; non-empty for rules created via the internal API.
	Dash0Comorigin *string `json:"dash0.com/origin,omitempty"`

	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource *CrdSource `json:"dash0.com/source,omitempty"`

	// Dash0Comversion Current version of the rule. Needs to be set when updating a rule to prevent conflicting writes.
	Dash0Comversion *string `json:"dash0.com/version,omitempty"`
}

SignalToMetricsLabels defines model for SignalToMetricsLabels.

type SignalToMetricsMatch added in v1.9.0

type SignalToMetricsMatch struct {
	Filters FilterCriteria            `json:"filters"`
	Signal  SignalToMetricsSignalType `json:"signal"`
}

SignalToMetricsMatch defines model for SignalToMetricsMatch.

type SignalToMetricsMetadata added in v1.9.0

type SignalToMetricsMetadata struct {
	Annotations *SignalToMetricsGroupAnnotations `json:"annotations,omitempty"`
	Labels      *SignalToMetricsLabels           `json:"labels,omitempty"`
	Name        string                           `json:"name"`
}

SignalToMetricsMetadata defines model for SignalToMetricsMetadata.

type SignalToMetricsOutput added in v1.9.0

type SignalToMetricsOutput struct {
	// Description Will be used as metadata on the generated metric.
	Description *string  `json:"description,omitempty"`
	Interval    Duration `json:"interval"`

	// KeepResourceAttributes Key matchers that select which resource attributes from the incoming signal
	// are kept as resource attributes on the output metric. An attribute is kept
	// if its key matches any matcher in this list. By default, no additional
	// resource attributes are kept.
	KeepResourceAttributes *[]Matcher `json:"keepResourceAttributes,omitempty"`

	// KeepSignalAttributes Key matchers that select which signal attributes (span attributes for traces,
	// log record attributes for logs) from the incoming signal are kept as metric
	// attributes (dimensions) on the output metric. An attribute is kept if its
	// key matches any matcher in this list. By default, no additional signal
	// attributes are kept, except for otel.span.status.code which is always set
	// when the signal type is spans.
	KeepSignalAttributes *[]Matcher `json:"keepSignalAttributes,omitempty"`

	// Name The name of the resulting metric
	Name string `json:"name"`
}

SignalToMetricsOutput defines model for SignalToMetricsOutput.

type SignalToMetricsResponse added in v1.9.0

type SignalToMetricsResponse = SignalToMetricsDefinition

SignalToMetricsResponse defines model for SignalToMetricsResponse.

type SignalToMetricsSignalCounts added in v1.21.0

type SignalToMetricsSignalCounts struct {
	// Enabled The subset that is enabled. Disabled rules are `total - enabled`.
	Enabled int `json:"enabled"`

	// Total Rules with this source signal, enabled and disabled alike.
	Total int `json:"total"`
}

SignalToMetricsSignalCounts defines model for SignalToMetricsSignalCounts.

type SignalToMetricsSignalType added in v1.9.0

type SignalToMetricsSignalType string

SignalToMetricsSignalType defines model for SignalToMetricsSignalType.

const (
	SignalToMetricsSignalTypeLogs  SignalToMetricsSignalType = "logs"
	SignalToMetricsSignalTypeSpans SignalToMetricsSignalType = "spans"
)

Defines values for SignalToMetricsSignalType.

type SignalToMetricsSource deprecated added in v1.9.0

type SignalToMetricsSource = CrdSource

SignalToMetricsSource is a deprecated alias for CrdSource.

Deprecated: since v1.12.0. Use CrdSource instead.

type SignalToMetricsSpec added in v1.9.0

type SignalToMetricsSpec struct {
	// AlternativeDatasetId The slug of the target dataset. Required when targetDatasetMode is
	// `alternative` or `both`. Must not be set when targetDatasetMode is
	// `original` or absent.
	AlternativeDatasetId *string                `json:"alternativeDatasetId,omitempty"`
	Display              SignalToMetricsDisplay `json:"display"`
	Enabled              bool                   `json:"enabled"`
	Match                SignalToMetricsMatch   `json:"match"`
	Output               SignalToMetricsOutput  `json:"output"`

	// TargetDatasetMode Controls where the generated metric is written.
	// - `original`: Metric lands in the dataset where the rule is defined.
	// - `alternative`: Metric lands in the dataset specified by `alternativeDatasetId`.
	// - `both`: Metric is produced twice — once for the original dataset, once for the alternative.
	TargetDatasetMode *SignalToMetricsTargetDatasetMode `json:"targetDatasetMode,omitempty"`
}

SignalToMetricsSpec defines model for SignalToMetricsSpec.

type SignalToMetricsTargetDatasetMode added in v1.14.0

type SignalToMetricsTargetDatasetMode string

SignalToMetricsTargetDatasetMode Controls where the generated metric is written. - `original`: Metric lands in the dataset where the rule is defined. - `alternative`: Metric lands in the dataset specified by `alternativeDatasetId`. - `both`: Metric is produced twice — once for the original dataset, once for the alternative.

const (
	Alternative SignalToMetricsTargetDatasetMode = "alternative"
	Both        SignalToMetricsTargetDatasetMode = "both"
	Original    SignalToMetricsTargetDatasetMode = "original"
)

Defines values for SignalToMetricsTargetDatasetMode.

type SignalToMetricsTestRequest added in v1.12.0

type SignalToMetricsTestRequest struct {
	Definition SignalToMetricsDefinition `json:"definition"`

	// TimeRange A range of time between two time references.
	TimeRange *TimeReferenceRange `json:"timeRange,omitempty"`
}

SignalToMetricsTestRequest defines model for SignalToMetricsTestRequest.

type SignalToMetricsTestResponse added in v1.12.0

type SignalToMetricsTestResponse struct {
	// ExecutionTime A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	ExecutionTime FixedTime `json:"executionTime"`

	// MatchedCount Number of signals (spans or logs) matching `spec.match.filters` over the
	// evaluated time window.
	MatchedCount int64     `json:"matchedCount"`
	TimeRange    TimeRange `json:"timeRange"`
}

SignalToMetricsTestResponse defines model for SignalToMetricsTestResponse.

type SlackBotConfig added in v1.9.0

type SlackBotConfig struct {
	Channel string `json:"channel"`
	TeamId  string `json:"teamId"`
}

SlackBotConfig defines model for SlackBotConfig.

type SlackBotFailedCheckAgenticWorkflowTrigger added in v1.17.0

type SlackBotFailedCheckAgenticWorkflowTrigger struct {
	Kind SlackBotFailedCheckAgenticWorkflowTriggerKind `json:"kind"`
	Spec SlackBotFailedCheckAgenticWorkflowTriggerSpec `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

SlackBotFailedCheckAgenticWorkflowTrigger defines model for SlackBotFailedCheckAgenticWorkflowTrigger.

type SlackBotFailedCheckAgenticWorkflowTriggerKind added in v1.17.0

type SlackBotFailedCheckAgenticWorkflowTriggerKind string

SlackBotFailedCheckAgenticWorkflowTriggerKind defines model for SlackBotFailedCheckAgenticWorkflowTrigger.Kind.

const (
	SlackBotFailedCheckAgenticWorkflowTriggerKindFailedCheckNew                 SlackBotFailedCheckAgenticWorkflowTriggerKind = "failed_check.new"
	SlackBotFailedCheckAgenticWorkflowTriggerKindGithubDeployment               SlackBotFailedCheckAgenticWorkflowTriggerKind = "github.deployment"
	SlackBotFailedCheckAgenticWorkflowTriggerKindGithubDeploymentStatus         SlackBotFailedCheckAgenticWorkflowTriggerKind = "github.deployment_status"
	SlackBotFailedCheckAgenticWorkflowTriggerKindGithubIssueComment             SlackBotFailedCheckAgenticWorkflowTriggerKind = "github.issue_comment"
	SlackBotFailedCheckAgenticWorkflowTriggerKindGithubPullRequest              SlackBotFailedCheckAgenticWorkflowTriggerKind = "github.pull_request"
	SlackBotFailedCheckAgenticWorkflowTriggerKindGithubPullRequestReview        SlackBotFailedCheckAgenticWorkflowTriggerKind = "github.pull_request_review"
	SlackBotFailedCheckAgenticWorkflowTriggerKindGithubPullRequestReviewComment SlackBotFailedCheckAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	SlackBotFailedCheckAgenticWorkflowTriggerKindGithubRelease                  SlackBotFailedCheckAgenticWorkflowTriggerKind = "github.release"
	SlackBotFailedCheckAgenticWorkflowTriggerKindLinearComment                  SlackBotFailedCheckAgenticWorkflowTriggerKind = "linear.comment"
	SlackBotFailedCheckAgenticWorkflowTriggerKindLinearLabelAdded               SlackBotFailedCheckAgenticWorkflowTriggerKind = "linear.label_added"
	SlackBotFailedCheckAgenticWorkflowTriggerKindManual                         SlackBotFailedCheckAgenticWorkflowTriggerKind = "manual"
	SlackBotFailedCheckAgenticWorkflowTriggerKindSchedule                       SlackBotFailedCheckAgenticWorkflowTriggerKind = "schedule"
	SlackBotFailedCheckAgenticWorkflowTriggerKindSlackBotFailedCheckNew         SlackBotFailedCheckAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	SlackBotFailedCheckAgenticWorkflowTriggerKindSlackBotMessage                SlackBotFailedCheckAgenticWorkflowTriggerKind = "slack_bot.message"
	SlackBotFailedCheckAgenticWorkflowTriggerKindSlackBotReaction               SlackBotFailedCheckAgenticWorkflowTriggerKind = "slack_bot.reaction"
	SlackBotFailedCheckAgenticWorkflowTriggerKindWebhook                        SlackBotFailedCheckAgenticWorkflowTriggerKind = "webhook"
)

Defines values for SlackBotFailedCheckAgenticWorkflowTriggerKind.

type SlackBotFailedCheckAgenticWorkflowTriggerSpec added in v1.17.0

type SlackBotFailedCheckAgenticWorkflowTriggerSpec struct {
	AnnotationFilters *FilterCriteria `json:"annotationFilters,omitempty"`

	// AvailableVariables The trigger-specific variables available as `{{variable.name}}` when this trigger fires.
	// This is in addition to the built-in variables that are always available. The dispatch
	// payload carries the Slack event's variables and the failed check's.
	AvailableVariables *[]SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item `json:"availableVariables,omitempty"`

	// ChannelNames Optional list of Slack channel names (e.g., `general`, `alerts`). When
	// specified, only failed checks reported in these channels trigger the automation.
	ChannelNames *[]string `json:"channelNames,omitempty"`

	// CheckRuleIDs Optional list of check rule IDs. When specified, only failed checks
	// whose rule ID matches one of the listed values trigger the automation.
	CheckRuleIDs *[]string       `json:"checkRuleIDs,omitempty"`
	LabelFilters *FilterCriteria `json:"labelFilters,omitempty"`

	// Message A command or keyword that the Slack message must contain. Evaluated as a
	// case-insensitive substring match (e.g., `investigate` matches any message
	// containing "investigate").
	Message *string `json:"message,omitempty"`
}

SlackBotFailedCheckAgenticWorkflowTriggerSpec defines model for SlackBotFailedCheckAgenticWorkflowTriggerSpec.

type SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item added in v1.21.0

type SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item struct {
	// contains filtered or unexported fields
}

SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item defines model for SlackBotFailedCheckAgenticWorkflowTriggerSpec.availableVariables.Item.

func (SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item) AsFailedCheckTriggerVariableName added in v1.21.0

AsFailedCheckTriggerVariableName returns the union data inside the SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item as a FailedCheckTriggerVariableName

func (SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item) AsSlackTriggerVariableName added in v1.21.0

AsSlackTriggerVariableName returns the union data inside the SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item as a SlackTriggerVariableName

func (*SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item) FromFailedCheckTriggerVariableName added in v1.21.0

FromFailedCheckTriggerVariableName overwrites any union data inside the SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item as the provided FailedCheckTriggerVariableName

func (*SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item) FromSlackTriggerVariableName added in v1.21.0

FromSlackTriggerVariableName overwrites any union data inside the SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item as the provided SlackTriggerVariableName

func (SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item) MarshalJSON added in v1.21.0

func (*SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item) MergeFailedCheckTriggerVariableName added in v1.21.0

MergeFailedCheckTriggerVariableName performs a merge with any union data inside the SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item, using the provided FailedCheckTriggerVariableName

func (*SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item) MergeSlackTriggerVariableName added in v1.21.0

MergeSlackTriggerVariableName performs a merge with any union data inside the SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item, using the provided SlackTriggerVariableName

func (*SlackBotFailedCheckAgenticWorkflowTriggerSpec_AvailableVariables_Item) UnmarshalJSON added in v1.21.0

type SlackBotMessageAgenticWorkflowTrigger added in v1.17.0

type SlackBotMessageAgenticWorkflowTrigger struct {
	// Delivery How a trigger delivers its event to an agent. An automation is the agent definition;
	// triggers are the pipes into it, and each pipe is configured independently.
	//
	// - `spawn`: Start a new agent thread for this event. This is today's behavior.
	// - `continue`: Route the event into the existing agent thread that owns the matching
	//   entity, falling back to spawning a fresh thread when none is active
	//   (resume-or-spawn). Only valid on continuation-capable triggers that carry an entity
	//   ref to route by; spawn-only triggers (e.g. `schedule`, `webhook`,
	//   `failed_check.new`) must not set it.
	Delivery *AgenticWorkflowTriggerDelivery           `json:"delivery,omitempty"`
	Kind     SlackBotMessageAgenticWorkflowTriggerKind `json:"kind"`
	Spec     SlackBotMessageAgenticWorkflowTriggerSpec `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

SlackBotMessageAgenticWorkflowTrigger defines model for SlackBotMessageAgenticWorkflowTrigger.

type SlackBotMessageAgenticWorkflowTriggerKind added in v1.17.0

type SlackBotMessageAgenticWorkflowTriggerKind string

SlackBotMessageAgenticWorkflowTriggerKind defines model for SlackBotMessageAgenticWorkflowTrigger.Kind.

const (
	SlackBotMessageAgenticWorkflowTriggerKindFailedCheckNew                 SlackBotMessageAgenticWorkflowTriggerKind = "failed_check.new"
	SlackBotMessageAgenticWorkflowTriggerKindGithubDeployment               SlackBotMessageAgenticWorkflowTriggerKind = "github.deployment"
	SlackBotMessageAgenticWorkflowTriggerKindGithubDeploymentStatus         SlackBotMessageAgenticWorkflowTriggerKind = "github.deployment_status"
	SlackBotMessageAgenticWorkflowTriggerKindGithubIssueComment             SlackBotMessageAgenticWorkflowTriggerKind = "github.issue_comment"
	SlackBotMessageAgenticWorkflowTriggerKindGithubPullRequest              SlackBotMessageAgenticWorkflowTriggerKind = "github.pull_request"
	SlackBotMessageAgenticWorkflowTriggerKindGithubPullRequestReview        SlackBotMessageAgenticWorkflowTriggerKind = "github.pull_request_review"
	SlackBotMessageAgenticWorkflowTriggerKindGithubPullRequestReviewComment SlackBotMessageAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	SlackBotMessageAgenticWorkflowTriggerKindGithubRelease                  SlackBotMessageAgenticWorkflowTriggerKind = "github.release"
	SlackBotMessageAgenticWorkflowTriggerKindLinearComment                  SlackBotMessageAgenticWorkflowTriggerKind = "linear.comment"
	SlackBotMessageAgenticWorkflowTriggerKindLinearLabelAdded               SlackBotMessageAgenticWorkflowTriggerKind = "linear.label_added"
	SlackBotMessageAgenticWorkflowTriggerKindManual                         SlackBotMessageAgenticWorkflowTriggerKind = "manual"
	SlackBotMessageAgenticWorkflowTriggerKindSchedule                       SlackBotMessageAgenticWorkflowTriggerKind = "schedule"
	SlackBotMessageAgenticWorkflowTriggerKindSlackBotFailedCheckNew         SlackBotMessageAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	SlackBotMessageAgenticWorkflowTriggerKindSlackBotMessage                SlackBotMessageAgenticWorkflowTriggerKind = "slack_bot.message"
	SlackBotMessageAgenticWorkflowTriggerKindSlackBotReaction               SlackBotMessageAgenticWorkflowTriggerKind = "slack_bot.reaction"
	SlackBotMessageAgenticWorkflowTriggerKindWebhook                        SlackBotMessageAgenticWorkflowTriggerKind = "webhook"
)

Defines values for SlackBotMessageAgenticWorkflowTriggerKind.

type SlackBotMessageAgenticWorkflowTriggerSpec added in v1.17.0

type SlackBotMessageAgenticWorkflowTriggerSpec struct {
	// AvailableVariables The trigger-specific variables available as `{{variable.name}}` when this trigger fires.
	// This is in addition to the built-in variables that are always available.
	AvailableVariables *[]SlackTriggerVariableName `json:"availableVariables,omitempty"`

	// ChannelNames Optional list of Slack channel names (e.g., `general`, `alerts`). When
	// specified, only messages from these channels trigger the automation. When omitted,
	// messages from any channel match.
	ChannelNames *[]string `json:"channelNames,omitempty"`

	// Message A command or keyword that the Slack message must contain. Evaluated as a
	// case-insensitive substring match (e.g., `investigate` matches any message
	// containing "investigate").
	Message string `json:"message"`

	// ThreadOnly When true, only messages within a thread trigger the automation. Defaults to false.
	ThreadOnly *bool `json:"threadOnly,omitempty"`

	// UserHandles Optional list of Slack user handles without the @ prefix (e.g., `jane.doe`).
	// When specified, only messages from these users trigger the automation. When omitted,
	// messages from any user match.
	UserHandles *[]string `json:"userHandles,omitempty"`
}

SlackBotMessageAgenticWorkflowTriggerSpec defines model for SlackBotMessageAgenticWorkflowTriggerSpec.

type SlackBotReactionAgenticWorkflowTrigger added in v1.17.0

type SlackBotReactionAgenticWorkflowTrigger struct {
	// Delivery How a trigger delivers its event to an agent. An automation is the agent definition;
	// triggers are the pipes into it, and each pipe is configured independently.
	//
	// - `spawn`: Start a new agent thread for this event. This is today's behavior.
	// - `continue`: Route the event into the existing agent thread that owns the matching
	//   entity, falling back to spawning a fresh thread when none is active
	//   (resume-or-spawn). Only valid on continuation-capable triggers that carry an entity
	//   ref to route by; spawn-only triggers (e.g. `schedule`, `webhook`,
	//   `failed_check.new`) must not set it.
	Delivery *AgenticWorkflowTriggerDelivery            `json:"delivery,omitempty"`
	Kind     SlackBotReactionAgenticWorkflowTriggerKind `json:"kind"`
	Spec     SlackBotReactionAgenticWorkflowTriggerSpec `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

SlackBotReactionAgenticWorkflowTrigger defines model for SlackBotReactionAgenticWorkflowTrigger.

type SlackBotReactionAgenticWorkflowTriggerKind added in v1.17.0

type SlackBotReactionAgenticWorkflowTriggerKind string

SlackBotReactionAgenticWorkflowTriggerKind defines model for SlackBotReactionAgenticWorkflowTrigger.Kind.

const (
	SlackBotReactionAgenticWorkflowTriggerKindFailedCheckNew                 SlackBotReactionAgenticWorkflowTriggerKind = "failed_check.new"
	SlackBotReactionAgenticWorkflowTriggerKindGithubDeployment               SlackBotReactionAgenticWorkflowTriggerKind = "github.deployment"
	SlackBotReactionAgenticWorkflowTriggerKindGithubDeploymentStatus         SlackBotReactionAgenticWorkflowTriggerKind = "github.deployment_status"
	SlackBotReactionAgenticWorkflowTriggerKindGithubIssueComment             SlackBotReactionAgenticWorkflowTriggerKind = "github.issue_comment"
	SlackBotReactionAgenticWorkflowTriggerKindGithubPullRequest              SlackBotReactionAgenticWorkflowTriggerKind = "github.pull_request"
	SlackBotReactionAgenticWorkflowTriggerKindGithubPullRequestReview        SlackBotReactionAgenticWorkflowTriggerKind = "github.pull_request_review"
	SlackBotReactionAgenticWorkflowTriggerKindGithubPullRequestReviewComment SlackBotReactionAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	SlackBotReactionAgenticWorkflowTriggerKindGithubRelease                  SlackBotReactionAgenticWorkflowTriggerKind = "github.release"
	SlackBotReactionAgenticWorkflowTriggerKindLinearComment                  SlackBotReactionAgenticWorkflowTriggerKind = "linear.comment"
	SlackBotReactionAgenticWorkflowTriggerKindLinearLabelAdded               SlackBotReactionAgenticWorkflowTriggerKind = "linear.label_added"
	SlackBotReactionAgenticWorkflowTriggerKindManual                         SlackBotReactionAgenticWorkflowTriggerKind = "manual"
	SlackBotReactionAgenticWorkflowTriggerKindSchedule                       SlackBotReactionAgenticWorkflowTriggerKind = "schedule"
	SlackBotReactionAgenticWorkflowTriggerKindSlackBotFailedCheckNew         SlackBotReactionAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	SlackBotReactionAgenticWorkflowTriggerKindSlackBotMessage                SlackBotReactionAgenticWorkflowTriggerKind = "slack_bot.message"
	SlackBotReactionAgenticWorkflowTriggerKindSlackBotReaction               SlackBotReactionAgenticWorkflowTriggerKind = "slack_bot.reaction"
	SlackBotReactionAgenticWorkflowTriggerKindWebhook                        SlackBotReactionAgenticWorkflowTriggerKind = "webhook"
)

Defines values for SlackBotReactionAgenticWorkflowTriggerKind.

type SlackBotReactionAgenticWorkflowTriggerSpec added in v1.17.0

type SlackBotReactionAgenticWorkflowTriggerSpec struct {
	// AvailableVariables The trigger-specific variables available as `{{variable.name}}` when this trigger fires.
	// Includes both the common Slack variables and reaction-specific variables.
	// This is in addition to the built-in variables that are always available.
	AvailableVariables *[]SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item `json:"availableVariables,omitempty"`

	// ChannelNames Optional list of Slack channel names (e.g., `general`, `alerts`). When
	// specified, only reactions in these channels trigger the automation.
	ChannelNames *[]string `json:"channelNames,omitempty"`

	// Emojis List of emoji names (without colons) that trigger the automation. Each is evaluated
	// as an exact match. The automation triggers when any of the listed emojis is used.
	Emojis []string `json:"emojis"`

	// UserHandles Optional list of Slack user handles without the @ prefix (e.g., `jane.doe`).
	// When specified, only reactions from these users trigger the automation.
	UserHandles *[]string `json:"userHandles,omitempty"`
}

SlackBotReactionAgenticWorkflowTriggerSpec defines model for SlackBotReactionAgenticWorkflowTriggerSpec.

type SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item added in v1.17.0

type SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item struct {
	// contains filtered or unexported fields
}

SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item defines model for SlackBotReactionAgenticWorkflowTriggerSpec.availableVariables.Item.

func (SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item) AsSlackReactionTriggerVariableName added in v1.17.0

AsSlackReactionTriggerVariableName returns the union data inside the SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item as a SlackReactionTriggerVariableName

func (SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item) AsSlackTriggerVariableName added in v1.17.0

AsSlackTriggerVariableName returns the union data inside the SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item as a SlackTriggerVariableName

func (*SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item) FromSlackReactionTriggerVariableName added in v1.17.0

FromSlackReactionTriggerVariableName overwrites any union data inside the SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item as the provided SlackReactionTriggerVariableName

func (*SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item) FromSlackTriggerVariableName added in v1.17.0

FromSlackTriggerVariableName overwrites any union data inside the SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item as the provided SlackTriggerVariableName

func (SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item) MarshalJSON added in v1.17.0

func (*SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item) MergeSlackReactionTriggerVariableName added in v1.17.0

MergeSlackReactionTriggerVariableName performs a merge with any union data inside the SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item, using the provided SlackReactionTriggerVariableName

func (*SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item) MergeSlackTriggerVariableName added in v1.17.0

MergeSlackTriggerVariableName performs a merge with any union data inside the SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item, using the provided SlackTriggerVariableName

func (*SlackBotReactionAgenticWorkflowTriggerSpec_AvailableVariables_Item) UnmarshalJSON added in v1.17.0

type SlackConfig added in v1.9.0

type SlackConfig struct {
	Channel    string `json:"channel"`
	WebhookURL string `json:"webhookURL"`
}

SlackConfig defines model for SlackConfig.

type SlackReactionTriggerVariableName added in v1.17.0

type SlackReactionTriggerVariableName string

SlackReactionTriggerVariableName Additional variable provided only by the `slack_bot.reaction` trigger.

- `slack.reaction.emoji`: The emoji name (without colons) that was added as a reaction.

const (
	SlackReactionEmoji SlackReactionTriggerVariableName = "slack.reaction.emoji"
)

Defines values for SlackReactionTriggerVariableName.

type SlackTriggerVariableName added in v1.17.0

type SlackTriggerVariableName string

SlackTriggerVariableName Variables provided by all Slack-based triggers (`slack_bot.message`, `slack_bot.reaction`, `slack_bot.failed_check.new`).

- `slack.channel.name`: Name of the Slack channel where the event occurred. - `slack.channel.id`: Slack channel ID. - `slack.user.handle`: Handle of the user who triggered the event. - `slack.user.id`: Slack user ID. - `slack.team.id`: Slack workspace (team) ID. - `slack.message.timestamp`: Timestamp of the message in Slack's format. - `slack.message.text`: Text content of the message. May be absent for some trigger types. - `slack.thread.timestamp`: Thread timestamp. Only present when the event occurred in a thread.

const (
	SlackChannelId        SlackTriggerVariableName = "slack.channel.id"
	SlackChannelName      SlackTriggerVariableName = "slack.channel.name"
	SlackMessageText      SlackTriggerVariableName = "slack.message.text"
	SlackMessageTimestamp SlackTriggerVariableName = "slack.message.timestamp"
	SlackTeamId           SlackTriggerVariableName = "slack.team.id"
	SlackThreadTimestamp  SlackTriggerVariableName = "slack.thread.timestamp"
	SlackUserHandle       SlackTriggerVariableName = "slack.user.handle"
	SlackUserId           SlackTriggerVariableName = "slack.user.id"
)

Defines values for SlackTriggerVariableName.

type SloAlertCondition added in v1.14.0

type SloAlertCondition struct {
	// ConditionRef Reference to an external AlertCondition by name.
	ConditionRef *string                    `json:"conditionRef,omitempty"`
	Kind         *string                    `json:"kind,omitempty"`
	Metadata     *SloAlertConditionMetadata `json:"metadata,omitempty"`
	Spec         *SloAlertConditionSpec     `json:"spec,omitempty"`
}

SloAlertCondition An alert condition that defines when an alert should fire. Can be inline or a reference to an external AlertCondition.

type SloAlertConditionDetails added in v1.14.0

type SloAlertConditionDetails struct {
	AlertAfter *Duration `json:"alertAfter,omitempty"`

	// Kind Kind of alerting condition. Defaults to 'burnrate'.
	Kind           *string  `json:"kind,omitempty"`
	LookbackWindow Duration `json:"lookbackWindow"`

	// Op Conditional operator used to compare the SLI against a threshold value.
	Op SloComparisonOperator `json:"op"`

	// Threshold Threshold value for the condition.
	Threshold float32 `json:"threshold"`
}

SloAlertConditionDetails Details of the alert condition. Defaults to burnrate kind.

type SloAlertConditionMetadata added in v1.14.0

type SloAlertConditionMetadata struct {
	DisplayName *string `json:"displayName,omitempty"`
	Name        *string `json:"name,omitempty"`
}

SloAlertConditionMetadata defines model for SloAlertConditionMetadata.

type SloAlertConditionSpec added in v1.14.0

type SloAlertConditionSpec struct {
	// Condition Details of the alert condition. Defaults to burnrate kind.
	Condition SloAlertConditionDetails `json:"condition"`

	// Description Description of the alert condition, up to 1050 characters.
	Description *string `json:"description,omitempty"`

	// Severity Severity level of the alert (e.g. 'page', 'warning', 'critical').
	Severity string `json:"severity"`
}

SloAlertConditionSpec defines model for SloAlertConditionSpec.

type SloAlertNotificationTarget added in v1.14.0

type SloAlertNotificationTarget struct {
	Kind     *string                 `json:"kind,omitempty"`
	Metadata *map[string]interface{} `json:"metadata,omitempty"`
	Spec     *map[string]interface{} `json:"spec,omitempty"`

	// TargetRef Reference to an external AlertNotificationTarget by name.
	TargetRef *string `json:"targetRef,omitempty"`
}

SloAlertNotificationTarget An alert notification target. Can be inline or a reference to an external AlertNotificationTarget via targetRef.

type SloAlertPolicy added in v1.14.0

type SloAlertPolicy struct {
	// AlertPolicyRef Reference to an external AlertPolicy by name.
	AlertPolicyRef *string                 `json:"alertPolicyRef,omitempty"`
	Kind           *string                 `json:"kind,omitempty"`
	Metadata       *SloAlertPolicyMetadata `json:"metadata,omitempty"`
	Spec           *SloAlertPolicySpec     `json:"spec,omitempty"`
}

SloAlertPolicy An alert policy following the OpenSLO AlertPolicy structure. Can contain inline conditions and notification targets, or reference an external policy via alertPolicyRef. Not supported by Dash0: alert policies on SLOs are accepted for OpenSLO compatibility but ignored. See the alertPolicies field on SloSpec.

type SloAlertPolicyMetadata added in v1.14.0

type SloAlertPolicyMetadata struct {
	DisplayName *string `json:"displayName,omitempty"`
	Name        *string `json:"name,omitempty"`
}

SloAlertPolicyMetadata defines model for SloAlertPolicyMetadata.

type SloAlertPolicySpec added in v1.14.0

type SloAlertPolicySpec struct {
	// AlertWhenBreaching Whether to trigger the alert when the condition is breaching.
	AlertWhenBreaching bool `json:"alertWhenBreaching"`

	// AlertWhenNoData Whether to trigger the alert when no data is available.
	AlertWhenNoData bool `json:"alertWhenNoData"`

	// AlertWhenResolved Whether to trigger the alert when the condition is resolved.
	AlertWhenResolved bool `json:"alertWhenResolved"`

	// Conditions Alert conditions (max one condition per OpenSLO v1).
	Conditions []SloAlertCondition `json:"conditions"`

	// Description Description of the alert policy, up to 1050 characters.
	Description *string `json:"description,omitempty"`

	// NotificationTargets Notification targets for this alert policy.
	NotificationTargets []SloAlertNotificationTarget `json:"notificationTargets"`
}

SloAlertPolicySpec defines model for SloAlertPolicySpec.

type SloAnnotations added in v1.14.0

type SloAnnotations struct {
	// Dash0ComcreatedAt Timestamp when the SLO was created. Set by the server; read-only.
	Dash0ComcreatedAt *time.Time `json:"dash0.com/created-at,omitempty"`

	// Dash0ComdeletedAt Soft-delete timestamp. Present when the SLO has been deleted but not yet purged. Set by the server; read-only.
	Dash0ComdeletedAt *time.Time `json:"dash0.com/deleted-at,omitempty"`

	// Dash0Comenabled Whether the SLO is actively tracked. Dash0 extension. Client-settable. Stored as a string; valid values are 'true' and 'false'. Defaults to 'true'.
	Dash0Comenabled *string `json:"dash0.com/enabled,omitempty"`

	// Dash0ComfolderPath Optional UI folder path for organising SLOs (e.g. '/infrastructure/hosts'). Nesting is expressed with '/' separators.
	Dash0ComfolderPath *string `json:"dash0.com/folder-path,omitempty"`

	// Dash0Comsharing Comma-separated list of principals to grant read access to. Supported formats: 'team:<team_id>' and 'user:<email>'. Example: 'team:team_01abc,user:alice@example.com'. Sharing is honored only on assets that declare a dash0.com/origin (for example those managed by Terraform, the operator, the CLI, or the API). Setting it on an asset that declares no dash0.com/origin is rejected with a 400 — manage that asset's access via the UI share dialog instead.
	Dash0Comsharing *string `json:"dash0.com/sharing,omitempty"`

	// Dash0ComupdatedAt Timestamp of the last update. Set by the server; read-only.
	Dash0ComupdatedAt    *time.Time        `json:"dash0.com/updated-at,omitempty"`
	AdditionalProperties map[string]string `json:"-"`
}

SloAnnotations Resource annotations. Keys prefixed with `dash0.com/` are reserved for Dash0-managed metadata. Some reserved keys are server-managed and ignored when supplied by the caller (e.g. the timestamp annotations); others, like `dash0.com/enabled` and `dash0.com/display-name`, are client-settable and honored on write — see the individual property descriptions. `dash0.com/display-name` holds an optional human-readable display name of the SLO, used instead of `metadata.name` when set (blank values are treated as unset). Blank keys are ignored. Use any other key for user-defined annotations, which are stored and returned on read. At most 50 user-defined annotations are allowed.

func (SloAnnotations) Get added in v1.14.0

func (a SloAnnotations) Get(fieldName string) (value string, found bool)

Getter for additional properties for SloAnnotations. Returns the specified element and whether it was found

func (SloAnnotations) MarshalJSON added in v1.14.0

func (a SloAnnotations) MarshalJSON() ([]byte, error)

Override default JSON handling for SloAnnotations to handle AdditionalProperties

func (*SloAnnotations) Set added in v1.14.0

func (a *SloAnnotations) Set(fieldName string, value string)

Setter for additional properties for SloAnnotations

func (*SloAnnotations) UnmarshalJSON added in v1.14.0

func (a *SloAnnotations) UnmarshalJSON(b []byte) error

Override default JSON handling for SloAnnotations to handle AdditionalProperties

type SloBudgetingMethod added in v1.14.0

type SloBudgetingMethod string

SloBudgetingMethod - `Occurrences`: Ratio of counts of good events to total events. - `Timeslices`: Ratio of good time slices to total time slices. - `RatioTimeslices`: Average of all time slices' success ratios.

const (
	Occurrences     SloBudgetingMethod = "Occurrences"
	RatioTimeslices SloBudgetingMethod = "RatioTimeslices"
	Timeslices      SloBudgetingMethod = "Timeslices"
)

Defines values for SloBudgetingMethod.

type SloCalendarWindow added in v1.14.0

type SloCalendarWindow struct {
	// StartTime Start time in 24h format without time zone (e.g. '2020-01-21 12:30:00').
	StartTime string `json:"startTime"`

	// TimeZone IANA Time Zone Database name (e.g. 'America/New_York').
	TimeZone string `json:"timeZone"`
}

SloCalendarWindow Calendar alignment configuration for a time window.

type SloComparisonOperator added in v1.14.0

type SloComparisonOperator string

SloComparisonOperator Conditional operator used to compare the SLI against a threshold value.

const (
	Gt  SloComparisonOperator = "gt"
	Gte SloComparisonOperator = "gte"
	Lt  SloComparisonOperator = "lt"
	Lte SloComparisonOperator = "lte"
)

Defines values for SloComparisonOperator.

type SloDefinition added in v1.14.0

type SloDefinition struct {
	ApiVersion SloDefinitionApiVersion `json:"apiVersion"`
	Kind       SloDefinitionKind       `json:"kind"`
	Metadata   SloMetadata             `json:"metadata"`
	Spec       SloSpec                 `json:"spec"`
}

SloDefinition A Service Level Objective (SLO) that defines a target value or range of values for a service level, described by a Service Level Indicator (SLI). Implements a subset of the OpenSLO v1 specification (https://openslo.com/) with Dash0-specific extensions for access control, dataset scoping, and UI organization.

The API group accepts both the bare `openslo/v1` (upstream OpenSLO v1) and the domain-qualified `openslo.com/v1` on write; reads always return the domain-qualified `openslo.com/v1`. The domain-qualified form (a Dash0 drift from upstream OpenSLO v1's `openslo/v1`) is required so the same document is installable as a Kubernetes CustomResourceDefinition, whose API group must contain a dot.

Currently supported: a single objective with an inline `ratioMetric` indicator, `Occurrences` budgeting, and a rolling `4w` (28d) time window.

Not currently supported — requests using any of these are rejected with a 400 (the one exception is `alertPolicies`, see below): `thresholdMetric` SLIs; `indicatorRef`; `metricSource.metricSourceRef`; multiple or composite objectives (`compositeWeight`, per-objective `indicator`/`indicatorRef`); threshold objective fields (`op`/`value`); time-slice objective fields (`timeSliceTarget`/`timeSliceWindow`); `Timeslices` and `RatioTimeslices` budgeting; and calendar-aligned time windows.

Alerting on SLOs (spec.alertPolicies) is not supported. Unlike the other unsupported fields, `alertPolicies` is accepted for OpenSLO compatibility but silently ignored — it is not stored, evaluated, or returned on read; see spec.alertPolicies for details.

SLOs evaluate with a fixed 5-minute settling delay applied automatically: at any moment, the SLI reflects telemetry that arrived at least 5 minutes ago. This ensures late-arriving signals are included in the SLI computation, at the cost of a small, fixed lag between live behavior and SLO state.

type SloDefinitionApiVersion added in v1.14.0

type SloDefinitionApiVersion string

SloDefinitionApiVersion defines model for SloDefinition.ApiVersion.

const (
	OpensloComv1 SloDefinitionApiVersion = "openslo.com/v1"
	Openslov1    SloDefinitionApiVersion = "openslo/v1"
)

Defines values for SloDefinitionApiVersion.

type SloDefinitionKind added in v1.14.0

type SloDefinitionKind string

SloDefinitionKind defines model for SloDefinition.Kind.

const (
	SLO SloDefinitionKind = "SLO"
)

Defines values for SloDefinitionKind.

type SloIndicator added in v1.14.0

type SloIndicator struct {
	// Metadata Metadata for the inline SLI.
	Metadata *SloIndicatorMetadata `json:"metadata,omitempty"`

	// Spec SLI specification. A ratioMetric must be provided; thresholdMetric is not currently supported.
	Spec SloIndicatorSpec `json:"spec"`
}

SloIndicator Inline Service Level Indicator (SLI) following the OpenSLO SLI structure.

type SloIndicatorMetadata added in v1.14.0

type SloIndicatorMetadata struct {
	// DisplayName Human-readable display name for the SLI.
	DisplayName *string `json:"displayName,omitempty"`

	// Name Name of the SLI.
	Name *string `json:"name,omitempty"`
}

SloIndicatorMetadata Metadata for the inline SLI.

type SloIndicatorSpec added in v1.14.0

type SloIndicatorSpec struct {
	// Description Optional description of the SLI, up to 1050 characters.
	Description *string `json:"description,omitempty"`

	// RatioMetric Ratio-based SLI metric. Provide either good+total, bad+total, or raw with rawType.
	RatioMetric *SloRatioMetric `json:"ratioMetric,omitempty"`

	// ThresholdMetric Threshold-based SLI metric. Raw data from the metric source is compared against objective thresholds (op and value on the objective, not here). Not currently supported — use a ratioMetric instead.
	ThresholdMetric *SloThresholdMetric `json:"thresholdMetric,omitempty"`
}

SloIndicatorSpec SLI specification. A ratioMetric must be provided; thresholdMetric is not currently supported.

type SloLabels added in v1.14.0

type SloLabels struct {
	// Dash0Comdataset Dataset this SLO belongs to. Defaults to the default dataset when absent.
	Dash0Comdataset *string `json:"dash0.com/dataset,omitempty"`

	// Dash0Comid Unique internal ID of the SLO. Set by the server on creation; do not set manually.
	Dash0Comid *string `json:"dash0.com/id,omitempty"`

	// Dash0Comorigin External identifier for API-managed resources (e.g. the CRD name from an operator or Terraform resource ID). Empty for user-created SLOs; non-empty for SLOs created via the internal API. SLOs with a non-empty origin have write access controlled exclusively through explicit permission entries rather than by the admin role.
	Dash0Comorigin *string `json:"dash0.com/origin,omitempty"`

	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource *CrdSource `json:"dash0.com/source,omitempty"`

	// Dash0Comversion Current version of the SLO. Needs to be set when updating an SLO to prevent conflicting writes.
	Dash0Comversion      *string           `json:"dash0.com/version,omitempty"`
	AdditionalProperties map[string]string `json:"-"`
}

SloLabels Resource labels. Keys prefixed with `dash0.com/` are reserved for Dash0-managed metadata (id, version, dataset, origin, source); reserved or blank keys supplied by the caller are ignored. Use any other key for user-defined labels, which are stored and returned on read. At most 50 user-defined labels are allowed.

func (SloLabels) Get added in v1.14.0

func (a SloLabels) Get(fieldName string) (value string, found bool)

Getter for additional properties for SloLabels. Returns the specified element and whether it was found

func (SloLabels) MarshalJSON added in v1.14.0

func (a SloLabels) MarshalJSON() ([]byte, error)

Override default JSON handling for SloLabels to handle AdditionalProperties

func (*SloLabels) Set added in v1.14.0

func (a *SloLabels) Set(fieldName string, value string)

Setter for additional properties for SloLabels

func (*SloLabels) UnmarshalJSON added in v1.14.0

func (a *SloLabels) UnmarshalJSON(b []byte) error

Override default JSON handling for SloLabels to handle AdditionalProperties

type SloMetadata added in v1.14.0

type SloMetadata struct {
	// Annotations Resource annotations. Keys prefixed with `dash0.com/` are reserved for Dash0-managed
	// metadata. Some reserved keys are server-managed and ignored when supplied by the
	// caller (e.g. the timestamp annotations); others, like `dash0.com/enabled` and
	// `dash0.com/display-name`, are client-settable and honored on write — see the
	// individual property descriptions. `dash0.com/display-name` holds an optional
	// human-readable display name of the SLO, used instead of `metadata.name` when set
	// (blank values are treated as unset). Blank keys are ignored. Use any other key for
	// user-defined annotations, which are stored and returned on read. At most 50
	// user-defined annotations are allowed.
	Annotations *SloAnnotations `json:"annotations,omitempty"`

	// Labels Resource labels. Keys prefixed with `dash0.com/` are reserved for Dash0-managed
	// metadata (id, version, dataset, origin, source); reserved or blank keys supplied by
	// the caller are ignored. Use any other key for user-defined labels, which are stored
	// and returned on read. At most 50 user-defined labels are allowed.
	Labels *SloLabels `json:"labels,omitempty"`

	// Name Name of the SLO: an RFC 1123 compatible Kubernetes object name. Used as the display name when the `dash0.com/display-name` annotation is not set.
	Name string `json:"name"`
}

SloMetadata defines model for SloMetadata.

type SloMetricSource added in v1.14.0

type SloMetricSource struct {
	// MetricSourceRef Reference to an existing DataSource object by name. Not currently supported — provide an inline `spec.query` instead. Requests that set metricSourceRef are rejected with a 400.
	MetricSourceRef *string `json:"metricSourceRef,omitempty"`

	// Spec Data-source-specific query parameters. For Prometheus this is `{ query: "<bare PromQL vector selector>" }`.
	Spec map[string]interface{} `json:"spec"`

	// Type Predefined data source type. Only 'Prometheus' is currently supported (the default when omitted); other types are rejected with a 400.
	Type *string `json:"type,omitempty"`
}

SloMetricSource Connection and query details for a metric data source. Only the Prometheus data source is currently supported: provide `spec.query` as a bare PromQL vector selector (e.g. `http_requests_total{status="500"}`) — function calls and aggregations are not accepted.

type SloMetricSourceWrapper added in v1.14.0

type SloMetricSourceWrapper struct {
	// MetricSource Connection and query details for a metric data source. Only the Prometheus data source is currently supported: provide `spec.query` as a bare PromQL vector selector (e.g. `http_requests_total{status="500"}`) — function calls and aggregations are not accepted.
	MetricSource SloMetricSource `json:"metricSource"`
}

SloMetricSourceWrapper Wraps a metric source for use in ratio metric numerator/denominator/raw.

type SloObjective added in v1.14.0

type SloObjective struct {
	// CompositeWeight Weight multiplier for composite SLOs. Composite SLOs are not currently supported — requests that set it are rejected with a 400.
	CompositeWeight *float32 `json:"compositeWeight,omitempty"`

	// DisplayName Human-readable name for this objective.
	DisplayName *string `json:"displayName,omitempty"`

	// Indicator Inline Service Level Indicator (SLI) following the OpenSLO SLI structure.
	Indicator *SloIndicator `json:"indicator,omitempty"`

	// IndicatorRef Reference to an external SLI for composite SLOs. Composite SLOs are not currently supported — requests that set it are rejected with a 400.
	IndicatorRef *string `json:"indicatorRef,omitempty"`

	// Op Conditional operator used to compare the SLI against a threshold value.
	Op *SloComparisonOperator `json:"op,omitempty"`

	// Target Budget target for this objective as a fraction [0.0, 1.0). Mutually exclusive with targetPercent; one of the two must be provided.
	Target *float32 `json:"target,omitempty"`

	// TargetPercent Budget target for this objective as a percentage [0.0, 100). Mutually exclusive with target; one of the two must be provided.
	TargetPercent *float32 `json:"targetPercent,omitempty"`

	// TimeSliceTarget Target for the ratio of good time slices to total time slices (0.0, 1.0] (for Timeslices budgeting). Not currently supported — requests that set it are rejected with a 400.
	TimeSliceTarget *float32  `json:"timeSliceTarget,omitempty"`
	TimeSliceWindow *Duration `json:"timeSliceWindow,omitempty"`

	// Value Threshold value to compare against (for thresholdMetric SLIs). Not currently supported — requests that set it are rejected with a 400.
	Value *float32 `json:"value,omitempty"`
}

SloObjective An objective threshold for the SLO. Defines tolerance levels for the SLI metrics.

type SloRatioMetric added in v1.14.0

type SloRatioMetric struct {
	// Bad Wraps a metric source for use in ratio metric numerator/denominator/raw.
	Bad *SloMetricSourceWrapper `json:"bad,omitempty"`

	// Counter True if the metric is a monotonically increasing counter, false if it is a single number that can arbitrarily go up or down. Ignored when using raw.
	Counter *bool `json:"counter,omitempty"`

	// Good Wraps a metric source for use in ratio metric numerator/denominator/raw.
	Good *SloMetricSourceWrapper `json:"good,omitempty"`

	// Raw Wraps a metric source for use in ratio metric numerator/denominator/raw.
	Raw *SloMetricSourceWrapper `json:"raw,omitempty"`

	// RawType Required with raw. Indicates how the stored ratio was calculated:
	// - `success`: good/total
	// - `failure`: bad/total
	RawType *SloRawType `json:"rawType,omitempty"`

	// Total Wraps a metric source for use in ratio metric numerator/denominator/raw.
	Total *SloMetricSourceWrapper `json:"total,omitempty"`
}

SloRatioMetric Ratio-based SLI metric. Provide either good+total, bad+total, or raw with rawType.

type SloRawType added in v1.14.0

type SloRawType string

SloRawType Required with raw. Indicates how the stored ratio was calculated: - `success`: good/total - `failure`: bad/total

const (
	Failure SloRawType = "failure"
	Success SloRawType = "success"
)

Defines values for SloRawType.

type SloSpec added in v1.14.0

type SloSpec struct {
	// AlertPolicies Alert policies for this SLO, following the OpenSLO v1 specification.
	// Not supported by Dash0. This field is accepted for OpenSLO compatibility, but any alert policies are ignored: they are not stored, not evaluated, and not returned when reading the SLO back.
	AlertPolicies *[]SloAlertPolicy `json:"alertPolicies,omitempty"`

	// BudgetingMethod - `Occurrences`: Ratio of counts of good events to total events.
	// - `Timeslices`: Ratio of good time slices to total time slices.
	// - `RatioTimeslices`: Average of all time slices' success ratios.
	BudgetingMethod SloBudgetingMethod `json:"budgetingMethod"`

	// Description Optional description of the SLO, up to 1050 characters.
	Description *string `json:"description,omitempty"`

	// Indicator Inline Service Level Indicator (SLI) following the OpenSLO SLI structure.
	Indicator *SloIndicator `json:"indicator,omitempty"`

	// IndicatorRef Name of an external SLI. Not currently supported — provide an inline indicator instead. Requests that set indicatorRef are rejected with a 400.
	IndicatorRef *string `json:"indicatorRef,omitempty"`

	// Objectives Thresholds for the SLO. Exactly one objective is supported; multiple or composite objectives are not currently supported and requests declaring more than one objective are rejected with a 400.
	Objectives []SloObjective `json:"objectives"`

	// Service The service this SLO is associated with. A `/` separates the service namespace from the service name, so `payments/eu` resolves to namespace `payments` and name `eu`, and a value without a slash is just the service name. If a service name itself contains a `/`, prefix the value with a leading `/` to treat the rest as a literal name with no namespace; for example `/payments/eu` resolves to the name `payments/eu`. If nothing matches, the SLO is simply not linked to a service.
	Service *string `json:"service,omitempty"`

	// TimeWindow Optional. A single rolling time window with a `4w` (28d) duration. Only rolling `4w`/`28d` windows are currently supported; calendar-aligned windows and other durations are rejected with a 400. When omitted, a rolling 28d window is used. Note the evaluation window is currently fixed at 28d regardless of the value provided.
	TimeWindow *[]SloTimeWindow `json:"timeWindow,omitempty"`
}

SloSpec defines model for SloSpec.

type SloThresholdMetric added in v1.14.0

type SloThresholdMetric struct {
	// MetricSource Connection and query details for a metric data source. Only the Prometheus data source is currently supported: provide `spec.query` as a bare PromQL vector selector (e.g. `http_requests_total{status="500"}`) — function calls and aggregations are not accepted.
	MetricSource SloMetricSource `json:"metricSource"`
}

SloThresholdMetric Threshold-based SLI metric. Raw data from the metric source is compared against objective thresholds (op and value on the objective, not here). Not currently supported — use a ratioMetric instead.

type SloTimeWindow added in v1.14.0

type SloTimeWindow struct {
	// Calendar Calendar alignment configuration for a time window.
	Calendar *SloCalendarWindow `json:"calendar,omitempty"`
	Duration Duration           `json:"duration"`

	// IsRolling Whether this is a rolling time window. Must be true — only rolling windows are currently supported.
	IsRolling *bool `json:"isRolling,omitempty"`
}

SloTimeWindow A time window for the SLO. Only a rolling `4w`/`28d` window is currently supported.

type SourceMapIntegration added in v1.12.3

type SourceMapIntegration struct {
	Kind SourceMapIntegrationKind `json:"kind"`
	Spec SourceMapIntegrationSpec `json:"spec"`
}

SourceMapIntegration defines model for SourceMapIntegration.

type SourceMapIntegrationKind added in v1.12.3

type SourceMapIntegrationKind string

SourceMapIntegrationKind defines model for SourceMapIntegration.Kind.

const (
	SourceMap SourceMapIntegrationKind = "source_map"
)

Defines values for SourceMapIntegrationKind.

type SourceMapIntegrationSecrets added in v1.12.3

type SourceMapIntegrationSecrets struct {
	// BearerToken Bearer token for authorization
	BearerToken *string `json:"bearerToken,omitempty"`

	// Headers Secret header values keyed by header name
	Headers *map[string]string `json:"headers,omitempty"`

	// Password Basic auth password
	Password *string `json:"password,omitempty"`
}

SourceMapIntegrationSecrets defines model for SourceMapIntegrationSecrets.

type SourceMapIntegrationSpec added in v1.12.3

type SourceMapIntegrationSpec struct {
	// Headers Custom HTTP headers to include in requests
	Headers    *map[string]string           `json:"headers,omitempty"`
	Secrets    *SourceMapIntegrationSecrets `json:"secrets,omitempty"`
	SecretsRef *SecretRef                   `json:"secretsRef,omitempty"`

	// UrlPrefixes URL prefixes for source map matching
	UrlPrefixes []string `json:"urlPrefixes"`

	// Username Basic auth username
	Username *string `json:"username,omitempty"`
}

SourceMapIntegrationSpec defines model for SourceMapIntegrationSpec.

type SpamFilter added in v1.12.0

type SpamFilter = SpamFilterDefinition

SpamFilter is a convenience alias for SpamFilterDefinition (v1alpha1).

type SpamFilterAnnotations added in v1.12.0

type SpamFilterAnnotations struct {
	// Dash0Comenabled Whether this spam filter is active. Defaults to `"true"`.
	// When set to `"false"`, the filter is skipped.
	Dash0Comenabled *SpamFilterAnnotationsDash0Comenabled `json:"dash0.com/enabled,omitempty"`
}

SpamFilterAnnotations Spam filters use hard delete (removed from the dataset settings array), so there is no `dash0.com/deleted-at` annotation. Timestamps (`created-at`, `updated-at`) are not tracked because filters are stored as elements of a JSONB array inside the dataset settings, which has no per-element timestamp support.

type SpamFilterAnnotationsDash0Comenabled added in v1.12.0

type SpamFilterAnnotationsDash0Comenabled string

SpamFilterAnnotationsDash0Comenabled Whether this spam filter is active. Defaults to `"true"`. When set to `"false"`, the filter is skipped.

Defines values for SpamFilterAnnotationsDash0Comenabled.

type SpamFilterApiVersion added in v1.12.3

type SpamFilterApiVersion string

SpamFilterApiVersion API version of the spam filter CRD. - `v1alpha1`: spec uses `contexts` (array, single element). - `v1alpha2`: spec uses `context` (scalar).

const (
	SpamFilterApiVersionV1alpha1 SpamFilterApiVersion = "v1alpha1"
	SpamFilterApiVersionV1alpha2 SpamFilterApiVersion = "v1alpha2"
)

Defines values for SpamFilterApiVersion.

type SpamFilterApiVersionV1Alpha1 added in v1.12.1

type SpamFilterApiVersionV1Alpha1 string

SpamFilterApiVersionV1Alpha1 defines model for SpamFilterApiVersionV1Alpha1.

const (
	SpamFilterApiVersionV1Alpha1V1alpha1 SpamFilterApiVersionV1Alpha1 = "v1alpha1"
)

Defines values for SpamFilterApiVersionV1Alpha1.

type SpamFilterApiVersionV1Alpha2 added in v1.12.1

type SpamFilterApiVersionV1Alpha2 string

SpamFilterApiVersionV1Alpha2 defines model for SpamFilterApiVersionV1Alpha2.

const (
	V1alpha2 SpamFilterApiVersionV1Alpha2 = "v1alpha2"
)

Defines values for SpamFilterApiVersionV1Alpha2.

type SpamFilterCreateRequest added in v1.12.0

type SpamFilterCreateRequest struct {
	// contains filtered or unexported fields
}

SpamFilterCreateRequest defines model for SpamFilterCreateRequest.

func (SpamFilterCreateRequest) AsSpamFilterDefinition added in v1.12.1

func (t SpamFilterCreateRequest) AsSpamFilterDefinition() (SpamFilterDefinition, error)

AsSpamFilterDefinition returns the union data inside the SpamFilterCreateRequest as a SpamFilterDefinition

func (SpamFilterCreateRequest) AsSpamFilterDefinitionV1Alpha2 added in v1.12.1

func (t SpamFilterCreateRequest) AsSpamFilterDefinitionV1Alpha2() (SpamFilterDefinitionV1Alpha2, error)

AsSpamFilterDefinitionV1Alpha2 returns the union data inside the SpamFilterCreateRequest as a SpamFilterDefinitionV1Alpha2

func (*SpamFilterCreateRequest) FromSpamFilterDefinition added in v1.12.1

func (t *SpamFilterCreateRequest) FromSpamFilterDefinition(v SpamFilterDefinition) error

FromSpamFilterDefinition overwrites any union data inside the SpamFilterCreateRequest as the provided SpamFilterDefinition

func (*SpamFilterCreateRequest) FromSpamFilterDefinitionV1Alpha2 added in v1.12.1

func (t *SpamFilterCreateRequest) FromSpamFilterDefinitionV1Alpha2(v SpamFilterDefinitionV1Alpha2) error

FromSpamFilterDefinitionV1Alpha2 overwrites any union data inside the SpamFilterCreateRequest as the provided SpamFilterDefinitionV1Alpha2

func (SpamFilterCreateRequest) MarshalJSON added in v1.12.1

func (t SpamFilterCreateRequest) MarshalJSON() ([]byte, error)

func (*SpamFilterCreateRequest) MergeSpamFilterDefinition added in v1.12.1

func (t *SpamFilterCreateRequest) MergeSpamFilterDefinition(v SpamFilterDefinition) error

MergeSpamFilterDefinition performs a merge with any union data inside the SpamFilterCreateRequest, using the provided SpamFilterDefinition

func (*SpamFilterCreateRequest) MergeSpamFilterDefinitionV1Alpha2 added in v1.12.1

func (t *SpamFilterCreateRequest) MergeSpamFilterDefinitionV1Alpha2(v SpamFilterDefinitionV1Alpha2) error

MergeSpamFilterDefinitionV1Alpha2 performs a merge with any union data inside the SpamFilterCreateRequest, using the provided SpamFilterDefinitionV1Alpha2

func (*SpamFilterCreateRequest) UnmarshalJSON added in v1.12.1

func (t *SpamFilterCreateRequest) UnmarshalJSON(b []byte) error

type SpamFilterDefinition added in v1.12.0

type SpamFilterDefinition struct {
	ApiVersion *SpamFilterApiVersionV1Alpha1 `json:"apiVersion,omitempty"`
	Kind       SpamFilterDefinitionKind      `json:"kind"`
	Metadata   SpamFilterMetadata            `json:"metadata"`

	// Spec v1alpha1 spam filter specification. The `filter` field defines structured
	// criteria that the server compiles into an OTTL condition for evaluation.
	Spec SpamFilterSpec `json:"spec"`
}

SpamFilterDefinition v1alpha1 spam filter definition. Uses `contexts` (array) in the spec.

type SpamFilterDefinitionKind added in v1.12.0

type SpamFilterDefinitionKind string

SpamFilterDefinitionKind defines model for SpamFilterDefinition.Kind.

const (
	SpamFilterDefinitionKindDash0SpamFilter SpamFilterDefinitionKind = "Dash0SpamFilter"
)

Defines values for SpamFilterDefinitionKind.

type SpamFilterDefinitionV1Alpha2 added in v1.12.1

type SpamFilterDefinitionV1Alpha2 struct {
	ApiVersion SpamFilterApiVersionV1Alpha2     `json:"apiVersion"`
	Kind       SpamFilterDefinitionV1Alpha2Kind `json:"kind"`
	Metadata   SpamFilterMetadata               `json:"metadata"`

	// Spec v1alpha2 spam filter specification. The `filter` field defines structured
	// criteria that the server compiles into an OTTL condition for evaluation.
	Spec SpamFilterSpecV1Alpha2 `json:"spec"`
}

SpamFilterDefinitionV1Alpha2 v1alpha2 spam filter definition. Uses `context` (scalar) in the spec.

type SpamFilterDefinitionV1Alpha2Kind added in v1.12.1

type SpamFilterDefinitionV1Alpha2Kind string

SpamFilterDefinitionV1Alpha2Kind defines model for SpamFilterDefinitionV1Alpha2.Kind.

const (
	SpamFilterDefinitionV1Alpha2KindDash0SpamFilter SpamFilterDefinitionV1Alpha2Kind = "Dash0SpamFilter"
)

Defines values for SpamFilterDefinitionV1Alpha2Kind.

type SpamFilterLabels added in v1.12.0

type SpamFilterLabels struct {
	Custom          *map[string]string `json:"custom,omitempty"`
	Dash0Comdataset *string            `json:"dash0.com/dataset,omitempty"`
	Dash0Comid      *string            `json:"dash0.com/id,omitempty"`

	// Dash0Comorigin External identifier for this spam filter. Must be unique per
	// organization and dataset when set. Used by Infrastructure-as-Code
	// tools (Terraform, Kubernetes operator). Auto-generated as
	// `api-<uuid>` on POST if not provided.
	Dash0Comorigin *string `json:"dash0.com/origin,omitempty"`

	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource *CrdSource `json:"dash0.com/source,omitempty"`
}

SpamFilterLabels defines model for SpamFilterLabels.

type SpamFilterMetadata added in v1.12.0

type SpamFilterMetadata struct {
	// Annotations Spam filters use hard delete (removed from the dataset settings array),
	// so there is no `dash0.com/deleted-at` annotation. Timestamps
	// (`created-at`, `updated-at`) are not tracked because filters are stored
	// as elements of a JSONB array inside the dataset settings, which has no
	// per-element timestamp support.
	Annotations *SpamFilterAnnotations `json:"annotations,omitempty"`
	Labels      *SpamFilterLabels      `json:"labels,omitempty"`

	// Name Human-readable name for the spam filter.
	Name string `json:"name"`
}

SpamFilterMetadata defines model for SpamFilterMetadata.

type SpamFilterObject added in v1.12.1

type SpamFilterObject interface {
	// contains filtered or unexported methods
}

SpamFilterObject is the marker interface for spam filter values returned by Client.GetSpamFilter. The upstream API models the response as a union over v1alpha1 and v1alpha2 shapes; this SDK does not convert between versions, so the caller type-switches on the concrete type:

switch v := got.(type) {
case *SpamFilter:
    // v1alpha1: v.Spec.Contexts is a []TelemetryFilterContext
case *SpamFilterV1Alpha2:
    // v1alpha2: v.Spec.Context is a single TelemetryFilterContext
}

This mirrors the Kubernetes runtime.Object pattern: decode into whichever concrete type the wire actually carried, expose it through a marker, and let the caller dispatch.

type SpamFilterResponse added in v1.12.0

type SpamFilterResponse struct {
	// contains filtered or unexported fields
}

SpamFilterResponse defines model for SpamFilterResponse.

func (SpamFilterResponse) AsSpamFilterDefinition added in v1.12.1

func (t SpamFilterResponse) AsSpamFilterDefinition() (SpamFilterDefinition, error)

AsSpamFilterDefinition returns the union data inside the SpamFilterResponse as a SpamFilterDefinition

func (SpamFilterResponse) AsSpamFilterDefinitionV1Alpha2 added in v1.12.1

func (t SpamFilterResponse) AsSpamFilterDefinitionV1Alpha2() (SpamFilterDefinitionV1Alpha2, error)

AsSpamFilterDefinitionV1Alpha2 returns the union data inside the SpamFilterResponse as a SpamFilterDefinitionV1Alpha2

func (*SpamFilterResponse) FromSpamFilterDefinition added in v1.12.1

func (t *SpamFilterResponse) FromSpamFilterDefinition(v SpamFilterDefinition) error

FromSpamFilterDefinition overwrites any union data inside the SpamFilterResponse as the provided SpamFilterDefinition

func (*SpamFilterResponse) FromSpamFilterDefinitionV1Alpha2 added in v1.12.1

func (t *SpamFilterResponse) FromSpamFilterDefinitionV1Alpha2(v SpamFilterDefinitionV1Alpha2) error

FromSpamFilterDefinitionV1Alpha2 overwrites any union data inside the SpamFilterResponse as the provided SpamFilterDefinitionV1Alpha2

func (SpamFilterResponse) MarshalJSON added in v1.12.1

func (t SpamFilterResponse) MarshalJSON() ([]byte, error)

func (*SpamFilterResponse) MergeSpamFilterDefinition added in v1.12.1

func (t *SpamFilterResponse) MergeSpamFilterDefinition(v SpamFilterDefinition) error

MergeSpamFilterDefinition performs a merge with any union data inside the SpamFilterResponse, using the provided SpamFilterDefinition

func (*SpamFilterResponse) MergeSpamFilterDefinitionV1Alpha2 added in v1.12.1

func (t *SpamFilterResponse) MergeSpamFilterDefinitionV1Alpha2(v SpamFilterDefinitionV1Alpha2) error

MergeSpamFilterDefinitionV1Alpha2 performs a merge with any union data inside the SpamFilterResponse, using the provided SpamFilterDefinitionV1Alpha2

func (*SpamFilterResponse) UnmarshalJSON added in v1.12.1

func (t *SpamFilterResponse) UnmarshalJSON(b []byte) error

type SpamFilterSpec added in v1.12.0

type SpamFilterSpec struct {
	// Contexts The signal types this spam filter applies to.
	Contexts []TelemetryFilterContext `json:"contexts"`
	Filter   FilterCriteria           `json:"filter"`
}

SpamFilterSpec v1alpha1 spam filter specification. The `filter` field defines structured criteria that the server compiles into an OTTL condition for evaluation.

type SpamFilterSpecV1Alpha2 added in v1.12.1

type SpamFilterSpecV1Alpha2 struct {
	Context TelemetryFilterContext `json:"context"`
	Filter  FilterCriteria         `json:"filter"`
}

SpamFilterSpecV1Alpha2 v1alpha2 spam filter specification. The `filter` field defines structured criteria that the server compiles into an OTTL condition for evaluation.

type SpamFilterV1Alpha2 added in v1.12.1

type SpamFilterV1Alpha2 = SpamFilterDefinitionV1Alpha2

SpamFilterV1Alpha2 is a convenience alias for SpamFilterDefinitionV1Alpha2.

type Span

type Span struct {
	Attributes []KeyValue `json:"attributes"`

	// Dash0ForwardLinks Forward links pointing to spans in other traces.
	// The property is only included when `includeOTLPSchemaExtensions` is `true`.
	Dash0ForwardLinks *[]SpanLink `json:"dash0ForwardLinks,omitempty"`

	// Dash0Name The property is only included when `includeOTLPSchemaExtensions` is `true`.
	Dash0Name *string `json:"dash0Name,omitempty"`

	// Dash0TraceOriginParentSpanId The property is only included when `includeOTLPSchemaExtensions` is `true`.
	Dash0TraceOriginParentSpanId *[]byte `json:"dash0TraceOriginParentSpanId,omitempty"`

	// Dash0TraceOriginType The property is only included when `includeOTLPSchemaExtensions` is `true`.
	Dash0TraceOriginType   *string     `json:"dash0TraceOriginType,omitempty"`
	DroppedAttributesCount *int64      `json:"droppedAttributesCount,omitempty"`
	DroppedEventsCount     *int64      `json:"droppedEventsCount,omitempty"`
	DroppedLinksCount      *int64      `json:"droppedLinksCount,omitempty"`
	EndTimeUnixNano        string      `json:"endTimeUnixNano"`
	Events                 []SpanEvent `json:"events"`
	Flags                  *int64      `json:"flags,omitempty"`

	// HasChildren The property is only included when `includeOTLPSchemaExtensions` is `true`.
	HasChildren *bool `json:"hasChildren,omitempty"`

	// Kind // Unspecified. Do NOT use as default.
	// // Implementations MAY assume SpanKind to be INTERNAL when receiving UNSPECIFIED.
	// SPAN_KIND_UNSPECIFIED = 0;
	//
	// // Indicates that the span represents an internal operation within an application,
	// // as opposed to an operation happening at the boundaries. Default value.
	// SPAN_KIND_INTERNAL = 1;
	//
	// // Indicates that the span covers server-side handling of an RPC or other
	// // remote network request.
	// SPAN_KIND_SERVER = 2;
	//
	// // Indicates that the span describes a request to some remote service.
	// SPAN_KIND_CLIENT = 3;
	//
	// // Indicates that the span describes a producer sending a message to a broker.
	// // Unlike CLIENT and SERVER, there is often no direct critical path latency relationship
	// // between producer and consumer spans. A PRODUCER span ends when the message was accepted
	// // by the broker while the logical processing of the message might span a much longer time.
	// SPAN_KIND_PRODUCER = 4;
	//
	// // Indicates that the span describes consumer receiving a message from a broker.
	// // Like the PRODUCER kind, there is often no direct critical path latency relationship
	// // between producer and consumer spans.
	// SPAN_KIND_CONSUMER = 5;
	Kind              SpanKind   `json:"kind"`
	Links             []SpanLink `json:"links"`
	Name              string     `json:"name"`
	ParentSpanId      *[]byte    `json:"parentSpanId,omitempty"`
	SpanId            []byte     `json:"spanId"`
	StartTimeUnixNano string     `json:"startTimeUnixNano"`
	Status            SpanStatus `json:"status"`
	TraceId           []byte     `json:"traceId"`
	TraceState        *string    `json:"traceState,omitempty"`
}

Span defines model for Span.

type SpanEvent

type SpanEvent struct {
	Attributes             []KeyValue `json:"attributes"`
	DroppedAttributesCount *int64     `json:"droppedAttributesCount,omitempty"`
	Name                   string     `json:"name"`
	TimeUnixNano           string     `json:"timeUnixNano"`
}

SpanEvent defines model for SpanEvent.

type SpanExportFormat added in v1.18.1

type SpanExportFormat string

SpanExportFormat The serialization format of the exported file.

  • `txt`: One rendered span line per record, carrying a fixed field set of start timestamp, service, span name, duration, kind, status code, trace ID and span ID. Ignores `columns`.
  • `ndjson`: One OTLP JSON payload per line, each carrying a single span inside the same `resourceSpans` envelope `GetSpans` returns, so each line is independently parseable by any OTLP JSON consumer.
  • `yaml`: The same per-span OTLP payloads as `ndjson`, as a multi-document YAML stream with documents separated by `---`.
  • `csv`: A header row plus one row per span, flattened to the requested `columns`.
const (
	SpanExportFormatCsv    SpanExportFormat = "csv"
	SpanExportFormatNdjson SpanExportFormat = "ndjson"
	SpanExportFormatTxt    SpanExportFormat = "txt"
	SpanExportFormatYaml   SpanExportFormat = "yaml"
)

Defines values for SpanExportFormat.

type SpanKind

type SpanKind = int32

SpanKind // Unspecified. Do NOT use as default. // Implementations MAY assume SpanKind to be INTERNAL when receiving UNSPECIFIED. SPAN_KIND_UNSPECIFIED = 0;

// Indicates that the span represents an internal operation within an application, // as opposed to an operation happening at the boundaries. Default value. SPAN_KIND_INTERNAL = 1;

// Indicates that the span covers server-side handling of an RPC or other // remote network request. SPAN_KIND_SERVER = 2;

// Indicates that the span describes a request to some remote service. SPAN_KIND_CLIENT = 3;

// Indicates that the span describes a producer sending a message to a broker. // Unlike CLIENT and SERVER, there is often no direct critical path latency relationship // between producer and consumer spans. A PRODUCER span ends when the message was accepted // by the broker while the logical processing of the message might span a much longer time. SPAN_KIND_PRODUCER = 4;

// Indicates that the span describes consumer receiving a message from a broker. // Like the PRODUCER kind, there is often no direct critical path latency relationship // between producer and consumer spans. SPAN_KIND_CONSUMER = 5;

type SpanLink struct {
	Attributes             []KeyValue `json:"attributes"`
	DroppedAttributesCount *int64     `json:"droppedAttributesCount,omitempty"`
	Flags                  *int64     `json:"flags,omitempty"`
	SpanId                 []byte     `json:"spanId"`
	TraceId                []byte     `json:"traceId"`
	TraceState             *string    `json:"traceState,omitempty"`
}

SpanLink defines model for SpanLink.

type SpanStatus

type SpanStatus struct {
	// Code // The default status.
	// STATUS_CODE_UNSET               = 0;
	// // The Span has been validated by an Application developer or Operator to
	// // have completed successfully.
	// STATUS_CODE_OK                  = 1;
	// // The Span contains an error.
	// STATUS_CODE_ERROR               = 2;
	Code SpanStatusCode `json:"code"`

	// Message A developer-facing human readable error message.
	Message *string `json:"message,omitempty"`
}

SpanStatus defines model for SpanStatus.

type SpanStatusCode

type SpanStatusCode = int32

SpanStatusCode // The default status. STATUS_CODE_UNSET = 0; // The Span has been validated by an Application developer or Operator to // have completed successfully. STATUS_CODE_OK = 1; // The Span contains an error. STATUS_CODE_ERROR = 2;

type SpansDownloadRequest added in v1.18.1

type SpansDownloadRequest struct {
	// Columns Attribute keys to emit as columns, in order, for the `csv` format — resource,
	// scope, or span attributes (e.g. `service.name`, `otel.span.duration`). Ignored by
	// the other formats, which have a fixed field set.
	Columns *[]string `json:"columns,omitempty"`

	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset        `json:"dataset,omitempty"`
	Filter  *FilterCriteria `json:"filter,omitempty"`

	// Format The serialization format of the exported file.
	// - `txt`: One rendered span line per record, carrying a fixed field set of start
	//   timestamp, service, span name, duration, kind, status code, trace ID and span ID.
	//   Ignores `columns`.
	// - `ndjson`: One OTLP JSON payload per line, each carrying a single span inside the
	//   same `resourceSpans` envelope `GetSpans` returns, so each line is independently
	//   parseable by any OTLP JSON consumer.
	// - `yaml`: The same per-span OTLP payloads as `ndjson`, as a multi-document YAML
	//   stream with documents separated by `---`.
	// - `csv`: A header row plus one row per span, flattened to the requested `columns`.
	Format SpanExportFormat `json:"format"`

	// Limit The maximum number of spans to export. Defaults to, and is capped at, 5000.
	// A larger value is rejected rather than silently clamped. Use the Dash0 CLI
	// (`dash0 spans query`) to export volumes beyond this cap.
	Limit *int64 `json:"limit,omitempty"`

	// Ordering Any supported attribute keys to order by.
	Ordering *OrderingCriteria `json:"ordering,omitempty"`

	// TimeRange A range of time between two time references.
	TimeRange TimeReferenceRange `json:"timeRange"`
}

SpansDownloadRequest Request for the `SpansDownload` API. Accepts the same query as `GetSpans` (`filter`, `timeRange`, `dataset`, `ordering`) and returns the matching spans serialized as a downloadable file rather than as a JSON page.

The response is streamed, so the export is not paginated: a single request returns up to `limit` spans, capped at 5000. Adaptive sampling is always disabled for exports, so an exported file is never a sample. Unlike `GetSpans` this request therefore takes no `sampling`, and one sent anyway is ignored: the sampling path can substitute a duration-percentile filter and quietly change which spans the file contains, so exports never take it.

type SslCertificateAssertion

type SslCertificateAssertion struct {
	Kind SslCertificateAssertionKind `json:"kind"`
	Spec SslCertificateAssertionSpec `json:"spec"`
}

SslCertificateAssertion defines model for SslCertificateAssertion.

type SslCertificateAssertionKind

type SslCertificateAssertionKind string

SslCertificateAssertionKind defines model for SslCertificateAssertion.Kind.

const (
	SslCertificate SslCertificateAssertionKind = "ssl_certificate"
)

Defines values for SslCertificateAssertionKind.

type SslCertificateAssertionSpec

type SslCertificateAssertionSpec struct {
	Value Duration `json:"value"`
}

SslCertificateAssertionSpec defines model for SslCertificateAssertionSpec.

type StringAssertionOperator

type StringAssertionOperator string

StringAssertionOperator defines model for StringAssertionOperator.

const (
	Contains         StringAssertionOperator = "contains"
	DoesNotContain   StringAssertionOperator = "does_not_contain"
	DoesNotEndWith   StringAssertionOperator = "does_not_end_with"
	DoesNotMatch     StringAssertionOperator = "does_not_match"
	DoesNotStartWith StringAssertionOperator = "does_not_start_with"
	EndsWith         StringAssertionOperator = "ends_with"
	Is               StringAssertionOperator = "is"
	IsNot            StringAssertionOperator = "is_not"
	IsNotOneOf       StringAssertionOperator = "is_not_one_of"
	IsNotSet         StringAssertionOperator = "is_not_set"
	IsOneOf          StringAssertionOperator = "is_one_of"
	IsSet            StringAssertionOperator = "is_set"
	Matches          StringAssertionOperator = "matches"
	StartsWith       StringAssertionOperator = "starts_with"
)

Defines values for StringAssertionOperator.

type SyntheticCheckAction

type SyntheticCheckAction string

SyntheticCheckAction defines model for SyntheticCheckAction.

const (
	SyntheticCheckDelete SyntheticCheckAction = "synthetic_check:delete"
	SyntheticCheckRead   SyntheticCheckAction = "synthetic_check:read"
	SyntheticCheckWrite  SyntheticCheckAction = "synthetic_check:write"
)

Defines values for SyntheticCheckAction.

type SyntheticCheckAnnotations

type SyntheticCheckAnnotations struct {
	Dash0ComdeletedAt *time.Time `json:"dash0.com/deleted-at,omitempty"`

	// Dash0ComfolderPath Optional UI folder path for organising groups (e.g. '/infrastructure/hosts'). Nesting is expressed with '/' separators.
	Dash0ComfolderPath *string `json:"dash0.com/folder-path,omitempty"`

	// Dash0Comsharing Comma-separated list of principals to grant read access to. Supported formats: 'team:<team_id>' and 'user:<email>'. Example: 'team:team_01abc,user:alice@example.com'. Sharing is honored only on assets that declare a dash0.com/origin (for example those managed by Terraform, the operator, the CLI, or the API). Setting it on an asset that declares no dash0.com/origin is rejected with a 400 — manage that asset's access via the UI share dialog instead.
	Dash0Comsharing *string `json:"dash0.com/sharing,omitempty"`
}

SyntheticCheckAnnotations defines model for SyntheticCheckAnnotations.

type SyntheticCheckAttempt added in v1.4.0

type SyntheticCheckAttempt struct {
	// AttemptId (Internal) Unique identifier for the attempt
	AttemptId string `json:"attemptId"`

	// Duration duration in nanoseconds
	Duration int64 `json:"duration"`

	// ErrorMessage Error message of the synthetic check attempt, if any
	ErrorMessage *string                 `json:"errorMessage,omitempty"`
	ErrorType    *SyntheticHttpErrorType `json:"errorType,omitempty"`

	// FailedCriticalAssertions List of critical assertions that failed
	FailedCriticalAssertions []FailedHttpCheckAssertion `json:"failedCriticalAssertions"`

	// FailedDegradedAssertions List of degraded assertions that failed
	FailedDegradedAssertions []FailedHttpCheckAssertion `json:"failedDegradedAssertions"`

	// IsTestRun (Internal) Whether this attempt was triggered as a test run
	IsTestRun bool `json:"isTestRun"`

	// Location A geographic location identifier from which synthetic checks can be executed.
	Location SyntheticCheckLocation `json:"location"`

	// PassedCriticalAssertions List of critical assertions that passed
	PassedCriticalAssertions []HttpCheckAssertion `json:"passedCriticalAssertions"`

	// PassedDegradedAssertions List of degraded assertions that passed
	PassedDegradedAssertions []HttpCheckAssertion `json:"passedDegradedAssertions"`

	// RunId (Internal) Run ID this attempt belongs to
	RunId string `json:"runId"`

	// SpanId (Internal) Span ID associated with this attempt
	SpanId []byte `json:"spanId"`

	// StartTime A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	StartTime FixedTime `json:"startTime"`

	// StatusCode HTTP status code
	StatusCode int `json:"statusCode"`

	// SyntheticCheckId ID of the synthetic check
	SyntheticCheckId string `json:"syntheticCheckId"`

	// SyntheticCheckVersion Version of the synthetic check
	SyntheticCheckVersion string `json:"syntheticCheckVersion"`

	// TraceId (Internal) Trace ID associated with this attempt
	TraceId []byte `json:"traceId"`
}

SyntheticCheckAttempt defines model for SyntheticCheckAttempt.

type SyntheticCheckAttemptDetails added in v1.4.0

type SyntheticCheckAttemptDetails struct {
	// AttemptId (Internal) Unique identifier for the attempt
	AttemptId string `json:"attemptId"`

	// Duration duration in nanoseconds
	Duration int64 `json:"duration"`

	// ErrorMessage Error message of the synthetic check attempt, if any
	ErrorMessage *string                 `json:"errorMessage,omitempty"`
	ErrorType    *SyntheticHttpErrorType `json:"errorType,omitempty"`

	// Events Span events using OTLP SpanEvent format
	Events []SpanEvent `json:"events"`

	// FailedCriticalAssertions List of critical assertions that failed
	FailedCriticalAssertions []FailedHttpCheckAssertion `json:"failedCriticalAssertions"`

	// FailedDegradedAssertions List of degraded assertions that failed
	FailedDegradedAssertions []FailedHttpCheckAssertion `json:"failedDegradedAssertions"`

	// IsTestRun (Internal) Whether this attempt was triggered as a test run
	IsTestRun bool `json:"isTestRun"`

	// Location A geographic location identifier from which synthetic checks can be executed.
	Location SyntheticCheckLocation `json:"location"`

	// PassedCriticalAssertions List of critical assertions that passed
	PassedCriticalAssertions []HttpCheckAssertion `json:"passedCriticalAssertions"`

	// PassedDegradedAssertions List of degraded assertions that passed
	PassedDegradedAssertions []HttpCheckAssertion `json:"passedDegradedAssertions"`

	// RunId (Internal) Run ID this attempt belongs to
	RunId string `json:"runId"`

	// SpanAttributes Span attributes using OTLP KeyValue format
	SpanAttributes []KeyValue `json:"spanAttributes"`

	// SpanId (Internal) Span ID associated with this attempt
	SpanId []byte `json:"spanId"`

	// StartTime A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	StartTime FixedTime `json:"startTime"`

	// StatusCode HTTP status code
	StatusCode int `json:"statusCode"`

	// SyntheticCheckId ID of the synthetic check
	SyntheticCheckId string `json:"syntheticCheckId"`

	// SyntheticCheckVersion Version of the synthetic check
	SyntheticCheckVersion string `json:"syntheticCheckVersion"`

	// TraceId (Internal) Trace ID associated with this attempt
	TraceId []byte `json:"traceId"`
}

SyntheticCheckAttemptDetails defines model for SyntheticCheckAttemptDetails.

type SyntheticCheckDefinition

type SyntheticCheckDefinition struct {
	Kind     SyntheticCheckDefinitionKind `json:"kind"`
	Metadata SyntheticCheckMetadata       `json:"metadata"`
	Spec     SyntheticCheckSpec           `json:"spec"`
}

SyntheticCheckDefinition defines model for SyntheticCheckDefinition.

type SyntheticCheckDefinitionKind

type SyntheticCheckDefinitionKind string

SyntheticCheckDefinitionKind defines model for SyntheticCheckDefinition.Kind.

const (
	Dash0SyntheticCheck SyntheticCheckDefinitionKind = "Dash0SyntheticCheck"
)

Defines values for SyntheticCheckDefinitionKind.

type SyntheticCheckDisplay

type SyntheticCheckDisplay struct {
	// Name Short-form name for the view to be shown prominently within the view list and atop
	// the screen when the view is selected.
	Name string `json:"name"`
}

SyntheticCheckDisplay defines model for SyntheticCheckDisplay.

type SyntheticCheckLabels

type SyntheticCheckLabels struct {
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Custom          *map[string]string `json:"custom,omitempty"`
	Dash0Comdataset *string            `json:"dash0.com/dataset,omitempty"`
	Dash0Comid      *string            `json:"dash0.com/id,omitempty"`
	Dash0Comorigin  *string            `json:"dash0.com/origin,omitempty"`

	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource  *CrdSource `json:"dash0.com/source,omitempty"`
	Dash0Comversion *string    `json:"dash0.com/version,omitempty"`
}

SyntheticCheckLabels defines model for SyntheticCheckLabels.

type SyntheticCheckLocation added in v1.6.0

type SyntheticCheckLocation = string

SyntheticCheckLocation A geographic location identifier from which synthetic checks can be executed.

type SyntheticCheckMetadata

type SyntheticCheckMetadata struct {
	Annotations *SyntheticCheckAnnotations `json:"annotations,omitempty"`
	Description *string                    `json:"description,omitempty"`
	Labels      *SyntheticCheckLabels      `json:"labels,omitempty"`
	Name        string                     `json:"name"`
}

SyntheticCheckMetadata defines model for SyntheticCheckMetadata.

type SyntheticCheckNotifications

type SyntheticCheckNotifications struct {
	// Channels The channel IDs that notifications should be sent to in case the check is critical or degraded after
	// executing all the retries.
	Channels []openapi_types.UUID `json:"channels"`

	// OnlyCriticalChannels The channel IDs that should only trigger in case synthetic check status reaches critical state.
	OnlyCriticalChannels *[]openapi_types.UUID `json:"onlyCriticalChannels,omitempty"`
}

SyntheticCheckNotifications defines model for SyntheticCheckNotifications.

type SyntheticCheckPermission

type SyntheticCheckPermission struct {
	Actions []SyntheticCheckAction `json:"actions"`
	Role    *string                `json:"role,omitempty"`
	TeamId  *string                `json:"teamId,omitempty"`
	UserId  *string                `json:"userId,omitempty"`
}

SyntheticCheckPermission defines model for SyntheticCheckPermission.

type SyntheticCheckPlugin

type SyntheticCheckPlugin struct {
	// contains filtered or unexported fields
}

SyntheticCheckPlugin defines model for SyntheticCheckPlugin.

func (SyntheticCheckPlugin) AsSyntheticHttpCheckPlugin

func (t SyntheticCheckPlugin) AsSyntheticHttpCheckPlugin() (SyntheticHttpCheckPlugin, error)

AsSyntheticHttpCheckPlugin returns the union data inside the SyntheticCheckPlugin as a SyntheticHttpCheckPlugin

func (*SyntheticCheckPlugin) FromSyntheticHttpCheckPlugin

func (t *SyntheticCheckPlugin) FromSyntheticHttpCheckPlugin(v SyntheticHttpCheckPlugin) error

FromSyntheticHttpCheckPlugin overwrites any union data inside the SyntheticCheckPlugin as the provided SyntheticHttpCheckPlugin

func (SyntheticCheckPlugin) MarshalJSON

func (t SyntheticCheckPlugin) MarshalJSON() ([]byte, error)

func (*SyntheticCheckPlugin) MergeSyntheticHttpCheckPlugin

func (t *SyntheticCheckPlugin) MergeSyntheticHttpCheckPlugin(v SyntheticHttpCheckPlugin) error

MergeSyntheticHttpCheckPlugin performs a merge with any union data inside the SyntheticCheckPlugin, using the provided SyntheticHttpCheckPlugin

func (*SyntheticCheckPlugin) UnmarshalJSON

func (t *SyntheticCheckPlugin) UnmarshalJSON(b []byte) error

type SyntheticCheckRetries

type SyntheticCheckRetries struct {
	// contains filtered or unexported fields
}

SyntheticCheckRetries defines model for SyntheticCheckRetries.

func (SyntheticCheckRetries) AsSyntheticCheckRetriesExponential

func (t SyntheticCheckRetries) AsSyntheticCheckRetriesExponential() (SyntheticCheckRetriesExponential, error)

AsSyntheticCheckRetriesExponential returns the union data inside the SyntheticCheckRetries as a SyntheticCheckRetriesExponential

func (SyntheticCheckRetries) AsSyntheticCheckRetriesFixed

func (t SyntheticCheckRetries) AsSyntheticCheckRetriesFixed() (SyntheticCheckRetriesFixed, error)

AsSyntheticCheckRetriesFixed returns the union data inside the SyntheticCheckRetries as a SyntheticCheckRetriesFixed

func (SyntheticCheckRetries) AsSyntheticCheckRetriesLinear

func (t SyntheticCheckRetries) AsSyntheticCheckRetriesLinear() (SyntheticCheckRetriesLinear, error)

AsSyntheticCheckRetriesLinear returns the union data inside the SyntheticCheckRetries as a SyntheticCheckRetriesLinear

func (SyntheticCheckRetries) AsSyntheticCheckRetriesOff

func (t SyntheticCheckRetries) AsSyntheticCheckRetriesOff() (SyntheticCheckRetriesOff, error)

AsSyntheticCheckRetriesOff returns the union data inside the SyntheticCheckRetries as a SyntheticCheckRetriesOff

func (*SyntheticCheckRetries) FromSyntheticCheckRetriesExponential

func (t *SyntheticCheckRetries) FromSyntheticCheckRetriesExponential(v SyntheticCheckRetriesExponential) error

FromSyntheticCheckRetriesExponential overwrites any union data inside the SyntheticCheckRetries as the provided SyntheticCheckRetriesExponential

func (*SyntheticCheckRetries) FromSyntheticCheckRetriesFixed

func (t *SyntheticCheckRetries) FromSyntheticCheckRetriesFixed(v SyntheticCheckRetriesFixed) error

FromSyntheticCheckRetriesFixed overwrites any union data inside the SyntheticCheckRetries as the provided SyntheticCheckRetriesFixed

func (*SyntheticCheckRetries) FromSyntheticCheckRetriesLinear

func (t *SyntheticCheckRetries) FromSyntheticCheckRetriesLinear(v SyntheticCheckRetriesLinear) error

FromSyntheticCheckRetriesLinear overwrites any union data inside the SyntheticCheckRetries as the provided SyntheticCheckRetriesLinear

func (*SyntheticCheckRetries) FromSyntheticCheckRetriesOff

func (t *SyntheticCheckRetries) FromSyntheticCheckRetriesOff(v SyntheticCheckRetriesOff) error

FromSyntheticCheckRetriesOff overwrites any union data inside the SyntheticCheckRetries as the provided SyntheticCheckRetriesOff

func (SyntheticCheckRetries) MarshalJSON

func (t SyntheticCheckRetries) MarshalJSON() ([]byte, error)

func (*SyntheticCheckRetries) MergeSyntheticCheckRetriesExponential

func (t *SyntheticCheckRetries) MergeSyntheticCheckRetriesExponential(v SyntheticCheckRetriesExponential) error

MergeSyntheticCheckRetriesExponential performs a merge with any union data inside the SyntheticCheckRetries, using the provided SyntheticCheckRetriesExponential

func (*SyntheticCheckRetries) MergeSyntheticCheckRetriesFixed

func (t *SyntheticCheckRetries) MergeSyntheticCheckRetriesFixed(v SyntheticCheckRetriesFixed) error

MergeSyntheticCheckRetriesFixed performs a merge with any union data inside the SyntheticCheckRetries, using the provided SyntheticCheckRetriesFixed

func (*SyntheticCheckRetries) MergeSyntheticCheckRetriesLinear

func (t *SyntheticCheckRetries) MergeSyntheticCheckRetriesLinear(v SyntheticCheckRetriesLinear) error

MergeSyntheticCheckRetriesLinear performs a merge with any union data inside the SyntheticCheckRetries, using the provided SyntheticCheckRetriesLinear

func (*SyntheticCheckRetries) MergeSyntheticCheckRetriesOff

func (t *SyntheticCheckRetries) MergeSyntheticCheckRetriesOff(v SyntheticCheckRetriesOff) error

MergeSyntheticCheckRetriesOff performs a merge with any union data inside the SyntheticCheckRetries, using the provided SyntheticCheckRetriesOff

func (*SyntheticCheckRetries) UnmarshalJSON

func (t *SyntheticCheckRetries) UnmarshalJSON(b []byte) error

type SyntheticCheckRetriesExponential

type SyntheticCheckRetriesExponential struct {
	Kind SyntheticCheckRetriesExponentialKind `json:"kind"`
	Spec SyntheticCheckRetriesExponentialSpec `json:"spec"`
}

SyntheticCheckRetriesExponential defines model for SyntheticCheckRetriesExponential.

type SyntheticCheckRetriesExponentialKind

type SyntheticCheckRetriesExponentialKind string

SyntheticCheckRetriesExponentialKind defines model for SyntheticCheckRetriesExponential.Kind.

const (
	Exponential SyntheticCheckRetriesExponentialKind = "exponential"
)

Defines values for SyntheticCheckRetriesExponentialKind.

type SyntheticCheckRetriesExponentialSpec

type SyntheticCheckRetriesExponentialSpec struct {
	Attempts     int      `json:"attempts"`
	Delay        Duration `json:"delay"`
	MaximumDelay Duration `json:"maximumDelay"`
}

SyntheticCheckRetriesExponentialSpec defines model for SyntheticCheckRetriesExponentialSpec.

type SyntheticCheckRetriesFixed

type SyntheticCheckRetriesFixed struct {
	Kind SyntheticCheckRetriesFixedKind `json:"kind"`
	Spec SyntheticCheckRetriesFixedSpec `json:"spec"`
}

SyntheticCheckRetriesFixed defines model for SyntheticCheckRetriesFixed.

type SyntheticCheckRetriesFixedKind

type SyntheticCheckRetriesFixedKind string

SyntheticCheckRetriesFixedKind defines model for SyntheticCheckRetriesFixed.Kind.

const (
	Fixed SyntheticCheckRetriesFixedKind = "fixed"
)

Defines values for SyntheticCheckRetriesFixedKind.

type SyntheticCheckRetriesFixedSpec

type SyntheticCheckRetriesFixedSpec struct {
	Attempts int      `json:"attempts"`
	Delay    Duration `json:"delay"`
}

SyntheticCheckRetriesFixedSpec defines model for SyntheticCheckRetriesFixedSpec.

type SyntheticCheckRetriesLinear

type SyntheticCheckRetriesLinear struct {
	Kind SyntheticCheckRetriesLinearKind `json:"kind"`
	Spec SyntheticCheckRetriesLinearSpec `json:"spec"`
}

SyntheticCheckRetriesLinear defines model for SyntheticCheckRetriesLinear.

type SyntheticCheckRetriesLinearKind

type SyntheticCheckRetriesLinearKind string

SyntheticCheckRetriesLinearKind defines model for SyntheticCheckRetriesLinear.Kind.

const (
	SyntheticCheckRetriesLinearKindLinear SyntheticCheckRetriesLinearKind = "linear"
)

Defines values for SyntheticCheckRetriesLinearKind.

type SyntheticCheckRetriesLinearSpec

type SyntheticCheckRetriesLinearSpec struct {
	Attempts     int      `json:"attempts"`
	Delay        Duration `json:"delay"`
	MaximumDelay Duration `json:"maximumDelay"`
}

SyntheticCheckRetriesLinearSpec defines model for SyntheticCheckRetriesLinearSpec.

type SyntheticCheckRetriesOff

type SyntheticCheckRetriesOff struct {
	Kind SyntheticCheckRetriesOffKind `json:"kind"`
	Spec SyntheticCheckRetriesOffSpec `json:"spec"`
}

SyntheticCheckRetriesOff defines model for SyntheticCheckRetriesOff.

type SyntheticCheckRetriesOffKind

type SyntheticCheckRetriesOffKind string

SyntheticCheckRetriesOffKind defines model for SyntheticCheckRetriesOff.Kind.

const (
	Off SyntheticCheckRetriesOffKind = "off"
)

Defines values for SyntheticCheckRetriesOffKind.

type SyntheticCheckRetriesOffSpec

type SyntheticCheckRetriesOffSpec = interface{}

SyntheticCheckRetriesOffSpec defines model for SyntheticCheckRetriesOffSpec.

type SyntheticCheckSchedule

type SyntheticCheckSchedule struct {
	Interval  Duration                 `json:"interval"`
	Locations []SyntheticCheckLocation `json:"locations"`

	// Strategy Whether to run checks against all specified locations for every run, or just a single location per run.
	Strategy SyntheticCheckSchedulingStrategy `json:"strategy"`
}

SyntheticCheckSchedule defines model for SyntheticCheckSchedule.

type SyntheticCheckSchedulingStrategy

type SyntheticCheckSchedulingStrategy string

SyntheticCheckSchedulingStrategy Whether to run checks against all specified locations for every run, or just a single location per run.

const (
	AllLocations   SyntheticCheckSchedulingStrategy = "all_locations"
	RandomLocation SyntheticCheckSchedulingStrategy = "random_location"
)

Defines values for SyntheticCheckSchedulingStrategy.

type SyntheticCheckSpec

type SyntheticCheckSpec struct {
	Display       *SyntheticCheckDisplay      `json:"display,omitempty"`
	Enabled       bool                        `json:"enabled"`
	Labels        *map[string]string          `json:"labels,omitempty"`
	Notifications SyntheticCheckNotifications `json:"notifications"`
	Permissions   *[]SyntheticCheckPermission `json:"permissions,omitempty"`
	Plugin        SyntheticCheckPlugin        `json:"plugin"`
	Retries       SyntheticCheckRetries       `json:"retries"`
	Schedule      SyntheticCheckSchedule      `json:"schedule"`
}

SyntheticCheckSpec defines model for SyntheticCheckSpec.

type SyntheticChecksApiListItem

type SyntheticChecksApiListItem struct {
	Dataset string  `json:"dataset"`
	Id      string  `json:"id"`
	Name    *string `json:"name,omitempty"`
	Origin  *string `json:"origin,omitempty"`

	// Source Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Source *CrdSource `json:"source,omitempty"`
}

SyntheticChecksApiListItem defines model for SyntheticChecksApiListItem.

type SyntheticHttpCheckAssertions

type SyntheticHttpCheckAssertions struct {
	CriticalAssertions HttpCheckAssertions `json:"criticalAssertions"`
	DegradedAssertions HttpCheckAssertions `json:"degradedAssertions"`
}

SyntheticHttpCheckAssertions defines model for SyntheticHttpCheckAssertions.

type SyntheticHttpCheckPlugin

type SyntheticHttpCheckPlugin struct {
	Kind SyntheticHttpCheckPluginKind `json:"kind"`
	Spec SyntheticHttpCheckPluginSpec `json:"spec"`
}

SyntheticHttpCheckPlugin defines model for SyntheticHttpCheckPlugin.

type SyntheticHttpCheckPluginKind

type SyntheticHttpCheckPluginKind string

SyntheticHttpCheckPluginKind defines model for SyntheticHttpCheckPlugin.Kind.

const (
	Http SyntheticHttpCheckPluginKind = "http"
)

Defines values for SyntheticHttpCheckPluginKind.

type SyntheticHttpCheckPluginSpec

type SyntheticHttpCheckPluginSpec struct {
	Assertions SyntheticHttpCheckAssertions `json:"assertions"`
	Request    HttpRequestSpec              `json:"request"`
}

SyntheticHttpCheckPluginSpec defines model for SyntheticHttpCheckPluginSpec.

type SyntheticHttpErrorType

type SyntheticHttpErrorType string

SyntheticHttpErrorType defines model for SyntheticHttpErrorType.

const (
	SyntheticHttpErrorTypeDns     SyntheticHttpErrorType = "dns"
	SyntheticHttpErrorTypeTcp     SyntheticHttpErrorType = "tcp"
	SyntheticHttpErrorTypeTimeout SyntheticHttpErrorType = "timeout"
	SyntheticHttpErrorTypeTls     SyntheticHttpErrorType = "tls"
	SyntheticHttpErrorTypeUnknown SyntheticHttpErrorType = "unknown"
)

Defines values for SyntheticHttpErrorType.

type TeamAnnotations added in v1.17.0

type TeamAnnotations struct {
	// Dash0ComcreatedAt Timestamp when the team was created. Set by the server; read-only.
	Dash0ComcreatedAt *time.Time `json:"dash0.com/created-at,omitempty"`

	// Dash0ComupdatedAt Timestamp of the last update to the team. Set by the server; read-only.
	Dash0ComupdatedAt    *time.Time        `json:"dash0.com/updated-at,omitempty"`
	AdditionalProperties map[string]string `json:"-"`
}

TeamAnnotations Key/value annotations on the team. Arbitrary keys are accepted on write (the request is not rejected), but the server only interprets and persists the reserved `dash0.com/*` keys documented below. Any other key supplied by the client is silently dropped and will not appear on the response or on subsequent reads.

func (TeamAnnotations) Get added in v1.17.0

func (a TeamAnnotations) Get(fieldName string) (value string, found bool)

Getter for additional properties for TeamAnnotations. Returns the specified element and whether it was found

func (TeamAnnotations) MarshalJSON added in v1.17.0

func (a TeamAnnotations) MarshalJSON() ([]byte, error)

Override default JSON handling for TeamAnnotations to handle AdditionalProperties

func (*TeamAnnotations) Set added in v1.17.0

func (a *TeamAnnotations) Set(fieldName string, value string)

Setter for additional properties for TeamAnnotations

func (*TeamAnnotations) UnmarshalJSON added in v1.17.0

func (a *TeamAnnotations) UnmarshalJSON(b []byte) error

Override default JSON handling for TeamAnnotations to handle AdditionalProperties

type TeamApiVersion added in v1.17.0

type TeamApiVersion string

TeamApiVersion API version of the team CRD. Currently only `dash0.com/v1alpha1` is supported.

const (
	Dash0Comv1alpha1 TeamApiVersion = "dash0.com/v1alpha1"
)

Defines values for TeamApiVersion.

type TeamDefinition deprecated added in v1.4.0

type TeamDefinition = TeamDefinitionV1Alpha1

TeamDefinition is a deprecated alias for TeamDefinitionV1Alpha1.

Deprecated: since v1.17.0. Use TeamDefinitionV1Alpha1 instead. The alias is kept as a soft-rename shim so v1.x consumers can migrate without touching every call site in one go.

type TeamDefinitionV1Alpha1 added in v1.17.0

type TeamDefinitionV1Alpha1 struct {
	// ApiVersion API version of the team CRD. Currently only `dash0.com/v1alpha1` is
	// supported.
	ApiVersion *TeamApiVersion            `json:"apiVersion,omitempty"`
	Kind       TeamDefinitionV1Alpha1Kind `json:"kind"`
	Metadata   TeamMetadata               `json:"metadata"`
	Spec       TeamSpec                   `json:"spec"`
}

TeamDefinitionV1Alpha1 v1alpha1 team definition. `metadata.name` is the team's technical name (used e.g. as the CRD name in an operator manifest or a Terraform resource ID), `spec.display` carries the human-facing attributes (name, description, color) and `spec.members` is the declarative list of member IDs that make up the team. `metadata.name` and `spec.display.name` are persisted independently.

type TeamDefinitionV1Alpha1Kind added in v1.17.0

type TeamDefinitionV1Alpha1Kind string

TeamDefinitionV1Alpha1Kind defines model for TeamDefinitionV1Alpha1.Kind.

const (
	Dash0Team TeamDefinitionV1Alpha1Kind = "Dash0Team"
)

Defines values for TeamDefinitionV1Alpha1Kind.

type TeamDisplay added in v1.4.0

type TeamDisplay struct {
	// Color A color gradient from one color to another.
	Color       Gradient `json:"color"`
	Description *string  `json:"description,omitempty"`

	// Name Human-facing name of the team, used in the UI.
	Name string `json:"name"`
}

TeamDisplay defines model for TeamDisplay.

type TeamLabels added in v1.4.0

type TeamLabels struct {
	// Dash0Comid Unique internal ID of the team. Server-set on creation and
	// stable for the lifetime of the team; ignored if supplied on
	// POST and PUT request bodies.
	Dash0Comid *string `json:"dash0.com/id,omitempty"`

	// Dash0Comorigin External identifier for API-managed teams (e.g. the CRD name
	// from an operator manifest or a Terraform resource ID).
	// Client-settable on create only — a team's origin cannot be
	// changed once it exists. Empty for teams created via the UI;
	// non-empty for teams created via the internal API or reconciled
	// by an operator. Uniquely identifies a team within its
	// organization when present.
	Dash0Comorigin *string `json:"dash0.com/origin,omitempty"`

	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource       *CrdSource        `json:"dash0.com/source,omitempty"`
	AdditionalProperties map[string]string `json:"-"`
}

TeamLabels Key/value labels on the team. Arbitrary keys are accepted on write (the request is not rejected), but the server only interprets and persists the reserved `dash0.com/*` keys documented below. Any other key supplied by the client is silently dropped and will not appear on the response or on subsequent reads.

func (TeamLabels) Get added in v1.17.0

func (a TeamLabels) Get(fieldName string) (value string, found bool)

Getter for additional properties for TeamLabels. Returns the specified element and whether it was found

func (TeamLabels) MarshalJSON added in v1.17.0

func (a TeamLabels) MarshalJSON() ([]byte, error)

Override default JSON handling for TeamLabels to handle AdditionalProperties

func (*TeamLabels) Set added in v1.17.0

func (a *TeamLabels) Set(fieldName string, value string)

Setter for additional properties for TeamLabels

func (*TeamLabels) UnmarshalJSON added in v1.17.0

func (a *TeamLabels) UnmarshalJSON(b []byte) error

Override default JSON handling for TeamLabels to handle AdditionalProperties

type TeamMetadata added in v1.4.0

type TeamMetadata struct {
	// Annotations Key/value annotations on the team. Arbitrary keys are accepted on
	// write (the request is not rejected), but the server only interprets
	// and persists the reserved `dash0.com/*` keys documented below. Any
	// other key supplied by the client is silently dropped and will not
	// appear on the response or on subsequent reads.
	Annotations *TeamAnnotations `json:"annotations,omitempty"`

	// Labels Key/value labels on the team. Arbitrary keys are accepted on write
	// (the request is not rejected), but the server only interprets and
	// persists the reserved `dash0.com/*` keys documented below. Any
	// other key supplied by the client is silently dropped and will not
	// appear on the response or on subsequent reads.
	Labels *TeamLabels `json:"labels,omitempty"`

	// Name Technical name of the team (e.g. `platform-team`). Distinct from
	// `spec.display.name`, which carries the human-facing name. Persisted
	// verbatim and echoed on read responses.
	Name string `json:"name"`
}

TeamMetadata defines model for TeamMetadata.

type TeamSpec added in v1.4.0

type TeamSpec struct {
	Display TeamDisplay `json:"display"`

	// Members The declarative membership of the team. Each entry is either a
	// member's internal ID (the `dash0.com/id` label value returned
	// for the member, e.g. `user_01ABC...`) or an email address.
	// Emails are matched case-insensitively against the
	// organization's members and translated to internal IDs during
	// reconciliation, so callers can author teams with
	// human-readable references. An empty array clears the team's
	// membership; a `null`/missing value is rejected with 400.
	// Unresolvable email addresses cause the entire request to fail
	// with 400 listing every offender. Responses always echo the
	// resolved internal IDs.
	Members []string `json:"members"`
}

TeamSpec defines model for TeamSpec.

type TeamsListItem added in v1.4.0

type TeamsListItem struct {
	// Color A color gradient from one color to another.
	Color Gradient `json:"color"`
	Id    string   `json:"id"`

	// Members A sample of five members. You can inspect the total member count via `totalMemberCount`. This array
	// is restricted to at most five members, because this could otherwise be too much data.
	Members []MemberDefinition `json:"members"`
	Name    string             `json:"name"`
	Origin  *string            `json:"origin,omitempty"`

	// Source Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Source           *CrdSource `json:"source,omitempty"`
	TotalMemberCount int        `json:"totalMemberCount"`
}

TeamsListItem defines model for TeamsListItem.

type TeamsWebhookConfig added in v1.9.0

type TeamsWebhookConfig struct {
	Url string `json:"url"`
}

TeamsWebhookConfig defines model for TeamsWebhookConfig.

type TelemetryFilter added in v1.12.3

type TelemetryFilter struct {
	// ApiVersion API version of the spam filter CRD.
	// - `v1alpha1`: spec uses `contexts` (array, single element).
	// - `v1alpha2`: spec uses `context` (scalar).
	ApiVersion *SpamFilterApiVersion `json:"apiVersion,omitempty"`

	// Condition The OpenTelemetry Transformation Language (OTTL) is a small, domain-specific programming language intended to
	// process data with OpenTelemetry-native concepts and constructs. An OTTL *Condition* is a boolean expression
	// determining a certain behavior.
	//
	// OTTL conditions are only valid for specific evaluation contexts:
	// https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/ottl/README.md#getting-started
	//
	// Examples:
	//  - Within the context of telemetry filtering, a condition evaluating to true means that the data should be dropped.
	Condition OTTLCondition          `json:"condition"`
	Context   TelemetryFilterContext `json:"context"`

	// Enabled Whether this telemetry filter is active. When absent or true, the filter
	// is applied. When explicitly set to false, the filter is skipped.
	Enabled *bool           `json:"enabled,omitempty"`
	Filter  *FilterCriteria `json:"filter,omitempty"`

	// Id Unique identifier for this spam filter. Server-generated on creation.
	// For existing filters without an ID, a deterministic UUID is derived
	// from a hash of the filter specification or of the condition.
	Id *openapi_types.UUID `json:"id,omitempty"`

	// Name An optional human-readable name for this telemetry filter.
	Name *string `json:"name,omitempty"`

	// Origin Immutable external identifier for this spam filter, used by
	// Infrastructure-as-Code tools (Terraform, Kubernetes operator).
	// When set, the filter is read-only in the UI.
	Origin *string `json:"origin,omitempty"`

	// Source Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Source *CrdSource `json:"source,omitempty"`
}

TelemetryFilter defines model for TelemetryFilter.

type TelemetryFilterContext added in v1.12.0

type TelemetryFilterContext string

TelemetryFilterContext defines model for TelemetryFilterContext.

const (
	TelemetryFilterContextDatapoint TelemetryFilterContext = "datapoint"
	TelemetryFilterContextLog       TelemetryFilterContext = "log"
	TelemetryFilterContextSpan      TelemetryFilterContext = "span"
	TelemetryFilterContextWebEvent  TelemetryFilterContext = "web_event"
)

Defines values for TelemetryFilterContext.

type TelemetryTransformationRuleAnnotations added in v1.12.3

type TelemetryTransformationRuleAnnotations struct {
	// Dash0ComcreatedAt Timestamp when the rule was created. Set by the server; read-only.
	Dash0ComcreatedAt *time.Time `json:"dash0.com/created-at,omitempty"`

	// Dash0ComdeletedAt Soft-delete timestamp. Present when the rule has been deleted but not yet purged. Set by the server; read-only.
	Dash0ComdeletedAt *time.Time `json:"dash0.com/deleted-at,omitempty"`

	// Dash0ComupdatedAt Timestamp of the last update. Set by the server; read-only.
	Dash0ComupdatedAt *time.Time `json:"dash0.com/updated-at,omitempty"`
}

TelemetryTransformationRuleAnnotations defines model for TelemetryTransformationRuleAnnotations.

type TelemetryTransformationRuleContext added in v1.12.3

type TelemetryTransformationRuleContext string

TelemetryTransformationRuleContext The OTTL evaluation context that determines which telemetry fields are accessible to the statements. Not all contexts are valid for all signal types:

For `traces`: - `resource`: Transform resource-level attributes. - `scope`: Transform instrumentation scope-level attributes. - `span`: Transform individual span properties and attributes. - `spanevent`: Transform individual span event properties and attributes.

For `metrics`: - `resource`: Transform resource-level attributes. - `scope`: Transform instrumentation scope-level attributes. - `metric`: Transform metric-level properties (name, description, type). - `datapoint`: Transform individual metric data point attributes.

For `logs`: - `resource`: Transform resource-level attributes. - `scope`: Transform instrumentation scope-level attributes. - `log`: Transform individual log record properties (body, severity, attributes).

For `profiles`: - `resource`: Transform resource-level attributes. - `scope`: Transform instrumentation scope-level attributes. - `profile`: Transform individual profile properties and attributes.

Contexts never supply access to items lower in the protobuf hierarchy, but always supply access to items higher in the hierarchy. For example, a `datapoint` context can access its metric, scope, and resource, but a `metric` context cannot access individual data points.

const (
	TelemetryTransformationRuleContextDatapoint TelemetryTransformationRuleContext = "datapoint"
	TelemetryTransformationRuleContextLog       TelemetryTransformationRuleContext = "log"
	TelemetryTransformationRuleContextMetric    TelemetryTransformationRuleContext = "metric"
	TelemetryTransformationRuleContextProfile   TelemetryTransformationRuleContext = "profile"
	TelemetryTransformationRuleContextResource  TelemetryTransformationRuleContext = "resource"
	TelemetryTransformationRuleContextScope     TelemetryTransformationRuleContext = "scope"
	TelemetryTransformationRuleContextSpan      TelemetryTransformationRuleContext = "span"
	TelemetryTransformationRuleContextSpanevent TelemetryTransformationRuleContext = "spanevent"
)

Defines values for TelemetryTransformationRuleContext.

type TelemetryTransformationRuleDefinition added in v1.12.3

type TelemetryTransformationRuleDefinition struct {
	Kind     TelemetryTransformationRuleDefinitionKind `json:"kind"`
	Metadata TelemetryTransformationRuleMetadata       `json:"metadata"`
	Spec     TelemetryTransformationRuleSpec           `json:"spec"`
}

TelemetryTransformationRuleDefinition defines model for TelemetryTransformationRuleDefinition.

type TelemetryTransformationRuleDefinitionKind added in v1.12.3

type TelemetryTransformationRuleDefinitionKind string

TelemetryTransformationRuleDefinitionKind defines model for TelemetryTransformationRuleDefinition.Kind.

const (
	Dash0TelemetryTransformationRule TelemetryTransformationRuleDefinitionKind = "Dash0TelemetryTransformationRule"
)

Defines values for TelemetryTransformationRuleDefinitionKind.

type TelemetryTransformationRuleDisplay added in v1.12.3

type TelemetryTransformationRuleDisplay struct {
	// Name Short-form name for the view to be shown prominently within the view list and atop
	// the screen when the view is selected.
	Name string `json:"name"`
}

TelemetryTransformationRuleDisplay defines model for TelemetryTransformationRuleDisplay.

type TelemetryTransformationRuleLabels added in v1.12.3

type TelemetryTransformationRuleLabels struct {
	// Dash0Comdataset Dataset this rule belongs to. Defaults to the default dataset when absent.
	Dash0Comdataset *string `json:"dash0.com/dataset,omitempty"`

	// Dash0Comid Unique internal ID of the telemetry transformation rule. Set by the server on creation; do not set manually.
	Dash0Comid *string `json:"dash0.com/id,omitempty"`

	// Dash0Comorigin External identifier for API-managed resources (e.g. the CRD name from an operator or Terraform resource ID). Empty for user-created rules; non-empty for rules created via the internal API.
	Dash0Comorigin *string `json:"dash0.com/origin,omitempty"`

	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource *CrdSource `json:"dash0.com/source,omitempty"`

	// Dash0Comversion Current version of the rule. Needs to be set when updating a rule to prevent conflicting writes.
	Dash0Comversion *string `json:"dash0.com/version,omitempty"`
}

TelemetryTransformationRuleLabels defines model for TelemetryTransformationRuleLabels.

type TelemetryTransformationRuleMetadata added in v1.12.3

type TelemetryTransformationRuleMetadata struct {
	Annotations *TelemetryTransformationRuleAnnotations `json:"annotations,omitempty"`
	Labels      *TelemetryTransformationRuleLabels      `json:"labels,omitempty"`
	Name        string                                  `json:"name"`
}

TelemetryTransformationRuleMetadata defines model for TelemetryTransformationRuleMetadata.

type TelemetryTransformationRuleSignalType added in v1.12.3

type TelemetryTransformationRuleSignalType string

TelemetryTransformationRuleSignalType The signal type that this transformation rule applies to. - `traces`: Apply transformations to trace data (spans and span events). - `metrics`: Apply transformations to metric data (metrics and data points). - `logs`: Apply transformations to log data (log records). - `profiles`: Apply transformations to profile data.

const (
	TelemetryTransformationRuleSignalTypeLogs     TelemetryTransformationRuleSignalType = "logs"
	TelemetryTransformationRuleSignalTypeMetrics  TelemetryTransformationRuleSignalType = "metrics"
	TelemetryTransformationRuleSignalTypeProfiles TelemetryTransformationRuleSignalType = "profiles"
	TelemetryTransformationRuleSignalTypeTraces   TelemetryTransformationRuleSignalType = "traces"
)

Defines values for TelemetryTransformationRuleSignalType.

type TelemetryTransformationRuleSpec added in v1.12.3

type TelemetryTransformationRuleSpec struct {
	Conditions *OTTLConditions `json:"conditions,omitempty"`

	// Context The OTTL evaluation context that determines which telemetry fields are accessible to the statements.
	// Not all contexts are valid for all signal types:
	//
	// For `traces`:
	// - `resource`: Transform resource-level attributes.
	// - `scope`: Transform instrumentation scope-level attributes.
	// - `span`: Transform individual span properties and attributes.
	// - `spanevent`: Transform individual span event properties and attributes.
	//
	// For `metrics`:
	// - `resource`: Transform resource-level attributes.
	// - `scope`: Transform instrumentation scope-level attributes.
	// - `metric`: Transform metric-level properties (name, description, type).
	// - `datapoint`: Transform individual metric data point attributes.
	//
	// For `logs`:
	// - `resource`: Transform resource-level attributes.
	// - `scope`: Transform instrumentation scope-level attributes.
	// - `log`: Transform individual log record properties (body, severity, attributes).
	//
	// For `profiles`:
	// - `resource`: Transform resource-level attributes.
	// - `scope`: Transform instrumentation scope-level attributes.
	// - `profile`: Transform individual profile properties and attributes.
	//
	// Contexts never supply access to items lower in the protobuf hierarchy, but always supply access to
	// items higher in the hierarchy. For example, a `datapoint` context can access its metric, scope, and
	// resource, but a `metric` context cannot access individual data points.
	Context TelemetryTransformationRuleContext  `json:"context"`
	Display *TelemetryTransformationRuleDisplay `json:"display,omitempty"`
	Enabled bool                                `json:"enabled"`

	// Signal The signal type that this transformation rule applies to.
	// - `traces`: Apply transformations to trace data (spans and span events).
	// - `metrics`: Apply transformations to metric data (metrics and data points).
	// - `logs`: Apply transformations to log data (log records).
	// - `profiles`: Apply transformations to profile data.
	Signal     TelemetryTransformationRuleSignalType `json:"signal"`
	Statements OTTLStatements                        `json:"statements"`
}

TelemetryTransformationRuleSpec defines model for TelemetryTransformationRuleSpec.

type TestSyntheticCheckRequest added in v1.4.0

type TestSyntheticCheckRequest struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset    *Dataset                 `json:"dataset,omitempty"`
	Definition SyntheticCheckDefinition `json:"definition"`
}

TestSyntheticCheckRequest defines model for TestSyntheticCheckRequest.

type TestSyntheticCheckResponse added in v1.4.0

type TestSyntheticCheckResponse struct {
	SyntheticCheckAttempt SyntheticCheckAttemptDetails `json:"syntheticCheckAttempt"`
}

TestSyntheticCheckResponse defines model for TestSyntheticCheckResponse.

type TimeRange

type TimeRange struct {
	// From A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	From FixedTime `json:"from"`

	// To A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	To FixedTime `json:"to"`
}

TimeRange defines model for TimeRange.

type TimeReference

type TimeReference = any

TimeReference defines model for TimeReference.

type TimeReferenceRange

type TimeReferenceRange struct {
	From TimeReference `json:"from"`
	To   TimeReference `json:"to"`
}

TimeReferenceRange A range of time between two time references.

type TimeSeriesAggregationAnnotations added in v1.17.0

type TimeSeriesAggregationAnnotations struct {
	// Dash0ComcreatedAt Timestamp when the aggregation was created. Set by the server; read-only.
	Dash0ComcreatedAt *time.Time `json:"dash0.com/created-at,omitempty"`

	// Dash0ComdeletedAt Timestamp when the aggregation was soft-deleted. Set by the server; read-only. Absent unless the aggregation is deleted.
	Dash0ComdeletedAt *time.Time `json:"dash0.com/deleted-at,omitempty"`

	// Dash0ComupdatedAt Timestamp of the last update. Set by the server; read-only.
	Dash0ComupdatedAt *time.Time `json:"dash0.com/updated-at,omitempty"`
}

TimeSeriesAggregationAnnotations defines model for TimeSeriesAggregationAnnotations.

type TimeSeriesAggregationAttributeModification added in v1.12.3

type TimeSeriesAggregationAttributeModification struct {
	Kind TimeSeriesAggregationAttributeModificationKind `json:"kind"`
	Spec TimeSeriesAggregationAttributeModificationSpec `json:"spec"`
}

TimeSeriesAggregationAttributeModification defines model for TimeSeriesAggregationAttributeModification.

type TimeSeriesAggregationAttributeModificationContext added in v1.12.3

type TimeSeriesAggregationAttributeModificationContext string

TimeSeriesAggregationAttributeModificationContext defines model for TimeSeriesAggregationAttributeModificationContext.

const (
	TimeSeriesAggregationAttributeModificationContextDatapoint TimeSeriesAggregationAttributeModificationContext = "datapoint"
	TimeSeriesAggregationAttributeModificationContextResource  TimeSeriesAggregationAttributeModificationContext = "resource"
	TimeSeriesAggregationAttributeModificationContextScope     TimeSeriesAggregationAttributeModificationContext = "scope"
)

Defines values for TimeSeriesAggregationAttributeModificationContext.

type TimeSeriesAggregationAttributeModificationKind added in v1.12.3

type TimeSeriesAggregationAttributeModificationKind string

TimeSeriesAggregationAttributeModificationKind defines model for TimeSeriesAggregationAttributeModification.Kind.

const (
	DropAttributes TimeSeriesAggregationAttributeModificationKind = "drop_attributes"
	KeepAttributes TimeSeriesAggregationAttributeModificationKind = "keep_attributes"
)

Defines values for TimeSeriesAggregationAttributeModificationKind.

type TimeSeriesAggregationAttributeModificationSpec added in v1.12.3

type TimeSeriesAggregationAttributeModificationSpec struct {
	Context    *TimeSeriesAggregationAttributeModificationContext `json:"context,omitempty"`
	KeyMatcher Matcher                                            `json:"keyMatcher"`
}

TimeSeriesAggregationAttributeModificationSpec defines model for TimeSeriesAggregationAttributeModificationSpec.

type TimeSeriesAggregationDefinition added in v1.12.3

type TimeSeriesAggregationDefinition struct {
	Kind     TimeSeriesAggregationDefinitionKind `json:"kind"`
	Metadata TimeSeriesAggregationMetadata       `json:"metadata"`
	Spec     TimeSeriesAggregationSpec           `json:"spec"`
}

TimeSeriesAggregationDefinition defines model for TimeSeriesAggregationDefinition.

type TimeSeriesAggregationDefinitionKind added in v1.12.3

type TimeSeriesAggregationDefinitionKind string

TimeSeriesAggregationDefinitionKind defines model for TimeSeriesAggregationDefinition.Kind.

const (
	Dash0TimeSeriesAggregation TimeSeriesAggregationDefinitionKind = "Dash0TimeSeriesAggregation"
)

Defines values for TimeSeriesAggregationDefinitionKind.

type TimeSeriesAggregationDisplay added in v1.12.3

type TimeSeriesAggregationDisplay struct {
	// Name Short-form name for the view to be shown prominently within the view list and atop
	// the screen when the view is selected.
	Name string `json:"name"`
}

TimeSeriesAggregationDisplay defines model for TimeSeriesAggregationDisplay.

type TimeSeriesAggregationLabels added in v1.12.3

type TimeSeriesAggregationLabels struct {
	Custom          *map[string]string `json:"custom,omitempty"`
	Dash0Comdataset *string            `json:"dash0.com/dataset,omitempty"`
	Dash0Comid      *string            `json:"dash0.com/id,omitempty"`
	Dash0Comorigin  *string            `json:"dash0.com/origin,omitempty"`

	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource  *CrdSource `json:"dash0.com/source,omitempty"`
	Dash0Comversion *string    `json:"dash0.com/version,omitempty"`
}

TimeSeriesAggregationLabels defines model for TimeSeriesAggregationLabels.

type TimeSeriesAggregationListResponse added in v1.17.0

type TimeSeriesAggregationListResponse struct {
	TimeSeriesAggregations []TimeSeriesAggregationDefinition `json:"timeSeriesAggregations"`
}

TimeSeriesAggregationListResponse defines model for TimeSeriesAggregationListResponse.

type TimeSeriesAggregationMetadata added in v1.12.3

type TimeSeriesAggregationMetadata struct {
	Annotations *TimeSeriesAggregationAnnotations `json:"annotations,omitempty"`
	Labels      *TimeSeriesAggregationLabels      `json:"labels,omitempty"`
	Name        string                            `json:"name"`
}

TimeSeriesAggregationMetadata defines model for TimeSeriesAggregationMetadata.

type TimeSeriesAggregationMetricNameMatch added in v1.12.3

type TimeSeriesAggregationMetricNameMatch struct {
	MetricNameMatcher Matcher         `json:"metricNameMatcher"`
	OtherFilters      *FilterCriteria `json:"otherFilters,omitempty"`
}

TimeSeriesAggregationMetricNameMatch defines model for TimeSeriesAggregationMetricNameMatch.

type TimeSeriesAggregationSample added in v1.12.3

type TimeSeriesAggregationSample struct {
	Delay      *Duration `json:"delay,omitempty"`
	Interval   Duration  `json:"interval"`
	StaleAfter *Duration `json:"staleAfter,omitempty"`
}

TimeSeriesAggregationSample defines model for TimeSeriesAggregationSample.

type TimeSeriesAggregationSpec added in v1.12.3

type TimeSeriesAggregationSpec struct {
	AttributeModifications *[]TimeSeriesAggregationAttributeModification `json:"attributeModifications,omitempty"`
	Display                *TimeSeriesAggregationDisplay                 `json:"display,omitempty"`
	Enabled                bool                                          `json:"enabled"`
	Match                  TimeSeriesAggregationMetricNameMatch          `json:"match"`

	// Priority Precedence when more than one rule matches a metric. Lower values are evaluated first
	// (higher precedence). Defaults to 0. Rules with equal priority are ordered deterministically
	// by creation time, then by id.
	Priority *int                        `json:"priority,omitempty"`
	Sample   TimeSeriesAggregationSample `json:"sample"`
}

TimeSeriesAggregationSpec defines model for TimeSeriesAggregationSpec.

type TimingAssertion

type TimingAssertion struct {
	Kind TimingAssertionKind `json:"kind"`
	Spec TimingAssertionSpec `json:"spec"`
}

TimingAssertion defines model for TimingAssertion.

type TimingAssertionKind

type TimingAssertionKind string

TimingAssertionKind defines model for TimingAssertion.Kind.

const (
	Timing TimingAssertionKind = "timing"
)

Defines values for TimingAssertionKind.

type TimingAssertionSpec

type TimingAssertionSpec struct {
	Operator NumericAssertionOperator `json:"operator"`
	Type     TimingType               `json:"type"`
	Value    Duration                 `json:"value"`
}

TimingAssertionSpec defines model for TimingAssertionSpec.

type TimingType

type TimingType string

TimingType defines model for TimingType.

const (
	TimingTypeConnection TimingType = "connection"
	TimingTypeDns        TimingType = "dns"
	TimingTypeRequest    TimingType = "request"
	TimingTypeResponse   TimingType = "response"
	TimingTypeSsl        TimingType = "ssl"
	TimingTypeTotal      TimingType = "total"
)

Defines values for TimingType.

type TlsSettings

type TlsSettings struct {
	AllowInsecure bool `json:"allowInsecure"`
}

TlsSettings defines model for TlsSettings.

type TracingSettings

type TracingSettings struct {
	AddTracingHeaders bool `json:"addTracingHeaders"`
}

TracingSettings defines model for TracingSettings.

type Transport added in v1.8.0

type Transport struct {
	// contains filtered or unexported fields
}

Transport is a reusable HTTP transport stack that provides rate limiting and retry with exponential backoff. Build one with NewTransport and share it between raw http.Client usage and a typed Client via WithTransport.

A Transport is safe for concurrent use.

func NewTransport added in v1.8.0

func NewTransport(opts ...TransportOption) *Transport

NewTransport creates a configured Transport with rate limiting and retry. Values outside valid ranges are clamped silently.

Example:

t := dash0.NewTransport(
    dash0.WithTransportMaxRetries(3),
    dash0.WithTransportTimeout(10 * time.Second),
)
httpClient := t.HTTPClient()
Example
package main

import (
	"fmt"
	"time"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	t := dash0.NewTransport(
		dash0.WithTransportMaxRetries(3),
		dash0.WithTransportTimeout(10*time.Second),
	)
	fmt.Println(t.HTTPClient() != nil)
}
Output:
true

func (*Transport) HTTPClient added in v1.8.0

func (t *Transport) HTTPClient() *http.Client

HTTPClient returns a new http.Client that uses this transport's rate limiting and retry stack. Each call returns a new http.Client, but all returned clients share the same underlying transport so rate-limit budgets and concurrency limits are shared.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	t := dash0.NewTransport()
	httpClient := t.HTTPClient()
	fmt.Println(httpClient != nil)
}
Output:
true

func (*Transport) RoundTripper added in v1.8.0

func (t *Transport) RoundTripper() http.RoundTripper

RoundTripper returns the underlying http.RoundTripper with the full transport stack (rate limiting and retry) applied. Use this to plug the transport into an existing http.Client or other HTTP infrastructure.

type TransportOption added in v1.8.0

type TransportOption func(*transportConfig)

TransportOption configures a Transport.

func WithBaseTransport added in v1.8.0

func WithBaseTransport(rt http.RoundTripper) TransportOption

WithBaseTransport sets the underlying http.RoundTripper that the transport stack wraps. If not set, http.DefaultTransport is used.

func WithTransportMaxConcurrentRequests added in v1.8.0

func WithTransportMaxConcurrentRequests(n int64) TransportOption

WithTransportMaxConcurrentRequests sets the maximum number of concurrent API calls. The value must be between 1 and 10 (inclusive). Values outside this range will be clamped. Default is 3.

func WithTransportMaxRetries added in v1.8.0

func WithTransportMaxRetries(n int) TransportOption

WithTransportMaxRetries sets the maximum number of retries for failed requests. Only idempotent requests (GET, PUT, DELETE) and requests marked with withIdempotent context are retried. Default is 1. Maximum is 5. Set to 0 to disable retries.

func WithTransportRetryOnConflict added in v1.21.1

func WithTransportRetryOnConflict() TransportOption

WithTransportRetryOnConflict enables retrying requests that fail with 409 Conflict. Retrying a conflict is off unless this option is passed, so the option takes no argument.

See WithRetryOnConflict for what the 409 means and why replaying the request is safe.

Example
package main

import (
	"fmt"

	dash0 "github.com/dash0hq/dash0-api-client-go"
)

func main() {
	t := dash0.NewTransport(
		dash0.WithTransportMaxRetries(3),
		dash0.WithTransportRetryOnConflict(),
	)
	fmt.Println(t.RoundTripper() != nil)
}
Output:
true

func WithTransportRetryWaitMax added in v1.8.0

func WithTransportRetryWaitMax(d time.Duration) TransportOption

WithTransportRetryWaitMax sets the maximum wait time between retries. Default is 30s. The backoff will not exceed this value.

func WithTransportRetryWaitMin added in v1.8.0

func WithTransportRetryWaitMin(d time.Duration) TransportOption

WithTransportRetryWaitMin sets the minimum wait time between retries. Default is 500ms. The actual wait time uses exponential backoff starting from this value.

func WithTransportTimeout added in v1.8.0

func WithTransportTimeout(d time.Duration) TransportOption

WithTransportTimeout sets the HTTP request timeout applied to clients returned by Transport.HTTPClient. Default is 30 seconds.

type ViewAction

type ViewAction string

ViewAction defines model for ViewAction.

const (
	ViewsDelete ViewAction = "views:delete"
	ViewsRead   ViewAction = "views:read"
	ViewsWrite  ViewAction = "views:write"
)

Defines values for ViewAction.

type ViewAnnotations

type ViewAnnotations struct {
	Dash0ComdeletedAt *time.Time `json:"dash0.com/deleted-at,omitempty"`

	// Dash0ComfolderPath Optional UI folder path for organising groups (e.g. '/infrastructure/hosts'). Nesting is expressed with '/' separators.
	Dash0ComfolderPath *string `json:"dash0.com/folder-path,omitempty"`

	// Dash0Comsharing Comma-separated list of principals to grant read access to. Supported formats: 'team:<team_id>' and 'user:<email>'. Example: 'team:team_01abc,user:alice@example.com'. Sharing is honored only on assets that declare a dash0.com/origin (for example those managed by Terraform, the operator, the CLI, or the API). Setting it on an asset that declares no dash0.com/origin is rejected with a 400 — manage that asset's access via the UI share dialog instead.
	Dash0Comsharing *string `json:"dash0.com/sharing,omitempty"`
}

ViewAnnotations defines model for ViewAnnotations.

type ViewApiListItem

type ViewApiListItem struct {
	Dataset string  `json:"dataset"`
	Id      string  `json:"id"`
	Name    *string `json:"name,omitempty"`
	Origin  *string `json:"origin,omitempty"`

	// Type The view type describes where this view configuration is intended to be applied in the UI.
	Type ViewType `json:"type"`
}

ViewApiListItem defines model for ViewApiListItem.

type ViewDefinition

type ViewDefinition struct {
	Kind     ViewDefinitionKind `json:"kind"`
	Metadata ViewMetadata       `json:"metadata"`
	Spec     ViewSpec           `json:"spec"`
}

ViewDefinition defines model for ViewDefinition.

type ViewDefinitionKind

type ViewDefinitionKind string

ViewDefinitionKind defines model for ViewDefinition.Kind.

const (
	Dash0View ViewDefinitionKind = "Dash0View"
)

Defines values for ViewDefinitionKind.

type ViewDisplay

type ViewDisplay struct {
	// Description Long-form explanation what the view is doing. Shown within the list of views to help
	// team members understand the purpose of the view.
	Description *string `json:"description,omitempty"`

	// Name Short-form name for the view to be shown prominently within the view list and atop
	// the screen when the view is selected.
	Name string `json:"name"`
}

ViewDisplay defines model for ViewDisplay.

type ViewLabels

type ViewLabels struct {
	Dash0Comdataset *string `json:"dash0.com/dataset,omitempty"`
	Dash0Comid      *string `json:"dash0.com/id,omitempty"`
	Dash0Comorigin  *string `json:"dash0.com/origin,omitempty"`

	// Dash0Comsource Origin of a Dash0 resource, derived from `dash0.com/origin` on read.
	// - `ui`: created interactively in the Dash0 UI.
	// - `terraform`: managed via the Dash0 Terraform provider.
	// - `operator`: managed via the Dash0 Kubernetes operator.
	// - `dash0-cli`: managed via the Dash0 CLI.
	// - `platform`: owned by Dash0 rather than by anyone in your organization. Covers both
	//   resources Dash0 generates from another resource you own (the recording rules an SLO
	//   produces) and resources Dash0 ships with the product (the built-in views).
	// - `api`: created directly through the API, and the fallback for any origin whose
	//   prefix is not recognized.
	//
	// New values may be added over time. Treat an unrecognized value as `api`
	// rather than rejecting the response.
	Dash0Comsource  *CrdSource `json:"dash0.com/source,omitempty"`
	Dash0Comversion *string    `json:"dash0.com/version,omitempty"`
}

ViewLabels defines model for ViewLabels.

type ViewMetadata

type ViewMetadata struct {
	Annotations *ViewAnnotations `json:"annotations,omitempty"`
	Labels      *ViewLabels      `json:"labels,omitempty"`
	Name        string           `json:"name"`
}

ViewMetadata defines model for ViewMetadata.

type ViewPermission

type ViewPermission struct {
	// Actions Outlines possible actions that matching views can take with this view.
	Actions []ViewAction `json:"actions"`

	// Role Use role identifiers such as `admin` and `basic_member` to reference user groups.
	Role   *string `json:"role,omitempty"`
	TeamId *string `json:"teamId,omitempty"`
	UserId *string `json:"userId,omitempty"`
}

ViewPermission defines model for ViewPermission.

type ViewSpec

type ViewSpec struct {
	Display ViewDisplay     `json:"display"`
	Filter  *FilterCriteria `json:"filter,omitempty"`

	// GroupBy A set of attribute keys to group the view by. This property may be missing to indicate that
	// no configuration was historically made for this view, i.e., the view was saved before the
	// grouping capability was added. In that case, you can assume a default grouping should be used.
	GroupBy        *[]string         `json:"groupBy,omitempty"`
	ImplicitFilter *FilterCriteria   `json:"implicitFilter,omitempty"`
	Permissions    *[]ViewPermission `json:"permissions,omitempty"`

	// Query The SQL query associated with this view. Only applicable when type is "sql".
	// When the view is loaded, this query is used to populate the editor and auto-executed.
	Query                *string                       `json:"query,omitempty"`
	ServiceMapProperties *ViewSpecServiceMapProperties `json:"serviceMapProperties,omitempty"`

	// ServiceName The selected service name for this view. Only applicable when type is "profiles".
	// When the view is loaded, this service is pre-selected in the filter bar.
	ServiceName *string    `json:"serviceName,omitempty"`
	Table       *ViewTable `json:"table,omitempty"`

	// Type The view type describes where this view configuration is intended to be applied in the UI.
	Type ViewType `json:"type"`

	// Visualizations A visualization configuration for the view. We only support a single visualization for now per view.
	Visualizations *[]ViewVisualization `json:"visualizations,omitempty"`
}

ViewSpec defines model for ViewSpec.

type ViewSpecServiceMapProperties added in v1.2.0

type ViewSpecServiceMapProperties struct {
	// ExpandedGroups A list of expanded group identifiers in the service map. When external services are grouped,
	// individual groups can be expanded to show all services within. This list stores which groups
	// are currently expanded.
	ExpandedGroups   *[]string                                    `json:"expandedGroups,omitempty"`
	ExternalServices ViewSpecServiceMapPropertiesExternalServices `json:"externalServices"`
	Layout           ViewSpecServiceMapPropertiesLayout           `json:"layout"`
	NodeSizing       bool                                         `json:"nodeSizing"`
	Particles        bool                                         `json:"particles"`
	SelectedMetric   string                                       `json:"selectedMetric"`
}

ViewSpecServiceMapProperties defines model for ViewSpecServiceMapProperties.

type ViewSpecServiceMapPropertiesExternalServices added in v1.2.0

type ViewSpecServiceMapPropertiesExternalServices string

ViewSpecServiceMapPropertiesExternalServices defines model for ViewSpecServiceMapProperties.ExternalServices.

Defines values for ViewSpecServiceMapPropertiesExternalServices.

type ViewSpecServiceMapPropertiesLayout added in v1.2.0

type ViewSpecServiceMapPropertiesLayout string

ViewSpecServiceMapPropertiesLayout defines model for ViewSpecServiceMapProperties.Layout.

Defines values for ViewSpecServiceMapPropertiesLayout.

type ViewTable

type ViewTable struct {
	Columns []ViewTableColumn `json:"columns"`

	// Sort Any supported attribute keys to order by.
	Sort OrderingCriteria `json:"sort"`
}

ViewTable defines model for ViewTable.

type ViewTableColumn

type ViewTableColumn struct {
	// ColSize A CSS grid layout sizing instruction. Supports hard-coded sizing such as `7rem`, but also `min-content`
	// and similar variants.
	ColSize *string `json:"colSize,omitempty"`

	// Key The key of the attribute to be displayed in this column. This can also be a built-in column name.
	Key   string  `json:"key"`
	Label *string `json:"label,omitempty"`
}

ViewTableColumn defines model for ViewTableColumn.

type ViewType

type ViewType string

ViewType The view type describes where this view configuration is intended to be applied in the UI.

const (
	AwsLambda            ViewType = "aws_lambda"
	FailedChecks         ViewType = "failed_checks"
	GcpCloudRunJobs      ViewType = "gcp_cloud_run_jobs"
	GcpCloudRunServices  ViewType = "gcp_cloud_run_services"
	GcpCloudSqlInstances ViewType = "gcp_cloud_sql_instances"
	GcpCloudStorage      ViewType = "gcp_cloud_storage"
	GcpPubsub            ViewType = "gcp_pubsub"
	Logs                 ViewType = "logs"
	Metrics              ViewType = "metrics"
	Profiles             ViewType = "profiles"
	Resources            ViewType = "resources"
	Services             ViewType = "services"
	Slos                 ViewType = "slos"
	Spans                ViewType = "spans"
	Sql                  ViewType = "sql"
	WebEvents            ViewType = "web_events"
)

Defines values for ViewType.

type ViewVisualization

type ViewVisualization struct {
	Metric *ViewVisualizationMetric `json:"metric,omitempty"`

	// Renderer The renderer type for the visualization. The pattern matching is inspired by glob, where `*` can be used as a wildcard.
	// The matching prioritizes precise matches before wildcard matches.
	// If there are multiple renderers, select buttons will be added to allow toggling between the renderers.
	Renderer *ViewVisualizationRenderer `json:"renderer,omitempty"`

	// Renderers A set of visualizations (charts) to render as part of this view. We currently only expect
	// to render a single
	Renderers  []ViewVisualizationRenderer `json:"renderers"`
	YAxisScale *AxisScale                  `json:"yAxisScale,omitempty"`
}

ViewVisualization defines model for ViewVisualization.

type ViewVisualizationMetric

type ViewVisualizationMetric string

ViewVisualizationMetric defines model for ViewVisualizationMetric.

const (
	LogsRate              ViewVisualizationMetric = "logs_rate"
	LogsTotal             ViewVisualizationMetric = "logs_total"
	SpansDurationAvg      ViewVisualizationMetric = "spans_duration_avg"
	SpansDurationP50      ViewVisualizationMetric = "spans_duration_p50"
	SpansDurationP75      ViewVisualizationMetric = "spans_duration_p75"
	SpansDurationP90      ViewVisualizationMetric = "spans_duration_p90"
	SpansDurationP95      ViewVisualizationMetric = "spans_duration_p95"
	SpansDurationP99      ViewVisualizationMetric = "spans_duration_p99"
	SpansErrorsPercentage ViewVisualizationMetric = "spans_errors_percentage"
	SpansErrorsRate       ViewVisualizationMetric = "spans_errors_rate"
	SpansErrorsTotal      ViewVisualizationMetric = "spans_errors_total"
	SpansRate             ViewVisualizationMetric = "spans_rate"
	SpansTotal            ViewVisualizationMetric = "spans_total"
)

Defines values for ViewVisualizationMetric.

type ViewVisualizationRenderer

type ViewVisualizationRenderer string

ViewVisualizationRenderer The renderer type for the visualization. The pattern matching is inspired by glob, where `*` can be used as a wildcard. The matching prioritizes precise matches before wildcard matches. If there are multiple renderers, select buttons will be added to allow toggling between the renderers.

const (
	LoggingstackedBar                    ViewVisualizationRenderer = "logging/*/stacked_bar"
	Resourcesfaasred                     ViewVisualizationRenderer = "resources/faas/red"
	Resourcesk8sCronJobsexecutions       ViewVisualizationRenderer = "resources/k8s-cron-jobs/executions"
	Resourcesk8sCronJobsred              ViewVisualizationRenderer = "resources/k8s-cron-jobs/red"
	Resourcesk8sDaemonSetsred            ViewVisualizationRenderer = "resources/k8s-daemon-sets/red"
	Resourcesk8sDaemonSetsscheduledNodes ViewVisualizationRenderer = "resources/k8s-daemon-sets/scheduled-nodes"
	Resourcesk8sDeploymentsred           ViewVisualizationRenderer = "resources/k8s-deployments/red"
	Resourcesk8sDeploymentsreplicas      ViewVisualizationRenderer = "resources/k8s-deployments/replicas"
	Resourcesk8sJobsexecutions           ViewVisualizationRenderer = "resources/k8s-jobs/executions"
	Resourcesk8sJobsred                  ViewVisualizationRenderer = "resources/k8s-jobs/red"
	Resourcesk8sNamespacesred            ViewVisualizationRenderer = "resources/k8s-namespaces/red"
	Resourcesk8sNodescpuMemoryDisk       ViewVisualizationRenderer = "resources/k8s-nodes/cpu-memory-disk"
	Resourcesk8sNodesstatus              ViewVisualizationRenderer = "resources/k8s-nodes/status"
	Resourcesk8sPodscpuMemory            ViewVisualizationRenderer = "resources/k8s-pods/cpu-memory"
	Resourcesk8sPodsred                  ViewVisualizationRenderer = "resources/k8s-pods/red"
	Resourcesk8sPodsstatus               ViewVisualizationRenderer = "resources/k8s-pods/status"
	Resourcesk8sReplicaSetsred           ViewVisualizationRenderer = "resources/k8s-replica-sets/red"
	Resourcesk8sReplicaSetsreplicas      ViewVisualizationRenderer = "resources/k8s-replica-sets/replicas"
	Resourcesk8sStatefulSetsred          ViewVisualizationRenderer = "resources/k8s-stateful-sets/red"
	Resourcesk8sStatefulSetsreplicas     ViewVisualizationRenderer = "resources/k8s-stateful-sets/replicas"
	Resourcesnamesred                    ViewVisualizationRenderer = "resources/names/red"
	Resourcesoperationsred               ViewVisualizationRenderer = "resources/operations/red"
	Resourcesoverviewoverview            ViewVisualizationRenderer = "resources/overview/overview"
	Resourcesservicesred                 ViewVisualizationRenderer = "resources/services/red"
	ResourcestableTree                   ViewVisualizationRenderer = "resources/*/table-tree"
	TracesExploreroutliers               ViewVisualizationRenderer = "traces-explorer/*/outliers"
	TracesExplorerred                    ViewVisualizationRenderer = "traces-explorer/*/red"
)

Defines values for ViewVisualizationRenderer.

type WebEventExportFormat added in v1.18.1

type WebEventExportFormat string

WebEventExportFormat The serialization format of the exported file.

  • `txt`: One rendered line per web event, carrying a fixed field set of timestamp, service, event name, title, duration and trace ID. Ignores `columns`.
  • `ndjson`: One OTLP JSON payload per line, each carrying a single web event inside the same `resourceLogs` envelope `GetWebEvents` returns — web events are stored as OTLP log records — so each line is independently parseable by any OTLP JSON consumer.
  • `yaml`: The same per-event OTLP payloads as `ndjson`, as a multi-document YAML stream with documents separated by `---`.
  • `csv`: A header row plus one row per web event, flattened to the requested `columns`.
const (
	Csv    WebEventExportFormat = "csv"
	Ndjson WebEventExportFormat = "ndjson"
	Txt    WebEventExportFormat = "txt"
	Yaml   WebEventExportFormat = "yaml"
)

Defines values for WebEventExportFormat.

type WebEventsDownloadRequest added in v1.18.1

type WebEventsDownloadRequest struct {
	// Columns Attribute keys to emit as columns, in order, for the `csv` format — resource,
	// scope, or event attributes (e.g. `service.name`, `event.name`,
	// `dash0.web.event.duration`). Ignored by the other formats, which have a fixed
	// field set.
	Columns *[]string `json:"columns,omitempty"`

	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset    *Dataset        `json:"dataset,omitempty"`
	EventNames *[]string       `json:"eventNames,omitempty"`
	Filter     *FilterCriteria `json:"filter,omitempty"`

	// Format The serialization format of the exported file.
	// - `txt`: One rendered line per web event, carrying a fixed field set of timestamp,
	//   service, event name, title, duration and trace ID. Ignores `columns`.
	// - `ndjson`: One OTLP JSON payload per line, each carrying a single web event inside
	//   the same `resourceLogs` envelope `GetWebEvents` returns — web events are stored as
	//   OTLP log records — so each line is independently parseable by any OTLP JSON
	//   consumer.
	// - `yaml`: The same per-event OTLP payloads as `ndjson`, as a multi-document YAML
	//   stream with documents separated by `---`.
	// - `csv`: A header row plus one row per web event, flattened to the requested `columns`.
	Format WebEventExportFormat `json:"format"`

	// Limit The maximum number of web events to export. Defaults to, and is capped at, 5000.
	// A larger value is rejected rather than silently clamped.
	Limit *int64 `json:"limit,omitempty"`

	// Ordering Any supported attribute keys to order by.
	Ordering    *OrderingCriteria `json:"ordering,omitempty"`
	ServiceName *string           `json:"serviceName,omitempty"`

	// TimeRange A range of time between two time references.
	TimeRange TimeReferenceRange `json:"timeRange"`
}

WebEventsDownloadRequest Request for the `WebEventsDownload` API. Accepts the same query as `GetWebEvents` (`serviceName`, `eventNames`, `filter`, `timeRange`, `dataset`, `ordering`) and returns the matching web events serialized as a downloadable file rather than as a JSON page.

The response is streamed, so the export is not paginated: a single request returns up to `limit` events, capped at 5000. Unlike the log and span exports there is no adaptive sampling to disable — web-event retrieval does not sample — so an exported file is the query's whole result set up to the cap.

There is no Dash0 CLI command for web events, so the cap is the only limit; a query matching more than 5000 events has to be narrowed to be exported in full.

type WebhookAgenticWorkflowTrigger added in v1.17.0

type WebhookAgenticWorkflowTrigger struct {
	Kind WebhookAgenticWorkflowTriggerKind `json:"kind"`
	Spec EmptyAgenticWorkflowTriggerSpec   `json:"spec"`

	// Task Optional per-trigger task/instruction prompt. When set, it is rendered with the same
	// `{{variable.name}}` substitution as `spec.prompt.user` and used as the task turn for
	// invocations from this trigger: the kickoff framing when the trigger spawns a new agent,
	// or the event framing when it continues an existing one. When omitted, the
	// automation-level `spec.prompt.user` (on spawn) or a connector-default event summary (on
	// continue) is used instead. The automation-level standing prompt is injected only once,
	// on spawn, and is not re-sent on continue.
	Task *AgenticWorkflowTriggerTask `json:"task,omitempty"`
}

WebhookAgenticWorkflowTrigger defines model for WebhookAgenticWorkflowTrigger.

type WebhookAgenticWorkflowTriggerKind added in v1.17.0

type WebhookAgenticWorkflowTriggerKind string

WebhookAgenticWorkflowTriggerKind defines model for WebhookAgenticWorkflowTrigger.Kind.

const (
	WebhookAgenticWorkflowTriggerKindFailedCheckNew                 WebhookAgenticWorkflowTriggerKind = "failed_check.new"
	WebhookAgenticWorkflowTriggerKindGithubDeployment               WebhookAgenticWorkflowTriggerKind = "github.deployment"
	WebhookAgenticWorkflowTriggerKindGithubDeploymentStatus         WebhookAgenticWorkflowTriggerKind = "github.deployment_status"
	WebhookAgenticWorkflowTriggerKindGithubIssueComment             WebhookAgenticWorkflowTriggerKind = "github.issue_comment"
	WebhookAgenticWorkflowTriggerKindGithubPullRequest              WebhookAgenticWorkflowTriggerKind = "github.pull_request"
	WebhookAgenticWorkflowTriggerKindGithubPullRequestReview        WebhookAgenticWorkflowTriggerKind = "github.pull_request_review"
	WebhookAgenticWorkflowTriggerKindGithubPullRequestReviewComment WebhookAgenticWorkflowTriggerKind = "github.pull_request_review_comment"
	WebhookAgenticWorkflowTriggerKindGithubRelease                  WebhookAgenticWorkflowTriggerKind = "github.release"
	WebhookAgenticWorkflowTriggerKindLinearComment                  WebhookAgenticWorkflowTriggerKind = "linear.comment"
	WebhookAgenticWorkflowTriggerKindLinearLabelAdded               WebhookAgenticWorkflowTriggerKind = "linear.label_added"
	WebhookAgenticWorkflowTriggerKindManual                         WebhookAgenticWorkflowTriggerKind = "manual"
	WebhookAgenticWorkflowTriggerKindSchedule                       WebhookAgenticWorkflowTriggerKind = "schedule"
	WebhookAgenticWorkflowTriggerKindSlackBotFailedCheckNew         WebhookAgenticWorkflowTriggerKind = "slack_bot.failed_check.new"
	WebhookAgenticWorkflowTriggerKindSlackBotMessage                WebhookAgenticWorkflowTriggerKind = "slack_bot.message"
	WebhookAgenticWorkflowTriggerKindSlackBotReaction               WebhookAgenticWorkflowTriggerKind = "slack_bot.reaction"
	WebhookAgenticWorkflowTriggerKindWebhook                        WebhookAgenticWorkflowTriggerKind = "webhook"
)

Defines values for WebhookAgenticWorkflowTriggerKind.

type WebhookConfig added in v1.9.0

type WebhookConfig struct {
	AllowInsecure   *bool              `json:"allowInsecure,omitempty"`
	FollowRedirects *bool              `json:"followRedirects,omitempty"`
	Headers         *map[string]string `json:"headers,omitempty"`
	Url             string             `json:"url"`
}

WebhookConfig defines model for WebhookConfig.

Directories

Path Synopsis
Package dash0test provides testing utilities for the Dash0 API client.
Package dash0test provides testing utilities for the Dash0 API client.
Package profiles manages named Dash0 configuration profiles.
Package profiles manages named Dash0 configuration profiles.
tools
postprocess command
Command postprocess applies transformations to generated.go to fix conflicts introduced by oapi-codegen that cannot be resolved via configuration alone.
Command postprocess applies transformations to generated.go to fix conflicts introduced by oapi-codegen that cannot be resolved via configuration alone.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL