GCPMetadata#

pydantic model phalanx.models.environments.GCPMetadata#

Google Cloud Platform hosting metadata.

Holds information about where in Google Cloud Platform this Phalanx environment is hosted. This supports generating documentation that includes this metadata, making it easier for administrators to know what options to pass to gcloud to do things such as get Kubernetes credentials.

Parameters:

data (Any) –

Show JSON schema
{
   "title": "GCPMetadata",
   "description": "Google Cloud Platform hosting metadata.\n\nHolds information about where in Google Cloud Platform this Phalanx\nenvironment is hosted. This supports generating documentation that\nincludes this metadata, making it easier for administrators to know what\noptions to pass to :command:`gcloud` to do things such as get Kubernetes\ncredentials.",
   "type": "object",
   "properties": {
      "projectId": {
         "description": "Project ID of GCP project hosting this environment",
         "title": "GCP project ID",
         "type": "string"
      },
      "region": {
         "description": "GCP region in which this environment is hosted",
         "title": "GCP region",
         "type": "string"
      },
      "clusterName": {
         "description": "Name of the GKE cluster hosting this environment",
         "title": "Kubernetes cluster name",
         "type": "string"
      }
   },
   "required": [
      "projectId",
      "region",
      "clusterName"
   ]
}

Config:

  • alias_generator: function = <function to_camel_case at 0x7fc83fdd5440>

  • populate_by_name: bool = True

Fields:
field cluster_name: str [Required] (alias 'clusterName')#

Name of the GKE cluster hosting this environment

field project_id: str [Required] (alias 'projectId')#

Project ID of GCP project hosting this environment

field region: str [Required]#

GCP region in which this environment is hosted

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