vapi_client/models/
bucket_plan.rs

1/*
2 * Vapi API
3 *
4 * Voice AI for developers.
5 *
6 * The version of the OpenAPI document: 1.0
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct BucketPlan {
16    /// This is the name of the bucket.
17    #[serde(rename = "name")]
18    pub name: String,
19    /// This is the region of the bucket.  Usage: - If `credential.type` is `aws`, then this is required. - If `credential.type` is `gcp`, then this is optional since GCP allows buckets to be accessed without a region but region is required for data residency requirements. Read here: https://cloud.google.com/storage/docs/request-endpoints  This overrides the `credential.region` field if it is provided.
20    #[serde(rename = "region", skip_serializing_if = "Option::is_none")]
21    pub region: Option<String>,
22    /// This is the path where call artifacts will be stored.  Usage: - To store call artifacts in a specific folder, set this to the full path. Eg. \"/folder-name1/folder-name2\". - To store call artifacts in the root of the bucket, leave this blank.  @default \"/\"
23    #[serde(rename = "path", skip_serializing_if = "Option::is_none")]
24    pub path: Option<String>,
25    /// This is the HMAC access key offered by GCP for interoperability with S3 clients. Here is the guide on how to create: https://cloud.google.com/storage/docs/authentication/managing-hmackeys#console  Usage: - If `credential.type` is `gcp`, then this is required. - If `credential.type` is `aws`, then this is not required since credential.awsAccessKeyId is used instead.
26    #[serde(rename = "hmacAccessKey", skip_serializing_if = "Option::is_none")]
27    pub hmac_access_key: Option<String>,
28    /// This is the secret for the HMAC access key. Here is the guide on how to create: https://cloud.google.com/storage/docs/authentication/managing-hmackeys#console  Usage: - If `credential.type` is `gcp`, then this is required. - If `credential.type` is `aws`, then this is not required since credential.awsSecretAccessKey is used instead.  Note: This is not returned in the API.
29    #[serde(rename = "hmacSecret", skip_serializing_if = "Option::is_none")]
30    pub hmac_secret: Option<String>,
31}
32
33impl BucketPlan {
34    pub fn new(name: String) -> BucketPlan {
35        BucketPlan {
36            name,
37            region: None,
38            path: None,
39            hmac_access_key: None,
40            hmac_secret: None,
41        }
42    }
43}