module Google::Cloud::Dataflow
Constants
- VERSION
Public Class Methods
Configure the google-cloud-dataflow library.
The following configuration parameters are supported:
-
`credentials` (type: `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
-
`lib_name` (type: `String`) - The library name as recorded in instrumentation and logging.
-
`lib_version` (type: `String`) - The library version as recorded in instrumentation and logging.
-
`interceptors` (type: `Array<GRPC::ClientInterceptor>`) - An array of interceptors that are run before calls are executed.
-
`timeout` (type: `Numeric`) - Default timeout in seconds.
-
`metadata` (type: `Hash{Symbol=>String}`) - Additional gRPC headers to be sent with the call.
-
`retry_policy` (type: `Hash`) - The retry policy. The value is a hash with the following keys:
* `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. * `:retry_codes` (*type:* `Array<String>`) - The error codes that should trigger a retry.
@return [::Google::Cloud::Config] The default configuration used by this library
# File lib/google/cloud/dataflow.rb, line 258 def self.configure yield ::Google::Cloud.configure.dataflow if block_given? ::Google::Cloud.configure.dataflow end
Create a new client object for FlexTemplatesService.
By default, this returns an instance of [Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client](googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest/Google/Cloud/Dataflow/V1beta3/FlexTemplatesService/Client.html) for version V1beta3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the FlexTemplatesService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About FlexTemplatesService
Provides a service for Flex templates. This feature is not ready yet.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v1beta3`.
@return [FlexTemplatesService::Client] A client object for the specified version.
# File lib/google/cloud/dataflow.rb, line 219 def self.flex_templates_service version: :v1beta3, &block require "google/cloud/dataflow/#{version.to_s.downcase}" package_name = Google::Cloud::Dataflow .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dataflow.const_get package_name package_module.const_get(:FlexTemplatesService).const_get(:Client).new(&block) end
Create a new client object for Jobs.
By default, this returns an instance of [Google::Cloud::Dataflow::V1beta3::Jobs::Client](googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest/Google/Cloud/Dataflow/V1beta3/Jobs/Client.html) for version V1beta3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Jobs service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Jobs
Provides a method to create and modify Google
Cloud
Dataflow
jobs. A Job is a multi-stage computation graph run by the Cloud
Dataflow
service.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v1beta3`.
@return [Jobs::Client] A client object for the specified version.
# File lib/google/cloud/dataflow.rb, line 97 def self.jobs version: :v1beta3, &block require "google/cloud/dataflow/#{version.to_s.downcase}" package_name = Google::Cloud::Dataflow .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dataflow.const_get package_name package_module.const_get(:Jobs).const_get(:Client).new(&block) end
Create a new client object for Messages.
By default, this returns an instance of [Google::Cloud::Dataflow::V1beta3::Messages::Client](googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest/Google/Cloud/Dataflow/V1beta3/Messages/Client.html) for version V1beta3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Messages service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Messages
The Dataflow
Messages API is used for monitoring the progress of Dataflow
jobs.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v1beta3`.
@return [Messages::Client] A client object for the specified version.
# File lib/google/cloud/dataflow.rb, line 128 def self.messages version: :v1beta3, &block require "google/cloud/dataflow/#{version.to_s.downcase}" package_name = Google::Cloud::Dataflow .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dataflow.const_get package_name package_module.const_get(:Messages).const_get(:Client).new(&block) end
Create a new client object for Metrics.
By default, this returns an instance of [Google::Cloud::Dataflow::V1beta3::Metrics::Client](googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest/Google/Cloud/Dataflow/V1beta3/Metrics/Client.html) for version V1beta3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Metrics service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Metrics
The Dataflow
Metrics API lets you monitor the progress of Dataflow
jobs.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v1beta3`.
@return [Metrics::Client] A client object for the specified version.
# File lib/google/cloud/dataflow.rb, line 159 def self.metrics version: :v1beta3, &block require "google/cloud/dataflow/#{version.to_s.downcase}" package_name = Google::Cloud::Dataflow .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dataflow.const_get package_name package_module.const_get(:Metrics).const_get(:Client).new(&block) end
Create a new client object for Snapshots.
By default, this returns an instance of [Google::Cloud::Dataflow::V1beta3::Snapshots::Client](googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest/Google/Cloud/Dataflow/V1beta3/Snapshots/Client.html) for version V1beta3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Snapshots service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Snapshots
Provides methods to manage snapshots of Google
Cloud
Dataflow
jobs.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v1beta3`.
@return [Snapshots::Client] A client object for the specified version.
# File lib/google/cloud/dataflow.rb, line 66 def self.snapshots version: :v1beta3, &block require "google/cloud/dataflow/#{version.to_s.downcase}" package_name = Google::Cloud::Dataflow .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dataflow.const_get package_name package_module.const_get(:Snapshots).const_get(:Client).new(&block) end
Create a new client object for TemplatesService.
By default, this returns an instance of [Google::Cloud::Dataflow::V1beta3::TemplatesService::Client](googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest/Google/Cloud/Dataflow/V1beta3/TemplatesService/Client.html) for version V1beta3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the TemplatesService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About TemplatesService
Provides a method to create Cloud
Dataflow
jobs from templates.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v1beta3`.
@return [TemplatesService::Client] A client object for the specified version.
# File lib/google/cloud/dataflow.rb, line 189 def self.templates_service version: :v1beta3, &block require "google/cloud/dataflow/#{version.to_s.downcase}" package_name = Google::Cloud::Dataflow .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dataflow.const_get package_name package_module.const_get(:TemplatesService).const_get(:Client).new(&block) end