Struct ProjectFull

pub struct ProjectFull {

    pub autocapture: Option<ProjectFullAutocapture>,
    pub blocked_ips: Option<Vec<String>>,
    pub cache: Option<bool>,
    pub cookie_domain: Option<String>,
    pub cookie_name: Option<String>,
    pub cookie_whitelist: Option<Vec<String>>,
    pub cookieless: Option<bool>,
    pub edgee_behind_proxy_cache: Option<bool>,
    pub enforce_no_store_policy: Option<bool>,
    pub force_https: Option<bool>,
    pub forwarded_headers: Option<Vec<ProjectFullForwardedHeadersItem>>,
    pub inject_sdk: Option<bool>,
    pub inject_sdk_position: Option<ProjectFullInjectSdkPosition>,
    pub log_severity: Option<ProjectFullLogSeverity>,
    pub override_cache: Vec<CacheRule>,
    pub override_cache_enabled: Option<bool>,
    pub password_protection: Option<bool>,
    pub proxy_only: Option<bool>,
    pub proxy_only_path_regex: Option<String>,
    pub rate_limiting: Option<Vec<RateLimitingRule>>,
    pub rate_limiting_enabled: Option<bool>,
    pub trusted_ips: Option<Vec<String>>,
}

A Project is a unique identifier that you can use to manage and organize your work. Each project belongs to an organization.

JSON schema

{
 "description": "A Project is a unique identifier that you can use to manage and organize your work. Each project belongs to an organization.",
 "type": "object",
 "properties": {
   "autocapture": {
     "description": "Configuration for automatic event capture by the Edgee SDK.",
     "type": "object",
     "properties": {
       "click": {
         "description": "Whether to automatically capture click events",
         "default": false,
         "type": "boolean"
       },
       "engagement": {
         "description": "Whether to automatically capture engagement events",
         "default": false,
         "type": "boolean"
       },
       "form": {
         "description": "Whether to automatically capture form events",
         "default": false,
         "type": "boolean"
       },
       "pageview": {
         "description": "Whether to automatically capture pageview events",
         "default": false,
         "type": "boolean"
       },
       "scroll": {
         "description": "Whether to automatically capture scroll events",
         "default": false,
         "type": "boolean"
       },
       "spa_pageview": {
         "description": "Whether to automatically capture single page app pageview events",
         "default": false,
         "type": "boolean"
       }
     }
   },
   "blocked_ips": {
     "description": "List of blocked IPs that can't access the project. Blocking IPs can only works is trusted_ips and password_protection are empty.",
     "default": [],
     "type": [
       "array",
       "null"
     ],
     "items": {
       "type": "string"
     }
   },
   "cache": {
     "description": "Whether caching is enabled for the project.",
     "default": false,
     "type": [
       "boolean",
       "null"
     ]
   },
   "cookie_domain": {
     "description": "The domain of the cookie that edgee will use to store the session ID.",
     "type": [
       "string",
       "null"
     ]
   },
   "cookie_name": {
     "description": "The name of the cookie that edgee will use to store the session ID.",
     "default": "edgee",
     "type": [
       "string",
       "null"
     ]
   },
   "cookie_whitelist": {
     "description": "List of cookies that are allowed to be set by the project.",
     "default": [],
     "type": [
       "array",
       "null"
     ],
     "items": {
       "type": "string"
     }
   },
   "cookieless": {
     "description": "Whether the Edgee should use a cookieless session.",
     "default": false,
     "type": [
       "boolean",
       "null"
     ]
   },
   "edgee_behind_proxy_cache": {
     "description": "Whether the project is behind a proxy cache (or CDN).",
     "default": false,
     "type": [
       "boolean",
       "null"
     ]
   },
   "enforce_no_store_policy": {
     "description": "A boolean that indicates whether Edgee should enforce a `no-store` cache-control header on the responses that can be computed.",
     "default": false,
     "type": [
       "boolean",
       "null"
     ]
   },
   "force_https": {
     "description": "Whether the project is forcing HTTPS.",
     "default": true,
     "type": [
       "boolean",
       "null"
     ]
   },
   "forwarded_headers": {
     "description": "List of headers that are forwarded to the origin.",
     "default": [],
     "type": [
       "array",
       "null"
     ],
     "items": {
       "type": "object",
       "properties": {
         "name": {
           "type": "string"
         },
         "value": {
           "type": "string"
         }
       }
     }
   },
   "inject_sdk": {
     "description": "Whether Edgee should inject the SDK into the html content.",
     "default": false,
     "type": [
       "boolean",
       "null"
     ]
   },
   "inject_sdk_position": {
     "description": "The position of the SDK injection.",
     "default": "append",
     "type": [
       "string",
       "null"
     ],
     "enum": [
       "prepend",
       "append"
     ]
   },
   "log_severity": {
     "description": "The log severity of the project.",
     "default": "INFO",
     "type": [
       "string",
       "null"
     ],
     "enum": [
       "DEBUG",
       "INFO",
       "WARNING",
       "ERROR"
     ]
   },
   "override_cache": {
     "description": "List of cache rules that override the default cache settings.",
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/CacheRule"
     }
   },
   "override_cache_enabled": {
     "description": "Whether the cache override is enabled.",
     "default": false,
     "type": [
       "boolean",
       "null"
     ]
   },
   "password_protection": {
     "description": "Whether the project is password protected.",
     "default": false,
     "type": [
       "boolean",
       "null"
     ]
   },
   "proxy_only": {
     "description": "Whether the Edgee will only proxy requests to the origin without any computing.",
     "default": false,
     "type": [
       "boolean",
       "null"
     ]
   },
   "proxy_only_path_regex": {
     "description": "A regular expression that matches the path of the request to be proxied only.",
     "type": [
       "string",
       "null"
     ]
   },
   "rate_limiting": {
     "description": "List of rate limiting rules for the project.",
     "default": [],
     "type": [
       "array",
       "null"
     ],
     "items": {
       "$ref": "#/components/schemas/RateLimitingRule"
     }
   },
   "rate_limiting_enabled": {
     "description": "Whether rate limiting is enabled for the project.",
     "default": false,
     "type": [
       "boolean",
       "null"
     ]
   },
   "trusted_ips": {
     "description": "List of trusted IPs that can access the project.",
     "default": [],
     "type": [
       "array",
       "null"
     ],
     "items": {
       "type": "string"
     }
   }
 }
}

Fields

autocapture: Option<ProjectFullAutocapture>

blocked_ips: Option<Vec<String>>

List of blocked IPs that can’t access the project. Blocking IPs can only works is trusted_ips and password_protection are empty.

cache: Option<bool>

Whether caching is enabled for the project.

cookie_domain: Option<String>

The domain of the cookie that edgee will use to store the session ID.

cookie_name: Option<String>

The name of the cookie that edgee will use to store the session ID.

cookie_whitelist: Option<Vec<String>>

List of cookies that are allowed to be set by the project.

cookieless: Option<bool>

Whether the Edgee should use a cookieless session.

edgee_behind_proxy_cache: Option<bool>

Whether the project is behind a proxy cache (or CDN).

enforce_no_store_policy: Option<bool>

A boolean that indicates whether Edgee should enforce a no-store cache-control header on the responses that can be computed.

force_https: Option<bool>

Whether the project is forcing HTTPS.

forwarded_headers: Option<Vec<ProjectFullForwardedHeadersItem>>

List of headers that are forwarded to the origin.

inject_sdk: Option<bool>

Whether Edgee should inject the SDK into the html content.

inject_sdk_position: Option<ProjectFullInjectSdkPosition>

The position of the SDK injection.

log_severity: Option<ProjectFullLogSeverity>

The log severity of the project.

override_cache: Vec<CacheRule>

List of cache rules that override the default cache settings.

override_cache_enabled: Option<bool>

Whether the cache override is enabled.

password_protection: Option<bool>

Whether the project is password protected.

proxy_only: Option<bool>

Whether the Edgee will only proxy requests to the origin without any computing.

proxy_only_path_regex: Option<String>

A regular expression that matches the path of the request to be proxied only.

rate_limiting: Option<Vec<RateLimitingRule>>

List of rate limiting rules for the project.

rate_limiting_enabled: Option<bool>

Whether rate limiting is enabled for the project.

trusted_ips: Option<Vec<String>>

List of trusted IPs that can access the project.

Implementations

impl ProjectFull

pub fn builder() -> ProjectFull

Trait Implementations

impl Clone for ProjectFull

fn clone(&self) -> ProjectFull

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectFull

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

Formats the value using the given formatter.

impl Default for ProjectFull

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProjectFull

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ProjectFull> for ProjectFull

fn from(value: &ProjectFull) -> Self

Converts to this type from the input type.

impl From<ProjectFull> for ProjectFull

fn from(value: ProjectFull) -> Self

Converts to this type from the input type.

impl JsonSchema for ProjectFull

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for ProjectFull

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<ProjectFull> for ProjectFull

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.