create_link_parameter

create_link_parameter는 파이프라인 파라미터 정보를 담은 클래스인 MRXLinkPipelineParameterModel을 생성하는 메소드입니다.

파이프라인 파라미터 생성

파이프라인 파라미터 객체를 생성합니다.

create_link_parameter(name: str, value: Any = None) -> MRXLinkPipelineParameterModel

• Parameters
  • name(str): 파이프라인 파라미터 이름
  • value(Any): 파이프라인 파라미터 값

    📘

    • 파라미터 이름(Name)은 알파벳과 숫자로만 이루어진 문자열만 지원하며, 해당 문자열은 알파벳으로 시작해야 합니다.
    • 파라미터 값(Value)은 string, boolean, int, float 타입만 지원합니다.

• Returns
  • MRXLinkPipelineParameterModel
• Troubleshooting
  • ValueError: The name of parameter '{name}' cannot be a python variable name
    • 파라미터 이름이 Python 변수 명이 될 수 없을 때 발생합니다.
  • ValueError: The name of parameter '{name}' cannot be only contains underscore
    • 파라미터 이름이 '_'으로만 이뤄졌을 때 발생합니다.
  • ValueError: The name of parameter name cannot be longer than 30
    • 파라미터 이름이 30자보다 길 때 발생합니다.
  • ValueError: The value of the parameter cannot be longer than 300
    • 파라미터 값이 300자보다 길 때 발생합니다.
  • ValueError: The value of '{name}' should be in [bool, str, int, float]
    • 파라미터 값이 string, boolean, int, float 중 하나가 아닐 때 발생합니다.

Example

Python

from mrx_link.sdk.utils import create_link_parameter

if __name__ == "__main__":
    # 파이프라인 파라미터 생성
    parameter1 = create_link_parameter(name="a", value=123)
    parameter2 = create_link_parameter(name="b", value="asdf")
    parameters = [parameter1, parameter2]