v1

type ListMLServicesSizesRequest struct {

	// Optional ID of the Deployment for which sizes are being requested.
	// If set, the response will exclude any sizes that are unavailable for the specified deployment model.
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// contains filtered or unexported fields
}

type MLServiceClient interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(ctx context.Context, in *v1.Empty, opts ...grpc.CallOption) (*v1.Version, error)
	// Get an existing MLServices resource for a given deployment (specified by the id).
	// Required permissions:
	// - ml.mlservices.get
	GetMLServices(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*MLServices, error)
	// Update an existing MLServices resource. If it does not exist, this will create a new one.
	// Pass the desired updated state of MLServices to this call.
	// Required permissions:
	// - ml.mlservices.update
	UpdateMLServices(ctx context.Context, in *MLServices, opts ...grpc.CallOption) (*MLServices, error)
	// List the available size configurations for MLServices.
	// Note that the returned size specifications are applied for ML Jobs.
	// Required permissions:
	// - ml.mlservicessize.list on the deployment (if deployment_id is provided)
	// - None, authenticated only
	ListMLServicesSizes(ctx context.Context, in *ListMLServicesSizesRequest, opts ...grpc.CallOption) (*MLServicesSizeList, error)
}

type MLServiceServer interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)
	// Get an existing MLServices resource for a given deployment (specified by the id).
	// Required permissions:
	// - ml.mlservices.get
	GetMLServices(context.Context, *v1.IDOptions) (*MLServices, error)
	// Update an existing MLServices resource. If it does not exist, this will create a new one.
	// Pass the desired updated state of MLServices to this call.
	// Required permissions:
	// - ml.mlservices.update
	UpdateMLServices(context.Context, *MLServices) (*MLServices, error)
	// List the available size configurations for MLServices.
	// Note that the returned size specifications are applied for ML Jobs.
	// Required permissions:
	// - ml.mlservicessize.list on the deployment (if deployment_id is provided)
	// - None, authenticated only
	ListMLServicesSizes(context.Context, *ListMLServicesSizesRequest) (*MLServicesSizeList, error)
}

type MLServices struct {

	// Identifier of the deployment for this MLServices resource.
	// This is a ready-only value.
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Set to true if ML services are enabled for this deployment.
	Enabled bool `protobuf:"varint,2,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// Size to use for the ML Jobs.
	// Use `ListMLServicesSizes` to get a list of available sizes.
	// If unspecified, the MLServiceSize marked as `is_default` is used.
	// This is an optional field.
	Size string `protobuf:"bytes,3,opt,name=size,proto3" json:"size,omitempty"`
	// The creation timestamp of the MLServices.
	// This also serves as a timestamp of when MLServices were first enabled.
	// This is a read-only value.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Status of the MLServices.
	// This is a read-only value.
	Status *Status `protobuf:"bytes,100,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

type MLServicesSize struct {

	// Identifier of the size configuration.
	SizeId string `protobuf:"bytes,1,opt,name=size_id,json=sizeId,proto3" json:"size_id,omitempty"`
	// If set, this is the default size when unspecified in MLServices.
	IsDefault bool `protobuf:"varint,2,opt,name=is_default,json=isDefault,proto3" json:"is_default,omitempty"`
	// Amount of CPU allocated (in vCPU units)
	Cpu float32 `protobuf:"fixed32,3,opt,name=cpu,proto3" json:"cpu,omitempty"`
	// Amount of Memory allocated (in GB)
	Memory int32 `protobuf:"varint,4,opt,name=memory,proto3" json:"memory,omitempty"`
	// Amount of GPUs allocated
	Gpu float32 `protobuf:"fixed32,5,opt,name=gpu,proto3" json:"gpu,omitempty"`
	// contains filtered or unexported fields
}

type MLServicesSizeList struct {

	// Items in this list.
	Items []*MLServicesSize `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

type ServiceStatus struct {

	// Type of service.
	// Should be one of: [training|prediction|projects]
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Set to true if the service is available.
	// Every service is always in ONLY ONE of the following states: (available|failed)
	Available bool `protobuf:"varint,2,opt,name=available,proto3" json:"available,omitempty"`
	// Set to true if the service is in a failed state.
	// Every service is always in ONLY ONE of the following states: (available|failed)
	Failed bool `protobuf:"varint,3,opt,name=failed,proto3" json:"failed,omitempty"`
	// Resource usage information for this service.
	Usage *ServiceStatus_Usage `protobuf:"bytes,4,opt,name=usage,proto3" json:"usage,omitempty"`
	// Number of replicas running for this service.
	Replicas int32 `protobuf:"varint,5,opt,name=replicas,proto3" json:"replicas,omitempty"`
	// contains filtered or unexported fields
}

type ServiceStatus_Usage struct {

	// Last known memory usage in bytes
	LastMemoryUsage int64 `protobuf:"varint,1,opt,name=last_memory_usage,json=lastMemoryUsage,proto3" json:"last_memory_usage,omitempty"`
	// Last known CPU usage in vCPU units
	LastCpuUsage float32 `protobuf:"fixed32,2,opt,name=last_cpu_usage,json=lastCpuUsage,proto3" json:"last_cpu_usage,omitempty"`
	// Last known memory limit in bytes
	LastMemoryLimit int64 `protobuf:"varint,3,opt,name=last_memory_limit,json=lastMemoryLimit,proto3" json:"last_memory_limit,omitempty"`
	// Last known CPU limit in vCPU units
	LastCpuLimit float32 `protobuf:"fixed32,4,opt,name=last_cpu_limit,json=lastCpuLimit,proto3" json:"last_cpu_limit,omitempty"`
	// contains filtered or unexported fields
}

type Status struct {

	// Overall status of where the MLServices resource is in its lifecycle at a given time.
	// It will contain only one of the following values:
	// "Bootstrapping"  - ArangoDB Deployment is being bootstrapped with the required databases, schemas and data.
	// "Initialising"   - The services needed for ArangoGraphML are being installed.
	// "Running"        - ArangoGraphML is setup and running correctly.
	// "Error"          - Indicates that there was an error with setting up ArangoGraphML. Check `message` field for additional info.
	// "Hibernated"     - Indicates that ArangoGraphML and all its associated services are hibernated.
	Phase string `protobuf:"bytes,1,opt,name=phase,proto3" json:"phase,omitempty"`
	// Supporting information about the phase of MLServices (such as error messages in case of failures).
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// The timestamp of when this status was last updated.
	LastUpdatedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=last_updated_at,json=lastUpdatedAt,proto3" json:"last_updated_at,omitempty"`
	// Status of each ArangoGraphML components/services.
	Services []*ServiceStatus `protobuf:"bytes,4,rep,name=services,proto3" json:"services,omitempty"`
	// Total number of hours ML Jobs have run for this Deployment.
	HoursUsed float32 `protobuf:"fixed32,5,opt,name=hours_used,json=hoursUsed,proto3" json:"hours_used,omitempty"`
	// Total number of runtime hours allowed for ML Jobs for this Deployment.
	// Set to 0 if unlimited (i.e, no restriction).
	HoursAllowed float32 `protobuf:"fixed32,6,opt,name=hours_allowed,json=hoursAllowed,proto3" json:"hours_allowed,omitempty"`
	// Timestamp after which MLServices are no longer usable.
	// This is set during trial use.
	// If unset, no expiry.
	ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	// Timestamp of when MLServices were last enabled for this deployment.
	LastEnabledAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=last_enabled_at,json=lastEnabledAt,proto3" json:"last_enabled_at,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedMLServiceServer struct {
}