Struct WebServiceDetails 

pub struct WebServiceDetails {

    pub autoscaling: Option<WebServiceDetailsAutoscaling>,
    pub build_plan: Option<BuildPlan>,
    pub cache: Option<Cache>,
    pub disk: Option<WebServiceDetailsDisk>,
    pub env: Option<ServiceEnv>,
    pub env_specific_details: Option<EnvSpecificDetails>,
    pub health_check_path: Option<String>,
    pub ip_allow_list: Vec<CidrBlockAndDescription>,
    pub maintenance_mode: Option<MaintenanceMode>,
    pub max_shutdown_delay_seconds: Option<MaxShutdownDelaySeconds>,
    pub num_instances: Option<i64>,
    pub open_ports: Vec<ServerPort>,
    pub parent_server: Option<Resource>,
    pub plan: Option<Plan>,
    pub previews: Option<Previews>,
    pub pull_request_previews_enabled: Option<PullRequestPreviewsEnabled>,
    pub region: Option<Region>,
    pub render_subdomain_policy: Option<RenderSubdomainPolicy>,
    pub runtime: Option<ServiceRuntime>,
    pub ssh_address: Option<SshAddress>,
    pub url: Option<String>,
}

WebServiceDetails

JSON schema

{
 "type": "object",
 "properties": {
   "autoscaling": {
     "type": "object",
     "properties": {
       "criteria": {
         "type": "object",
         "properties": {
           "cpu": {
             "type": "object",
             "properties": {
               "enabled": {
                 "default": false,
                 "type": "boolean"
               },
               "percentage": {
                 "description": "Determines when your service will be
scaled. If the average resource utilization is significantly above/below
the target, we will increase/decrease the number of instances.\n",
                 "type": "integer"
               }
             }
           },
           "memory": {
             "type": "object",
             "properties": {
               "enabled": {
                 "default": false,
                 "type": "boolean"
               },
               "percentage": {
                 "description": "Determines when your service will be
scaled. If the average resource utilization is significantly above/below
the target, we will increase/decrease the number of instances.\n",
                 "type": "integer"
               }
             }
           }
         }
       },
       "enabled": {
         "default": false,
         "type": "boolean"
       },
       "max": {
         "description": "The maximum number of instances for the
service",
         "type": "integer"
       },
       "min": {
         "description": "The minimum number of instances for the
service",
         "type": "integer"
       }
     }
   },
   "buildPlan": {
     "$ref": "#/components/schemas/buildPlan"
   },
   "cache": {
     "$ref": "#/components/schemas/cache"
   },
   "disk": {
     "type": "object",
     "properties": {
       "id": {
         "examples": [
           "dsk-cph1rs3idesc73a2b2mg"
         ],
         "type": "string",
         "pattern": "^dsk-[0-9a-z]{20}$"
       },
       "mountPath": {
         "type": "string"
       },
       "name": {
         "type": "string"
       },
       "sizeGB": {
         "type": "integer"
       }
     }
   },
   "env": {
     "$ref": "#/components/schemas/serviceEnv"
   },
   "envSpecificDetails": {
     "$ref": "#/components/schemas/envSpecificDetails"
   },
   "healthCheckPath": {
     "type": "string"
   },
   "ipAllowList": {
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/cidrBlockAndDescription"
     }
   },
   "maintenanceMode": {
     "$ref": "#/components/schemas/maintenanceMode"
   },
   "maxShutdownDelaySeconds": {
     "$ref": "#/components/schemas/maxShutdownDelaySeconds"
   },
   "numInstances": {
     "description": "For a *manually* scaled service, this is the number
of instances the service is scaled to. DOES NOT indicate the number of
running instances for an *autoscaled* service.",
     "type": "integer"
   },
   "openPorts": {
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/serverPort"
     }
   },
   "parentServer": {
     "$ref": "#/components/schemas/resource"
   },
   "plan": {
     "$ref": "#/components/schemas/plan"
   },
   "previews": {
     "$ref": "#/components/schemas/previews"
   },
   "pullRequestPreviewsEnabled": {
     "$ref": "#/components/schemas/pullRequestPreviewsEnabled"
   },
   "region": {
     "$ref": "#/components/schemas/region"
   },
   "renderSubdomainPolicy": {
     "$ref": "#/components/schemas/renderSubdomainPolicy"
   },
   "runtime": {
     "$ref": "#/components/schemas/serviceRuntime"
   },
   "sshAddress": {
     "$ref": "#/components/schemas/sshAddress"
   },
   "url": {
     "type": "string"
   }
 }
}

Fields

autoscaling: Option<WebServiceDetailsAutoscaling>

build_plan: Option<BuildPlan>

cache: Option<Cache>

disk: Option<WebServiceDetailsDisk>

env: Option<ServiceEnv>

env_specific_details: Option<EnvSpecificDetails>

health_check_path: Option<String>

ip_allow_list: Vec<CidrBlockAndDescription>

maintenance_mode: Option<MaintenanceMode>

max_shutdown_delay_seconds: Option<MaxShutdownDelaySeconds>

num_instances: Option<i64>

For a manually scaled service, this is the number of instances the service is scaled to. DOES NOT indicate the number of running instances for an autoscaled service.

open_ports: Vec<ServerPort>

parent_server: Option<Resource>

plan: Option<Plan>

previews: Option<Previews>

pull_request_previews_enabled: Option<PullRequestPreviewsEnabled>

region: Option<Region>

render_subdomain_policy: Option<RenderSubdomainPolicy>

runtime: Option<ServiceRuntime>

ssh_address: Option<SshAddress>

url: Option<String>

Trait Implementations

impl Clone for WebServiceDetails

fn clone(&self) -> WebServiceDetails

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebServiceDetails

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

Formats the value using the given formatter.

impl Default for WebServiceDetails

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebServiceDetails

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<WebServiceDetails> for ServiceServiceDetails

fn from(value: WebServiceDetails) -> Self

Converts to this type from the input type.

impl Serialize for WebServiceDetails

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

where __S: Serializer,

Serialize this value into the given Serde serializer.