Class Job (1.12.0)

Job(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Transcoding job resource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
name str
The resource name of the job. Format: projects/{project_number}/locations/{location}/jobs/{job}
input_uri str
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). See `Supported input and output formats
output_uri str
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/. See `Supported input and output formats
template_id str
Input only. Specify the template_id to use for populating Job.config. The default is preset/web-hd, which is the only supported preset. User defined JobTemplate: {job_template_id} This field is a member of oneof_ job_config.
config google.cloud.video.transcoder_v1.types.JobConfig
The configuration for this job. This field is a member of oneof_ job_config.
state google.cloud.video.transcoder_v1.types.Job.ProcessingState
Output only. The current state of the job.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time the job was created.
start_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time the transcoding started.
end_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time the transcoding finished.
ttl_after_completion_days int
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.
labels MutableMapping[str, str]
The labels associated with this job. You can use these to organize and group your jobs.
error google.rpc.status_pb2.Status
Output only. An error object that describes the reason for the failure. This property is always present when state is FAILED.
mode google.cloud.video.transcoder_v1.types.Job.ProcessingMode
The processing mode of the job. The default is PROCESSING_MODE_INTERACTIVE.
batch_mode_priority int
The processing priority of a batch job. This field can only be set for batch mode jobs. The default value is 0. This value cannot be negative. Higher values correspond to higher priorities for the job.
optimization google.cloud.video.transcoder_v1.types.Job.OptimizationStrategy
Optional. The optimization strategy of the job. The default is AUTODETECT.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

OptimizationStrategy

OptimizationStrategy(value)

The optimization strategy of the job. The default is AUTODETECT.

Values: OPTIMIZATION_STRATEGY_UNSPECIFIED (0): The optimization strategy is not specified. AUTODETECT (1): Prioritize job processing speed. DISABLED (2): Disable all optimizations.

ProcessingMode

ProcessingMode(value)

The processing mode of the job.

Values: PROCESSING_MODE_UNSPECIFIED (0): The job processing mode is not specified. PROCESSING_MODE_INTERACTIVE (1): The job processing mode is interactive mode. Interactive job will either be ran or rejected if quota does not allow for it. PROCESSING_MODE_BATCH (2): The job processing mode is batch mode. Batch mode allows queuing of jobs.

ProcessingState

ProcessingState(value)

The current state of the job.

Values: PROCESSING_STATE_UNSPECIFIED (0): The processing state is not specified. PENDING (1): The job is enqueued and will be picked up for processing soon. RUNNING (2): The job is being processed. SUCCEEDED (3): The job has been completed successfully. FAILED (4): The job has failed. For additional information, see failure_reason and failure_details