models

type Cluster struct {

	// The time when this cluster was registered with Signadot.
	CreatedAt string `json:"createdAt,omitempty"`

	// The name of the cluster.
	Name string `json:"name,omitempty"`

	// operator
	Operator *ClusterOperator `json:"operator,omitempty"`
}

type ClusterOperator struct {

	// The operator version of the cluster.  This may be
	// nil if the cluster has not yet connected to Signadot.
	Version string `json:"version,omitempty"`
}

type ClusterToken struct {

	// The time when this cluster was registered with Signadot.
	CreatedAt string `json:"createdAt,omitempty"`

	// The ID of this token
	ID string `json:"id,omitempty"`

	// A Masked token value.
	MaskedValue string `json:"maskedValue,omitempty"`

	// status
	Status *ClusterTokenStatus `json:"status,omitempty"`

	// The token value.
	Token string `json:"token,omitempty"`
}

type ClusterTokenStatus struct {

	// The last time at which this token was used to connect.
	LastConnectedAt string `json:"lastConnectedAt,omitempty"`

	// The last IP address from which this token connected.
	LastConnectedIP string `json:"lastConnectedIp,omitempty"`
}

type EmptyResponse interface{}

type ErrorResponse struct {

	// error
	Error string `json:"error,omitempty"`

	// request Id
	RequestID string `json:"requestId,omitempty"`
}

type ResourceInfo struct {

	// Cluster that the resource is created in
	Cluster string `json:"cluster,omitempty"`

	// Name of the created resource
	Name string `json:"name,omitempty"`

	// Name of the sandbox containing the resource
	Sandbox string `json:"sandbox,omitempty"`
}

type ResourcePlugin struct {

	// The time at which the resource plugin was created
	CreatedAt string `json:"createdAt,omitempty"`

	// Name of the resource plugin
	Name string `json:"name,omitempty"`

	// spec
	Spec *ResourcepluginSpec `json:"spec,omitempty"`

	// status
	Status *ResourcepluginStatus `json:"status,omitempty"`

	// The time at which the resource plugin was last updated
	UpdatedAt string `json:"updatedAt,omitempty"`
}

type ResourcepluginRunner struct {

	// Image for the runner instance
	Image string `json:"image,omitempty"`

	// Namespace to create this runner instance in
	Namespace string `json:"namespace,omitempty"`

	// Pod template overlay
	PodTemplateOverlay string `json:"podTemplateOverlay,omitempty"`
}

type ResourcepluginSpec struct {

	// Create refers to the `create` steps for spinning up the resource
	Create []*ResourcepluginStep `json:"create"`

	// Delete refers to the `delete` steps for spinning up the resource
	Delete []*ResourcepluginStep `json:"delete"`

	// Description for the resource
	Description string `json:"description,omitempty"`

	// runner
	Runner *ResourcepluginRunner `json:"runner,omitempty"`
}

type ResourcepluginStatus struct {

	// Resources created using the resource plugin
	Resources []*ResourceInfo `json:"resources"`
}

type ResourcepluginStep struct {

	// Inputs for the step
	Inputs []*ResourcepluginStepInput `json:"inputs"`

	// Name for the step
	Name string `json:"name,omitempty"`

	// Outputs for the step
	Outputs []*ResourcepluginStepOut `json:"outputs"`

	// Script to execute in the step
	Script string `json:"script,omitempty"`
}

type ResourcepluginStepInput struct {

	// as
	As *ResourcepluginStepInputTo `json:"as,omitempty"`

	// Name for the input
	Name string `json:"name,omitempty"`

	// Type of input
	Type string `json:"type,omitempty"`

	// ValueFromSandbox defines whether or not to source value from the sandbox spec
	ValueFromSandbox bool `json:"valueFromSandbox,omitempty"`

	// value from step
	ValueFromStep *ResourcepluginValueFromStep `json:"valueFromStep,omitempty"`
}

type ResourcepluginStepInputTo struct {

	// Inject the input as an env variable with name Env inside the
	// main container
	Env string `json:"env,omitempty"`

	// Expose the input as a file at Path inside the main container
	Path string `json:"path,omitempty"`
}

type ResourcepluginStepOut struct {

	// Description for the output
	Description string `json:"description,omitempty"`

	// Name of the output variable
	Name string `json:"name,omitempty"`

	// Type of output
	Type string `json:"type,omitempty"`

	// Path within the main container from where the output will be read
	ValueFromPath string `json:"valueFromPath,omitempty"`
}

type ResourcepluginValueFromStep struct {

	// Name of the step
	Name string `json:"name,omitempty"`

	// Name of the variable from the step
	Output string `json:"output,omitempty"`
}

type RouteGroup struct {

	// created at
	CreatedAt string `json:"createdAt,omitempty"`

	// endpoints
	Endpoints []*RouteGroupEndpoint `json:"endpoints,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// routing key
	RoutingKey string `json:"routingKey,omitempty"`

	// spec
	Spec *RouteGroupSpec `json:"spec,omitempty"`

	// status
	Status *RouteGroupStatus `json:"status,omitempty"`
}

type RouteGroupEndpoint struct {

	// name
	Name string `json:"name,omitempty"`

	// target
	Target string `json:"target,omitempty"`

	// url
	URL string `json:"url,omitempty"`
}

type RouteGroupMatch struct {

	// When All is non-nil, T matches a set of labels if and only if every element of All matches them.
	// Only one field may be non-nil.
	All []*RouteGroupMatch `json:"all,omitempty"`

	// When Any is non-nil, T matches a set of labels if and only if some element of Any matches them.
	// Only one field may be non-nil.
	Any []*RouteGroupMatch `json:"any,omitempty"`

	// label
	Label *RouteGroupMatchLabel `json:"label,omitempty"`
}

type RouteGroupMatchLabel struct {

	// Key is an exact match on a label key, glob
	// characters are just considered normal characters.
	Key string `json:"key,omitempty"`

	// Value is a glob match for the value of a
	// sandbox label.  See https://pkg.go.dev/path/filepath#Match
	// for the file glob syntax.
	Value string `json:"value,omitempty"`
}

type RouteGroupSpec struct {

	// Cluster gives the cluster to which the route group applies.
	Cluster string `json:"cluster,omitempty"`

	// Description provides a short description of the route group.
	Description string `json:"description,omitempty"`

	// Endpoints define endpoints which target different in-cluster
	// services.
	Endpoints []*RouteGroupSpecEndpoint `json:"endpoints"`

	// match
	Match *RouteGroupMatch `json:"match,omitempty"`
}

type RouteGroupSpecEndpoint struct {

	// name
	Name string `json:"name,omitempty"`

	// target
	Target string `json:"target,omitempty"`
}

type RouteGroupStatus struct {

	// MatchedSandboxes gives the list of sandboxes whose labels
	// were matched by the 'match' object in the spec.
	MatchedSandboxes []string `json:"matchedSandboxes"`

	// Message is a human readable explanation of why
	// the sandbox is healthy or not.
	Message string `json:"message,omitempty"`

	// Ready indicates whether the sandbox is ready,
	// meaning that it can be used for testing.
	Ready bool `json:"ready,omitempty"`

	// Reason is a machine readable explanation of why
	// the sandbox is healthy or not.
	Reason string `json:"reason,omitempty"`
}

type Sandbox struct {

	// created at
	CreatedAt string `json:"createdAt,omitempty"`

	// endpoints
	Endpoints []*SandboxEndpoint `json:"endpoints"`

	// Human-readable name of this sandbox
	Name string `json:"name,omitempty"`

	// routing key
	RoutingKey string `json:"routingKey,omitempty"`

	// spec
	Spec *SandboxSpec `json:"spec,omitempty"`

	// status
	Status *SandboxReadiness `json:"status,omitempty"`
}

type SandboxCustomPatch struct {

	// type
	Type string `json:"type,omitempty"`

	// value
	Value string `json:"value,omitempty"`
}

type SandboxCustomizations struct {

	// Env var modifications that will be applied to the forked workload
	Env []*SandboxEnvVar `json:"env"`

	// One or more docker images that will be applied to the forked workload
	Images []*SandboxImage `json:"images"`

	// patch
	Patch *SandboxCustomPatch `json:"patch,omitempty"`
}

type SandboxDefaultRouteGroup struct {

	// endpoints
	Endpoints []*RouteGroupSpecEndpoint `json:"endpoints"`
}

type SandboxEndpoint struct {

	// baseline Url
	BaselineURL string `json:"baselineUrl,omitempty"`

	// host
	Host string `json:"host,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// port
	Port int64 `json:"port,omitempty"`

	// protocol
	Protocol string `json:"protocol,omitempty"`

	// route type
	RouteType string `json:"routeType,omitempty"`

	// target
	Target string `json:"target,omitempty"`

	// url
	URL string `json:"url,omitempty"`
}

type SandboxEnvValueFrom struct {

	// fork
	Fork *SandboxEnvValueFromFork `json:"fork,omitempty"`

	// resource
	Resource *SandboxEnvValueFromResource `json:"resource,omitempty"`
}

type SandboxEnvValueFromFork struct {

	// expression
	Expression string `json:"expression,omitempty"`

	// fork of
	ForkOf *SandboxForkOf `json:"forkOf,omitempty"`
}

type SandboxEnvValueFromResource struct {

	// name
	Name string `json:"name,omitempty"`

	// output key
	OutputKey string `json:"outputKey,omitempty"`
}

type SandboxEnvVar struct {

	// name of container to which it applies
	Container string `json:"container,omitempty"`

	// environmental variable name
	Name string `json:"name,omitempty"`

	// upsert or delete
	Operation string `json:"operation,omitempty"`

	// environmental variable value
	Value string `json:"value,omitempty"`

	// value from
	ValueFrom *SandboxEnvValueFrom `json:"valueFrom,omitempty"`
}

type SandboxFork struct {

	// customizations
	Customizations *SandboxCustomizations `json:"customizations,omitempty"`

	// Deprecated. Use defaultRouteGroup.Endpoints instead.
	Endpoints []*SandboxForkEndpoint `json:"endpoints"`

	// fork of
	ForkOf *SandboxForkOf `json:"forkOf,omitempty"`
}

type SandboxForkEndpoint struct {

	// Name of the endpoint
	Name string `json:"name,omitempty"`

	// Port it will map to on the forked workload
	Port int64 `json:"port,omitempty"`

	// Protocol that this endpoint uses
	Protocol string `json:"protocol,omitempty"`
}

type SandboxForkOf struct {

	// Kind of entity that we want to route to. One of (Service or Deployment or Rollout).
	// Example: Deployment
	// Required: true
	Kind *string `json:"kind"`

	// Name of the entity within the Kubernetes cluster.
	// Example: my-frontend
	// Required: true
	Name *string `json:"name"`

	// Namespace within which the entity lives in the Kubernetes cluster.
	// Example: default
	// Required: true
	Namespace *string `json:"namespace"`
}

type SandboxHostEndpoint struct {

	// Hostname that this endpoint points to
	Host string `json:"host,omitempty"`

	// Name of the endpoint
	Name string `json:"name,omitempty"`

	// Port it will map to on the specified host
	Port int64 `json:"port,omitempty"`

	// Protocol that this endpoint uses
	Protocol string `json:"protocol,omitempty"`
}

type SandboxImage struct {

	// Container is the container this image must apply to in the forked workload
	Container string `json:"container,omitempty"`

	// Name of the image (e.g. gcr.io/my-image/repo:my-tag)
	Image string `json:"image,omitempty"`
}

type SandboxReadiness struct {

	// Message is a human readable explanation of why
	// the sandbox is healthy or not.
	Message string `json:"message,omitempty"`

	// Ready indicates whether the sandbox is ready,
	// meaning that it can be used for testing.
	Ready bool `json:"ready,omitempty"`

	// Reason is a machine readable explanation of why
	// the sandbox is healthy or not.
	Reason string `json:"reason,omitempty"`
}

type SandboxResource struct {

	// name
	Name string `json:"name,omitempty"`

	// params
	Params map[string]string `json:"params,omitempty"`

	// plugin
	Plugin string `json:"plugin,omitempty"`
}

type SandboxSpec struct {

	// Cluster within which this sandbox should be created
	// Required: true
	Cluster *string `json:"cluster"`

	// default route group
	DefaultRouteGroup *SandboxDefaultRouteGroup `json:"defaultRouteGroup,omitempty"`

	// Description of the purpose of this sandbox
	Description string `json:"description,omitempty"`

	// Deprecated. Use defaultRouteGroup.Endpoints instead.
	Endpoints []*SandboxHostEndpoint `json:"endpoints"`

	// Forks is the specification of each forked entity
	// Required: true
	Forks []*SandboxFork `json:"forks"`

	// Labels are used to specify metadata associated with the sandbox as key-value pairs.
	Labels map[string]string `json:"labels,omitempty"`

	// Resources specifies each required resource to spin up the sandbox
	Resources []*SandboxResource `json:"resources"`

	// ttl
	TTL *SandboxTTL `json:"ttl,omitempty"`
}

type SandboxTTL struct {

	// Duration represents the duration until sandbox end of life.
	// It should be an unsigned integer not exceeding 32 bits followed by
	// a units character, which can be one of the following.
	//  - 'm' for minutes
	//  - 'h' for hours
	//  - 'd' for days
	//  - 'w' for weeks
	Duration string `json:"duration,omitempty"`

	// OffsetFrom indicates what the Duration is relative to.  It
	// may be the empty string or "createdAt".  The empty string
	// defaults to meaning "createdAt".
	OffsetFrom string `json:"offsetFrom,omitempty"`
}