Creates a job in the specified region.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: transcoder1-beta1 --scope <scope> projects locations-jobs-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The parent location to create and process this job. Format: projects/{project}/locations/{location}

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Job:
  config:
    output:
      uri: string
    pubsub-destination:
      topic: string
  create-time: string
  end-time: string
  failure-reason: string
  input-uri: string
  name: string
  origin-uri:
    dash: string
    hls: string
  output-uri: string
  priority: integer
  progress:
    analyzed: number
    encoded: number
    notified: number
    uploaded: number
  start-time: string
  state: string
  template-id: string
  ttl-after-completion-days: integer

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .config.output uri=ipsum

    • URI for the output file(s). For example, gs://my-bucket/outputs/. If empty the value is populated from Job.output_uri.
  • ..pubsub-destination topic=voluptua.

    • The name of the Pub/Sub topic to publish job completion notification to. For example: projects/{project}/topics/{topic}.
  • ... create-time=at

    • Output only. The time the job was created.
  • end-time=sanctus
    • Output only. The time the transcoding finished.
  • failure-reason=sed
    • Output only. A description of the reason for the failure. This property is always present when state is FAILED.
  • input-uri=amet.
    • 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=takimata
    • The resource name of the job. Format: projects/{project}/locations/{location}/jobs/{job}
  • origin-uri dash=amet.
    • Dash manifest URI. If multiple Dash manifests are created, only the first one is listed.
  • hls=duo

    • HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4. If multiple HLS manifests are created, only the first one is listed.
  • .. output-uri=ipsum

    • 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=39
    • 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 analyzed=0.39155134552901283
    • Estimated fractional progress for analyzing step.
  • encoded=0.6971199155222326
    • Estimated fractional progress for encoding step.
  • notified=0.7615363125225725
    • Estimated fractional progress for notifying step.
  • uploaded=0.8638300740145545

    • Estimated fractional progress for uploading step.
  • .. start-time=ipsum

    • Output only. The time the transcoding started.
  • state=invidunt
    • Output only. The current state of the job.
  • template-id=amet
    • 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}
  • ttl-after-completion-days=81
    • 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.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").