Struct InitializeRequest 

pub struct InitializeRequest {

    pub base_platform: Option<Platform>,
    pub helm_release: Option<HelmRelease>,
    pub initial_desired_release: InitialDesiredRelease,
    pub input_values: Map<String, Value>,
    pub name: Option<String>,
    pub permission: Option<String>,
    pub platform: Option<Platform>,
    pub public_subdomain: Option<String>,
    pub resource_prefix: Option<String>,
    pub scope: Option<String>,
    pub setup_item: Option<String>,
    pub setup_method: Option<String>,
    pub stack_settings: Option<StackSettings>,
}

InitializeRequest

JSON schema

{
 "type": "object",
 "required": [
   "initialDesiredRelease"
 ],
 "properties": {
   "basePlatform": {
     "description": "Optional base cloud platform for Kubernetes setup targets such as\nEKS/GKE/AKS. The runtime platform remains Kubernetes.",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/Platform"
           }
         ]
       }
     ]
   },
   "helmRelease": {
     "description": "Helm release that installed this deployment, for `helm` setups. Lets\nthe manager tell the deployment owner the exact `helm uninstall`\ncommand. Older clients omit it.",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/HelmRelease"
           }
         ]
       }
     ]
   },
   "initialDesiredRelease": {
     "$ref": "#/components/schemas/InitialDesiredRelease"
   },
   "inputValues": {
     "description": "Deployer-provided stack inputs. Embedded platform managers resolve\nthese before creating the deployment; standalone managers accept the\nfield so generated setup clients have one stable initialize contract.",
     "type": "object",
     "additionalProperties": {}
   },
   "name": {
     "type": [
       "string",
       "null"
     ]
   },
   "permission": {
     "type": [
       "string",
       "null"
     ]
   },
   "platform": {
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/Platform"
           }
         ]
       }
     ]
   },
   "publicSubdomain": {
     "description": "Subdomain to request under the generated domain, used by stores that assign one.",
     "type": [
       "string",
       "null"
     ]
   },
   "resourcePrefix": {
     "description": "Stable prefix for resources owned by this deployment.",
     "type": [
       "string",
       "null"
     ]
   },
   "scope": {
     "type": [
       "string",
       "null"
     ]
   },
   "setupItem": {
     "description": "Customer setup item selected from the deployment-group contract.",
     "type": [
       "string",
       "null"
     ]
   },
   "setupMethod": {
     "description": "Setup method that is registering this deployment, such as `manual` for\nrendered Operator manifests or `helm` for generated Helm installs.",
     "type": [
       "string",
       "null"
     ]
   },
   "stackSettings": {
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/StackSettings"
           }
         ]
       }
     ]
   }
 }
}

Fields

base_platform: Option<Platform>

Optional base cloud platform for Kubernetes setup targets such as EKS/GKE/AKS. The runtime platform remains Kubernetes.

helm_release: Option<HelmRelease>

Helm release that installed this deployment, for helm setups. Lets the manager tell the deployment owner the exact helm uninstall command. Older clients omit it.

initial_desired_release: InitialDesiredRelease

input_values: Map<String, Value>

Deployer-provided stack inputs. Embedded platform managers resolve these before creating the deployment; standalone managers accept the field so generated setup clients have one stable initialize contract.

name: Option<String>

permission: Option<String>

platform: Option<Platform>

public_subdomain: Option<String>

Subdomain to request under the generated domain, used by stores that assign one.

resource_prefix: Option<String>

Stable prefix for resources owned by this deployment.

scope: Option<String>

setup_item: Option<String>

Customer setup item selected from the deployment-group contract.

setup_method: Option<String>

Setup method that is registering this deployment, such as manual for rendered Operator manifests or helm for generated Helm installs.

stack_settings: Option<StackSettings>

Implementations

impl InitializeRequest

pub fn builder() -> InitializeRequest

Trait Implementations

impl Clone for InitializeRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InitializeRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InitializeRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&InitializeRequest> for InitializeRequest

fn from(value: &InitializeRequest) -> Self

Converts to this type from the input type.

impl From<InitializeRequest> for InitializeRequest

fn from(value: InitializeRequest) -> Self

Converts to this type from the input type.

impl Serialize for InitializeRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<InitializeRequest> for InitializeRequest

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.