odc

package
v1.26.0 Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2024 License: GPL-3.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ReplyStatus_name = map[int32]string{
		0: "UNKNOWN",
		1: "SUCCESS",
		2: "ERROR",
	}
	ReplyStatus_value = map[string]int32{
		"UNKNOWN": 0,
		"SUCCESS": 1,
		"ERROR":   2,
	}
)

Enum value maps for ReplyStatus.

View Source 
var (
	SessionStatus_name = map[int32]string{
		0: "UNKNOWN_",
		1: "RUNNING",
		2: "STOPPED",
	}
	SessionStatus_value = map[string]int32{
		"UNKNOWN_": 0,
		"RUNNING":  1,
		"STOPPED":  2,
	}
)

Enum value maps for SessionStatus.

View Source 
var File_protos_odc_proto protoreflect.FileDescriptor
View Source 
var ODC_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "odc.ODC",
	HandlerType: (*ODCServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Initialize",
			Handler:    _ODC_Initialize_Handler,
		},
		{
			MethodName: "Submit",
			Handler:    _ODC_Submit_Handler,
		},
		{
			MethodName: "Activate",
			Handler:    _ODC_Activate_Handler,
		},
		{
			MethodName: "Run",
			Handler:    _ODC_Run_Handler,
		},
		{
			MethodName: "Update",
			Handler:    _ODC_Update_Handler,
		},
		{
			MethodName: "Configure",
			Handler:    _ODC_Configure_Handler,
		},
		{
			MethodName: "SetProperties",
			Handler:    _ODC_SetProperties_Handler,
		},
		{
			MethodName: "GetState",
			Handler:    _ODC_GetState_Handler,
		},
		{
			MethodName: "Start",
			Handler:    _ODC_Start_Handler,
		},
		{
			MethodName: "Stop",
			Handler:    _ODC_Stop_Handler,
		},
		{
			MethodName: "Reset",
			Handler:    _ODC_Reset_Handler,
		},
		{
			MethodName: "Terminate",
			Handler:    _ODC_Terminate_Handler,
		},
		{
			MethodName: "Shutdown",
			Handler:    _ODC_Shutdown_Handler,
		},
		{
			MethodName: "Status",
			Handler:    _ODC_Status_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "protos/odc.proto",
}

ODC_ServiceDesc is the grpc.ServiceDesc for ODC service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterODCServer 

func RegisterODCServer(s grpc.ServiceRegistrar, srv ODCServer)

Types

type ActivateRequest 

type ActivateRequest struct {
	Partitionid string `protobuf:"bytes,1,opt,name=partitionid,proto3" json:"partitionid,omitempty"` // Partition ID from ECS
	Runnr       uint64 `protobuf:"varint,5,opt,name=runnr,proto3" json:"runnr,omitempty"`            // Run number from ECS
	Timeout     uint32 `protobuf:"varint,6,opt,name=timeout,proto3" json:"timeout,omitempty"`        // Request timeout in sec. If not set or 0 than default is used.
	// Either `topology`, `content` or `script` has to be set. If all or none is set then an error is returned.
	Topology string `protobuf:"bytes,2,opt,name=topology,proto3" json:"topology,omitempty"` // Filepath to the XML DDS topology file
	Content  string `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`   // Content of the XML DDS topology
	Script   string `protobuf:"bytes,4,opt,name=script,proto3" json:"script,omitempty"`     // Shell commands to be executed by ODC in order to generate content of the XML DDS topology
	// contains filtered or unexported fields
}

Activate request

func (*ActivateRequest) Descriptor deprecated 

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

Deprecated: Use ActivateRequest.ProtoReflect.Descriptor instead.

func (*ActivateRequest) GetContent added in v0.27.0 

func (x *ActivateRequest) GetContent() string

func (*ActivateRequest) GetPartitionid 

func (x *ActivateRequest) GetPartitionid() string

func (*ActivateRequest) GetRunnr added in v0.27.0 

func (x *ActivateRequest) GetRunnr() uint64

func (*ActivateRequest) GetScript added in v0.27.0 

func (x *ActivateRequest) GetScript() string

func (*ActivateRequest) GetTimeout added in v0.27.0 

func (x *ActivateRequest) GetTimeout() uint32

func (*ActivateRequest) GetTopology 

func (x *ActivateRequest) GetTopology() string

func (*ActivateRequest) ProtoMessage 

func (*ActivateRequest) ProtoMessage()

func (*ActivateRequest) ProtoReflect 

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

func (*ActivateRequest) Reset 

func (x *ActivateRequest) Reset()

func (*ActivateRequest) String 

func (x *ActivateRequest) String() string

type ConfigureRequest 

type ConfigureRequest struct {
	Request *StateRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"` // State change request. See StateRequest for details.
	// contains filtered or unexported fields
}

Configure request

func (*ConfigureRequest) Descriptor deprecated 

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

Deprecated: Use ConfigureRequest.ProtoReflect.Descriptor instead.

func (*ConfigureRequest) GetRequest 

func (x *ConfigureRequest) GetRequest() *StateRequest

func (*ConfigureRequest) ProtoMessage 

func (*ConfigureRequest) ProtoMessage()

func (*ConfigureRequest) ProtoReflect 

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

func (*ConfigureRequest) Reset 

func (x *ConfigureRequest) Reset()

func (*ConfigureRequest) String 

func (x *ConfigureRequest) String() string

type Device 

type Device struct {
	Id      uint64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`           // Runtime task ID (same as in DDS)
	State   string `protobuf:"bytes,2,opt,name=state,proto3" json:"state,omitempty"`      // FairMQ device state as string
	Path    string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`        // Runtime task path (same as in DDS)
	Ignored bool   `protobuf:"varint,4,opt,name=ignored,proto3" json:"ignored,omitempty"` // Device was stopped and set to be ignored
	Host    string `protobuf:"bytes,5,opt,name=host,proto3" json:"host,omitempty"`        // Host where the task runs
	// contains filtered or unexported fields
}

Device information Runtime task ID and path are the same as in DDS. To get task details use DDS Topology API.

func (*Device) Descriptor deprecated 

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

Deprecated: Use Device.ProtoReflect.Descriptor instead.

func (*Device) GetHost added in v0.45.1 

func (x *Device) GetHost() string

func (*Device) GetId 

func (x *Device) GetId() uint64

func (*Device) GetIgnored added in v0.45.1 

func (x *Device) GetIgnored() bool

func (*Device) GetPath 

func (x *Device) GetPath() string

func (*Device) GetState 

func (x *Device) GetState() string

func (*Device) ProtoMessage 

func (*Device) ProtoMessage()

func (*Device) ProtoReflect 

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

func (*Device) Reset 

func (x *Device) Reset()

func (*Device) String 

func (x *Device) String() string

type Error 

type Error struct {
	Msg  string `protobuf:"bytes,1,opt,name=msg,proto3" json:"msg,omitempty"`    // Detailed error message
	Code int32  `protobuf:"varint,2,opt,name=code,proto3" json:"code,omitempty"` // Error code.
	// contains filtered or unexported fields
}

General error

func (*Error) Descriptor deprecated 

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

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetCode 

func (x *Error) GetCode() int32

func (*Error) GetMsg 

func (x *Error) GetMsg() string

func (*Error) ProtoMessage 

func (*Error) ProtoMessage()

func (*Error) ProtoReflect 

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

func (*Error) Reset 

func (x *Error) Reset()

func (*Error) String 

func (x *Error) String() string

type GeneralReply 

type GeneralReply struct {
	Msg         string      `protobuf:"bytes,1,opt,name=msg,proto3" json:"msg,omitempty"`                             // Detailed reply message
	Status      ReplyStatus `protobuf:"varint,2,opt,name=status,proto3,enum=odc.ReplyStatus" json:"status,omitempty"` // Request status code (UNKNOWN, SUCCESS, ERROR)
	Error       *Error      `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`                         // If status is ERROR than this field contains error description otherwise it's empty
	Exectime    int32       `protobuf:"varint,4,opt,name=exectime,proto3" json:"exectime,omitempty"`                  // Request execution time in ms
	Partitionid string      `protobuf:"bytes,5,opt,name=partitionid,proto3" json:"partitionid,omitempty"`             // Partition ID from ECS
	Sessionid   string      `protobuf:"bytes,6,opt,name=sessionid,proto3" json:"sessionid,omitempty"`                 // DDS session ID
	State       string      `protobuf:"bytes,7,opt,name=state,proto3" json:"state,omitempty"`                         // If successful and applicable to a request then contains an aggregated FairMQ device state, otherwise UNDEFINED.
	Runnr       uint64      `protobuf:"varint,8,opt,name=runnr,proto3" json:"runnr,omitempty"`                        // Run number from ECS (optional)
	Hosts       []string    `protobuf:"bytes,9,rep,name=hosts,proto3" json:"hosts,omitempty"`                         // Where applicable, provides a list of used hosts (Submit/Run requests)
	// contains filtered or unexported fields
}

General reply to requests

func (*GeneralReply) Descriptor deprecated 

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

Deprecated: Use GeneralReply.ProtoReflect.Descriptor instead.

func (*GeneralReply) GetError 

func (x *GeneralReply) GetError() *Error

func (*GeneralReply) GetExectime 

func (x *GeneralReply) GetExectime() int32

func (*GeneralReply) GetHosts added in v0.63.0 

func (x *GeneralReply) GetHosts() []string

func (*GeneralReply) GetMsg 

func (x *GeneralReply) GetMsg() string

func (*GeneralReply) GetPartitionid 

func (x *GeneralReply) GetPartitionid() string

func (*GeneralReply) GetRunnr added in v0.27.0 

func (x *GeneralReply) GetRunnr() uint64

func (*GeneralReply) GetSessionid 

func (x *GeneralReply) GetSessionid() string

func (*GeneralReply) GetState 

func (x *GeneralReply) GetState() string

func (*GeneralReply) GetStatus 

func (x *GeneralReply) GetStatus() ReplyStatus

func (*GeneralReply) ProtoMessage 

func (*GeneralReply) ProtoMessage()

func (*GeneralReply) ProtoReflect 

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

func (*GeneralReply) Reset 

func (x *GeneralReply) Reset()

func (*GeneralReply) String 

func (x *GeneralReply) String() string

type InitializeRequest 

type InitializeRequest struct {
	Partitionid string `protobuf:"bytes,1,opt,name=partitionid,proto3" json:"partitionid,omitempty"` // Partition ID from ECS
	Runnr       uint64 `protobuf:"varint,3,opt,name=runnr,proto3" json:"runnr,omitempty"`            // Run number from ECS
	Timeout     uint32 `protobuf:"varint,4,opt,name=timeout,proto3" json:"timeout,omitempty"`        // Request timeout in sec. If not set or 0 than default is used.
	Sessionid   string `protobuf:"bytes,2,opt,name=sessionid,proto3" json:"sessionid,omitempty"`     // DDS session ID. If session ID is provided that ODC connects to an existing DDS session. If session ID is an empty string that a new DDS session is created.
	// contains filtered or unexported fields
}

Initialize request

func (*InitializeRequest) Descriptor deprecated 

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

Deprecated: Use InitializeRequest.ProtoReflect.Descriptor instead.

func (*InitializeRequest) GetPartitionid 

func (x *InitializeRequest) GetPartitionid() string

func (*InitializeRequest) GetRunnr added in v0.27.0 

func (x *InitializeRequest) GetRunnr() uint64

func (*InitializeRequest) GetSessionid 

func (x *InitializeRequest) GetSessionid() string

func (*InitializeRequest) GetTimeout added in v0.27.0 

func (x *InitializeRequest) GetTimeout() uint32

func (*InitializeRequest) ProtoMessage 

func (*InitializeRequest) ProtoMessage()

func (*InitializeRequest) ProtoReflect 

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

func (*InitializeRequest) Reset 

func (x *InitializeRequest) Reset()

func (*InitializeRequest) String 

func (x *InitializeRequest) String() string

type ODCClient 

type ODCClient interface {
	// Creates a new DDS session or attaches to an existing DDS session.
	Initialize(ctx context.Context, in *InitializeRequest, opts ...grpc.CallOption) (*GeneralReply, error)
	// Submits DDS agents (deploys a dynamic cluster) according to a specified computing resources.
	// Can be called multiple times in order to submit more DDS agents (allocate more resources).
	Submit(ctx context.Context, in *SubmitRequest, opts ...grpc.CallOption) (*GeneralReply, error)
	// Activates a given topology.
	Activate(ctx context.Context, in *ActivateRequest, opts ...grpc.CallOption) (*GeneralReply, error)
	// Run request combines Initialize, Submit and Activate into a single request.
	// Run request always creates a new DDS session.
	Run(ctx context.Context, in *RunRequest, opts ...grpc.CallOption) (*GeneralReply, error)
	// Updates a topology (up or down scale number of tasks or any other topology change).
	// It consists of 3 commands: Reset, Activate and Configure.
	// Can be called multiple times.
	Update(ctx context.Context, in *UpdateRequest, opts ...grpc.CallOption) (*GeneralReply, error)
	// Transitions devices into Ready state.
	Configure(ctx context.Context, in *ConfigureRequest, opts ...grpc.CallOption) (*StateReply, error)
	// Changes devices configuration.
	SetProperties(ctx context.Context, in *SetPropertiesRequest, opts ...grpc.CallOption) (*GeneralReply, error)
	// Get current aggregated state of devices.
	GetState(ctx context.Context, in *StateRequest, opts ...grpc.CallOption) (*StateReply, error)
	// Transition devices into Running state.
	Start(ctx context.Context, in *StartRequest, opts ...grpc.CallOption) (*StateReply, error)
	// Transitions devices into Ready state.
	Stop(ctx context.Context, in *StopRequest, opts ...grpc.CallOption) (*StateReply, error)
	// Transitions devices into Idle state.
	Reset(ctx context.Context, in *ResetRequest, opts ...grpc.CallOption) (*StateReply, error)
	// Shuts devices down via End transition.
	Terminate(ctx context.Context, in *TerminateRequest, opts ...grpc.CallOption) (*StateReply, error)
	// Shutdown DDS session.
	Shutdown(ctx context.Context, in *ShutdownRequest, opts ...grpc.CallOption) (*GeneralReply, error)
	// Status request.
	Status(ctx context.Context, in *StatusRequest, opts ...grpc.CallOption) (*StatusReply, error)
}

ODCClient is the client API for ODC service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewODCClient 

func NewODCClient(cc grpc.ClientConnInterface) ODCClient

type ODCServer 

type ODCServer interface {
	// Creates a new DDS session or attaches to an existing DDS session.
	Initialize(context.Context, *InitializeRequest) (*GeneralReply, error)
	// Submits DDS agents (deploys a dynamic cluster) according to a specified computing resources.
	// Can be called multiple times in order to submit more DDS agents (allocate more resources).
	Submit(context.Context, *SubmitRequest) (*GeneralReply, error)
	// Activates a given topology.
	Activate(context.Context, *ActivateRequest) (*GeneralReply, error)
	// Run request combines Initialize, Submit and Activate into a single request.
	// Run request always creates a new DDS session.
	Run(context.Context, *RunRequest) (*GeneralReply, error)
	// Updates a topology (up or down scale number of tasks or any other topology change).
	// It consists of 3 commands: Reset, Activate and Configure.
	// Can be called multiple times.
	Update(context.Context, *UpdateRequest) (*GeneralReply, error)
	// Transitions devices into Ready state.
	Configure(context.Context, *ConfigureRequest) (*StateReply, error)
	// Changes devices configuration.
	SetProperties(context.Context, *SetPropertiesRequest) (*GeneralReply, error)
	// Get current aggregated state of devices.
	GetState(context.Context, *StateRequest) (*StateReply, error)
	// Transition devices into Running state.
	Start(context.Context, *StartRequest) (*StateReply, error)
	// Transitions devices into Ready state.
	Stop(context.Context, *StopRequest) (*StateReply, error)
	// Transitions devices into Idle state.
	Reset(context.Context, *ResetRequest) (*StateReply, error)
	// Shuts devices down via End transition.
	Terminate(context.Context, *TerminateRequest) (*StateReply, error)
	// Shutdown DDS session.
	Shutdown(context.Context, *ShutdownRequest) (*GeneralReply, error)
	// Status request.
	Status(context.Context, *StatusRequest) (*StatusReply, error)
}

ODCServer is the server API for ODC service. All implementations should embed UnimplementedODCServer for forward compatibility

type PartitionStatus added in v0.27.0 

type PartitionStatus struct {
	Partitionid string        `protobuf:"bytes,1,opt,name=partitionid,proto3" json:"partitionid,omitempty"`               // Partition ID from ECS
	Runnr       uint64        `protobuf:"varint,5,opt,name=runnr,proto3" json:"runnr,omitempty"`                          // Run number from ECS
	Timeout     uint32        `protobuf:"varint,6,opt,name=timeout,proto3" json:"timeout,omitempty"`                      // Request timeout in sec. If not set or 0 than default is used.
	Sessionid   string        `protobuf:"bytes,2,opt,name=sessionid,proto3" json:"sessionid,omitempty"`                   // DDS session ID
	Status      SessionStatus `protobuf:"varint,3,opt,name=status,proto3,enum=odc.SessionStatus" json:"status,omitempty"` // DDS session status
	State       string        `protobuf:"bytes,4,opt,name=state,proto3" json:"state,omitempty"`                           // If successful and applicable to a request then contains an aggregated FairMQ device state, otherwise UNDEFINED.
	// contains filtered or unexported fields
}

Status of each partition

func (*PartitionStatus) Descriptor deprecated added in v0.27.0 

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

Deprecated: Use PartitionStatus.ProtoReflect.Descriptor instead.

func (*PartitionStatus) GetPartitionid added in v0.27.0 

func (x *PartitionStatus) GetPartitionid() string

func (*PartitionStatus) GetRunnr added in v0.27.0 

func (x *PartitionStatus) GetRunnr() uint64

func (*PartitionStatus) GetSessionid added in v0.27.0 

func (x *PartitionStatus) GetSessionid() string

func (*PartitionStatus) GetState added in v0.27.0 

func (x *PartitionStatus) GetState() string

func (*PartitionStatus) GetStatus added in v0.27.0 

func (x *PartitionStatus) GetStatus() SessionStatus

func (*PartitionStatus) GetTimeout added in v0.27.0 

func (x *PartitionStatus) GetTimeout() uint32

func (*PartitionStatus) ProtoMessage added in v0.27.0 

func (*PartitionStatus) ProtoMessage()

func (*PartitionStatus) ProtoReflect added in v0.27.0 

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

func (*PartitionStatus) Reset added in v0.27.0 

func (x *PartitionStatus) Reset()

func (*PartitionStatus) String added in v0.27.0 

func (x *PartitionStatus) String() string

type Property 

type Property struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`     // Property key
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // Property value
	// contains filtered or unexported fields
}

Key-Value property

func (*Property) Descriptor deprecated 

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

Deprecated: Use Property.ProtoReflect.Descriptor instead.

func (*Property) GetKey 

func (x *Property) GetKey() string

func (*Property) GetValue 

func (x *Property) GetValue() string

func (*Property) ProtoMessage 

func (*Property) ProtoMessage()

func (*Property) ProtoReflect 

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

func (*Property) Reset 

func (x *Property) Reset()

func (*Property) String 

func (x *Property) String() string

type ReplyStatus 

type ReplyStatus int32

Request status 

const (
	ReplyStatus_UNKNOWN ReplyStatus = 0 // Status is unknown
	ReplyStatus_SUCCESS ReplyStatus = 1 // Request performed successfully
	ReplyStatus_ERROR   ReplyStatus = 2 // Failed to perform request
)

func (ReplyStatus) Descriptor 

func (ReplyStatus) Descriptor() protoreflect.EnumDescriptor

func (ReplyStatus) Enum 

func (x ReplyStatus) Enum() *ReplyStatus

func (ReplyStatus) EnumDescriptor deprecated 

func (ReplyStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use ReplyStatus.Descriptor instead.

func (ReplyStatus) Number 

func (x ReplyStatus) Number() protoreflect.EnumNumber

func (ReplyStatus) String 

func (x ReplyStatus) String() string

func (ReplyStatus) Type 

func (ReplyStatus) Type() protoreflect.EnumType

type ResetRequest 

type ResetRequest struct {
	Request *StateRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"` // State change request. See StateRequest for details.
	// contains filtered or unexported fields
}

Reset request

func (*ResetRequest) Descriptor deprecated 

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

Deprecated: Use ResetRequest.ProtoReflect.Descriptor instead.

func (*ResetRequest) GetRequest 

func (x *ResetRequest) GetRequest() *StateRequest

func (*ResetRequest) ProtoMessage 

func (*ResetRequest) ProtoMessage()

func (*ResetRequest) ProtoReflect 

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

func (*ResetRequest) Reset 

func (x *ResetRequest) Reset()

func (*ResetRequest) String 

func (x *ResetRequest) String() string

type RunRequest 

type RunRequest struct {
	Partitionid string `protobuf:"bytes,1,opt,name=partitionid,proto3" json:"partitionid,omitempty"` // Partition ID from ECS
	Runnr       uint64 `protobuf:"varint,7,opt,name=runnr,proto3" json:"runnr,omitempty"`            // Run number from ECS
	Timeout     uint32 `protobuf:"varint,8,opt,name=timeout,proto3" json:"timeout,omitempty"`        // Request timeout in sec. If not set or 0 than default is used.
	// Either `topology`, `content` or `script` has to be set. If all or none is set then an error is returned.
	Topology             string `protobuf:"bytes,2,opt,name=topology,proto3" json:"topology,omitempty"`                          // Filepath to the XML DDS topology file
	Content              string `protobuf:"bytes,5,opt,name=content,proto3" json:"content,omitempty"`                            // Content of the XML DDS topology
	Script               string `protobuf:"bytes,6,opt,name=script,proto3" json:"script,omitempty"`                              // Shell commands to be executed by ODC in order to generate content of the XML DDS topology
	Plugin               string `protobuf:"bytes,3,opt,name=plugin,proto3" json:"plugin,omitempty"`                              // Name of the resource plugin registered in odc-server
	Resources            string `protobuf:"bytes,4,opt,name=resources,proto3" json:"resources,omitempty"`                        // Resource description
	ExtractTopoResources bool   `protobuf:"varint,9,opt,name=extractTopoResources,proto3" json:"extractTopoResources,omitempty"` // extract required resources from the topology file only (plugin & resources fields are ignored)
	// contains filtered or unexported fields
}

Run request

func (*RunRequest) Descriptor deprecated 

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

Deprecated: Use RunRequest.ProtoReflect.Descriptor instead.

func (*RunRequest) GetContent added in v0.27.0 

func (x *RunRequest) GetContent() string

func (*RunRequest) GetExtractTopoResources added in v0.71.0 

func (x *RunRequest) GetExtractTopoResources() bool

func (*RunRequest) GetPartitionid 

func (x *RunRequest) GetPartitionid() string

func (*RunRequest) GetPlugin added in v0.21.80 

func (x *RunRequest) GetPlugin() string

func (*RunRequest) GetResources added in v0.21.80 

func (x *RunRequest) GetResources() string

func (*RunRequest) GetRunnr added in v0.27.0 

func (x *RunRequest) GetRunnr() uint64

func (*RunRequest) GetScript added in v0.27.0 

func (x *RunRequest) GetScript() string

func (*RunRequest) GetTimeout added in v0.27.0 

func (x *RunRequest) GetTimeout() uint32

func (*RunRequest) GetTopology 

func (x *RunRequest) GetTopology() string

func (*RunRequest) ProtoMessage 

func (*RunRequest) ProtoMessage()

func (*RunRequest) ProtoReflect 

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

func (*RunRequest) Reset 

func (x *RunRequest) Reset()

func (*RunRequest) String 

func (x *RunRequest) String() string

type SessionStatus added in v0.27.0 

type SessionStatus int32

Session status as defined by DDS 

const (
	SessionStatus_UNKNOWN_ SessionStatus = 0 // Status is unknown
	SessionStatus_RUNNING  SessionStatus = 1 // DDS session is running
	SessionStatus_STOPPED  SessionStatus = 2 // DDS session is stopped
)

func (SessionStatus) Descriptor added in v0.27.0 

func (SessionStatus) Descriptor() protoreflect.EnumDescriptor

func (SessionStatus) Enum added in v0.27.0 

func (x SessionStatus) Enum() *SessionStatus

func (SessionStatus) EnumDescriptor deprecated added in v0.27.0 

func (SessionStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use SessionStatus.Descriptor instead.

func (SessionStatus) Number added in v0.27.0 

func (x SessionStatus) Number() protoreflect.EnumNumber

func (SessionStatus) String added in v0.27.0 

func (x SessionStatus) String() string

func (SessionStatus) Type added in v0.27.0 

func (SessionStatus) Type() protoreflect.EnumType

type SetPropertiesRequest 

type SetPropertiesRequest struct {
	Partitionid string      `protobuf:"bytes,1,opt,name=partitionid,proto3" json:"partitionid,omitempty"` // Partition ID from ECS
	Runnr       uint64      `protobuf:"varint,4,opt,name=runnr,proto3" json:"runnr,omitempty"`            // Run number from ECS
	Timeout     uint32      `protobuf:"varint,5,opt,name=timeout,proto3" json:"timeout,omitempty"`        // Request timeout in sec. If not set or 0 than default is used.
	Path        string      `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`               // Task path in the DDS topology. Can be a regular expression.
	Properties  []*Property `protobuf:"bytes,3,rep,name=properties,proto3" json:"properties,omitempty"`   // List of properties to be set
	// contains filtered or unexported fields
}

Set properties request

func (*SetPropertiesRequest) Descriptor deprecated 

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

Deprecated: Use SetPropertiesRequest.ProtoReflect.Descriptor instead.

func (*SetPropertiesRequest) GetPartitionid 

func (x *SetPropertiesRequest) GetPartitionid() string

func (*SetPropertiesRequest) GetPath 

func (x *SetPropertiesRequest) GetPath() string

func (*SetPropertiesRequest) GetProperties 

func (x *SetPropertiesRequest) GetProperties() []*Property

func (*SetPropertiesRequest) GetRunnr added in v0.27.0 

func (x *SetPropertiesRequest) GetRunnr() uint64

func (*SetPropertiesRequest) GetTimeout added in v0.27.0 

func (x *SetPropertiesRequest) GetTimeout() uint32

func (*SetPropertiesRequest) ProtoMessage 

func (*SetPropertiesRequest) ProtoMessage()

func (*SetPropertiesRequest) ProtoReflect 

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

func (*SetPropertiesRequest) Reset 

func (x *SetPropertiesRequest) Reset()

func (*SetPropertiesRequest) String 

func (x *SetPropertiesRequest) String() string

type ShutdownRequest 

type ShutdownRequest struct {
	Partitionid string `protobuf:"bytes,1,opt,name=partitionid,proto3" json:"partitionid,omitempty"` // Partition ID from ECS
	Runnr       uint64 `protobuf:"varint,2,opt,name=runnr,proto3" json:"runnr,omitempty"`            // Run number from ECS
	Timeout     uint32 `protobuf:"varint,3,opt,name=timeout,proto3" json:"timeout,omitempty"`        // Request timeout in sec. If not set or 0 than default is used.
	// contains filtered or unexported fields
}

Shutdown request

func (*ShutdownRequest) Descriptor deprecated 

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

Deprecated: Use ShutdownRequest.ProtoReflect.Descriptor instead.

func (*ShutdownRequest) GetPartitionid 

func (x *ShutdownRequest) GetPartitionid() string

func (*ShutdownRequest) GetRunnr added in v0.27.0 

func (x *ShutdownRequest) GetRunnr() uint64

func (*ShutdownRequest) GetTimeout added in v0.27.0 

func (x *ShutdownRequest) GetTimeout() uint32

func (*ShutdownRequest) ProtoMessage 

func (*ShutdownRequest) ProtoMessage()

func (*ShutdownRequest) ProtoReflect 

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

func (*ShutdownRequest) Reset 

func (x *ShutdownRequest) Reset()

func (*ShutdownRequest) String 

func (x *ShutdownRequest) String() string

type StartRequest 

type StartRequest struct {
	Request *StateRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"` // State change request. See StateRequest for details.
	// contains filtered or unexported fields
}

Start request

func (*StartRequest) Descriptor deprecated 

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

Deprecated: Use StartRequest.ProtoReflect.Descriptor instead.

func (*StartRequest) GetRequest 

func (x *StartRequest) GetRequest() *StateRequest

func (*StartRequest) ProtoMessage 

func (*StartRequest) ProtoMessage()

func (*StartRequest) ProtoReflect 

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

func (*StartRequest) Reset 

func (x *StartRequest) Reset()

func (*StartRequest) String 

func (x *StartRequest) String() string

type StateReply 

type StateReply struct {
	Reply   *GeneralReply `protobuf:"bytes,1,opt,name=reply,proto3" json:"reply,omitempty"`     // General reply. See GeneralReply message for details.
	Devices []*Device     `protobuf:"bytes,2,rep,name=devices,proto3" json:"devices,omitempty"` // If detailed reply is requested then this field contains a list of affected devices otherwise it's empty.
	// contains filtered or unexported fields
}

Device change/get state reply

func (*StateReply) Descriptor deprecated 

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

Deprecated: Use StateReply.ProtoReflect.Descriptor instead.

func (*StateReply) GetDevices 

func (x *StateReply) GetDevices() []*Device

func (*StateReply) GetReply 

func (x *StateReply) GetReply() *GeneralReply

func (*StateReply) ProtoMessage 

func (*StateReply) ProtoMessage()

func (*StateReply) ProtoReflect 

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

func (*StateReply) Reset 

func (x *StateReply) Reset()

func (*StateReply) String 

func (x *StateReply) String() string

type StateRequest 

type StateRequest struct {
	Partitionid string `protobuf:"bytes,1,opt,name=partitionid,proto3" json:"partitionid,omitempty"` // Partition ID from ECS
	Runnr       uint64 `protobuf:"varint,4,opt,name=runnr,proto3" json:"runnr,omitempty"`            // Run number from ECS
	Timeout     uint32 `protobuf:"varint,5,opt,name=timeout,proto3" json:"timeout,omitempty"`        // Request timeout in sec. If not set or 0 than default is used.
	Path        string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`               // Task path in the DDS topology. Can be a regular expression.
	Detailed    bool   `protobuf:"varint,3,opt,name=detailed,proto3" json:"detailed,omitempty"`      // If true then a list of affected devices is populated in the reply.
	// contains filtered or unexported fields
}

Device change/get state request

func (*StateRequest) Descriptor deprecated 

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

Deprecated: Use StateRequest.ProtoReflect.Descriptor instead.

func (*StateRequest) GetDetailed 

func (x *StateRequest) GetDetailed() bool

func (*StateRequest) GetPartitionid 

func (x *StateRequest) GetPartitionid() string

func (*StateRequest) GetPath 

func (x *StateRequest) GetPath() string

func (*StateRequest) GetRunnr added in v0.27.0 

func (x *StateRequest) GetRunnr() uint64

func (*StateRequest) GetTimeout added in v0.27.0 

func (x *StateRequest) GetTimeout() uint32

func (*StateRequest) ProtoMessage 

func (*StateRequest) ProtoMessage()

func (*StateRequest) ProtoReflect 

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

func (*StateRequest) Reset 

func (x *StateRequest) Reset()

func (*StateRequest) String 

func (x *StateRequest) String() string

type StatusReply added in v0.27.0 

type StatusReply struct {
	Msg        string             `protobuf:"bytes,1,opt,name=msg,proto3" json:"msg,omitempty"`                             // Detailed reply message
	Status     ReplyStatus        `protobuf:"varint,2,opt,name=status,proto3,enum=odc.ReplyStatus" json:"status,omitempty"` // Request status code (UNKNOWN, SUCCESS, ERROR)
	Error      *Error             `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`                         // If status is ERROR than this field contains error description otherwise it's empty
	Exectime   int32              `protobuf:"varint,4,opt,name=exectime,proto3" json:"exectime,omitempty"`                  // Request execution time in ms
	Partitions []*PartitionStatus `protobuf:"bytes,5,rep,name=partitions,proto3" json:"partitions,omitempty"`               // Status of each partition
	// contains filtered or unexported fields
}

ODC status reply

func (*StatusReply) Descriptor deprecated added in v0.27.0 

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

Deprecated: Use StatusReply.ProtoReflect.Descriptor instead.

func (*StatusReply) GetError added in v0.27.0 

func (x *StatusReply) GetError() *Error

func (*StatusReply) GetExectime added in v0.27.0 

func (x *StatusReply) GetExectime() int32

func (*StatusReply) GetMsg added in v0.27.0 

func (x *StatusReply) GetMsg() string

func (*StatusReply) GetPartitions added in v0.27.0 

func (x *StatusReply) GetPartitions() []*PartitionStatus

func (*StatusReply) GetStatus added in v0.27.0 

func (x *StatusReply) GetStatus() ReplyStatus

func (*StatusReply) ProtoMessage added in v0.27.0 

func (*StatusReply) ProtoMessage()

func (*StatusReply) ProtoReflect added in v0.27.0 

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

func (*StatusReply) Reset added in v0.27.0 

func (x *StatusReply) Reset()

func (*StatusReply) String added in v0.27.0 

func (x *StatusReply) String() string

type StatusRequest added in v0.27.0 

type StatusRequest struct {
	Running bool `protobuf:"varint,1,opt,name=running,proto3" json:"running,omitempty"` // Select only running DDS sessions
	// contains filtered or unexported fields
}

Status request

func (*StatusRequest) Descriptor deprecated added in v0.27.0 

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

Deprecated: Use StatusRequest.ProtoReflect.Descriptor instead.

func (*StatusRequest) GetRunning added in v0.27.0 

func (x *StatusRequest) GetRunning() bool

func (*StatusRequest) ProtoMessage added in v0.27.0 

func (*StatusRequest) ProtoMessage()

func (*StatusRequest) ProtoReflect added in v0.27.0 

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

func (*StatusRequest) Reset added in v0.27.0 

func (x *StatusRequest) Reset()

func (*StatusRequest) String added in v0.27.0 

func (x *StatusRequest) String() string

type StopRequest 

type StopRequest struct {
	Request *StateRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"` // State change request. See StateRequest for details.
	// contains filtered or unexported fields
}

Stop request

func (*StopRequest) Descriptor deprecated 

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

Deprecated: Use StopRequest.ProtoReflect.Descriptor instead.

func (*StopRequest) GetRequest 

func (x *StopRequest) GetRequest() *StateRequest

func (*StopRequest) ProtoMessage 

func (*StopRequest) ProtoMessage()

func (*StopRequest) ProtoReflect 

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

func (*StopRequest) Reset 

func (x *StopRequest) Reset()

func (*StopRequest) String 

func (x *StopRequest) String() string

type SubmitRequest 

type SubmitRequest struct {
	Partitionid string `protobuf:"bytes,1,opt,name=partitionid,proto3" json:"partitionid,omitempty"` // Partition ID from ECS
	Runnr       uint64 `protobuf:"varint,4,opt,name=runnr,proto3" json:"runnr,omitempty"`            // Run number from ECS
	Timeout     uint32 `protobuf:"varint,5,opt,name=timeout,proto3" json:"timeout,omitempty"`        // Request timeout in sec. If not set or 0 than default is used.
	Plugin      string `protobuf:"bytes,2,opt,name=plugin,proto3" json:"plugin,omitempty"`           // Name of the resource plugin registered in odc-server
	Resources   string `protobuf:"bytes,3,opt,name=resources,proto3" json:"resources,omitempty"`     // Resource description
	// contains filtered or unexported fields
}

Submit request

func (*SubmitRequest) Descriptor deprecated 

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

Deprecated: Use SubmitRequest.ProtoReflect.Descriptor instead.

func (*SubmitRequest) GetPartitionid 

func (x *SubmitRequest) GetPartitionid() string

func (*SubmitRequest) GetPlugin added in v0.21.80 

func (x *SubmitRequest) GetPlugin() string

func (*SubmitRequest) GetResources added in v0.21.80 

func (x *SubmitRequest) GetResources() string

func (*SubmitRequest) GetRunnr added in v0.27.0 

func (x *SubmitRequest) GetRunnr() uint64

func (*SubmitRequest) GetTimeout added in v0.27.0 

func (x *SubmitRequest) GetTimeout() uint32

func (*SubmitRequest) ProtoMessage 

func (*SubmitRequest) ProtoMessage()

func (*SubmitRequest) ProtoReflect 

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

func (*SubmitRequest) Reset 

func (x *SubmitRequest) Reset()

func (*SubmitRequest) String 

func (x *SubmitRequest) String() string

type TerminateRequest 

type TerminateRequest struct {
	Request *StateRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"` // State change request. See StateRequest for details.
	// contains filtered or unexported fields
}

Terminate request

func (*TerminateRequest) Descriptor deprecated 

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

Deprecated: Use TerminateRequest.ProtoReflect.Descriptor instead.

func (*TerminateRequest) GetRequest 

func (x *TerminateRequest) GetRequest() *StateRequest

func (*TerminateRequest) ProtoMessage 

func (*TerminateRequest) ProtoMessage()

func (*TerminateRequest) ProtoReflect 

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

func (*TerminateRequest) Reset 

func (x *TerminateRequest) Reset()

func (*TerminateRequest) String 

func (x *TerminateRequest) String() string

type UnimplementedODCServer 

type UnimplementedODCServer struct {
}

UnimplementedODCServer should be embedded to have forward compatible implementations.

func (UnimplementedODCServer) Activate 

func (UnimplementedODCServer) Activate(context.Context, *ActivateRequest) (*GeneralReply, error)

func (UnimplementedODCServer) Configure 

func (UnimplementedODCServer) Configure(context.Context, *ConfigureRequest) (*StateReply, error)

func (UnimplementedODCServer) GetState 

func (UnimplementedODCServer) GetState(context.Context, *StateRequest) (*StateReply, error)

func (UnimplementedODCServer) Initialize 

func (UnimplementedODCServer) Initialize(context.Context, *InitializeRequest) (*GeneralReply, error)

func (UnimplementedODCServer) Reset 

func (UnimplementedODCServer) Reset(context.Context, *ResetRequest) (*StateReply, error)

func (UnimplementedODCServer) Run 

func (UnimplementedODCServer) Run(context.Context, *RunRequest) (*GeneralReply, error)

func (UnimplementedODCServer) SetProperties 

func (UnimplementedODCServer) SetProperties(context.Context, *SetPropertiesRequest) (*GeneralReply, error)

func (UnimplementedODCServer) Shutdown 

func (UnimplementedODCServer) Shutdown(context.Context, *ShutdownRequest) (*GeneralReply, error)

func (UnimplementedODCServer) Start 

func (UnimplementedODCServer) Start(context.Context, *StartRequest) (*StateReply, error)

func (UnimplementedODCServer) Status added in v0.27.0 

func (UnimplementedODCServer) Status(context.Context, *StatusRequest) (*StatusReply, error)

func (UnimplementedODCServer) Stop 

func (UnimplementedODCServer) Stop(context.Context, *StopRequest) (*StateReply, error)

func (UnimplementedODCServer) Submit 

func (UnimplementedODCServer) Submit(context.Context, *SubmitRequest) (*GeneralReply, error)

func (UnimplementedODCServer) Terminate 

func (UnimplementedODCServer) Terminate(context.Context, *TerminateRequest) (*StateReply, error)

func (UnimplementedODCServer) Update 

func (UnimplementedODCServer) Update(context.Context, *UpdateRequest) (*GeneralReply, error)

type UnsafeODCServer 

type UnsafeODCServer interface {
	// contains filtered or unexported methods
}

UnsafeODCServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ODCServer will result in compilation errors.

type UpdateRequest 

type UpdateRequest struct {
	Partitionid string `protobuf:"bytes,1,opt,name=partitionid,proto3" json:"partitionid,omitempty"` // Partition ID from ECS
	Runnr       uint64 `protobuf:"varint,5,opt,name=runnr,proto3" json:"runnr,omitempty"`            // Run number from ECS
	Timeout     uint32 `protobuf:"varint,6,opt,name=timeout,proto3" json:"timeout,omitempty"`        // Request timeout in sec. If not set or 0 than default is used.
	// Either `topology`, `content` or `script` has to be set. If all or none is set then an error is returned.
	Topology string `protobuf:"bytes,2,opt,name=topology,proto3" json:"topology,omitempty"` // Filepath to the XML DDS topology file
	Content  string `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`   // Content of the XML DDS topology
	Script   string `protobuf:"bytes,4,opt,name=script,proto3" json:"script,omitempty"`     // Shell commands to be executed by ODC in order to generate content of the XML DDS topology
	// contains filtered or unexported fields
}

Update request

func (*UpdateRequest) Descriptor deprecated 

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

Deprecated: Use UpdateRequest.ProtoReflect.Descriptor instead.

func (*UpdateRequest) GetContent added in v0.27.0 

func (x *UpdateRequest) GetContent() string

func (*UpdateRequest) GetPartitionid 

func (x *UpdateRequest) GetPartitionid() string

func (*UpdateRequest) GetRunnr added in v0.27.0 

func (x *UpdateRequest) GetRunnr() uint64

func (*UpdateRequest) GetScript added in v0.27.0 

func (x *UpdateRequest) GetScript() string

func (*UpdateRequest) GetTimeout added in v0.27.0 

func (x *UpdateRequest) GetTimeout() uint32

func (*UpdateRequest) GetTopology 

func (x *UpdateRequest) GetTopology() string

func (*UpdateRequest) ProtoMessage 

func (*UpdateRequest) ProtoMessage()

func (*UpdateRequest) ProtoReflect 

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

func (*UpdateRequest) Reset 

func (x *UpdateRequest) Reset()

func (*UpdateRequest) String 

func (x *UpdateRequest) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.