Struct vector::sources::gcp_pubsub::PubsubConfig

pub struct PubsubConfig {

    pub project: String,
    pub subscription: String,
    pub endpoint: String,
    pub auth: GcpAuthConfig,
    pub tls: Option<TlsConfig>,
    pub max_concurrency: usize,
    pub full_response_size: usize,
    pub poll_time_seconds: Duration,
    pub ack_deadline_secs: Duration,
    pub ack_deadline_seconds: Option<u16>,
    pub retry_delay_secs: Duration,
    pub retry_delay_seconds: Option<f64>,
    pub keepalive_secs: Duration,
    pub log_namespace: Option<bool>,
    pub framing: FramingConfig,
    pub decoding: DeserializerConfig,
    pub acknowledgements: SourceAcknowledgementsConfig,
}

Configuration for the gcp_pubsub source.

Fields

project: String

The project name from which to pull logs.

subscription: String

The subscription within the project which is configured to receive logs.

endpoint: String

The endpoint from which to pull data.

auth: GcpAuthConfig

tls: Option<TlsConfig>

max_concurrency: usize

The maximum number of concurrent stream connections to open at once.

full_response_size: usize

The number of messages in a response to mark a stream as “busy”. This is used to determine if more streams should be started.

The GCP Pub/Sub servers send responses with 100 or more messages when the subscription is busy.

poll_time_seconds: Duration

How often to poll the currently active streams to see if they are all busy and so open a new stream.

ack_deadline_secs: Duration

The acknowledgement deadline, in seconds, to use for this stream.

Messages that are not acknowledged when this deadline expires may be retransmitted.

ack_deadline_seconds: Option<u16>

The acknowledgement deadline, in seconds, to use for this stream.

Messages that are not acknowledged when this deadline expires may be retransmitted.

retry_delay_secs: Duration

The amount of time, in seconds, to wait between retry attempts after an error.

retry_delay_seconds: Option<f64>

The amount of time, in seconds, to wait between retry attempts after an error.

keepalive_secs: Duration

The amount of time, in seconds, with no received activity before sending a keepalive request. If this is set larger than 60, you may see periodic errors sent from the server.

log_namespace: Option<bool>

The namespace to use for logs. This overrides the global setting.

framing: FramingConfig

decoding: DeserializerConfig

acknowledgements: SourceAcknowledgementsConfig

Trait Implementations

impl Clone for PubsubConfig

fn clone(&self) -> PubsubConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for PubsubConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for PubsubConfig

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

Formats the value using the given formatter.

impl Default for PubsubConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PubsubConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for PubsubConfig

fn generate_config() -> Value

impl NamedComponent for PubsubConfig

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl Serialize for PubsubConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SourceConfig for PubsubConfig

fn build<'life0, 'async_trait>( &'life0 self, cx: SourceContext, ) -> Pin<Box<dyn Future<Output = Result<Source>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Builds the source with the given context.

fn outputs(&self, global_log_namespace: LogNamespace) -> Vec<SourceOutput>

Gets the list of outputs exposed by this source.

fn can_acknowledge(&self) -> bool

Whether or not this source can acknowledge the events it emits.

fn resources(&self) -> Vec<Resource>

Gets the list of resources, if any, used by this source.

impl ToValue for PubsubConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.