| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 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="#list">list(parent=None, Format=None, Format, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">List TemplateVersions using project_id and an optional display_name field.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 82 | <p class="firstline">Retrieves the next page of results.</p> |
| 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| 85 | <code class="details" id="list">list(parent=None, Format=None, Format, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| 86 | <pre>List TemplateVersions using project_id and an optional display_name field. |
| 87 | List all the TemplateVersions in the Template if display set. |
| 88 | List all the TemplateVersions in the Project if display_name not set. |
| 89 | |
| 90 | Args: |
| 91 | parent: string, parent includes project_id, and display_name is optional. |
| 92 | |
| 93 | List by project_id(pid1) and display_name(tid1). |
| 94 | Format: projects/{pid1}/catalogTemplates/{tid1} |
| 95 | |
| 96 | List by project_id(pid1). |
| 97 | Format: projects/{pid1} (required) |
| 98 | pageToken: string, The page token, received from a previous ListTemplateVersions call. |
| 99 | Provide this to retrieve the subsequent page. |
| 100 | pageSize: integer, The maximum number of TemplateVersions to return per page. |
| 101 | x__xgafv: string, V1 error format. |
| 102 | Allowed values |
| 103 | 1 - v1 error format |
| 104 | 2 - v2 error format |
| 105 | |
| 106 | Returns: |
| 107 | An object of the form: |
| 108 | |
| 109 | { # Respond a list of TemplateVersions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 110 | "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. |
| 111 | # If this field is omitted, there are no subsequent pages. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 112 | "templateVersions": [ # A list of TemplateVersions. |
| 113 | { # ///////////////////////////////////////////////////////////////////////////// |
| 114 | # //// Template Catalog is used to organize user TemplateVersions. |
| 115 | # //// TemplateVersions that have the same project_id and display_name are |
| 116 | # //// belong to the same Template. |
| 117 | # //// Templates with the same project_id belong to the same Project. |
| 118 | # //// TemplateVersion may have labels and multiple labels are allowed. |
| 119 | # //// Duplicated labels in the same `TemplateVersion` are not allowed. |
| 120 | # //// TemplateVersion may have tags and multiple tags are allowed. Duplicated |
| 121 | # //// tags in the same `Template` are not allowed! |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 122 | "type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact. |
| 123 | "versionId": "A String", # An auto generated version_id for TemplateVersion. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 124 | "labels": { # Labels for the Template Version. Labels can be duplicate within Template. |
| 125 | "a_key": "A String", |
| 126 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 127 | "tags": [ # Alias for version_id, helps locate a TemplateVersion. |
| 128 | "A String", |
| 129 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 130 | "artifact": { # Job information for templates. # Job graph and metadata if it is a legacy Template. |
| 131 | # Container image path and metadata if it is flex Template. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 132 | "metadata": { # Metadata describing a template. # Metadata set for legacy Template. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 133 | "description": "A String", # Optional. A description of the template. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 134 | "parameters": [ # The parameters for the template. |
| 135 | { # Metadata for a specific parameter. |
| 136 | "label": "A String", # Required. The label to display for the parameter. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 137 | "helpText": "A String", # Required. The help text to display for the parameter. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 138 | "regexes": [ # Optional. Regexes that the parameter must match. |
| 139 | "A String", |
| 140 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 141 | "paramType": "A String", # Optional. The type of the parameter. |
| 142 | # Used for selecting input picker. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 143 | "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 144 | "name": "A String", # Required. The name of the parameter. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 145 | }, |
| 146 | ], |
| 147 | "name": "A String", # Required. The name of the template. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 148 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 149 | "jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 150 | "containerSpec": { # Container Spec. # Container image path set for flex Template. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 151 | "image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 152 | "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template. |
| 153 | "language": "A String", # Required. The SDK Language. |
| 154 | "version": "A String", # Optional. The SDK version. |
| 155 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 156 | "metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules. |
| 157 | "description": "A String", # Optional. A description of the template. |
| 158 | "parameters": [ # The parameters for the template. |
| 159 | { # Metadata for a specific parameter. |
| 160 | "label": "A String", # Required. The label to display for the parameter. |
| 161 | "helpText": "A String", # Required. The help text to display for the parameter. |
| 162 | "regexes": [ # Optional. Regexes that the parameter must match. |
| 163 | "A String", |
| 164 | ], |
| 165 | "paramType": "A String", # Optional. The type of the parameter. |
| 166 | # Used for selecting input picker. |
| 167 | "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| 168 | "name": "A String", # Required. The name of the parameter. |
| 169 | }, |
| 170 | ], |
| 171 | "name": "A String", # Required. The name of the template. |
| 172 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 173 | }, |
| 174 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 175 | "createTime": "A String", # Creation time of this TemplateVersion. |
| 176 | "displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template. |
| 177 | "description": "A String", # Template description from the user. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 178 | "projectId": "A String", # A unique project_id. Multiple Templates per Project. |
| 179 | }, |
| 180 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 181 | }</pre> |
| 182 | </div> |
| 183 | |
| 184 | <div class="method"> |
| 185 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 186 | <pre>Retrieves the next page of results. |
| 187 | |
| 188 | Args: |
| 189 | previous_request: The request for the previous page. (required) |
| 190 | previous_response: The response from the request for the previous page. (required) |
| 191 | |
| 192 | Returns: |
| 193 | A request object that you can call 'execute()' on to request the next |
| 194 | page. Returns None if there are no more items in the collection. |
| 195 | </pre> |
| 196 | </div> |
| 197 | |
| 198 | </body></html> |