v1alpha1

package
v2.3.1 Latest Latest
Warning

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

Go to latest
Published: May 25, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_proto_render_v1alpha1_render_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CompositeInput

type CompositeInput struct {

	// The composite resource (XR) to reconcile.
	CompositeResource *structpb.Struct `protobuf:"bytes,1,opt,name=composite_resource,json=compositeResource,proto3" json:"composite_resource,omitempty"`
	// The Composition to use.
	Composition *structpb.Struct `protobuf:"bytes,2,opt,name=composition,proto3" json:"composition,omitempty"`
	// Functions to call in the pipeline.
	Functions []*FunctionInput `protobuf:"bytes,3,rep,name=functions,proto3" json:"functions,omitempty"`
	// Existing composed resources from a previous reconcile. Optional.
	ObservedResources []*structpb.Struct `protobuf:"bytes,4,rep,name=observed_resources,json=observedResources,proto3" json:"observed_resources,omitempty"`
	// Resources available for functions that request them via the Requirements
	// protocol. Optional.
	RequiredResources []*structpb.Struct `protobuf:"bytes,5,rep,name=required_resources,json=requiredResources,proto3" json:"required_resources,omitempty"`
	// Kubernetes Secrets for function credentials. Optional.
	Credentials []*structpb.Struct `protobuf:"bytes,6,rep,name=credentials,proto3" json:"credentials,omitempty"`
	// OpenAPI v3 documents providing schemas for resource kinds. Functions can
	// request schemas via the Requirements protocol. Each entry is a full OpenAPI
	// v3 document as JSON. Optional.
	RequiredSchemas []*structpb.Struct `protobuf:"bytes,7,rep,name=required_schemas,json=requiredSchemas,proto3" json:"required_schemas,omitempty"`
	// contains filtered or unexported fields
}

A CompositeInput contains all inputs needed to render a composite resource (XR) using the real XR reconciler.

func (*CompositeInput) Descriptor deprecated

func (*CompositeInput) Descriptor() ([]byte, []int)

Deprecated: Use CompositeInput.ProtoReflect.Descriptor instead.

func (*CompositeInput) GetCompositeResource

func (x *CompositeInput) GetCompositeResource() *structpb.Struct

func (*CompositeInput) GetComposition

func (x *CompositeInput) GetComposition() *structpb.Struct

func (*CompositeInput) GetCredentials

func (x *CompositeInput) GetCredentials() []*structpb.Struct

func (*CompositeInput) GetFunctions

func (x *CompositeInput) GetFunctions() []*FunctionInput

func (*CompositeInput) GetObservedResources

func (x *CompositeInput) GetObservedResources() []*structpb.Struct

func (*CompositeInput) GetRequiredResources

func (x *CompositeInput) GetRequiredResources() []*structpb.Struct

func (*CompositeInput) GetRequiredSchemas

func (x *CompositeInput) GetRequiredSchemas() []*structpb.Struct

func (*CompositeInput) ProtoMessage

func (*CompositeInput) ProtoMessage()

func (*CompositeInput) ProtoReflect

func (x *CompositeInput) ProtoReflect() protoreflect.Message

func (*CompositeInput) Reset

func (x *CompositeInput) Reset()

func (*CompositeInput) String

func (x *CompositeInput) String() string

type CompositeOutput

type CompositeOutput struct {

	// The XR with desired status and conditions set by the reconciler.
	CompositeResource *structpb.Struct `protobuf:"bytes,1,opt,name=composite_resource,json=compositeResource,proto3" json:"composite_resource,omitempty"`
	// Composed resources the reconciler would apply via server-side apply.
	ComposedResources []*structpb.Struct `protobuf:"bytes,2,rep,name=composed_resources,json=composedResources,proto3" json:"composed_resources,omitempty"`
	// Composed resources the reconciler would garbage collect.
	DeletedResources []*structpb.Struct `protobuf:"bytes,3,rep,name=deleted_resources,json=deletedResources,proto3" json:"deleted_resources,omitempty"`
	// Events the reconciler would emit.
	Events []*Event `protobuf:"bytes,4,rep,name=events,proto3" json:"events,omitempty"`
	// Required resources that were requested by the function pipeline. The
	// structs are fnv1.ResourceSelector messages.
	RequiredResources []*structpb.Struct `protobuf:"bytes,5,rep,name=required_resources,json=requiredResources,proto3" json:"required_resources,omitempty"`
	// Required schemas that were requested by the function pipeline. The structs
	// are fnv1.SchemaSelector messages.
	RequiredSchemas []*structpb.Struct `protobuf:"bytes,6,rep,name=required_schemas,json=requiredSchemas,proto3" json:"required_schemas,omitempty"`
	// contains filtered or unexported fields
}

A CompositeOutput contains the results of rendering a composite resource.

func (*CompositeOutput) Descriptor deprecated

func (*CompositeOutput) Descriptor() ([]byte, []int)

Deprecated: Use CompositeOutput.ProtoReflect.Descriptor instead.

func (*CompositeOutput) GetComposedResources

func (x *CompositeOutput) GetComposedResources() []*structpb.Struct

func (*CompositeOutput) GetCompositeResource

func (x *CompositeOutput) GetCompositeResource() *structpb.Struct

func (*CompositeOutput) GetDeletedResources

func (x *CompositeOutput) GetDeletedResources() []*structpb.Struct

func (*CompositeOutput) GetEvents

func (x *CompositeOutput) GetEvents() []*Event

func (*CompositeOutput) GetRequiredResources

func (x *CompositeOutput) GetRequiredResources() []*structpb.Struct

func (*CompositeOutput) GetRequiredSchemas

func (x *CompositeOutput) GetRequiredSchemas() []*structpb.Struct

func (*CompositeOutput) ProtoMessage

func (*CompositeOutput) ProtoMessage()

func (*CompositeOutput) ProtoReflect

func (x *CompositeOutput) ProtoReflect() protoreflect.Message

func (*CompositeOutput) Reset

func (x *CompositeOutput) Reset()

func (*CompositeOutput) String

func (x *CompositeOutput) String() string

type CronOperationInput

type CronOperationInput struct {

	// The CronOperation to render.
	CronOperation *structpb.Struct `protobuf:"bytes,1,opt,name=cron_operation,json=cronOperation,proto3" json:"cron_operation,omitempty"`
	// The scheduled time. Defaults to now if not set.
	ScheduledTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=scheduled_time,json=scheduledTime,proto3,oneof" json:"scheduled_time,omitempty"`
	// contains filtered or unexported fields
}

A CronOperationInput contains all inputs needed to produce the Operation a CronOperation would create.

func (*CronOperationInput) Descriptor deprecated

func (*CronOperationInput) Descriptor() ([]byte, []int)

Deprecated: Use CronOperationInput.ProtoReflect.Descriptor instead.

func (*CronOperationInput) GetCronOperation

func (x *CronOperationInput) GetCronOperation() *structpb.Struct

func (*CronOperationInput) GetScheduledTime

func (x *CronOperationInput) GetScheduledTime() *timestamppb.Timestamp

func (*CronOperationInput) ProtoMessage

func (*CronOperationInput) ProtoMessage()

func (*CronOperationInput) ProtoReflect

func (x *CronOperationInput) ProtoReflect() protoreflect.Message

func (*CronOperationInput) Reset

func (x *CronOperationInput) Reset()

func (*CronOperationInput) String

func (x *CronOperationInput) String() string

type CronOperationOutput

type CronOperationOutput struct {

	// The Operation the CronOperation would create.
	Operation *structpb.Struct `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
	// contains filtered or unexported fields
}

A CronOperationOutput contains the Operation a CronOperation would create.

func (*CronOperationOutput) Descriptor deprecated

func (*CronOperationOutput) Descriptor() ([]byte, []int)

Deprecated: Use CronOperationOutput.ProtoReflect.Descriptor instead.

func (*CronOperationOutput) GetOperation

func (x *CronOperationOutput) GetOperation() *structpb.Struct

func (*CronOperationOutput) ProtoMessage

func (*CronOperationOutput) ProtoMessage()

func (*CronOperationOutput) ProtoReflect

func (x *CronOperationOutput) ProtoReflect() protoreflect.Message

func (*CronOperationOutput) Reset

func (x *CronOperationOutput) Reset()

func (*CronOperationOutput) String

func (x *CronOperationOutput) String() string

type Event

type Event struct {

	// Type is Normal or Warning.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Reason is the short, machine-readable reason for the event.
	Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	// Message is the human-readable description of the event.
	Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

An Event represents a Kubernetes event the reconciler would emit.

func (*Event) Descriptor deprecated

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetMessage

func (x *Event) GetMessage() string

func (*Event) GetReason

func (x *Event) GetReason() string

func (*Event) GetType

func (x *Event) GetType() string

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect

func (x *Event) ProtoReflect() protoreflect.Message

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

type FunctionInput

type FunctionInput struct {

	// Name of the function, matching the pipeline step's functionRef.name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// gRPC address of the running function (e.g. "localhost:9443").
	Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	// contains filtered or unexported fields
}

A FunctionInput identifies a running composition function by name and gRPC address. The caller is responsible for starting function runtimes and providing their addresses.

func (*FunctionInput) Descriptor deprecated

func (*FunctionInput) Descriptor() ([]byte, []int)

Deprecated: Use FunctionInput.ProtoReflect.Descriptor instead.

func (*FunctionInput) GetAddress

func (x *FunctionInput) GetAddress() string

func (*FunctionInput) GetName

func (x *FunctionInput) GetName() string

func (*FunctionInput) ProtoMessage

func (*FunctionInput) ProtoMessage()

func (*FunctionInput) ProtoReflect

func (x *FunctionInput) ProtoReflect() protoreflect.Message

func (*FunctionInput) Reset

func (x *FunctionInput) Reset()

func (*FunctionInput) String

func (x *FunctionInput) String() string

type OperationInput

type OperationInput struct {

	// The Operation to reconcile.
	Operation *structpb.Struct `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
	// Functions to call in the pipeline.
	Functions []*FunctionInput `protobuf:"bytes,2,rep,name=functions,proto3" json:"functions,omitempty"`
	// Resources available for functions that request them via the Requirements
	// protocol. Optional.
	RequiredResources []*structpb.Struct `protobuf:"bytes,3,rep,name=required_resources,json=requiredResources,proto3" json:"required_resources,omitempty"`
	// Kubernetes Secrets for function credentials. Optional.
	Credentials []*structpb.Struct `protobuf:"bytes,4,rep,name=credentials,proto3" json:"credentials,omitempty"`
	// OpenAPI v3 documents providing schemas for resource kinds. Functions can
	// request schemas via the Requirements protocol. Each entry is a full OpenAPI
	// v3 document as JSON. Optional.
	RequiredSchemas []*structpb.Struct `protobuf:"bytes,5,rep,name=required_schemas,json=requiredSchemas,proto3" json:"required_schemas,omitempty"`
	// contains filtered or unexported fields
}

An OperationInput contains all inputs needed to render an Operation using the real Operation reconciler.

func (*OperationInput) Descriptor deprecated

func (*OperationInput) Descriptor() ([]byte, []int)

Deprecated: Use OperationInput.ProtoReflect.Descriptor instead.

func (*OperationInput) GetCredentials

func (x *OperationInput) GetCredentials() []*structpb.Struct

func (*OperationInput) GetFunctions

func (x *OperationInput) GetFunctions() []*FunctionInput

func (*OperationInput) GetOperation

func (x *OperationInput) GetOperation() *structpb.Struct

func (*OperationInput) GetRequiredResources

func (x *OperationInput) GetRequiredResources() []*structpb.Struct

func (*OperationInput) GetRequiredSchemas

func (x *OperationInput) GetRequiredSchemas() []*structpb.Struct

func (*OperationInput) ProtoMessage

func (*OperationInput) ProtoMessage()

func (*OperationInput) ProtoReflect

func (x *OperationInput) ProtoReflect() protoreflect.Message

func (*OperationInput) Reset

func (x *OperationInput) Reset()

func (*OperationInput) String

func (x *OperationInput) String() string

type OperationOutput

type OperationOutput struct {

	// The Operation with status set by the reconciler.
	Operation *structpb.Struct `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
	// Resources the Operation would apply via server-side apply.
	AppliedResources []*structpb.Struct `protobuf:"bytes,2,rep,name=applied_resources,json=appliedResources,proto3" json:"applied_resources,omitempty"`
	// Events the reconciler would emit.
	Events []*Event `protobuf:"bytes,3,rep,name=events,proto3" json:"events,omitempty"`
	// Required resources that were requested by the function pipeline. The
	// structs are fnv1.ResourceSelector messages.
	RequiredResources []*structpb.Struct `protobuf:"bytes,4,rep,name=required_resources,json=requiredResources,proto3" json:"required_resources,omitempty"`
	// Required schemas that were requested by the function pipeline. The structs
	// are fnv1.SchemaSelector messages.
	RequiredSchemas []*structpb.Struct `protobuf:"bytes,5,rep,name=required_schemas,json=requiredSchemas,proto3" json:"required_schemas,omitempty"`
	// contains filtered or unexported fields
}

An OperationOutput contains the results of rendering an Operation.

func (*OperationOutput) Descriptor deprecated

func (*OperationOutput) Descriptor() ([]byte, []int)

Deprecated: Use OperationOutput.ProtoReflect.Descriptor instead.

func (*OperationOutput) GetAppliedResources

func (x *OperationOutput) GetAppliedResources() []*structpb.Struct

func (*OperationOutput) GetEvents

func (x *OperationOutput) GetEvents() []*Event

func (*OperationOutput) GetOperation

func (x *OperationOutput) GetOperation() *structpb.Struct

func (*OperationOutput) GetRequiredResources

func (x *OperationOutput) GetRequiredResources() []*structpb.Struct

func (*OperationOutput) GetRequiredSchemas

func (x *OperationOutput) GetRequiredSchemas() []*structpb.Struct

func (*OperationOutput) ProtoMessage

func (*OperationOutput) ProtoMessage()

func (*OperationOutput) ProtoReflect

func (x *OperationOutput) ProtoReflect() protoreflect.Message

func (*OperationOutput) Reset

func (x *OperationOutput) Reset()

func (*OperationOutput) String

func (x *OperationOutput) String() string

type RenderRequest

type RenderRequest struct {

	// Metadata pertaining to the render request.
	Meta *RequestMeta `protobuf:"bytes,1,opt,name=meta,proto3" json:"meta,omitempty"`
	// The resource to render. Exactly one must be set.
	//
	// Types that are valid to be assigned to Input:
	//
	//	*RenderRequest_Composite
	//	*RenderRequest_Operation
	//	*RenderRequest_CronOperation
	//	*RenderRequest_WatchOperation
	Input isRenderRequest_Input `protobuf_oneof:"input"`
	// contains filtered or unexported fields
}

A RenderRequest asks the render engine to render a resource.

func (*RenderRequest) Descriptor deprecated

func (*RenderRequest) Descriptor() ([]byte, []int)

Deprecated: Use RenderRequest.ProtoReflect.Descriptor instead.

func (*RenderRequest) GetComposite

func (x *RenderRequest) GetComposite() *CompositeInput

func (*RenderRequest) GetCronOperation

func (x *RenderRequest) GetCronOperation() *CronOperationInput

func (*RenderRequest) GetInput

func (x *RenderRequest) GetInput() isRenderRequest_Input

func (*RenderRequest) GetMeta

func (x *RenderRequest) GetMeta() *RequestMeta

func (*RenderRequest) GetOperation

func (x *RenderRequest) GetOperation() *OperationInput

func (*RenderRequest) GetWatchOperation

func (x *RenderRequest) GetWatchOperation() *WatchOperationInput

func (*RenderRequest) ProtoMessage

func (*RenderRequest) ProtoMessage()

func (*RenderRequest) ProtoReflect

func (x *RenderRequest) ProtoReflect() protoreflect.Message

func (*RenderRequest) Reset

func (x *RenderRequest) Reset()

func (*RenderRequest) String

func (x *RenderRequest) String() string

type RenderRequest_Composite

type RenderRequest_Composite struct {
	Composite *CompositeInput `protobuf:"bytes,2,opt,name=composite,proto3,oneof"`
}

type RenderRequest_CronOperation

type RenderRequest_CronOperation struct {
	CronOperation *CronOperationInput `protobuf:"bytes,4,opt,name=cron_operation,json=cronOperation,proto3,oneof"`
}

type RenderRequest_Operation

type RenderRequest_Operation struct {
	Operation *OperationInput `protobuf:"bytes,3,opt,name=operation,proto3,oneof"`
}

type RenderRequest_WatchOperation

type RenderRequest_WatchOperation struct {
	WatchOperation *WatchOperationInput `protobuf:"bytes,5,opt,name=watch_operation,json=watchOperation,proto3,oneof"`
}

type RenderResponse

type RenderResponse struct {

	// Metadata pertaining to the render response.
	Meta *ResponseMeta `protobuf:"bytes,1,opt,name=meta,proto3" json:"meta,omitempty"`
	// The render result. The variant matches the input variant.
	//
	// Types that are valid to be assigned to Output:
	//
	//	*RenderResponse_Composite
	//	*RenderResponse_Operation
	//	*RenderResponse_CronOperation
	//	*RenderResponse_WatchOperation
	Output isRenderResponse_Output `protobuf_oneof:"output"`
	// contains filtered or unexported fields
}

A RenderResponse is the result of rendering a resource.

func (*RenderResponse) Descriptor deprecated

func (*RenderResponse) Descriptor() ([]byte, []int)

Deprecated: Use RenderResponse.ProtoReflect.Descriptor instead.

func (*RenderResponse) GetComposite

func (x *RenderResponse) GetComposite() *CompositeOutput

func (*RenderResponse) GetCronOperation

func (x *RenderResponse) GetCronOperation() *CronOperationOutput

func (*RenderResponse) GetMeta

func (x *RenderResponse) GetMeta() *ResponseMeta

func (*RenderResponse) GetOperation

func (x *RenderResponse) GetOperation() *OperationOutput

func (*RenderResponse) GetOutput

func (x *RenderResponse) GetOutput() isRenderResponse_Output

func (*RenderResponse) GetWatchOperation

func (x *RenderResponse) GetWatchOperation() *WatchOperationOutput

func (*RenderResponse) ProtoMessage

func (*RenderResponse) ProtoMessage()

func (*RenderResponse) ProtoReflect

func (x *RenderResponse) ProtoReflect() protoreflect.Message

func (*RenderResponse) Reset

func (x *RenderResponse) Reset()

func (*RenderResponse) String

func (x *RenderResponse) String() string

type RenderResponse_Composite

type RenderResponse_Composite struct {
	Composite *CompositeOutput `protobuf:"bytes,2,opt,name=composite,proto3,oneof"`
}

type RenderResponse_CronOperation

type RenderResponse_CronOperation struct {
	CronOperation *CronOperationOutput `protobuf:"bytes,4,opt,name=cron_operation,json=cronOperation,proto3,oneof"`
}

type RenderResponse_Operation

type RenderResponse_Operation struct {
	Operation *OperationOutput `protobuf:"bytes,3,opt,name=operation,proto3,oneof"`
}

type RenderResponse_WatchOperation

type RenderResponse_WatchOperation struct {
	WatchOperation *WatchOperationOutput `protobuf:"bytes,5,opt,name=watch_operation,json=watchOperation,proto3,oneof"`
}

type RequestMeta

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

RequestMeta contains metadata pertaining to a RenderRequest.

func (*RequestMeta) Descriptor deprecated

func (*RequestMeta) Descriptor() ([]byte, []int)

Deprecated: Use RequestMeta.ProtoReflect.Descriptor instead.

func (*RequestMeta) ProtoMessage

func (*RequestMeta) ProtoMessage()

func (*RequestMeta) ProtoReflect

func (x *RequestMeta) ProtoReflect() protoreflect.Message

func (*RequestMeta) Reset

func (x *RequestMeta) Reset()

func (*RequestMeta) String

func (x *RequestMeta) String() string

type ResponseMeta

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

ResponseMeta contains metadata pertaining to a RenderResponse.

func (*ResponseMeta) Descriptor deprecated

func (*ResponseMeta) Descriptor() ([]byte, []int)

Deprecated: Use ResponseMeta.ProtoReflect.Descriptor instead.

func (*ResponseMeta) ProtoMessage

func (*ResponseMeta) ProtoMessage()

func (*ResponseMeta) ProtoReflect

func (x *ResponseMeta) ProtoReflect() protoreflect.Message

func (*ResponseMeta) Reset

func (x *ResponseMeta) Reset()

func (*ResponseMeta) String

func (x *ResponseMeta) String() string

type WatchOperationInput

type WatchOperationInput struct {

	// The WatchOperation to render.
	WatchOperation *structpb.Struct `protobuf:"bytes,1,opt,name=watch_operation,json=watchOperation,proto3" json:"watch_operation,omitempty"`
	// The resource whose change triggered the WatchOperation.
	WatchedResource *structpb.Struct `protobuf:"bytes,2,opt,name=watched_resource,json=watchedResource,proto3" json:"watched_resource,omitempty"`
	// contains filtered or unexported fields
}

A WatchOperationInput contains all inputs needed to produce the Operation a WatchOperation would create in response to a watched resource change.

func (*WatchOperationInput) Descriptor deprecated

func (*WatchOperationInput) Descriptor() ([]byte, []int)

Deprecated: Use WatchOperationInput.ProtoReflect.Descriptor instead.

func (*WatchOperationInput) GetWatchOperation

func (x *WatchOperationInput) GetWatchOperation() *structpb.Struct

func (*WatchOperationInput) GetWatchedResource

func (x *WatchOperationInput) GetWatchedResource() *structpb.Struct

func (*WatchOperationInput) ProtoMessage

func (*WatchOperationInput) ProtoMessage()

func (*WatchOperationInput) ProtoReflect

func (x *WatchOperationInput) ProtoReflect() protoreflect.Message

func (*WatchOperationInput) Reset

func (x *WatchOperationInput) Reset()

func (*WatchOperationInput) String

func (x *WatchOperationInput) String() string

type WatchOperationOutput

type WatchOperationOutput struct {

	// The Operation the WatchOperation would create.
	Operation *structpb.Struct `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
	// contains filtered or unexported fields
}

A WatchOperationOutput contains the Operation a WatchOperation would create.

func (*WatchOperationOutput) Descriptor deprecated

func (*WatchOperationOutput) Descriptor() ([]byte, []int)

Deprecated: Use WatchOperationOutput.ProtoReflect.Descriptor instead.

func (*WatchOperationOutput) GetOperation

func (x *WatchOperationOutput) GetOperation() *structpb.Struct

func (*WatchOperationOutput) ProtoMessage

func (*WatchOperationOutput) ProtoMessage()

func (*WatchOperationOutput) ProtoReflect

func (x *WatchOperationOutput) ProtoReflect() protoreflect.Message

func (*WatchOperationOutput) Reset

func (x *WatchOperationOutput) Reset()

func (*WatchOperationOutput) String

func (x *WatchOperationOutput) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL