Source code for azure.mgmt.media.models.job_output_py3

# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------

from msrest.serialization import Model


[docs]class JobOutput(Model): """Describes all the properties of a JobOutput. You probably want to use the sub-classes and not this class directly. Known sub-classes are: JobOutputAsset Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. :ivar error: If the JobOutput is in the Error state, it contains the details of the error. :vartype error: ~azure.mgmt.media.models.JobError :ivar state: Describes the state of the JobOutput. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled' :vartype state: str or ~azure.mgmt.media.models.JobState :ivar progress: If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. :vartype progress: int :param label: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. :type label: str :param odatatype: Required. Constant filled by server. :type odatatype: str """ _validation = { 'error': {'readonly': True}, 'state': {'readonly': True}, 'progress': {'readonly': True}, 'odatatype': {'required': True}, } _attribute_map = { 'error': {'key': 'error', 'type': 'JobError'}, 'state': {'key': 'state', 'type': 'JobState'}, 'progress': {'key': 'progress', 'type': 'int'}, 'label': {'key': 'label', 'type': 'str'}, 'odatatype': {'key': '@odata\\.type', 'type': 'str'}, } _subtype_map = { 'odatatype': {'#Microsoft.Media.JobOutputAsset': 'JobOutputAsset'} } def __init__(self, *, label: str=None, **kwargs) -> None: super(JobOutput, self).__init__(**kwargs) self.error = None self.state = None self.progress = None self.label = label self.odatatype = None