Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dataflow
  5. dataflow/v1b3
  6. Template

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dataflow/v1b3.Template

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi
pulumi/pulumi-google-native

    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:

    GcsPath string

    A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with gs://.

    JobName string

    The job name to use for the created job.

    Environment Pulumi.GoogleNative.Dataflow.V1b3.Inputs.RuntimeEnvironment

    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
    GcsPath string

    A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with gs://.

    JobName string

    The job name to use for the created job.

    Environment RuntimeEnvironmentArgs

    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
    gcsPath String

    A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with gs://.

    jobName String

    The job name to use for the created job.

    environment RuntimeEnvironment

    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
    gcsPath string

    A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with gs://.

    jobName string

    The job name to use for the created job.

    environment RuntimeEnvironment

    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 RuntimeEnvironmentArgs

    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
    gcsPath String

    A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with gs://.

    jobName 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.GoogleNative.Dataflow.V1b3.Outputs.TemplateMetadataResponse

    The template metadata describing the template name, available parameters, etc.

    RuntimeMetadata Pulumi.GoogleNative.Dataflow.V1b3.Outputs.RuntimeMetadataResponse

    Describes the runtime metadata with SDKInfo and available parameters.

    Status Pulumi.GoogleNative.Dataflow.V1b3.Outputs.StatusResponse

    The status of the get template request. Any problems with the request will be indicated in the error_details.

    TemplateType string

    Template Type.

    Id string

    The provider-assigned unique ID for this managed resource.

    Metadata TemplateMetadataResponse

    The template metadata describing the template name, available parameters, etc.

    RuntimeMetadata RuntimeMetadataResponse

    Describes the runtime metadata with SDKInfo and available parameters.

    Status StatusResponse

    The status of the get template request. Any problems with the request will be indicated in the error_details.

    TemplateType string

    Template Type.

    id String

    The provider-assigned unique ID for this managed resource.

    metadata TemplateMetadataResponse

    The template metadata describing the template name, available parameters, etc.

    runtimeMetadata RuntimeMetadataResponse

    Describes the runtime metadata with SDKInfo and available parameters.

    status StatusResponse

    The status of the get template request. Any problems with the request will be indicated in the error_details.

    templateType String

    Template Type.

    id string

    The provider-assigned unique ID for this managed resource.

    metadata TemplateMetadataResponse

    The template metadata describing the template name, available parameters, etc.

    runtimeMetadata RuntimeMetadataResponse

    Describes the runtime metadata with SDKInfo and available parameters.

    status StatusResponse

    The status of the get template request. Any problems with the request will be indicated in the error_details.

    templateType string

    Template Type.

    id str

    The provider-assigned unique ID for this managed resource.

    metadata TemplateMetadataResponse

    The template metadata describing the template name, available parameters, etc.

    runtime_metadata RuntimeMetadataResponse

    Describes the runtime metadata with SDKInfo and available parameters.

    status StatusResponse

    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.

    runtimeMetadata 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.

    templateType String

    Template Type.

    Supporting Types

    ParameterMetadataResponse, ParameterMetadataResponseArgs

    CustomMetadata Dictionary<string, string>

    Optional. Additional metadata for describing this parameter.

    GroupName 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.

    HelpText string

    The help text to display for the parameter.

    IsOptional 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.

    ParamType string

    Optional. The type of the parameter. Used for selecting input picker.

    ParentName 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.

    ParentTriggerValues List<string>

    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.

    CustomMetadata map[string]string

    Optional. Additional metadata for describing this parameter.

    GroupName 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.

    HelpText string

    The help text to display for the parameter.

    IsOptional 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.

    ParamType string

    Optional. The type of the parameter. Used for selecting input picker.

    ParentName 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.

    ParentTriggerValues []string

    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.

    customMetadata Map<String,String>

    Optional. Additional metadata for describing this parameter.

    groupName 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.

    helpText String

    The help text to display for the parameter.

    isOptional 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.

    paramType String

    Optional. The type of the parameter. Used for selecting input picker.

    parentName 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.

    parentTriggerValues List<String>

    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.

    customMetadata {[key: string]: string}

    Optional. Additional metadata for describing this parameter.

    groupName 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.

    helpText string

    The help text to display for the parameter.

    isOptional 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.

    paramType string

    Optional. The type of the parameter. Used for selecting input picker.

    parentName 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.

    parentTriggerValues string[]

    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_values Sequence[str]

    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.

    customMetadata Map<String>

    Optional. Additional metadata for describing this parameter.

    groupName 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.

    helpText String

    The help text to display for the parameter.

    isOptional 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.

    paramType String

    Optional. The type of the parameter. Used for selecting input picker.

    parentName 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.

    parentTriggerValues List<String>

    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

    TempLocation string

    The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

    WorkerRegion 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.

    AdditionalExperiments List<string>

    Optional. Additional experiment flags for the job, specified with the --experiments option.

    AdditionalUserLabels Dictionary<string, string>

    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" }.

    BypassTempDirValidation bool

    Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.

    EnableStreamingEngine bool

    Optional. Whether to enable Streaming Engine for the job.

    IpConfiguration Pulumi.GoogleNative.Dataflow.V1b3.RuntimeEnvironmentIpConfiguration

    Optional. Configuration for VM IPs.

    KmsKeyName string

    Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/

    MachineType string

    Optional. The machine type to use for the job. Defaults to the value from the template if not specified.

    MaxWorkers 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".

    NumWorkers int

    Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.

    ServiceAccountEmail string

    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.

    WorkerZone 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 and zone 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.

    TempLocation string

    The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

    WorkerRegion 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.

    AdditionalExperiments []string

    Optional. Additional experiment flags for the job, specified with the --experiments option.

    AdditionalUserLabels map[string]string

    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" }.

    BypassTempDirValidation bool

    Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.

    EnableStreamingEngine bool

    Optional. Whether to enable Streaming Engine for the job.

    IpConfiguration RuntimeEnvironmentIpConfiguration

    Optional. Configuration for VM IPs.

    KmsKeyName string

    Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/

    MachineType string

    Optional. The machine type to use for the job. Defaults to the value from the template if not specified.

    MaxWorkers 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".

    NumWorkers int

    Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.

    ServiceAccountEmail string

    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.

    WorkerZone 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 and zone 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.

    tempLocation String

    The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

    workerRegion 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.

    additionalExperiments List<String>

    Optional. Additional experiment flags for the job, specified with the --experiments option.

    additionalUserLabels Map<String,String>

    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" }.

    bypassTempDirValidation Boolean

    Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.

    enableStreamingEngine Boolean

    Optional. Whether to enable Streaming Engine for the job.

    ipConfiguration RuntimeEnvironmentIpConfiguration

    Optional. Configuration for VM IPs.

    kmsKeyName String

    Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/

    machineType String

    Optional. The machine type to use for the job. Defaults to the value from the template if not specified.

    maxWorkers 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".

    numWorkers Integer

    Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.

    serviceAccountEmail String

    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.

    workerZone 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 and zone 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.

    tempLocation string

    The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

    workerRegion 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.

    additionalExperiments string[]

    Optional. Additional experiment flags for the job, specified with the --experiments option.

    additionalUserLabels {[key: string]: string}

    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" }.

    bypassTempDirValidation boolean

    Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.

    enableStreamingEngine boolean

    Optional. Whether to enable Streaming Engine for the job.

    ipConfiguration RuntimeEnvironmentIpConfiguration

    Optional. Configuration for VM IPs.

    kmsKeyName string

    Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/

    machineType string

    Optional. The machine type to use for the job. Defaults to the value from the template if not specified.

    maxWorkers 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".

    numWorkers number

    Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.

    serviceAccountEmail string

    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.

    workerZone 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 and zone 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_labels Mapping[str, str]

    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_dir_validation bool

    Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.

    enable_streaming_engine bool

    Optional. Whether to enable Streaming Engine for the job.

    ip_configuration RuntimeEnvironmentIpConfiguration

    Optional. Configuration for VM IPs.

    kms_key_name str

    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_email str

    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 and zone 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.

    tempLocation String

    The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

    workerRegion 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.

    additionalExperiments List<String>

    Optional. Additional experiment flags for the job, specified with the --experiments option.

    additionalUserLabels Map<String>

    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" }.

    bypassTempDirValidation Boolean

    Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.

    enableStreamingEngine Boolean

    Optional. Whether to enable Streaming Engine for the job.

    ipConfiguration "WORKER_IP_UNSPECIFIED" | "WORKER_IP_PUBLIC" | "WORKER_IP_PRIVATE"

    Optional. Configuration for VM IPs.

    kmsKeyName String

    Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/

    machineType String

    Optional. The machine type to use for the job. Defaults to the value from the template if not specified.

    maxWorkers 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".

    numWorkers Number

    Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.

    serviceAccountEmail String

    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.

    workerZone 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 and zone 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

    WorkerIpUnspecified
    WORKER_IP_UNSPECIFIED

    The configuration is unknown, or unspecified.

    WorkerIpPublic
    WORKER_IP_PUBLIC

    Workers should have public IP addresses.

    WorkerIpPrivate
    WORKER_IP_PRIVATE

    Workers should have private IP addresses.

    RuntimeEnvironmentIpConfigurationWorkerIpUnspecified
    WORKER_IP_UNSPECIFIED

    The configuration is unknown, or unspecified.

    RuntimeEnvironmentIpConfigurationWorkerIpPublic
    WORKER_IP_PUBLIC

    Workers should have public IP addresses.

    RuntimeEnvironmentIpConfigurationWorkerIpPrivate
    WORKER_IP_PRIVATE

    Workers should have private IP addresses.

    WorkerIpUnspecified
    WORKER_IP_UNSPECIFIED

    The configuration is unknown, or unspecified.

    WorkerIpPublic
    WORKER_IP_PUBLIC

    Workers should have public IP addresses.

    WorkerIpPrivate
    WORKER_IP_PRIVATE

    Workers should have private IP addresses.

    WorkerIpUnspecified
    WORKER_IP_UNSPECIFIED

    The configuration is unknown, or unspecified.

    WorkerIpPublic
    WORKER_IP_PUBLIC

    Workers should have public IP addresses.

    WorkerIpPrivate
    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 []ParameterMetadataResponse

    The parameters for the template.

    SdkInfo SDKInfoResponse

    SDK Info for the template.

    parameters List<ParameterMetadataResponse>

    The parameters for the template.

    sdkInfo SDKInfoResponse

    SDK Info for the template.

    parameters ParameterMetadataResponse[]

    The parameters for the template.

    sdkInfo SDKInfoResponse

    SDK Info for the template.

    parameters Sequence[ParameterMetadataResponse]

    The parameters for the template.

    sdk_info SDKInfoResponse

    SDK Info for the template.

    parameters List<Property Map>

    The parameters for the template.

    sdkInfo Property Map

    SDK Info for the template.

    SDKInfoResponse, SDKInfoResponseArgs

    Language string

    The SDK Language.

    Version string

    Optional. The SDK version.

    Language string

    The SDK Language.

    Version string

    Optional. The SDK version.

    language String

    The SDK Language.

    version String

    Optional. The SDK version.

    language string

    The SDK Language.

    version string

    Optional. The SDK version.

    language str

    The SDK Language.

    version str

    Optional. The SDK version.

    language String

    The SDK Language.

    version String

    Optional. The SDK version.

    StatusResponse, StatusResponseArgs

    Code int

    The status code, which should be an enum value of google.rpc.Code.

    Details List<ImmutableDictionary<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.GoogleNative.Dataflow.V1b3.Inputs.ParameterMetadataResponse>

    The parameters for the template.

    Description string

    Optional. A description of the template.

    Name string

    The name of the template.

    Parameters []ParameterMetadataResponse

    The parameters for the template.

    description String

    Optional. A description of the template.

    name String

    The name of the template.

    parameters List<ParameterMetadataResponse>

    The parameters for the template.

    description string

    Optional. A description of the template.

    name string

    The name of the template.

    parameters ParameterMetadataResponse[]

    The parameters for the template.

    description str

    Optional. A description of the template.

    name str

    The name of the template.

    parameters Sequence[ParameterMetadataResponse]

    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-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi
    pulumi/pulumi-google-native