| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, h1, h2, h3, div, span, p, pre, a { |
| 5 |
margin: 0; |
| 6 |
padding: 0; |
| 7 |
border: 0; |
| 8 |
font-weight: inherit; |
| 9 |
font-style: inherit; |
| 10 |
font-size: 100%; |
| 11 |
font-family: inherit; |
| 12 |
vertical-align: baseline; |
| 13 |
} |
| 14 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, h2, h3 { |
| 50 |
border-bottom: solid #CCC 1px; |
| 51 |
} |
| 52 |
|
| 53 |
.toc_element { |
| 54 |
margin-top: 0.5em; |
| 55 |
} |
| 56 |
|
| 57 |
.firstline { |
| 58 |
margin-left: 2 em; |
| 59 |
} |
| 60 |
|
| 61 |
.method { |
| 62 |
margin-top: 1em; |
| 63 |
border: solid 1px #CCC; |
| 64 |
padding: 1em; |
| 65 |
background: #EEE; |
| 66 |
} |
| 67 |
|
| 68 |
.details { |
| 69 |
font-weight: bold; |
| 70 |
font-size: 14px; |
| 71 |
} |
| 72 |
|
| 73 |
</style> |
| 74 |
|
| 75 |
<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> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">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.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 85 |
<p class="firstline">Retrieves the next page of results.</p> |
| 86 |
<h3>Method Details</h3> |
| 87 |
<div class="method"> |
| 88 |
<code class="details" id="close">close()</code> |
| 89 |
<pre>Close httplib2 connections.</pre> |
| 90 |
</div> |
| 91 |
|
| 92 |
<div class="method"> |
| 93 |
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 94 |
<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. |
| 95 |
|
| 96 |
Args: |
| 97 |
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) |
| 98 |
pageSize: integer, The maximum number of TemplateVersions to return per page. |
| 99 |
pageToken: string, The page token, received from a previous ListTemplateVersions call. Provide this to retrieve the subsequent page. |
| 100 |
x__xgafv: string, V1 error format. |
| 101 |
Allowed values |
| 102 |
1 - v1 error format |
| 103 |
2 - v2 error format |
| 104 |
|
| 105 |
Returns: |
| 106 |
An object of the form: |
| 107 |
|
| 108 |
{ # Respond a list of TemplateVersions. |
| 109 |
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| 110 |
"templateVersions": [ # A list of TemplateVersions. |
| 111 |
{ # ///////////////////////////////////////////////////////////////////////////// //// 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! |
| 112 |
"artifact": { # Job information for templates. # Job graph and metadata if it is a legacy Template. Container image path and metadata if it is flex Template. |
| 113 |
"containerSpec": { # Container Spec. # Container image path set for flex Template. |
| 114 |
"defaultEnvironment": { # The environment values to be set at runtime for flex template. # Default runtime environment for the job. |
| 115 |
"additionalExperiments": [ # Additional experiment flags for the job. |
| 116 |
"A String", |
| 117 |
], |
| 118 |
"additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }. |
| 119 |
"a_key": "A String", |
| 120 |
}, |
| 121 |
"enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job. |
| 122 |
"flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs |
| 123 |
"ipConfiguration": "A String", # Configuration for VM IPs. |
| 124 |
"kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ |
| 125 |
"machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified. |
| 126 |
"maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. |
| 127 |
"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| 128 |
"numWorkers": 42, # The initial number of Google Compute Engine instances for the job. |
| 129 |
"serviceAccountEmail": "A String", # The email address of the service account to run the job as. |
| 130 |
"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. |
| 131 |
"tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. |
| 132 |
"workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. |
| 133 |
"workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence. |
| 134 |
"zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence. |
| 135 |
}, |
| 136 |
"image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image |
| 137 |
"metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules. |
| 138 |
"description": "A String", # Optional. A description of the template. |
| 139 |
"name": "A String", # Required. The name of the template. |
| 140 |
"parameters": [ # The parameters for the template. |
| 141 |
{ # Metadata for a specific parameter. |
| 142 |
"helpText": "A String", # Required. The help text to display for the parameter. |
| 143 |
"isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| 144 |
"label": "A String", # Required. The label to display for the parameter. |
| 145 |
"name": "A String", # Required. The name of the parameter. |
| 146 |
"paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker. |
| 147 |
"regexes": [ # Optional. Regexes that the parameter must match. |
| 148 |
"A String", |
| 149 |
], |
| 150 |
}, |
| 151 |
], |
| 152 |
}, |
| 153 |
"sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template. |
| 154 |
"language": "A String", # Required. The SDK Language. |
| 155 |
"version": "A String", # Optional. The SDK version. |
| 156 |
}, |
| 157 |
}, |
| 158 |
"jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template. |
| 159 |
"metadata": { # Metadata describing a template. # Metadata set for legacy Template. |
| 160 |
"description": "A String", # Optional. A description of the template. |
| 161 |
"name": "A String", # Required. The name of the template. |
| 162 |
"parameters": [ # The parameters for the template. |
| 163 |
{ # Metadata for a specific parameter. |
| 164 |
"helpText": "A String", # Required. The help text to display for the parameter. |
| 165 |
"isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| 166 |
"label": "A String", # Required. The label to display for the parameter. |
| 167 |
"name": "A String", # Required. The name of the parameter. |
| 168 |
"paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker. |
| 169 |
"regexes": [ # Optional. Regexes that the parameter must match. |
| 170 |
"A String", |
| 171 |
], |
| 172 |
}, |
| 173 |
], |
| 174 |
}, |
| 175 |
}, |
| 176 |
"createTime": "A String", # Creation time of this TemplateVersion. |
| 177 |
"description": "A String", # Template description from the user. |
| 178 |
"displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template. |
| 179 |
"labels": { # Labels for the Template Version. Labels can be duplicate within Template. |
| 180 |
"a_key": "A String", |
| 181 |
}, |
| 182 |
"projectId": "A String", # A unique project_id. Multiple Templates per Project. |
| 183 |
"tags": [ # Alias for version_id, helps locate a TemplateVersion. |
| 184 |
"A String", |
| 185 |
], |
| 186 |
"type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact. |
| 187 |
"versionId": "A String", # An auto generated version_id for TemplateVersion. |
| 188 |
}, |
| 189 |
], |
| 190 |
}</pre> |
| 191 |
</div> |
| 192 |
|
| 193 |
<div class="method"> |
| 194 |
<code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 195 |
<pre>Retrieves the next page of results. |
| 196 |
|
| 197 |
Args: |
| 198 |
previous_request: The request for the previous page. (required) |
| 199 |
previous_response: The response from the request for the previous page. (required) |
| 200 |
|
| 201 |
Returns: |
| 202 |
A request object that you can call 'execute()' on to request the next |
| 203 |
page. Returns None if there are no more items in the collection. |
| 204 |
</pre> |
| 205 |
</div> |
| 206 |
|
| 207 |
</body></html> |