class Google::Cloud::Dataflow::V1beta3::TemplatesService::Client

Client for the TemplatesService service.

Provides a method to create Cloud Dataflow jobs from templates.

Attributes

templates_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the TemplatesService Client class.

See {::Google::Cloud::Dataflow::V1beta3::TemplatesService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all TemplatesService clients
::Google::Cloud::Dataflow::V1beta3::TemplatesService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dataflow/v1beta3/templates_service/client.rb, line 54
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Dataflow", "V1beta3"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new TemplatesService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Dataflow::V1beta3::TemplatesService::Client.new

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

@yield [config] Configure the TemplatesService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/dataflow/v1beta3/templates_service/client.rb, line 109
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/dataflow/v1beta3/templates_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @templates_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dataflow::V1beta3::TemplatesService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the TemplatesService 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 {::Google::Cloud::Dataflow::V1beta3::TemplatesService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dataflow/v1beta3/templates_service/client.rb, line 88
def configure
  yield @config if block_given?
  @config
end
create_job_from_template(request, options = nil) { |response, operation| ... } click to toggle source

Creates a Cloud Dataflow job from a template.

@overload create_job_from_template(request, options = nil)

Pass arguments to `create_job_from_template` via a request object, either of type
{::Google::Cloud::Dataflow::V1beta3::CreateJobFromTemplateRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataflow::V1beta3::CreateJobFromTemplateRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload create_job_from_template(project_id: nil, job_name: nil, gcs_path: nil, parameters: nil, environment: nil, location: nil)

Pass arguments to `create_job_from_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).

@param project_id [::String]
  Required. The ID of the Cloud Platform project that the job belongs to.
@param job_name [::String]
  Required. The job name to use for the created job.
@param gcs_path [::String]
  Required. A Cloud Storage path to the template from which to
  create the job.
  Must be a valid Cloud Storage URL, beginning with `gs://`.
@param parameters [::Hash{::String => ::String}]
  The runtime parameters to pass to the job.
@param environment [::Google::Cloud::Dataflow::V1beta3::RuntimeEnvironment, ::Hash]
  The runtime environment for the job.
@param location [::String]
  The [regional endpoint]
  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to
  which to direct the request.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataflow::V1beta3::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dataflow::V1beta3::Job]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataflow/v1beta3/templates_service/client.rb, line 190
def create_job_from_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::CreateJobFromTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_job_from_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataflow::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_job_from_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_job_from_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @templates_service_stub.call_rpc :create_job_from_template, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
get_template(request, options = nil) { |response, operation| ... } click to toggle source

Get the template associated with a template.

@overload get_template(request, options = nil)

Pass arguments to `get_template` via a request object, either of type
{::Google::Cloud::Dataflow::V1beta3::GetTemplateRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataflow::V1beta3::GetTemplateRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_template(project_id: nil, gcs_path: nil, view: nil, location: nil)

Pass arguments to `get_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).

@param project_id [::String]
  Required. The ID of the Cloud Platform project that the job belongs to.
@param gcs_path [::String]
  Required. A Cloud Storage path to the template from which to
  create the job.
  Must be valid Cloud Storage URL, beginning with 'gs://'.
@param view [::Google::Cloud::Dataflow::V1beta3::GetTemplateRequest::TemplateView]
  The view to retrieve. Defaults to METADATA_ONLY.
@param location [::String]
  The [regional endpoint]
  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to
  which to direct the request.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataflow::V1beta3::GetTemplateResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dataflow::V1beta3::GetTemplateResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataflow/v1beta3/templates_service/client.rb, line 340
def get_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::GetTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataflow::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @templates_service_stub.call_rpc :get_template, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
launch_template(request, options = nil) { |response, operation| ... } click to toggle source

Launch a template.

@overload launch_template(request, options = nil)

Pass arguments to `launch_template` via a request object, either of type
{::Google::Cloud::Dataflow::V1beta3::LaunchTemplateRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataflow::V1beta3::LaunchTemplateRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload launch_template(project_id: nil, validate_only: nil, gcs_path: nil, dynamic_template: nil, launch_parameters: nil, location: nil)

Pass arguments to `launch_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).

@param project_id [::String]
  Required. The ID of the Cloud Platform project that the job belongs to.
@param validate_only [::Boolean]
  If true, the request is validated but not actually executed.
  Defaults to false.
@param gcs_path [::String]
  A Cloud Storage path to the template from which to create
  the job.
  Must be valid Cloud Storage URL, beginning with 'gs://'.
@param dynamic_template [::Google::Cloud::Dataflow::V1beta3::DynamicTemplateLaunchParams, ::Hash]
  Params for launching a dynamic template.
@param launch_parameters [::Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters, ::Hash]
  The parameters of the template to launch. This should be part of the
  body of the POST request.
@param location [::String]
  The [regional endpoint]
  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to
  which to direct the request.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataflow::V1beta3::LaunchTemplateResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dataflow::V1beta3::LaunchTemplateResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataflow/v1beta3/templates_service/client.rb, line 268
def launch_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::LaunchTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.launch_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataflow::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.launch_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.launch_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @templates_service_stub.call_rpc :launch_template, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end