| <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> . <a href="dataflow_v1b3.projects.catalogTemplates.templateVersions.html">templateVersions</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new Template with TemplateVersion. Requires project_id(projects) and template display_name(catalogTemplates). The template display_name is set by the user.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Creates a new Template with TemplateVersion. Requires project_id(projects) and template display_name(catalogTemplates). The template display_name is set by the user. |
| |
| Args: |
| parent: string, The parent project and template that the TemplateVersion will be created under. Create 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: |
| |
| { # Creates a new Template with TemplateVersions. |
| "templateVersion": { # ///////////////////////////////////////////////////////////////////////////// //// 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! # The TemplateVersion object to create. |
| "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. |
| "containerSpec": { # Container Spec. # Container image path set for flex Template. |
| "defaultEnvironment": { # The environment values to be set at runtime for flex template. # Default runtime environment for the job. |
| "additionalExperiments": [ # Additional experiment flags for the job. |
| "A String", |
| ], |
| "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" }. |
| "a_key": "A String", |
| }, |
| "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job. |
| "flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs |
| "ipConfiguration": "A String", # Configuration for VM IPs. |
| "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ |
| "machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified. |
| "maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. |
| "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| "numWorkers": 42, # The initial number of Google Compute Engine instances for the job. |
| "serviceAccountEmail": "A String", # The email address of the service account to run the job as. |
| "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. |
| "tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. |
| "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. |
| "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. |
| "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. |
| }, |
| "image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image |
| "metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules. |
| "description": "A String", # Optional. A description of the template. |
| "name": "A String", # Required. The name of the template. |
| "parameters": [ # The parameters for the template. |
| { # Metadata for a specific parameter. |
| "helpText": "A String", # Required. The help text to display for the parameter. |
| "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| "label": "A String", # Required. The label to display for the parameter. |
| "name": "A String", # Required. The name of the parameter. |
| "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker. |
| "regexes": [ # Optional. Regexes that the parameter must match. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template. |
| "language": "A String", # Required. The SDK Language. |
| "version": "A String", # Optional. The SDK version. |
| }, |
| }, |
| "jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template. |
| "metadata": { # Metadata describing a template. # Metadata set for legacy Template. |
| "description": "A String", # Optional. A description of the template. |
| "name": "A String", # Required. The name of the template. |
| "parameters": [ # The parameters for the template. |
| { # Metadata for a specific parameter. |
| "helpText": "A String", # Required. The help text to display for the parameter. |
| "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| "label": "A String", # Required. The label to display for the parameter. |
| "name": "A String", # Required. The name of the parameter. |
| "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker. |
| "regexes": [ # Optional. Regexes that the parameter must match. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| }, |
| "createTime": "A String", # Creation time of this TemplateVersion. |
| "description": "A String", # Template description from the user. |
| "displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template. |
| "labels": { # Labels for the Template Version. Labels can be duplicate within Template. |
| "a_key": "A String", |
| }, |
| "projectId": "A String", # A unique project_id. Multiple Templates per Project. |
| "tags": [ # Alias for version_id, helps locate a TemplateVersion. |
| "A String", |
| ], |
| "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. |
| }, |
| } |
| |
| 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! |
| "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. |
| "containerSpec": { # Container Spec. # Container image path set for flex Template. |
| "defaultEnvironment": { # The environment values to be set at runtime for flex template. # Default runtime environment for the job. |
| "additionalExperiments": [ # Additional experiment flags for the job. |
| "A String", |
| ], |
| "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" }. |
| "a_key": "A String", |
| }, |
| "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job. |
| "flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs |
| "ipConfiguration": "A String", # Configuration for VM IPs. |
| "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ |
| "machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified. |
| "maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. |
| "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| "numWorkers": 42, # The initial number of Google Compute Engine instances for the job. |
| "serviceAccountEmail": "A String", # The email address of the service account to run the job as. |
| "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. |
| "tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. |
| "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. |
| "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. |
| "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. |
| }, |
| "image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image |
| "metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules. |
| "description": "A String", # Optional. A description of the template. |
| "name": "A String", # Required. The name of the template. |
| "parameters": [ # The parameters for the template. |
| { # Metadata for a specific parameter. |
| "helpText": "A String", # Required. The help text to display for the parameter. |
| "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| "label": "A String", # Required. The label to display for the parameter. |
| "name": "A String", # Required. The name of the parameter. |
| "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker. |
| "regexes": [ # Optional. Regexes that the parameter must match. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template. |
| "language": "A String", # Required. The SDK Language. |
| "version": "A String", # Optional. The SDK version. |
| }, |
| }, |
| "jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template. |
| "metadata": { # Metadata describing a template. # Metadata set for legacy Template. |
| "description": "A String", # Optional. A description of the template. |
| "name": "A String", # Required. The name of the template. |
| "parameters": [ # The parameters for the template. |
| { # Metadata for a specific parameter. |
| "helpText": "A String", # Required. The help text to display for the parameter. |
| "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| "label": "A String", # Required. The label to display for the parameter. |
| "name": "A String", # Required. The name of the parameter. |
| "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker. |
| "regexes": [ # Optional. Regexes that the parameter must match. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| }, |
| "createTime": "A String", # Creation time of this TemplateVersion. |
| "description": "A String", # Template description from the user. |
| "displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template. |
| "labels": { # Labels for the Template Version. Labels can be duplicate within Template. |
| "a_key": "A String", |
| }, |
| "projectId": "A String", # A unique project_id. Multiple Templates per Project. |
| "tags": [ # Alias for version_id, helps locate a TemplateVersion. |
| "A String", |
| ], |
| "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. |
| }</pre> |
| </div> |
| |
| </body></html> |
