mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 04:10:02 +01:00
357 lines
15 KiB
HTML
357 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-transcoder1-cli/projects_locations-jobs-create/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Jobs Create - Transcoder v5.0.4+20240221</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Locations Jobs Create";
|
|
var mkdocs_page_input_path = "projects_locations-jobs-create.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-transcoder1-cli/projects_locations-jobs-create/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Transcoder v5.0.4+20240221
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-job-templates-create/">Locations Job Templates Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-job-templates-delete/">Locations Job Templates Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-job-templates-get/">Locations Job Templates Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-job-templates-list/">Locations Job Templates List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Jobs Create</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-jobs-delete/">Locations Jobs Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-jobs-get/">Locations Jobs Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-jobs-list/">Locations Jobs List</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Transcoder v5.0.4+20240221</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Projects »</li>
|
|
<li>Locations Jobs Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/transcoder1-cli/edit/master/docs/projects_locations-jobs-create.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Creates a job in the specified region.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
|
You can set the scope for this method like this: <code>transcoder1 --scope <scope> projects locations-jobs-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The parent location to create and process this job. Format: <code>projects/{project}/locations/{location}</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>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.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>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
|
|
|
|
</code></pre>
|
|
<p>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.</p>
|
|
<ul>
|
|
<li><code>-r . batch-mode-priority=73</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>config.output uri=at</code></p>
|
|
<ul>
|
|
<li>URI for the output file(s). For example, <code>gs://my-bucket/outputs/</code>. If empty, the value is populated from Job.output_uri. See <a href="https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats">Supported input and output formats</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..pubsub-destination topic=sanctus</code></p>
|
|
<ul>
|
|
<li>The name of the Pub/Sub topic to publish job completion notification to. For example: <code>projects/{project}/topics/{topic}</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... create-time=sed</code></p>
|
|
<ul>
|
|
<li>Output only. The time the job was created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-time=amet.</code><ul>
|
|
<li>Output only. The time the transcoding finished.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>error code=42</code><ul>
|
|
<li>The status code, which should be an enum value of google.rpc.Code.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>message=amet.</code></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. input-uri=duo</code></p>
|
|
<ul>
|
|
<li>Input only. Specify the <code>input_uri</code> to populate empty <code>uri</code> fields in each element of <code>Job.config.inputs</code> or <code>JobTemplate.config.inputs</code> when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, <code>gs://bucket/inputs/file.mp4</code>). See <a href="https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats">Supported input and output formats</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>labels=key=ipsum</code><ul>
|
|
<li>The labels associated with this job. You can use these to organize and group your jobs.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>mode=gubergren</code><ul>
|
|
<li>The processing mode of the job. The default is <code>PROCESSING_MODE_INTERACTIVE</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=lorem</code><ul>
|
|
<li>The resource name of the job. Format: <code>projects/{project_number}/locations/{location}/jobs/{job}</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>optimization=gubergren</code><ul>
|
|
<li>Optional. The optimization strategy of the job. The default is <code>AUTODETECT</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>output-uri=eos</code><ul>
|
|
<li>Input only. Specify the <code>output_uri</code> to populate an empty <code>Job.config.output.uri</code> or <code>JobTemplate.config.output.uri</code> when using template. URI for the output file(s). For example, <code>gs://my-bucket/outputs/</code>. See <a href="https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats">Supported input and output formats</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-time=dolor</code><ul>
|
|
<li>Output only. The time the transcoding started.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state=ea</code><ul>
|
|
<li>Output only. The current state of the job.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>template-id=ipsum</code><ul>
|
|
<li>Input only. Specify the <code>template_id</code> to use for populating <code>Job.config</code>. The default is <code>preset/web-hd</code>, which is the only supported preset. User defined JobTemplate: <code>{job_template_id}</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ttl-after-completion-days=13</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>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 <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../projects_locations-job-templates-list/" class="btn btn-neutral float-left" title="Locations Job Templates List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-jobs-delete/" class="btn btn-neutral float-right" title="Locations Jobs Delete">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/transcoder1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-job-templates-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-jobs-delete/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|