Categorygithub.com/steadybit/event-kit/go/event_kit_api
modulepackage
1.4.1
Repository: https://github.com/steadybit/event-kit.git
Documentation: pkg.go.dev

# README

EventKit Go API

This module exposes Go types that you will find helpful when implementing an EventKit extension.

The types are generated automatically from the EventKit OpenAPI specification.

Installation

Add the following to your go.mod file:

go get github.com/steadybit/event-kit/go/event_kit_api

Usage

import (
	"github.com/steadybit/event-kit/go/event_kit_api"
    "github.com/steadybit/extension-kit/extutil"
)

eventList := event_kit_api.EventListenerList{
    EventListeners: []event_kit_api.EventListener{
        {
            Method:     "POST",
            Path:       "/events/experiment-started",
            ListenTo:   []string{"experiment.execution.created"},
        },
        {
            Method:     "POST",
            Path:       "/events/experiment-completed",
            ListenTo:   []string{"experiment.execution.completed"},
        },
    },
}

# Constants

Defines values for PrincipalType.
Defines values for AccessTokenType.
Defines values for AccessTokenType.
Defines values for ExperimentStepExecutionType.
Defines values for ExperimentStepExecutionActionKind.
Defines values for PrincipalType.
Defines values for ExperimentStepTargetExecutionState.
Defines values for ExperimentStepExecutionActionKind.
Defines values for ExperimentStepTargetExecutionState.
Defines values for ExperimentStepTargetExecutionState.
Defines values for MutatingHttpMethod.
Defines values for ExperimentStepTargetExecutionState.
Defines values for ExperimentExecutionState.
Defines values for ExperimentExecutionState.
Defines values for ExperimentExecutionState.
Defines values for ExperimentExecutionState.
Defines values for ExperimentExecutionState.
Defines values for ExperimentExecutionState.
Defines values for ExperimentExecutionState.
Defines values for ExperimentExecutionState.
Defines values for ExperimentStepExecutionState.
Defines values for ExperimentStepExecutionState.
Defines values for ExperimentStepExecutionState.
Defines values for ExperimentStepExecutionState.
Defines values for ExperimentStepExecutionState.
Defines values for ExperimentStepExecutionState.
Defines values for ExperimentStepExecutionState.
Defines values for ExperimentStepExecutionState.
Defines values for ExperimentStepTargetExecutionState.
Defines values for DescribingEndpointReferenceMethod.
Defines values for ExperimentStepExecutionActionKind.
Defines values for ExperimentStepExecutionActionKind.
Post
Defines values for MutatingHttpMethod.
Defines values for ExperimentStepTargetExecutionState.
Defines values for MutatingHttpMethod.
Defines values for ExperimentStepTargetExecutionState.
Defines values for ExperimentStepTargetExecutionState.
Defines values for PrincipalType.
Defines values for ExperimentStepExecutionType.

# Structs

AccessTokenPrincipal defines model for AccessTokenPrincipal.
BatchPrincipal defines model for BatchPrincipal.
DescribingEndpointReference HTTP endpoint which the Steadybit platform/agent could communicate with.
Environment defines model for Environment.
EventListener defines model for EventListener.
EventListenerList Lists all listeners that the platform/agent could call.
EventListenerListResponse defines model for EventListenerListResponse.
EventRequestBody defines model for EventRequestBody.
ExperimentExecution defines model for ExperimentExecution.
ExperimentStepExecution defines model for ExperimentStepExecution.
ExperimentStepTargetExecution defines model for ExperimentStepTargetExecution.
Team defines model for Team.
Tenant defines model for Tenant.
UserPrincipal defines model for UserPrincipal.

# Interfaces

No description provided by the author

# Type aliases

AccessTokenType defines model for AccessTokenType.
DescribingEndpointReferenceMethod HTTP method to use when calling the HTTP endpoint.
ExperimentExecutionState defines model for ExperimentExecution.State.
ExperimentStepExecutionActionKind defines model for ExperimentStepExecution.ActionKind.
ExperimentStepExecutionState defines model for ExperimentStepExecution.State.
ExperimentStepExecutionType defines model for ExperimentStepExecution.Type.
ExperimentStepTargetExecutionState defines model for ExperimentStepTargetExecution.State.
ListenResult defines model for ListenResult.
MutatingHttpMethod defines model for MutatingHttpMethod.
PrincipalType defines model for PrincipalType.