utils.rcclient.entities.app_template
Module Contents
Classes
Represents the metadata of a parameter of a data app. |
|
A data class representing a parameter for a AppTemplate. |
|
Attributes
- utils.rcclient.entities.app_template.logger
- class utils.rcclient.entities.app_template.Metadata
Represents the metadata of a parameter of a data app.
- input_name
The name of the input.
- Type:
str, optional
- is_required
A flag indicating whether the input is required or not.
- Type:
bool, optional
- tooltip
The tooltip text for the input.
- Type:
str, optional
- default_value
The default value of the input.
- Type:
str, optional
- multiple
A flag indicating whether the input supports multiple values or not.
- Type:
bool, optional
- input_name: str
- is_required: bool = False
- tooltip: str
- default_value: str
- multiple: bool
- classmethod from_(metadata_res)
- utils.rcclient.entities.app_template.ParamMetadata
- class utils.rcclient.entities.app_template.Param
A data class representing a parameter for a AppTemplate.
- name
The name of the parameter.
- Type:
str
- input_type
The input type for the parameter. Defaults to InputType.ENTITY.
- Type:
InputType, optional
- name: str
- input_type: utils.rcclient.enums.AppTemplateInputType
- classmethod from_(param_res)
- class utils.rcclient.entities.app_template.AppTemplate
- name: str
- app_type: utils.rcclient.enums.AppType
- display_name: str
- description: str
- requirements: str
- status: utils.rcclient.enums.Status
- auto_ml_problem_type: utils.rcclient.enums.AutoMlProblemType
- build_status: utils.rcclient.enums.BuildStatus
- _id: str
- _local_code_loc: str
- _app_template_svc: ClassVar
- classmethod from_(res: utils.rcclient.dtos.response_dtos.AppTemplateResponseDto) AppTemplate
- classmethod get_svc()
- classmethod get_all()
- get_code_loc()
Get the lines of code (LOC) for the object’s code. This method retrieves the number of lines of code for the code associated with the object.
- Returns:
The number of lines of code.
- Return type:
int
- is_system_template()
- download(path)
- publish(force=False, create_dist=False)
Publishes the App Template to make it accessible to other users.
- Parameters:
force (bool, optional) – Whether to forcefully publish the App Template even if there are warnings. Defaults to False.
- classmethod update_build_status(tenant_id, user_id, dataapp_id, build_status)
- create_input_param(name: str, input_type: utils.rcclient.enums.InputType = InputType.ENTITY, metadata: Metadata = Metadata())
Create an input parameter for the object. This method allows the user to create an input parameter with the specified name and input type. The input parameter can be used to define the input requirements for the object’s functionality. :param name: The name of the input parameter to be created. :type name: str :param input_type: The type of input parameter (default is InputType.ENTITY). :type input_type: InputType, optional :param The InputType is an enumeration representing different types of input parameters.: :param metadata: Additional metadata for the input parameter (default is None). :type metadata: Metadata, optional :param Metadata can be used to provide additional information or settings related to the input parameter.:
- Returns:
None
- disable()
- enable()