ucloud-sdk-python3 0.11.81__py3-none-any.whl

ucloud/services/udi/client.py

@@ -0,0 +1,250 @@
+""" Code is generated by ucloud-model, DO NOT EDIT IT. """
+
+import typing
+
+
+from ucloud.core.client import Client
+from ucloud.services.udi.schemas import apis
+
+
+class UDIClient(Client):
+    def __init__(
+        self, config: dict, transport=None, middleware=None, logger=None
+    ):
+        super(UDIClient, self).__init__(config, transport, middleware, logger)
+
+    def create_function_template(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """CreateFunctionTemplate - 创建功能参数模板
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **ContainerFormat** (str) - (Required) 文件输出格式
+        - **EncodeFormat** (str) - (Required) 编码格式
+        - **Function** (str) - (Required) 功能名称
+        - **ProjectName** (str) - (Required) 项目名称
+        - **TemplateName** (str) - (Required) 模板名称
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **AudioBitRate** (str) - 音频比特率
+        - **AudioBitRateCustom** (str) - 自定义音频比特率
+        - **AudioChannel** (str) - 音频声道
+        - **AudioSampleRate** (str) - 音频采样率
+        - **CRF** (str) - CRF压缩率
+        - **CRFCustom** (str) - 自定义CRF压缩率
+        - **FrameRate** (str) - 帧率
+        - **FrameRateCustom** (str) - 自定义帧率
+        - **Resolution** (str) - 分辨率
+        - **ResolutionHeight** (str) - 分辨率高
+        - **ResolutionWidth** (str) - 分辨率宽
+        - **VideoBitRate** (str) - 视频比特率
+        - **VideoBitRateCustom** (str) - 自定义视频比特率
+
+        **Response**
+
+        - **TemplateId** (str) - 创建的模板ID
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.CreateFunctionTemplateRequestSchema().dumps(d)
+
+        # build options
+        kwargs["max_retries"] = 0  # ignore retry when api is not idempotent
+
+        resp = self.invoke("CreateFunctionTemplate", d, **kwargs)
+        return apis.CreateFunctionTemplateResponseSchema().loads(resp)
+
+    def create_media_task(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """CreateMediaTask - 创建一个多媒体任务
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **Bucket** (str) - (Required) Bucket名称
+        - **DstKey** (str) - (Required) 目标生成文件
+        - **Function** (str) - (Required) 功能名称：例VideoTranscode
+        - **FunctionParamTemplateId** (str) - (Required) 功能的参数模板ID，需要事先创建模板才可用，也可以使用预设模板，详细可通过DescribeFunctionTemplate接口查询
+        - **SrcKey** (str) - (Required) 源文件
+        - **StorageBackend** (str) - (Required) 存储源
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+
+        **Response**
+
+        - **TaskId** (str) - 任务ID
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.CreateMediaTaskRequestSchema().dumps(d)
+
+        # build options
+        kwargs["max_retries"] = 0  # ignore retry when api is not idempotent
+
+        resp = self.invoke("CreateMediaTask", d, **kwargs)
+        return apis.CreateMediaTaskResponseSchema().loads(resp)
+
+    def delete_function_template(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """DeleteFunctionTemplate - 删除功能模板
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **TemplateId** (str) - (Required) 要删除的模板ID
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+
+        **Response**
+
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.DeleteFunctionTemplateRequestSchema().dumps(d)
+
+        resp = self.invoke("DeleteFunctionTemplate", d, **kwargs)
+        return apis.DeleteFunctionTemplateResponseSchema().loads(resp)
+
+    def describe_function_template(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """DescribeFunctionTemplate - 获取功能模板
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **Type** (str) - 功能模板类型：预设（preset）自定义（custom），为空则获取两种类型
+
+        **Response**
+
+        - **Templates** (list) - 见 **FunctionTemplate** 模型定义
+
+        **Response Model**
+
+        **FunctionTemplate**
+        - **FunctionName** (str) -
+        - **Id** (str) -
+        - **Name** (str) -
+
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.DescribeFunctionTemplateRequestSchema().dumps(d)
+
+        resp = self.invoke("DescribeFunctionTemplate", d, **kwargs)
+        return apis.DescribeFunctionTemplateResponseSchema().loads(resp)
+
+    def describe_media_functions(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """DescribeMediaFunctions - 描述当前支持的多媒体功能以及对应功能需要的参数信息
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **Function** (str) - 要查询的Function名称，为空则返回所有支持的Function
+
+        **Response**
+
+        - **Functions** (list) - 见 **Function** 模型定义
+
+        **Response Model**
+
+        **Function**
+        - **DisplayName** (str) -
+        - **FunctionName** (str) -
+        - **InputType** (str) -
+        - **OutputType** (str) -
+        - **SupportParams** (list) - 见 **ParamOption** 模型定义
+
+
+        **ParamOption**
+        - **DisplayName** (str) -
+        - **OptionalValues** (list) -
+        - **ParamName** (str) -
+        - **Required** (bool) -
+        - **WhenValueCustom** (list) - 见 **ParamCustom** 模型定义
+
+
+        **ParamCustom**
+        - **Max** (int) -
+        - **Min** (int) -
+        - **ParamName** (str) -
+        - **ParamType** (str) -
+
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.DescribeMediaFunctionsRequestSchema().dumps(d)
+
+        resp = self.invoke("DescribeMediaFunctions", d, **kwargs)
+        return apis.DescribeMediaFunctionsResponseSchema().loads(resp)
+
+    def describe_media_task(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """DescribeMediaTask - 查询任务状态
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **TaskId** (str) - 要查询的任务ID，为空则查询所有
+
+        **Response**
+
+        - **Tasks** (list) - 见 **MediaTask** 模型定义
+
+        **Response Model**
+
+        **MediaTask**
+        - **Function** (str) -
+        - **Id** (str) -
+        - **Status** (str) -
+
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.DescribeMediaTaskRequestSchema().dumps(d)
+
+        resp = self.invoke("DescribeMediaTask", d, **kwargs)
+        return apis.DescribeMediaTaskResponseSchema().loads(resp)

ucloud/services/udi/schemas/apis.py

@@ -0,0 +1,205 @@
+""" Code is generated by ucloud-model, DO NOT EDIT IT. """
+
+from ucloud.core.typesystem import schema, fields
+from ucloud.services.udi.schemas import models
+
+""" UDI API Schema
+"""
+
+
+"""
+API: CreateFunctionTemplate
+
+创建功能参数模板
+"""
+
+
+class CreateFunctionTemplateRequestSchema(schema.RequestSchema):
+    """CreateFunctionTemplate - 创建功能参数模板"""
+
+    fields = {
+        "AudioBitRate": fields.Str(required=False, dump_to="AudioBitRate"),
+        "AudioBitRateCustom": fields.Str(
+            required=False, dump_to="AudioBitRateCustom"
+        ),
+        "AudioChannel": fields.Str(required=False, dump_to="AudioChannel"),
+        "AudioSampleRate": fields.Str(
+            required=False, dump_to="AudioSampleRate"
+        ),
+        "CRF": fields.Str(required=False, dump_to="CRF"),
+        "CRFCustom": fields.Str(required=False, dump_to="CRFCustom"),
+        "ContainerFormat": fields.Str(required=True, dump_to="ContainerFormat"),
+        "EncodeFormat": fields.Str(required=True, dump_to="EncodeFormat"),
+        "FrameRate": fields.Str(required=False, dump_to="FrameRate"),
+        "FrameRateCustom": fields.Str(
+            required=False, dump_to="FrameRateCustom"
+        ),
+        "Function": fields.Str(required=True, dump_to="Function"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "ProjectName": fields.Str(required=True, dump_to="ProjectName"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Resolution": fields.Str(required=False, dump_to="Resolution"),
+        "ResolutionHeight": fields.Str(
+            required=False, dump_to="ResolutionHeight"
+        ),
+        "ResolutionWidth": fields.Str(
+            required=False, dump_to="ResolutionWidth"
+        ),
+        "TemplateName": fields.Str(required=True, dump_to="TemplateName"),
+        "VideoBitRate": fields.Str(required=False, dump_to="VideoBitRate"),
+        "VideoBitRateCustom": fields.Str(
+            required=False, dump_to="VideoBitRateCustom"
+        ),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class CreateFunctionTemplateResponseSchema(schema.ResponseSchema):
+    """CreateFunctionTemplate - 创建功能参数模板"""
+
+    fields = {
+        "TemplateId": fields.Str(required=True, load_from="TemplateId"),
+    }
+
+
+"""
+API: CreateMediaTask
+
+创建一个多媒体任务
+"""
+
+
+class CreateMediaTaskRequestSchema(schema.RequestSchema):
+    """CreateMediaTask - 创建一个多媒体任务"""
+
+    fields = {
+        "Bucket": fields.Str(required=True, dump_to="Bucket"),
+        "DstKey": fields.Str(required=True, dump_to="DstKey"),
+        "Function": fields.Str(required=True, dump_to="Function"),
+        "FunctionParamTemplateId": fields.Str(
+            required=True, dump_to="FunctionParamTemplateId"
+        ),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "SrcKey": fields.Str(required=True, dump_to="SrcKey"),
+        "StorageBackend": fields.Str(required=True, dump_to="StorageBackend"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class CreateMediaTaskResponseSchema(schema.ResponseSchema):
+    """CreateMediaTask - 创建一个多媒体任务"""
+
+    fields = {
+        "TaskId": fields.Str(required=False, load_from="TaskId"),
+    }
+
+
+"""
+API: DeleteFunctionTemplate
+
+删除功能模板
+"""
+
+
+class DeleteFunctionTemplateRequestSchema(schema.RequestSchema):
+    """DeleteFunctionTemplate - 删除功能模板"""
+
+    fields = {
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "TemplateId": fields.Str(required=True, dump_to="TemplateId"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class DeleteFunctionTemplateResponseSchema(schema.ResponseSchema):
+    """DeleteFunctionTemplate - 删除功能模板"""
+
+    fields = {}
+
+
+"""
+API: DescribeFunctionTemplate
+
+获取功能模板
+"""
+
+
+class DescribeFunctionTemplateRequestSchema(schema.RequestSchema):
+    """DescribeFunctionTemplate - 获取功能模板"""
+
+    fields = {
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Type": fields.Str(required=False, dump_to="Type"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class DescribeFunctionTemplateResponseSchema(schema.ResponseSchema):
+    """DescribeFunctionTemplate - 获取功能模板"""
+
+    fields = {
+        "Templates": fields.List(
+            models.FunctionTemplateSchema(),
+            required=False,
+            load_from="Templates",
+        ),
+    }
+
+
+"""
+API: DescribeMediaFunctions
+
+描述当前支持的多媒体功能以及对应功能需要的参数信息
+"""
+
+
+class DescribeMediaFunctionsRequestSchema(schema.RequestSchema):
+    """DescribeMediaFunctions - 描述当前支持的多媒体功能以及对应功能需要的参数信息"""
+
+    fields = {
+        "Function": fields.Str(required=False, dump_to="Function"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class DescribeMediaFunctionsResponseSchema(schema.ResponseSchema):
+    """DescribeMediaFunctions - 描述当前支持的多媒体功能以及对应功能需要的参数信息"""
+
+    fields = {
+        "Functions": fields.List(
+            models.FunctionSchema(), required=False, load_from="Functions"
+        ),
+    }
+
+
+"""
+API: DescribeMediaTask
+
+查询任务状态
+"""
+
+
+class DescribeMediaTaskRequestSchema(schema.RequestSchema):
+    """DescribeMediaTask - 查询任务状态"""
+
+    fields = {
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "TaskId": fields.Str(required=False, dump_to="TaskId"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class DescribeMediaTaskResponseSchema(schema.ResponseSchema):
+    """DescribeMediaTask - 查询任务状态"""
+
+    fields = {
+        "Tasks": fields.List(
+            models.MediaTaskSchema(), required=False, load_from="Tasks"
+        ),
+    }

ucloud/services/udi/schemas/models.py

@@ -0,0 +1,58 @@
+""" Code is generated by ucloud-model, DO NOT EDIT IT. """
+
+from ucloud.core.typesystem import schema, fields
+
+
+class FunctionTemplateSchema(schema.ResponseSchema):
+    """FunctionTemplate -"""
+
+    fields = {
+        "FunctionName": fields.Str(required=False, load_from="FunctionName"),
+        "Id": fields.Str(required=False, load_from="Id"),
+        "Name": fields.Str(required=False, load_from="Name"),
+    }
+
+
+class ParamCustomSchema(schema.ResponseSchema):
+    """ParamCustom -"""
+
+    fields = {
+        "Max": fields.Int(required=False, load_from="Max"),
+        "Min": fields.Int(required=False, load_from="Min"),
+        "ParamName": fields.Str(required=False, load_from="ParamName"),
+        "ParamType": fields.Str(required=False, load_from="ParamType"),
+    }
+
+
+class ParamOptionSchema(schema.ResponseSchema):
+    """ParamOption -"""
+
+    fields = {
+        "DisplayName": fields.Str(required=False, load_from="DisplayName"),
+        "OptionalValues": fields.List(fields.Str()),
+        "ParamName": fields.Str(required=False, load_from="ParamName"),
+        "Required": fields.Bool(required=False, load_from="Required"),
+        "WhenValueCustom": fields.List(ParamCustomSchema()),
+    }
+
+
+class FunctionSchema(schema.ResponseSchema):
+    """Function -"""
+
+    fields = {
+        "DisplayName": fields.Str(required=False, load_from="DisplayName"),
+        "FunctionName": fields.Str(required=False, load_from="FunctionName"),
+        "InputType": fields.Str(required=False, load_from="InputType"),
+        "OutputType": fields.Str(required=False, load_from="OutputType"),
+        "SupportParams": fields.List(ParamOptionSchema()),
+    }
+
+
+class MediaTaskSchema(schema.ResponseSchema):
+    """MediaTask -"""
+
+    fields = {
+        "Function": fields.Str(required=False, load_from="Function"),
+        "Id": fields.Str(required=False, load_from="Id"),
+        "Status": fields.Str(required=False, load_from="Status"),
+    }