| <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.catalogTemplates.html">catalogTemplates</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="dataflow_v1b3.projects.catalogTemplates.templateVersions.html">templateVersions()</a></code> |
| </p> |
| <p class="firstline">Returns the templateVersions Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#commit">commit(name=None, Format, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new TemplateVersion (Important: not new Template) entry in the</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name=None, Format, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes an existing Template. Do nothing if Template does not exist.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name=None, Format=None, Format, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get TemplateVersion using project_id and display_name with an optional</p> |
| <p class="toc_element"> |
| <code><a href="#label">label(name=None, Format, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the label of the TemplateVersion. Label can be duplicated in</p> |
| <p class="toc_element"> |
| <code><a href="#tag">tag(name=None, Format, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the tag of the TemplateVersion, and tag is unique in Template.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="commit">commit(name=None, Format, body=None, x__xgafv=None)</code> |
| <pre>Creates a new TemplateVersion (Important: not new Template) entry in the |
| spanner table. Requires project_id and display_name (template). |
| |
| Args: |
| name: string, The location of the template, name includes project_id and display_name. |
| |
| Commit using project_id(pid1) and display_name(tid1). |
| Format: projects/{pid1}/catalogTemplates/{tid1} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Commit will add a new TemplateVersion to an existing template. |
| "templateVersion": { # ///////////////////////////////////////////////////////////////////////////// # TemplateVersion obejct to create. |
| # //// 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! |
| "type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact. |
| "versionId": "A String", # An auto generated version_id for TemplateVersion. |
| "labels": { # Labels for the Template Version. Labels can be duplicate within Template. |
| "a_key": "A String", |
| }, |
| "tags": [ # Alias for version_id, helps locate a TemplateVersion. |
| "A String", |
| ], |
| "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. |
| "metadata": { # Metadata describing a template. # Metadata set for legacy Template. |
| "description": "A String", # Optional. A description of the template. |
| "parameters": [ # The parameters for the template. |
| { # Metadata for a specific parameter. |
| "label": "A String", # Required. The label to display for the parameter. |
| "helpText": "A String", # Required. The help text to display for the parameter. |
| "regexes": [ # Optional. Regexes that the parameter must match. |
| "A String", |
| ], |
| "paramType": "A String", # Optional. The type of the parameter. |
| # Used for selecting input picker. |
| "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| "name": "A String", # Required. The name of the parameter. |
| }, |
| ], |
| "name": "A String", # Required. The name of the template. |
| }, |
| "jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template. |
| "containerSpec": { # Container Spec. # Container image path set for flex Template. |
| "image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image |
| "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template. |
| "language": "A String", # Required. The SDK Language. |
| "version": "A String", # Optional. The SDK version. |
| }, |
| "metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules. |
| "description": "A String", # Optional. A description of the template. |
| "parameters": [ # The parameters for the template. |
| { # Metadata for a specific parameter. |
| "label": "A String", # Required. The label to display for the parameter. |
| "helpText": "A String", # Required. The help text to display for the parameter. |
| "regexes": [ # Optional. Regexes that the parameter must match. |
| "A String", |
| ], |
| "paramType": "A String", # Optional. The type of the parameter. |
| # Used for selecting input picker. |
| "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| "name": "A String", # Required. The name of the parameter. |
| }, |
| ], |
| "name": "A String", # Required. The name of the template. |
| }, |
| }, |
| }, |
| "createTime": "A String", # Creation time of this TemplateVersion. |
| "displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template. |
| "description": "A String", # Template description from the user. |
| "projectId": "A String", # A unique project_id. Multiple Templates per Project. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # ///////////////////////////////////////////////////////////////////////////// |
| # //// 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! |
| "type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact. |
| "versionId": "A String", # An auto generated version_id for TemplateVersion. |
| "labels": { # Labels for the Template Version. Labels can be duplicate within Template. |
| "a_key": "A String", |
| }, |
| "tags": [ # Alias for version_id, helps locate a TemplateVersion. |
| "A String", |
| ], |
| "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. |
| "metadata": { # Metadata describing a template. # Metadata set for legacy Template. |
| "description": "A String", # Optional. A description of the template. |
| "parameters": [ # The parameters for the template. |
| { # Metadata for a specific parameter. |
| "label": "A String", # Required. The label to display for the parameter. |
| "helpText": "A String", # Required. The help text to display for the parameter. |
| "regexes": [ # Optional. Regexes that the parameter must match. |
| "A String", |
| ], |
| "paramType": "A String", # Optional. The type of the parameter. |
| # Used for selecting input picker. |
| "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| "name": "A String", # Required. The name of the parameter. |
| }, |
| ], |
| "name": "A String", # Required. The name of the template. |
| }, |
| "jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template. |
| "containerSpec": { # Container Spec. # Container image path set for flex Template. |
| "image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image |
| "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template. |
| "language": "A String", # Required. The SDK Language. |
| "version": "A String", # Optional. The SDK version. |
| }, |
| "metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules. |
| "description": "A String", # Optional. A description of the template. |
| "parameters": [ # The parameters for the template. |
| { # Metadata for a specific parameter. |
| "label": "A String", # Required. The label to display for the parameter. |
| "helpText": "A String", # Required. The help text to display for the parameter. |
| "regexes": [ # Optional. Regexes that the parameter must match. |
| "A String", |
| ], |
| "paramType": "A String", # Optional. The type of the parameter. |
| # Used for selecting input picker. |
| "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| "name": "A String", # Required. The name of the parameter. |
| }, |
| ], |
| "name": "A String", # Required. The name of the template. |
| }, |
| }, |
| }, |
| "createTime": "A String", # Creation time of this TemplateVersion. |
| "displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template. |
| "description": "A String", # Template description from the user. |
| "projectId": "A String", # A unique project_id. Multiple Templates per Project. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name=None, Format, x__xgafv=None)</code> |
| <pre>Deletes an existing Template. Do nothing if Template does not exist. |
| |
| Args: |
| name: string, name includes project_id and display_name. |
| |
| Delete by project_id(pid1) and display_name(tid1). |
| Format: projects/{pid1}/catalogTemplates/{tid1} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated |
| # empty messages in your APIs. A typical example is to use it as the request |
| # or the response type of an API method. For instance: |
| # |
| # service Foo { |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| # } |
| # |
| # The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name=None, Format=None, Format, x__xgafv=None)</code> |
| <pre>Get TemplateVersion using project_id and display_name with an optional |
| version_id field. Get latest (has tag "latest") TemplateVersion if |
| version_id not set. |
| |
| Args: |
| name: string, Resource name includes project_id and display_name. version_id is optional. |
| Get the latest TemplateVersion if version_id not set. |
| |
| Get by project_id(pid1) and display_name(tid1): |
| Format: projects/{pid1}/catalogTemplates/{tid1} |
| |
| Get by project_id(pid1), display_name(tid1), and version_id(vid1): |
| Format: projects/{pid1}/catalogTemplates/{tid1@vid} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # ///////////////////////////////////////////////////////////////////////////// |
| # //// 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! |
| "type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact. |
| "versionId": "A String", # An auto generated version_id for TemplateVersion. |
| "labels": { # Labels for the Template Version. Labels can be duplicate within Template. |
| "a_key": "A String", |
| }, |
| "tags": [ # Alias for version_id, helps locate a TemplateVersion. |
| "A String", |
| ], |
| "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. |
| "metadata": { # Metadata describing a template. # Metadata set for legacy Template. |
| "description": "A String", # Optional. A description of the template. |
| "parameters": [ # The parameters for the template. |
| { # Metadata for a specific parameter. |
| "label": "A String", # Required. The label to display for the parameter. |
| "helpText": "A String", # Required. The help text to display for the parameter. |
| "regexes": [ # Optional. Regexes that the parameter must match. |
| "A String", |
| ], |
| "paramType": "A String", # Optional. The type of the parameter. |
| # Used for selecting input picker. |
| "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| "name": "A String", # Required. The name of the parameter. |
| }, |
| ], |
| "name": "A String", # Required. The name of the template. |
| }, |
| "jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template. |
| "containerSpec": { # Container Spec. # Container image path set for flex Template. |
| "image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image |
| "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template. |
| "language": "A String", # Required. The SDK Language. |
| "version": "A String", # Optional. The SDK version. |
| }, |
| "metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules. |
| "description": "A String", # Optional. A description of the template. |
| "parameters": [ # The parameters for the template. |
| { # Metadata for a specific parameter. |
| "label": "A String", # Required. The label to display for the parameter. |
| "helpText": "A String", # Required. The help text to display for the parameter. |
| "regexes": [ # Optional. Regexes that the parameter must match. |
| "A String", |
| ], |
| "paramType": "A String", # Optional. The type of the parameter. |
| # Used for selecting input picker. |
| "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| "name": "A String", # Required. The name of the parameter. |
| }, |
| ], |
| "name": "A String", # Required. The name of the template. |
| }, |
| }, |
| }, |
| "createTime": "A String", # Creation time of this TemplateVersion. |
| "displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template. |
| "description": "A String", # Template description from the user. |
| "projectId": "A String", # A unique project_id. Multiple Templates per Project. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="label">label(name=None, Format, body=None, x__xgafv=None)</code> |
| <pre>Updates the label of the TemplateVersion. Label can be duplicated in |
| Template, so either add or remove the label in the TemplateVersion. |
| |
| Args: |
| name: string, Resource name includes project_id, display_name, and version_id. |
| |
| Updates by project_id(pid1), display_name(tid1), and version_id(vid1): |
| Format: projects/{pid1}/catalogTemplates/{tid1@vid} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Either add the label to TemplateVersion or remove it from the |
| # TemplateVersion. |
| "op": "A String", # Requests for add label to TemplateVersion or remove label from |
| # TemplateVersion. |
| "key": "A String", # The label key for update. |
| "value": "A String", # The label value for update. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Respond the labels in the TemplateVersion. |
| "labels": { # All the label in the TemplateVersion. |
| "a_key": "A String", |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="tag">tag(name=None, Format, body=None, x__xgafv=None)</code> |
| <pre>Updates the tag of the TemplateVersion, and tag is unique in Template. |
| If tag exists in another TemplateVersion in the Template, updates the tag |
| to this TemplateVersion will remove it from the old TemplateVersion and add |
| it to this TemplateVersion. If request is remove_only (remove_only = true), |
| remove the tag from this TemplateVersion. |
| |
| Args: |
| name: string, Resource name includes project_id, display_name, and version_id. |
| |
| Updates by project_id(pid1), display_name(tid1), and version_id(vid1): |
| Format: projects/{pid1}/catalogTemplates/{tid1@vid} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Add a tag to the current TemplateVersion. If tag exist in another |
| # TemplateVersion in the Template, remove the tag before add it to the current |
| # TemplateVersion. If remove_only set, remove the tag from the current |
| # TemplateVersion. |
| "removeOnly": True or False, # The flag that indicates if the request is only for remove tag from |
| # TemplateVersion. |
| "tag": "A String", # The tag for update. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Respond the current tags in the TemplateVersion. |
| "tags": [ # All the tags in the TemplateVersion. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
