Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.dataflow/v1b3.Template
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. Auto-naming is currently not supported for this resource. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
Create Template Resource
new Template(name: string, args: TemplateArgs, opts?: CustomResourceOptions);
@overload
def Template(resource_name: str,
opts: Optional[ResourceOptions] = None,
environment: Optional[RuntimeEnvironmentArgs] = None,
gcs_path: Optional[str] = None,
job_name: Optional[str] = None,
location: Optional[str] = None,
parameters: Optional[Mapping[str, str]] = None,
project: Optional[str] = None)
@overload
def Template(resource_name: str,
args: TemplateArgs,
opts: Optional[ResourceOptions] = None)
func NewTemplate(ctx *Context, name string, args TemplateArgs, opts ...ResourceOption) (*Template, error)
public Template(string name, TemplateArgs args, CustomResourceOptions? opts = null)
public Template(String name, TemplateArgs args)
public Template(String name, TemplateArgs args, CustomResourceOptions options)
type: google-native:dataflow/v1b3:Template
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Template Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Template resource accepts the following input properties:
- Gcs
Path string A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with
gs://
.- Job
Name string The job name to use for the created job.
- Environment
Pulumi.
Google Native. Dataflow. V1b3. Inputs. Runtime Environment The runtime environment for the job.
- Location string
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
- Parameters Dictionary<string, string>
The runtime parameters to pass to the job.
- Project string
- Gcs
Path string A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with
gs://
.- Job
Name string The job name to use for the created job.
- Environment
Runtime
Environment Args The runtime environment for the job.
- Location string
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
- Parameters map[string]string
The runtime parameters to pass to the job.
- Project string
- gcs
Path String A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with
gs://
.- job
Name String The job name to use for the created job.
- environment
Runtime
Environment The runtime environment for the job.
- location String
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
- parameters Map<String,String>
The runtime parameters to pass to the job.
- project String
- gcs
Path string A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with
gs://
.- job
Name string The job name to use for the created job.
- environment
Runtime
Environment The runtime environment for the job.
- location string
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
- parameters {[key: string]: string}
The runtime parameters to pass to the job.
- project string
- gcs_
path str A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with
gs://
.- job_
name str The job name to use for the created job.
- environment
Runtime
Environment Args The runtime environment for the job.
- location str
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
- parameters Mapping[str, str]
The runtime parameters to pass to the job.
- project str
- gcs
Path String A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with
gs://
.- job
Name String The job name to use for the created job.
- environment Property Map
The runtime environment for the job.
- location String
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
- parameters Map<String>
The runtime parameters to pass to the job.
- project String
Outputs
All input properties are implicitly available as output properties. Additionally, the Template resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Metadata
Pulumi.
Google Native. Dataflow. V1b3. Outputs. Template Metadata Response The template metadata describing the template name, available parameters, etc.
- Runtime
Metadata Pulumi.Google Native. Dataflow. V1b3. Outputs. Runtime Metadata Response Describes the runtime metadata with SDKInfo and available parameters.
- Status
Pulumi.
Google Native. Dataflow. V1b3. Outputs. Status Response The status of the get template request. Any problems with the request will be indicated in the error_details.
- Template
Type string Template Type.
- Id string
The provider-assigned unique ID for this managed resource.
- Metadata
Template
Metadata Response The template metadata describing the template name, available parameters, etc.
- Runtime
Metadata RuntimeMetadata Response Describes the runtime metadata with SDKInfo and available parameters.
- Status
Status
Response The status of the get template request. Any problems with the request will be indicated in the error_details.
- Template
Type string Template Type.
- id String
The provider-assigned unique ID for this managed resource.
- metadata
Template
Metadata Response The template metadata describing the template name, available parameters, etc.
- runtime
Metadata RuntimeMetadata Response Describes the runtime metadata with SDKInfo and available parameters.
- status
Status
Response The status of the get template request. Any problems with the request will be indicated in the error_details.
- template
Type String Template Type.
- id string
The provider-assigned unique ID for this managed resource.
- metadata
Template
Metadata Response The template metadata describing the template name, available parameters, etc.
- runtime
Metadata RuntimeMetadata Response Describes the runtime metadata with SDKInfo and available parameters.
- status
Status
Response The status of the get template request. Any problems with the request will be indicated in the error_details.
- template
Type string Template Type.
- id str
The provider-assigned unique ID for this managed resource.
- metadata
Template
Metadata Response The template metadata describing the template name, available parameters, etc.
- runtime_
metadata RuntimeMetadata Response Describes the runtime metadata with SDKInfo and available parameters.
- status
Status
Response The status of the get template request. Any problems with the request will be indicated in the error_details.
- template_
type str Template Type.
- id String
The provider-assigned unique ID for this managed resource.
- metadata Property Map
The template metadata describing the template name, available parameters, etc.
- runtime
Metadata Property Map Describes the runtime metadata with SDKInfo and available parameters.
- status Property Map
The status of the get template request. Any problems with the request will be indicated in the error_details.
- template
Type String Template Type.
Supporting Types
ParameterMetadataResponse, ParameterMetadataResponseArgs
- Custom
Metadata Dictionary<string, string> Optional. Additional metadata for describing this parameter.
- Group
Name string Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
- Help
Text string The help text to display for the parameter.
- Is
Optional bool Optional. Whether the parameter is optional. Defaults to false.
- Label string
The label to display for the parameter.
- Name string
The name of the parameter.
- Param
Type string Optional. The type of the parameter. Used for selecting input picker.
- Parent
Name string Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
- Parent
Trigger List<string>Values Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
- Regexes List<string>
Optional. Regexes that the parameter must match.
- Custom
Metadata map[string]string Optional. Additional metadata for describing this parameter.
- Group
Name string Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
- Help
Text string The help text to display for the parameter.
- Is
Optional bool Optional. Whether the parameter is optional. Defaults to false.
- Label string
The label to display for the parameter.
- Name string
The name of the parameter.
- Param
Type string Optional. The type of the parameter. Used for selecting input picker.
- Parent
Name string Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
- Parent
Trigger []stringValues Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
- Regexes []string
Optional. Regexes that the parameter must match.
- custom
Metadata Map<String,String> Optional. Additional metadata for describing this parameter.
- group
Name String Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
- help
Text String The help text to display for the parameter.
- is
Optional Boolean Optional. Whether the parameter is optional. Defaults to false.
- label String
The label to display for the parameter.
- name String
The name of the parameter.
- param
Type String Optional. The type of the parameter. Used for selecting input picker.
- parent
Name String Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
- parent
Trigger List<String>Values Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
- regexes List<String>
Optional. Regexes that the parameter must match.
- custom
Metadata {[key: string]: string} Optional. Additional metadata for describing this parameter.
- group
Name string Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
- help
Text string The help text to display for the parameter.
- is
Optional boolean Optional. Whether the parameter is optional. Defaults to false.
- label string
The label to display for the parameter.
- name string
The name of the parameter.
- param
Type string Optional. The type of the parameter. Used for selecting input picker.
- parent
Name string Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
- parent
Trigger string[]Values Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
- regexes string[]
Optional. Regexes that the parameter must match.
- custom_
metadata Mapping[str, str] Optional. Additional metadata for describing this parameter.
- group_
name str Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
- help_
text str The help text to display for the parameter.
- is_
optional bool Optional. Whether the parameter is optional. Defaults to false.
- label str
The label to display for the parameter.
- name str
The name of the parameter.
- param_
type str Optional. The type of the parameter. Used for selecting input picker.
- parent_
name str Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
- parent_
trigger_ Sequence[str]values Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
- regexes Sequence[str]
Optional. Regexes that the parameter must match.
- custom
Metadata Map<String> Optional. Additional metadata for describing this parameter.
- group
Name String Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
- help
Text String The help text to display for the parameter.
- is
Optional Boolean Optional. Whether the parameter is optional. Defaults to false.
- label String
The label to display for the parameter.
- name String
The name of the parameter.
- param
Type String Optional. The type of the parameter. Used for selecting input picker.
- parent
Name String Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
- parent
Trigger List<String>Values Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
- regexes List<String>
Optional. Regexes that the parameter must match.
RuntimeEnvironment, RuntimeEnvironmentArgs
- Temp
Location string The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with
gs://
.- Worker
Region 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.
- Additional
Experiments List<string> Optional. Additional experiment flags for the job, specified with the
--experiments
option.- Additional
User Dictionary<string, string>Labels Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
- Bypass
Temp boolDir Validation Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
- Enable
Streaming boolEngine Optional. Whether to enable Streaming Engine for the job.
- Ip
Configuration Pulumi.Google Native. Dataflow. V1b3. Runtime Environment Ip Configuration Optional. Configuration for VM IPs.
- Kms
Key stringName Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
- Machine
Type string Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
- Max
Workers int Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1.
- Network string
Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
- Num
Workers int Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
- Service
Account stringEmail Optional. The email address of the service account to run the job as.
- Subnetwork string
Optional. 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.
- Worker
Zone string Optional. 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
andzone
are set,worker_zone
takes precedence.- Zone string
Optional. The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
- Temp
Location string The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with
gs://
.- Worker
Region 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.
- Additional
Experiments []string Optional. Additional experiment flags for the job, specified with the
--experiments
option.- Additional
User map[string]stringLabels Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
- Bypass
Temp boolDir Validation Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
- Enable
Streaming boolEngine Optional. Whether to enable Streaming Engine for the job.
- Ip
Configuration RuntimeEnvironment Ip Configuration Optional. Configuration for VM IPs.
- Kms
Key stringName Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
- Machine
Type string Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
- Max
Workers int Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1.
- Network string
Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
- Num
Workers int Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
- Service
Account stringEmail Optional. The email address of the service account to run the job as.
- Subnetwork string
Optional. 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.
- Worker
Zone string Optional. 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
andzone
are set,worker_zone
takes precedence.- Zone string
Optional. The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
- temp
Location String The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with
gs://
.- worker
Region 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.
- additional
Experiments List<String> Optional. Additional experiment flags for the job, specified with the
--experiments
option.- additional
User Map<String,String>Labels Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
- bypass
Temp BooleanDir Validation Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
- enable
Streaming BooleanEngine Optional. Whether to enable Streaming Engine for the job.
- ip
Configuration RuntimeEnvironment Ip Configuration Optional. Configuration for VM IPs.
- kms
Key StringName Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
- machine
Type String Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
- max
Workers Integer Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1.
- network String
Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
- num
Workers Integer Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
- service
Account StringEmail Optional. The email address of the service account to run the job as.
- subnetwork String
Optional. 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.
- worker
Zone String Optional. 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
andzone
are set,worker_zone
takes precedence.- zone String
Optional. The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
- temp
Location string The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with
gs://
.- worker
Region 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.
- additional
Experiments string[] Optional. Additional experiment flags for the job, specified with the
--experiments
option.- additional
User {[key: string]: string}Labels Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
- bypass
Temp booleanDir Validation Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
- enable
Streaming booleanEngine Optional. Whether to enable Streaming Engine for the job.
- ip
Configuration RuntimeEnvironment Ip Configuration Optional. Configuration for VM IPs.
- kms
Key stringName Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
- machine
Type string Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
- max
Workers number Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1.
- network string
Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
- num
Workers number Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
- service
Account stringEmail Optional. The email address of the service account to run the job as.
- subnetwork string
Optional. 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.
- worker
Zone string Optional. 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
andzone
are set,worker_zone
takes precedence.- zone string
Optional. The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
- temp_
location str The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with
gs://
.- worker_
region str 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.
- additional_
experiments Sequence[str] Optional. Additional experiment flags for the job, specified with the
--experiments
option.- additional_
user_ Mapping[str, str]labels Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
- bypass_
temp_ booldir_ validation Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
- enable_
streaming_ boolengine Optional. Whether to enable Streaming Engine for the job.
- ip_
configuration RuntimeEnvironment Ip Configuration Optional. Configuration for VM IPs.
- kms_
key_ strname Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
- machine_
type str Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
- max_
workers int Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1.
- network str
Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
- num_
workers int Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
- service_
account_ stremail Optional. The email address of the service account to run the job as.
- subnetwork str
Optional. 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.
- worker_
zone str Optional. 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
andzone
are set,worker_zone
takes precedence.- zone str
Optional. The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
- temp
Location String The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with
gs://
.- worker
Region 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.
- additional
Experiments List<String> Optional. Additional experiment flags for the job, specified with the
--experiments
option.- additional
User Map<String>Labels Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
- bypass
Temp BooleanDir Validation Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
- enable
Streaming BooleanEngine Optional. Whether to enable Streaming Engine for the job.
- ip
Configuration "WORKER_IP_UNSPECIFIED" | "WORKER_IP_PUBLIC" | "WORKER_IP_PRIVATE" Optional. Configuration for VM IPs.
- kms
Key StringName Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
- machine
Type String Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
- max
Workers Number Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1.
- network String
Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
- num
Workers Number Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
- service
Account StringEmail Optional. The email address of the service account to run the job as.
- subnetwork String
Optional. 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.
- worker
Zone String Optional. 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
andzone
are set,worker_zone
takes precedence.- zone String
Optional. The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
RuntimeEnvironmentIpConfiguration, RuntimeEnvironmentIpConfigurationArgs
- Worker
Ip Unspecified - WORKER_IP_UNSPECIFIED
The configuration is unknown, or unspecified.
- Worker
Ip Public - WORKER_IP_PUBLIC
Workers should have public IP addresses.
- Worker
Ip Private - WORKER_IP_PRIVATE
Workers should have private IP addresses.
- Runtime
Environment Ip Configuration Worker Ip Unspecified - WORKER_IP_UNSPECIFIED
The configuration is unknown, or unspecified.
- Runtime
Environment Ip Configuration Worker Ip Public - WORKER_IP_PUBLIC
Workers should have public IP addresses.
- Runtime
Environment Ip Configuration Worker Ip Private - WORKER_IP_PRIVATE
Workers should have private IP addresses.
- Worker
Ip Unspecified - WORKER_IP_UNSPECIFIED
The configuration is unknown, or unspecified.
- Worker
Ip Public - WORKER_IP_PUBLIC
Workers should have public IP addresses.
- Worker
Ip Private - WORKER_IP_PRIVATE
Workers should have private IP addresses.
- Worker
Ip Unspecified - WORKER_IP_UNSPECIFIED
The configuration is unknown, or unspecified.
- Worker
Ip Public - WORKER_IP_PUBLIC
Workers should have public IP addresses.
- Worker
Ip Private - WORKER_IP_PRIVATE
Workers should have private IP addresses.
- WORKER_IP_UNSPECIFIED
- WORKER_IP_UNSPECIFIED
The configuration is unknown, or unspecified.
- WORKER_IP_PUBLIC
- WORKER_IP_PUBLIC
Workers should have public IP addresses.
- WORKER_IP_PRIVATE
- WORKER_IP_PRIVATE
Workers should have private IP addresses.
- "WORKER_IP_UNSPECIFIED"
- WORKER_IP_UNSPECIFIED
The configuration is unknown, or unspecified.
- "WORKER_IP_PUBLIC"
- WORKER_IP_PUBLIC
Workers should have public IP addresses.
- "WORKER_IP_PRIVATE"
- WORKER_IP_PRIVATE
Workers should have private IP addresses.
RuntimeMetadataResponse, RuntimeMetadataResponseArgs
- Parameters
List<Pulumi.
Google Native. Dataflow. V1b3. Inputs. Parameter Metadata Response> The parameters for the template.
- Sdk
Info Pulumi.Google Native. Dataflow. V1b3. Inputs. SDKInfo Response SDK Info for the template.
- Parameters
[]Parameter
Metadata Response The parameters for the template.
- Sdk
Info SDKInfoResponse SDK Info for the template.
- parameters
List<Parameter
Metadata Response> The parameters for the template.
- sdk
Info SDKInfoResponse SDK Info for the template.
- parameters
Parameter
Metadata Response[] The parameters for the template.
- sdk
Info SDKInfoResponse SDK Info for the template.
- parameters
Sequence[Parameter
Metadata Response] The parameters for the template.
- sdk_
info SDKInfoResponse SDK Info for the template.
- parameters List<Property Map>
The parameters for the template.
- sdk
Info Property Map SDK Info for the template.
SDKInfoResponse, SDKInfoResponseArgs
StatusResponse, StatusResponseArgs
- Code int
The status code, which should be an enum value of google.rpc.Code.
- Details
List<Immutable
Dictionary<string, string>> A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- Code int
The status code, which should be an enum value of google.rpc.Code.
- Details []map[string]string
A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code Integer
The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String,String>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message String
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code number
The status code, which should be an enum value of google.rpc.Code.
- details {[key: string]: string}[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code int
The status code, which should be an enum value of google.rpc.Code.
- details Sequence[Mapping[str, str]]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message str
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code Number
The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message String
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
TemplateMetadataResponse, TemplateMetadataResponseArgs
- Description string
Optional. A description of the template.
- Name string
The name of the template.
- Parameters
List<Pulumi.
Google Native. Dataflow. V1b3. Inputs. Parameter Metadata Response> The parameters for the template.
- Description string
Optional. A description of the template.
- Name string
The name of the template.
- Parameters
[]Parameter
Metadata Response The parameters for the template.
- description String
Optional. A description of the template.
- name String
The name of the template.
- parameters
List<Parameter
Metadata Response> The parameters for the template.
- description string
Optional. A description of the template.
- name string
The name of the template.
- parameters
Parameter
Metadata Response[] The parameters for the template.
- description str
Optional. A description of the template.
- name str
The name of the template.
- parameters
Sequence[Parameter
Metadata Response] The parameters for the template.
- description String
Optional. A description of the template.
- name String
The name of the template.
- parameters List<Property Map>
The parameters for the template.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.