Struct Service

pub struct Service {

    pub accepts: String,
    pub rejects: Option<String>,
    pub category: String,
    pub classification: String,
    pub config: JsonMap,
    pub description: Text,
    pub default_result_classification: String,
    pub enabled: bool,
    pub is_external: bool,
    pub licence_count: u32,
    pub min_instances: Option<u32>,
    pub max_queue_length: u32,
    pub uses_tags: bool,
    pub uses_tag_scores: bool,
    pub uses_temp_submission_data: bool,
    pub uses_metadata: bool,
    pub name: String,
    pub version: String,
    pub privileged: bool,
    pub disable_cache: bool,
    pub stage: String,
    pub submission_params: Vec<SubmissionParams>,
    pub timeout: u32,
    pub docker_config: DockerConfig,
    pub dependencies: HashMap<String, DependencyConfig>,
    pub update_channel: ChannelKinds,
    pub update_config: Option<UpdateConfig>,
}

Service Configuration

Fields

accepts: String

Regex to accept files as identified by Assemblyline Regexes applied to assemblyline style file type string

rejects: Option<String>

Regex to reject files as identified by Assemblyline Regexes applied to assemblyline style file type string

category: String

Which category does this service belong to?

classification: String

Classification of the service

config: JsonMap

Service Configuration

description: Text

Description of service

default_result_classification: String

Default classification assigned to service results

enabled: bool

Is the service enabled

is_external: bool

Does this service perform analysis outside of Assemblyline?

licence_count: u32

How many licences is the service allowed to use?

min_instances: Option<u32>

The minimum number of service instances. Overrides Scaler’s min_instances configuration.

max_queue_length: u32

If more than this many jobs are queued for this service drop those over this limit. 0 is unlimited.

uses_tags: bool

Does this service use tags from other services for analysis?

uses_tag_scores: bool

Does this service use scores of tags from other services for analysis?

uses_temp_submission_data: bool

Does this service use temp data from other services for analysis?

uses_metadata: bool

Does this service use submission metadata for analysis?

name: String

Name of service

version: String

Version of service

privileged: bool

Should the service be able to talk to core infrastructure or just service-server for tasking?

disable_cache: bool

Should the result cache be disabled for this service?

stage: String

Which execution stage does this service run in?

submission_params: Vec<SubmissionParams>

Submission parameters of service

timeout: u32

Service task timeout, in seconds

docker_config: DockerConfig

Docker configuration for service

dependencies: HashMap<String, DependencyConfig>

Dependency configuration for service

update_channel: ChannelKinds

What channel to watch for service updates?

update_config: Option<UpdateConfig>

Update configuration for fetching external resources

Implementations

impl Service

pub fn key(&self) -> String

Trait Implementations

impl Debug for Service

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Described<ElasticMeta> for Service

fn metadata() -> Descriptor<ElasticMeta>

Get self description of this type

impl<'de> Deserialize<'de> for Service

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Service

fn eq(&self, other: &Service) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Service

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Service