Reference documentation and code samples for the Dataflow API module Google::Cloud::Dataflow.
Methods
.configure
def self.configure() -> ::Google::Cloud::Config
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.
- (::Google::Cloud.configure.dataflow)
- (::Google::Cloud::Config) — The default configuration used by this library
.flex_templates_service
def self.flex_templates_service(version: :v1beta3, &block) -> FlexTemplatesService::Client
Create a new client object for FlexTemplatesService.
By default, this returns an instance of
Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client
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.
-
version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional.
Defaults to
:v1beta3
.
- (FlexTemplatesService::Client) — A client object for the specified version.
.jobs
def self.jobs(version: :v1beta3, &block) -> Jobs::Client
Create a new client object for Jobs.
By default, this returns an instance of
Google::Cloud::Dataflow::V1beta3::Jobs::Client
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.
-
version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional.
Defaults to
:v1beta3
.
- (Jobs::Client) — A client object for the specified version.
.messages
def self.messages(version: :v1beta3, &block) -> Messages::Client
Create a new client object for Messages.
By default, this returns an instance of
Google::Cloud::Dataflow::V1beta3::Messages::Client
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.
-
version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional.
Defaults to
:v1beta3
.
- (Messages::Client) — A client object for the specified version.
.metrics
def self.metrics(version: :v1beta3, &block) -> Metrics::Client
Create a new client object for Metrics.
By default, this returns an instance of
Google::Cloud::Dataflow::V1beta3::Metrics::Client
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.
-
version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional.
Defaults to
:v1beta3
.
- (Metrics::Client) — A client object for the specified version.
.snapshots
def self.snapshots(version: :v1beta3, &block) -> Snapshots::Client
Create a new client object for Snapshots.
By default, this returns an instance of
Google::Cloud::Dataflow::V1beta3::Snapshots::Client
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.
-
version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional.
Defaults to
:v1beta3
.
- (Snapshots::Client) — A client object for the specified version.
.templates_service
def self.templates_service(version: :v1beta3, &block) -> TemplatesService::Client
Create a new client object for TemplatesService.
By default, this returns an instance of
Google::Cloud::Dataflow::V1beta3::TemplatesService::Client
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.
-
version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional.
Defaults to
:v1beta3
.
- (TemplatesService::Client) — A client object for the specified version.
Constants
VERSION
value: "0.1.3"