DatalabLifecycleConfigurationPost

pydantic model openapi_client.models.datalab_lifecycle_configuration_post.DatalabLifecycleConfigurationPost

Settings for a new lifecycle configuration. Scripts must be base64-encoded.

Fields:
field lifecycle_name: Annotated[str, Field(min_length=3, strict=True, max_length=63)] [Required] (alias 'LifecycleName')

Name for the configuration, unique across the application and fixed once created. 3 to 63 characters, starting with a letter, using letters, numbers and hyphens only.

Constraints:
  • strict = True

  • min_length = 3

  • max_length = 63

field description: StrictStr [Required] (alias 'Description')
Constraints:
  • strict = True

field type: Optional[StrictStr] = 'notebook' (alias 'Type')

Which kind of datalab the configuration applies to. Studio configurations require an on-start script and cannot be updated afterwards.

field on_create_script: Optional[Annotated[str, Field(strict=True, max_length=16384)]] = None (alias 'OnCreateScript')

Base64-encoded script run once, when a datalab using this configuration is first created. Notebook configurations only.

field on_start_script: Optional[Annotated[str, Field(strict=True, max_length=16384)]] = None (alias 'OnStartScript')

Base64-encoded script run every time a datalab using this configuration starts.

field keywords: Optional[List[StrictStr]] = None (alias 'Keywords')

Search keywords for the configuration.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of DatalabLifecycleConfigurationPost from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of DatalabLifecycleConfigurationPost from a dict

Return type:

Optional[Self]