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 --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. The parent location to create and process this job. Format:
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:
batch-mode-priority: integer
config:
output:
uri: string
pubsub-destination:
topic: string
create-time: string
end-time: string
error:
code: integer
message: string
input-uri: string
labels: { string: string }
mode: string
name: string
optimization: string
output-uri: string
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 . batch-mode-priority=73
- 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.
-
config.output uri=at
- URI for the output file(s). For example,
gs://my-bucket/outputs/
. If empty, the value is populated from Job.output_uri. See Supported input and output formats.
- URI for the output file(s). For example,
-
..pubsub-destination topic=sanctus
- The name of the Pub/Sub topic to publish job completion notification to. For example:
projects/{project}/topics/{topic}
.
- The name of the Pub/Sub topic to publish job completion notification to. For example:
-
... create-time=sed
- Output only. The time the job was created.
end-time=amet.
- Output only. The time the transcoding finished.
error code=42
- The status code, which should be an enum value of google.rpc.Code.
-
message=amet.
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-
.. input-uri=duo
- Input only. Specify the
input_uri
to populate emptyuri
fields in each element ofJob.config.inputs
orJobTemplate.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.
- Input only. Specify the
labels=key=ipsum
- The labels associated with this job. You can use these to organize and group your jobs.
- the value will be associated with the given
key
mode=gubergren
- The processing mode of the job. The default is
PROCESSING_MODE_INTERACTIVE
.
- The processing mode of the job. The default is
name=lorem
- The resource name of the job. Format:
projects/{project_number}/locations/{location}/jobs/{job}
- The resource name of the job. Format:
optimization=gubergren
- Optional. The optimization strategy of the job. The default is
AUTODETECT
.
- Optional. The optimization strategy of the job. The default is
output-uri=eos
- Input only. Specify the
output_uri
to populate an emptyJob.config.output.uri
orJobTemplate.config.output.uri
when using template. URI for the output file(s). For example,gs://my-bucket/outputs/
. See Supported input and output formats.
- Input only. Specify the
start-time=dolor
- Output only. The time the transcoding started.
state=ea
- Output only. The current state of the job.
template-id=ipsum
- Input only. Specify the
template_id
to use for populatingJob.config
. The default ispreset/web-hd
, which is the only supported preset. User defined JobTemplate:{job_template_id}
- Input only. Specify the
ttl-after-completion-days=13
- 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.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
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").