Struct vector::config::SourceOutput

pub struct SourceOutput {
    pub port: Option<String>,
    pub ty: DataType,
    pub schema_definition: Option<Arc<Definition>>,
}

Fields

port: Option<String>

ty: DataType

schema_definition: Option<Arc<Definition>>

Implementations

impl SourceOutput

pub fn new_maybe_logs( ty: DataType, schema_definition: Definition, ) -> SourceOutput

Create a SourceOutput of the given data type that contains a single output Definition. If the data type does not contain logs, the schema definition will be ignored. Designed for use in log sources.

pub fn new_metrics() -> SourceOutput

Create a SourceOutput of the given data type that contains no output Definitions. Designed for use in metrics sources.

Sets the datatype to be DataType::Metric.

pub fn new_traces() -> SourceOutput

Create a SourceOutput of the given data type that contains no output Definitions. Designed for use in trace sources.

Sets the datatype to be DataType::Trace.

pub fn schema_definition(&self, schema_enabled: bool) -> Option<Definition>

Return the schema schema::Definition from this output.

Takes a schema_enabled flag to determine if the full definition including the fields and associated types should be returned, or if a simple definition should be returned. A simple definition is just the default for the namespace. For the Vector namespace the meanings are included. Schema enabled is set in the users configuration.

impl SourceOutput

pub fn with_port(self, name: impl Into<String>) -> SourceOutput

Set the port name for this SourceOutput.

Trait Implementations

impl Clone for SourceOutput

fn clone(&self) -> SourceOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SourceOutput

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

Formats the value using the given formatter.

impl Display for SourceOutput

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

Formats the value using the given formatter.

impl PartialEq for SourceOutput

fn eq(&self, other: &SourceOutput) -> 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 StructuralPartialEq for SourceOutput