Dataflow V1beta3 API - Class Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client (v0.5.0)

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

Client for the FlexTemplatesService service.

Provides a service for Flex templates. This feature is not ready yet.

Inherits

  • Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the FlexTemplatesService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all FlexTemplatesService clients
::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the FlexTemplatesService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#initialize

def initialize() { |config| ... } -> Client

Create a new FlexTemplatesService client object.

Yields
  • (config) — Configure the FlexTemplatesService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.new do |config|
  config.timeout = 10.0
end

#launch_flex_template

def launch_flex_template(request, options = nil) -> ::Google::Cloud::Dataflow::V1beta3::LaunchFlexTemplateResponse
def launch_flex_template(project_id: nil, launch_parameter: nil, location: nil, validate_only: nil) -> ::Google::Cloud::Dataflow::V1beta3::LaunchFlexTemplateResponse

Launch a job with a FlexTemplate.

Overloads 
def launch_flex_template(request, options = nil) -> ::Google::Cloud::Dataflow::V1beta3::LaunchFlexTemplateResponse
Pass arguments to launch_flex_template via a request object, either of type LaunchFlexTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataflow::V1beta3::LaunchFlexTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def launch_flex_template(project_id: nil, launch_parameter: nil, location: nil, validate_only: nil) -> ::Google::Cloud::Dataflow::V1beta3::LaunchFlexTemplateResponse
Pass arguments to launch_flex_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • project_id (::String) — Required. The ID of the Cloud Platform project that the job belongs to.
  • launch_parameter (::Google::Cloud::Dataflow::V1beta3::LaunchFlexTemplateParameter, ::Hash) — Required. Parameter to launch a job form Flex Template.
  • location (::String) — Required. The regional endpoint to which to direct the request. E.g., us-central1, us-west1.
  • validate_only (::Boolean) — If true, the request is validated but not actually executed. Defaults to false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataflow/v1beta3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataflow::V1beta3::LaunchFlexTemplateRequest.new

# Call the launch_flex_template method.
result = client.launch_flex_template request

# The returned object is of type Google::Cloud::Dataflow::V1beta3::LaunchFlexTemplateResponse.
p result