airbyte_client 0.41.0

Airbyte Client is an unofficial client library for the Airbyte API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

/*
 * Airbyte Configuration API
 *
 * Airbyte Configuration API [https://airbyte.io](https://airbyte.io).  The Configuration API is an internal Airbyte API that is designed for communications between different Airbyte components. * Its main purpose is to enable the Airbyte Engineering team to configure the internal state of [Airbyte Cloud](https://airbyte.com/airbyte-cloud) * It is also sometimes used by OSS users to configure their own Self-Hosted Airbyte deployment (internal state, etc)  WARNING * Airbyte does NOT have active commitments to support this API long-term. * OSS users can utilize the Configuration API, but at their own risk. * This API is utilized internally by the Airbyte Engineering team and may be modified in the future if the need arises. * Modifications by the Airbyte Engineering team could create breaking changes and OSS users would need to update their code to catch up to any backwards incompatible changes in the API.  This API is a collection of HTTP RPC-style methods. While it is not a REST API, those familiar with REST should find the conventions of this API recognizable.  Here are some conventions that this API follows: * All endpoints are http POST methods. * All endpoints accept data via `application/json` request bodies. The API does not accept any data via query params. * The naming convention for endpoints is: localhost:8000/api/{VERSION}/{METHOD_FAMILY}/{METHOD_NAME} e.g. `localhost:8000/api/v1/connections/create`. * For all `update` methods, the whole object must be passed in, even the fields that did not change.  Authentication (OSS): * When authenticating to the Configuration API, you must use Basic Authentication by setting the Authentication Header to Basic and base64 encoding the username and password (which are `airbyte` and `password` by default - so base64 encoding `airbyte:password` results in `YWlyYnl0ZTpwYXNzd29yZA==`). So the full header reads `'Authorization': \"Basic YWlyYnl0ZTpwYXNzd29yZA==\"`
 *
 * The version of the OpenAPI document: 1.0.0
 * Contact: contact@airbyte.io
 * Generated by: https://openapi-generator.tech
 */

/// AirbyteStreamConfiguration : the mutable part of the stream to configure the destination

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct AirbyteStreamConfiguration {
    #[serde(rename = "syncMode")]
    pub sync_mode: crate::models::SyncMode,
    /// Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if `sync_mode` is `incremental`. Otherwise it is ignored.
    #[serde(rename = "cursorField", skip_serializing_if = "Option::is_none")]
    pub cursor_field: Option<Vec<String>>,
    #[serde(rename = "destinationSyncMode")]
    pub destination_sync_mode: crate::models::DestinationSyncMode,
    /// Paths to the fields that will be used as primary key. This field is REQUIRED if `destination_sync_mode` is `*_dedup`. Otherwise it is ignored.
    #[serde(rename = "primaryKey", skip_serializing_if = "Option::is_none")]
    pub primary_key: Option<Vec<Vec<String>>>,
    /// Alias name to the stream to be used in the destination
    #[serde(rename = "aliasName", skip_serializing_if = "Option::is_none")]
    pub alias_name: Option<String>,
    /// If this is true, the stream is selected with all of its properties. For new connections, this considers if the stream is suggested or not
    #[serde(rename = "selected", skip_serializing_if = "Option::is_none")]
    pub selected: Option<bool>,
    /// Does the connector suggest that this stream be enabled by default?
    #[serde(rename = "suggested", skip_serializing_if = "Option::is_none")]
    pub suggested: Option<bool>,
    /// Whether field selection should be enabled. If this is true, only the properties in `selectedFields` will be included.
    #[serde(
        rename = "fieldSelectionEnabled",
        skip_serializing_if = "Option::is_none"
    )]
    pub field_selection_enabled: Option<bool>,
    /// Paths to the fields that will be included in the configured catalog. This must be set if `fieldSelectedEnabled` is set. An empty list indicates that no properties will be included.
    #[serde(rename = "selectedFields", skip_serializing_if = "Option::is_none")]
    pub selected_fields: Option<Vec<crate::models::SelectedFieldInfo>>,
}

impl AirbyteStreamConfiguration {
    /// the mutable part of the stream to configure the destination
    pub fn new(
        sync_mode: crate::models::SyncMode,
        destination_sync_mode: crate::models::DestinationSyncMode,
    ) -> AirbyteStreamConfiguration {
        AirbyteStreamConfiguration {
            sync_mode,
            cursor_field: None,
            destination_sync_mode,
            primary_key: None,
            alias_name: None,
            selected: None,
            suggested: None,
            field_selection_enabled: None,
            selected_fields: None,
        }
    }
}