Struct PubSubInputConfig

pub struct PubSubInputConfig {
    pub connect_timeout_seconds: Option<i64>,
    pub credentials: Option<String>,
    pub emulator: Option<String>,
    pub endpoint: Option<String>,
    pub pool_size: Option<i64>,
    pub project_id: Option<String>,
    pub snapshot: Option<String>,
    pub subscription: String,
    pub timeout_seconds: Option<i64>,
    pub timestamp: Option<String>,
}

Google Pub/Sub input connector configuration.

JSON schema

{
 "description": "Google Pub/Sub input connector configuration.",
 "type": "object",
 "required": [
   "subscription"
 ],
 "properties": {
   "connect_timeout_seconds": {
     "description": "gRPC connection timeout.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int32",
     "minimum": 0.0
   },
   "credentials": {
     "description": "The content of a Google Cloud credentials JSON file.\n\nWhen this option is specified, the connector will use the provided credentials for\nauthentication.  Otherwise, it will use Application Default Credentials (ADC) configured\nin the environment where the Feldera service is running.  See\n[Google Cloud documentation](https://cloud.google.com/docs/authentication/provide-credentials-adc)\nfor information on configuring application default credentials.\n\nWhen running Feldera in an environment where ADC are not configured,\ne.g., a Docker container, use this option to ship Google Cloud credentials from another environment.\nFor example, if you use the\n[`gcloud auth application-default login`](https://cloud.google.com/pubsub/docs/authentication#client-libs)\ncommand for authentication in your local development environment, ADC are stored in the\n`.config/gcloud/application_default_credentials.json` file in your home directory.",
     "type": [
       "string",
       "null"
     ]
   },
   "emulator": {
     "description": "Set in order to use a Pub/Sub [emulator](https://cloud.google.com/pubsub/docs/emulator)\ninstead of the production service, e.g., 'localhost:8681'.",
     "type": [
       "string",
       "null"
     ]
   },
   "endpoint": {
     "description": "Override the default service endpoint 'pubsub.googleapis.com'",
     "type": [
       "string",
       "null"
     ]
   },
   "pool_size": {
     "description": "gRPC channel pool size.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int32",
     "minimum": 0.0
   },
   "project_id": {
     "description": "Google Cloud project_id.\n\nWhen not specified, the connector will use the project id associated\nwith the authenticated account.",
     "type": [
       "string",
       "null"
     ]
   },
   "snapshot": {
     "description": "Reset subscription's backlog to a given snapshot on startup,\nusing the Pub/Sub `Seek` API.\n\nThis option is mutually exclusive with the `timestamp` option.",
     "type": [
       "string",
       "null"
     ]
   },
   "subscription": {
     "description": "Subscription name.",
     "type": "string"
   },
   "timeout_seconds": {
     "description": "gRPC request timeout.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int32",
     "minimum": 0.0
   },
   "timestamp": {
     "description": "Reset subscription's backlog to a given timestamp on startup,\nusing the Pub/Sub `Seek` API.\n\nThe value of this option is an ISO 8601-encoded UTC time, e.g., \"2024-08-17T16:39:57-08:00\".\n\nThis option is mutually exclusive with the `snapshot` option.",
     "type": [
       "string",
       "null"
     ]
   }
 }
}

Fields

connect_timeout_seconds: Option<i64>

gRPC connection timeout.

credentials: Option<String>

The content of a Google Cloud credentials JSON file.

When this option is specified, the connector will use the provided credentials for authentication. Otherwise, it will use Application Default Credentials (ADC) configured in the environment where the Feldera service is running. See Google Cloud documentation for information on configuring application default credentials.

When running Feldera in an environment where ADC are not configured, e.g., a Docker container, use this option to ship Google Cloud credentials from another environment. For example, if you use the gcloud auth application-default login command for authentication in your local development environment, ADC are stored in the .config/gcloud/application_default_credentials.json file in your home directory.

emulator: Option<String>

Set in order to use a Pub/Sub emulator instead of the production service, e.g., ‘localhost:8681’.

endpoint: Option<String>

Override the default service endpoint ‘pubsub.googleapis.com’

pool_size: Option<i64>

gRPC channel pool size.

project_id: Option<String>

Google Cloud project_id.

When not specified, the connector will use the project id associated with the authenticated account.

snapshot: Option<String>

Reset subscription’s backlog to a given snapshot on startup, using the Pub/Sub Seek API.

This option is mutually exclusive with the timestamp option.

subscription: String

Subscription name.

timeout_seconds: Option<i64>

gRPC request timeout.

timestamp: Option<String>

Reset subscription’s backlog to a given timestamp on startup, using the Pub/Sub Seek API.

The value of this option is an ISO 8601-encoded UTC time, e.g., “2024-08-17T16:39:57-08:00”.

This option is mutually exclusive with the snapshot option.

Implementations

impl PubSubInputConfig

pub fn builder() -> PubSubInputConfig

Trait Implementations

impl Clone for PubSubInputConfig

fn clone(&self) -> PubSubInputConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PubSubInputConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PubSubInputConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PubSubInputConfig> for PubSubInputConfig

fn from(value: &PubSubInputConfig) -> Self

Converts to this type from the input type.

impl From<PubSubInputConfig> for PubSubInputConfig

fn from(value: PubSubInputConfig) -> Self

Converts to this type from the input type.

impl Serialize for PubSubInputConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PubSubInputConfig> for PubSubInputConfig

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: PubSubInputConfig) -> Result<Self, ConversionError>

Performs the conversion.