ControlSystemConfig#

pydantic model phalanx.models.environments.ControlSystemConfig#

Configuration for the Control System.

Parameters:

data (Any) –

Show JSON schema
{
   "title": "ControlSystemConfig",
   "description": "Configuration for the Control System.",
   "type": "object",
   "properties": {
      "appNamespace": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Set the namespace for the control system components. Each control system application consists of many components that need to know what namespace to which they belong.",
         "title": "Application Namespace"
      },
      "imageTag": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The image tag to use for control system images.",
         "title": "Image Tag"
      },
      "siteTag": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The tag that tells the control system component where it is running.",
         "title": "Site Tag"
      },
      "topicName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The Kafka identifier for control system topics.",
         "title": "Topic Identifier"
      },
      "kafkaBrokerAddress": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The Kafka broker address for the control system components.",
         "title": "Kafka Broker Address"
      },
      "kafkaTopicReplicationFactor": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The Kafka topic replication factor for control system components.",
         "title": "Kafka Topic Replication Factor"
      },
      "schemaRegistryUrl": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The Schema Registry URL for the control system components.",
         "title": "Schema Registry URL"
      },
      "s3EndpointUrl": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The S3 URL for the environment specific LFA.",
         "title": "S3 Endpoint URL"
      }
   }
}

Config:
  • alias_generator: function = <function to_camel_case at 0x7f9c5633c0e0>

  • populate_by_name: bool = True

Fields:
field app_namespace: str | None = None (alias 'appNamespace')#

Set the namespace for the control system components. Each control system application consists of many components that need to know what namespace to which they belong.

field image_tag: str | None = None (alias 'imageTag')#

The image tag to use for control system images.

field kafka_broker_address: str | None = None (alias 'kafkaBrokerAddress')#

The Kafka broker address for the control system components.

field kafka_topic_replication_factor: int | None = None (alias 'kafkaTopicReplicationFactor')#

The Kafka topic replication factor for control system components.

field s3_endpoint_url: str | None = None (alias 's3EndpointUrl')#

The S3 URL for the environment specific LFA.

field schema_registry_url: str | None = None (alias 'schemaRegistryUrl')#

The Schema Registry URL for the control system components.

field site_tag: str | None = None (alias 'siteTag')#

The tag that tells the control system component where it is running.

field topic_name: str | None = None (alias 'topicName')#

The Kafka identifier for control system topics.

model_dump(**kwargs)#

Export the model as a dictionary.

Overridden to change the default of by_alias from False to True, so that by default the exported dictionary uses camel-case.

Parameters:

kwargs (Any) –

Return type:

dict[str, Any]

model_dump_json(**kwargs)#

Export the model as JSON.

Overridden to change the default of by_alias from False to True, so that by default the exported dictionary uses camel-case.

Parameters:

kwargs (Any) –

Return type:

str

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.