Packages

Transcoder API client library. This API converts video files into formats suitable for consumer distribution. For more information, see the Transcoder API overview.

Current section

Files

Jump to
google_api_transcoder lib google_api transcoder v1beta1 model job.ex
Raw

lib/google_api/transcoder/v1beta1/model/job.ex

# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.
defmodule GoogleApi.Transcoder.V1beta1.Model.Job do
@moduledoc """
Transcoding job resource.
## Attributes
* `config` (*type:* `GoogleApi.Transcoder.V1beta1.Model.JobConfig.t`, *default:* `nil`) - The configuration for this job.
* `createTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. The time the job was created.
* `endTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. The time the transcoding finished.
* `failureDetails` (*type:* `list(GoogleApi.Transcoder.V1beta1.Model.FailureDetail.t)`, *default:* `nil`) - Output only. List of failure details. This property may contain additional information about the failure when `failure_reason` is present. *Note*: This feature is not yet available.
* `failureReason` (*type:* `String.t`, *default:* `nil`) - Output only. A description of the reason for the failure. This property is always present when `state` is `FAILED`.
* `inputUri` (*type:* `String.t`, *default:* `nil`) - Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).
* `name` (*type:* `String.t`, *default:* `nil`) - The resource name of the job. Format: `projects/{project}/locations/{location}/jobs/{job}`
* `originUri` (*type:* `GoogleApi.Transcoder.V1beta1.Model.OriginUri.t`, *default:* `nil`) - Output only. The origin URI. *Note*: This feature is not yet available.
* `outputUri` (*type:* `String.t`, *default:* `nil`) - Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`.
* `priority` (*type:* `integer()`, *default:* `nil`) - Specify the priority of the job. Enter a value between 0 and 100, where 0 is the lowest priority and 100 is the highest priority. The default is 0.
* `progress` (*type:* `GoogleApi.Transcoder.V1beta1.Model.Progress.t`, *default:* `nil`) - Output only. Estimated fractional progress, from `0` to `1` for each step. *Note*: This feature is not yet available.
* `startTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. The time the transcoding started.
* `state` (*type:* `String.t`, *default:* `nil`) - Output only. The current state of the job.
* `templateId` (*type:* `String.t`, *default:* `nil`) - Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`
* `ttlAfterCompletionDays` (*type:* `integer()`, *default:* `nil`) - Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:config => GoogleApi.Transcoder.V1beta1.Model.JobConfig.t() | nil,
:createTime => DateTime.t() | nil,
:endTime => DateTime.t() | nil,
:failureDetails => list(GoogleApi.Transcoder.V1beta1.Model.FailureDetail.t()) | nil,
:failureReason => String.t() | nil,
:inputUri => String.t() | nil,
:name => String.t() | nil,
:originUri => GoogleApi.Transcoder.V1beta1.Model.OriginUri.t() | nil,
:outputUri => String.t() | nil,
:priority => integer() | nil,
:progress => GoogleApi.Transcoder.V1beta1.Model.Progress.t() | nil,
:startTime => DateTime.t() | nil,
:state => String.t() | nil,
:templateId => String.t() | nil,
:ttlAfterCompletionDays => integer() | nil
}
field(:config, as: GoogleApi.Transcoder.V1beta1.Model.JobConfig)
field(:createTime, as: DateTime)
field(:endTime, as: DateTime)
field(:failureDetails, as: GoogleApi.Transcoder.V1beta1.Model.FailureDetail, type: :list)
field(:failureReason)
field(:inputUri)
field(:name)
field(:originUri, as: GoogleApi.Transcoder.V1beta1.Model.OriginUri)
field(:outputUri)
field(:priority)
field(:progress, as: GoogleApi.Transcoder.V1beta1.Model.Progress)
field(:startTime, as: DateTime)
field(:state)
field(:templateId)
field(:ttlAfterCompletionDays)
end
defimpl Poison.Decoder, for: GoogleApi.Transcoder.V1beta1.Model.Job do
def decode(value, options) do
GoogleApi.Transcoder.V1beta1.Model.Job.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.Transcoder.V1beta1.Model.Job do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end