Note: The following fields are mutually exclusive: dynamic_template, gcs_path. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: dynamic_template, gcs_path. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: dynamic_template, gcs_path. If a field in that set is populated, all other fields in the set will automatically be cleared.
#gcs_path
defgcs_path()->::String
Returns
(::String) — A Cloud Storage path to the template to use to create
the job.
Must be valid Cloud Storage URL, beginning with gs://.
Note: The following fields are mutually exclusive: gcs_path, dynamic_template. If a field in that set is populated, all other fields in the set will automatically be cleared.
#gcs_path=
defgcs_path=(value)->::String
Parameter
value (::String) — A Cloud Storage path to the template to use to create
the job.
Must be valid Cloud Storage URL, beginning with gs://.
Note: The following fields are mutually exclusive: gcs_path, dynamic_template. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — A Cloud Storage path to the template to use to create
the job.
Must be valid Cloud Storage URL, beginning with gs://.
Note: The following fields are mutually exclusive: gcs_path, dynamic_template. If a field in that set is populated, all other fields in the set will automatically be cleared.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Dataflow V1beta3 API - Class Google::Cloud::Dataflow::V1beta3::LaunchTemplateRequest (v0.13.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.1 (latest)](/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.13.0/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.12.1](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.12.1/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.11.0/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.10.0/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.9.1](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.9.1/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.8.2](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.8.2/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.7.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.7.0/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.6.0/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.5.0/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.4.0/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.3.0/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.2.0/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest)\n- [0.1.4](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.1.4/Google-Cloud-Dataflow-V1beta3-LaunchTemplateRequest) \nReference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::LaunchTemplateRequest.\n\nA request to launch a template. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #dynamic_template\n\n def dynamic_template() -\u003e ::Google::Cloud::Dataflow::V1beta3::DynamicTemplateLaunchParams\n\n**Returns**\n\n- ([::Google::Cloud::Dataflow::V1beta3::DynamicTemplateLaunchParams](./Google-Cloud-Dataflow-V1beta3-DynamicTemplateLaunchParams)) --- Parameters for launching a dynamic template.\n\n\n Note: The following fields are mutually exclusive: `dynamic_template`, `gcs_path`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #dynamic_template=\n\n def dynamic_template=(value) -\u003e ::Google::Cloud::Dataflow::V1beta3::DynamicTemplateLaunchParams\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataflow::V1beta3::DynamicTemplateLaunchParams](./Google-Cloud-Dataflow-V1beta3-DynamicTemplateLaunchParams)) --- Parameters for launching a dynamic template.\n\n\nNote: The following fields are mutually exclusive: `dynamic_template`, `gcs_path`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Dataflow::V1beta3::DynamicTemplateLaunchParams](./Google-Cloud-Dataflow-V1beta3-DynamicTemplateLaunchParams)) --- Parameters for launching a dynamic template.\n\n\n Note: The following fields are mutually exclusive: `dynamic_template`, `gcs_path`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #gcs_path\n\n def gcs_path() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with `gs://`.\n\n\n Note: The following fields are mutually exclusive: `gcs_path`, `dynamic_template`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #gcs_path=\n\n def gcs_path=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with `gs://`.\n\n\nNote: The following fields are mutually exclusive: `gcs_path`, `dynamic_template`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with `gs://`.\n\n\n Note: The following fields are mutually exclusive: `gcs_path`, `dynamic_template`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #launch_parameters\n\n def launch_parameters() -\u003e ::Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters\n\n**Returns**\n\n- ([::Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters](./Google-Cloud-Dataflow-V1beta3-LaunchTemplateParameters)) --- The parameters of the template to launch. Part of the body of the POST request.\n\n### #launch_parameters=\n\n def launch_parameters=(value) -\u003e ::Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters](./Google-Cloud-Dataflow-V1beta3-LaunchTemplateParameters)) --- The parameters of the template to launch. Part of the body of the POST request. \n**Returns**\n\n- ([::Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters](./Google-Cloud-Dataflow-V1beta3-LaunchTemplateParameters)) --- The parameters of the template to launch. Part of the body of the POST request.\n\n### #location\n\n def location() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The [regional endpoint](https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.\n\n### #location=\n\n def location=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The [regional endpoint](https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. \n**Returns**\n\n- (::String) --- The [regional endpoint](https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.\n\n### #project_id\n\n def project_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The ID of the Cloud Platform project that the job belongs to.\n\n### #project_id=\n\n def project_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The ID of the Cloud Platform project that the job belongs to. \n**Returns**\n\n- (::String) --- Required. The ID of the Cloud Platform project that the job belongs to.\n\n### #validate_only\n\n def validate_only() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If true, the request is validated but not actually executed. Defaults to false.\n\n### #validate_only=\n\n def validate_only=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If true, the request is validated but not actually executed. Defaults to false. \n**Returns**\n\n- (::Boolean) --- If true, the request is validated but not actually executed. Defaults to false."]]