blob: aec96ff8bd41e290385f364e66953d7af7e1fcce [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dataflow_v1b3.html">Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.templateVersions.html">templateVersions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(parent=None, Format=None, Format, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">List TemplateVersions using project_id and an optional display_name field.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(parent=None, Format=None, Format, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>List TemplateVersions using project_id and an optional display_name field.
List all the TemplateVersions in the Template if display set.
List all the TemplateVersions in the Project if display_name not set.
Args:
parent: string, parent includes project_id, and display_name is optional.
List by project_id(pid1) and display_name(tid1).
Format: projects/{pid1}/catalogTemplates/{tid1}
List by project_id(pid1).
Format: projects/{pid1} (required)
pageToken: string, The page token, received from a previous ListTemplateVersions call.
Provide this to retrieve the subsequent page.
pageSize: integer, The maximum number of TemplateVersions to return per page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Respond a list of TemplateVersions.
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as `page_token` to retrieve the next page.
# If this field is omitted, there are no subsequent pages.
&quot;templateVersions&quot;: [ # A list of TemplateVersions.
{ # /////////////////////////////////////////////////////////////////////////////
# //// Template Catalog is used to organize user TemplateVersions.
# //// TemplateVersions that have the same project_id and display_name are
# //// belong to the same Template.
# //// Templates with the same project_id belong to the same Project.
# //// TemplateVersion may have labels and multiple labels are allowed.
# //// Duplicated labels in the same `TemplateVersion` are not allowed.
# //// TemplateVersion may have tags and multiple tags are allowed. Duplicated
# //// tags in the same `Template` are not allowed!
&quot;type&quot;: &quot;A String&quot;, # Either LEGACY or FLEX. This should match with the type of artifact.
&quot;versionId&quot;: &quot;A String&quot;, # An auto generated version_id for TemplateVersion.
&quot;labels&quot;: { # Labels for the Template Version. Labels can be duplicate within Template.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;tags&quot;: [ # Alias for version_id, helps locate a TemplateVersion.
&quot;A String&quot;,
],
&quot;artifact&quot;: { # Job information for templates. # Job graph and metadata if it is a legacy Template.
# Container image path and metadata if it is flex Template.
&quot;metadata&quot;: { # Metadata describing a template. # Metadata set for legacy Template.
&quot;description&quot;: &quot;A String&quot;, # Optional. A description of the template.
&quot;parameters&quot;: [ # The parameters for the template.
{ # Metadata for a specific parameter.
&quot;label&quot;: &quot;A String&quot;, # Required. The label to display for the parameter.
&quot;helpText&quot;: &quot;A String&quot;, # Required. The help text to display for the parameter.
&quot;regexes&quot;: [ # Optional. Regexes that the parameter must match.
&quot;A String&quot;,
],
&quot;paramType&quot;: &quot;A String&quot;, # Optional. The type of the parameter.
# Used for selecting input picker.
&quot;isOptional&quot;: True or False, # Optional. Whether the parameter is optional. Defaults to false.
&quot;name&quot;: &quot;A String&quot;, # Required. The name of the parameter.
},
],
&quot;name&quot;: &quot;A String&quot;, # Required. The name of the template.
},
&quot;jobGraphGcsPath&quot;: &quot;A String&quot;, # job_graph_gcs_path set for legacy Template.
&quot;containerSpec&quot;: { # Container Spec. # Container image path set for flex Template.
&quot;image&quot;: &quot;A String&quot;, # Name of the docker container image. E.g., gcr.io/project/some-image
&quot;sdkInfo&quot;: { # SDK Information. # Required. SDK info of the Flex Template.
&quot;language&quot;: &quot;A String&quot;, # Required. The SDK Language.
&quot;version&quot;: &quot;A String&quot;, # Optional. The SDK version.
},
&quot;metadata&quot;: { # Metadata describing a template. # Metadata describing a template including description and validation rules.
&quot;description&quot;: &quot;A String&quot;, # Optional. A description of the template.
&quot;parameters&quot;: [ # The parameters for the template.
{ # Metadata for a specific parameter.
&quot;label&quot;: &quot;A String&quot;, # Required. The label to display for the parameter.
&quot;helpText&quot;: &quot;A String&quot;, # Required. The help text to display for the parameter.
&quot;regexes&quot;: [ # Optional. Regexes that the parameter must match.
&quot;A String&quot;,
],
&quot;paramType&quot;: &quot;A String&quot;, # Optional. The type of the parameter.
# Used for selecting input picker.
&quot;isOptional&quot;: True or False, # Optional. Whether the parameter is optional. Defaults to false.
&quot;name&quot;: &quot;A String&quot;, # Required. The name of the parameter.
},
],
&quot;name&quot;: &quot;A String&quot;, # Required. The name of the template.
},
},
},
&quot;createTime&quot;: &quot;A String&quot;, # Creation time of this TemplateVersion.
&quot;displayName&quot;: &quot;A String&quot;, # A customized name for Template. Multiple TemplateVersions per Template.
&quot;description&quot;: &quot;A String&quot;, # Template description from the user.
&quot;projectId&quot;: &quot;A String&quot;, # A unique project_id. Multiple Templates per Project.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>