Dataflow V1beta3 API - Class Google::Cloud::Dataflow::V1beta3::LaunchTemplateRequest (v0.11.0)

Reference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::LaunchTemplateRequest.

A request to launch a template.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#dynamic_template

def dynamic_template() -> ::Google::Cloud::Dataflow::V1beta3::DynamicTemplateLaunchParams

Returns

(::Google::Cloud::Dataflow::V1beta3::DynamicTemplateLaunchParams) — Params for launching a dynamic template.

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.

#dynamic_template=

def dynamic_template=(value) -> ::Google::Cloud::Dataflow::V1beta3::DynamicTemplateLaunchParams

Parameter

value (::Google::Cloud::Dataflow::V1beta3::DynamicTemplateLaunchParams) — Params for launching a dynamic template.

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.

Returns

(::Google::Cloud::Dataflow::V1beta3::DynamicTemplateLaunchParams) — Params for launching a dynamic template.

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

def gcs_path() -> ::String

Returns

(::String) — A Cloud Storage path to the template from which 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=

def gcs_path=(value) -> ::String

Parameter

value (::String) — A Cloud Storage path to the template from which 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 from which 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.

#launch_parameters

def launch_parameters() -> ::Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters

Returns

(::Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters) — The parameters of the template to launch. This should be part of the body of the POST request.

#launch_parameters=

def launch_parameters=(value) -> ::Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters

Parameter

value (::Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters) — The parameters of the template to launch. This should be part of the body of the POST request.

Returns

(::Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters) — The parameters of the template to launch. This should be part of the body of the POST request.

#location

def location() -> ::String

Returns

(::String) — The regional endpoint to which to direct the request.

#location=

def location=(value) -> ::String

Parameter

value (::String) — The regional endpoint to which to direct the request.

Returns

(::String) — The regional endpoint to which to direct the request.

#project_id

def project_id() -> ::String

Returns

(::String) — Required. The ID of the Cloud Platform project that the job belongs to.

#project_id=

def project_id=(value) -> ::String

Parameter

value (::String) — Required. The ID of the Cloud Platform project that the job belongs to.

Returns

(::String) — Required. The ID of the Cloud Platform project that the job belongs to.

#validate_only

def validate_only() -> ::Boolean

Returns

(::Boolean) — If true, the request is validated but not actually executed. Defaults to false.

#validate_only=

def validate_only=(value) -> ::Boolean

Parameter

value (::Boolean) — If true, the request is validated but not actually executed. Defaults to false.

Returns

(::Boolean) — If true, the request is validated but not actually executed. Defaults to false.