Dataflow API - Module Google::Cloud::Dataflow (v0.6.0)

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 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.
Yields
  • (::Google::Cloud.configure.dataflow)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.flex_templates_service

def self.flex_templates_service(version: :v1beta3, transport: :grpc, &block) -> ::Object

Create a new client object for FlexTemplatesService.

By default, this returns an instance of Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client for a gRPC client for version V1beta3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the FlexTemplatesService service. You can determine whether the method will succeed by calling Dataflow.flex_templates_service_available?.

About FlexTemplatesService

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

Parameters
  • version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional. Defaults to :v1beta3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.flex_templates_service_available?

def self.flex_templates_service_available?(version: :v1beta3, transport: :grpc) -> boolean

Determines whether the FlexTemplatesService service is supported by the current client. If true, you can retrieve a client object by calling Dataflow.flex_templates_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the FlexTemplatesService service, or if the versioned client gem needs an update to support the FlexTemplatesService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional. Defaults to :v1beta3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.jobs

def self.jobs(version: :v1beta3, transport: :grpc, &block) -> ::Object

Create a new client object for Jobs.

By default, this returns an instance of Google::Cloud::Dataflow::V1beta3::Jobs::Client for a gRPC client for version V1beta3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Jobs service. You can determine whether the method will succeed by calling Dataflow.jobs_available?.

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.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional. Defaults to :v1beta3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.jobs_available?

def self.jobs_available?(version: :v1beta3, transport: :grpc) -> boolean

Determines whether the Jobs service is supported by the current client. If true, you can retrieve a client object by calling Dataflow.jobs. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Jobs service, or if the versioned client gem needs an update to support the Jobs service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional. Defaults to :v1beta3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.messages

def self.messages(version: :v1beta3, transport: :grpc, &block) -> ::Object

Create a new client object for Messages.

By default, this returns an instance of Google::Cloud::Dataflow::V1beta3::Messages::Client for a gRPC client for version V1beta3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Messages service. You can determine whether the method will succeed by calling Dataflow.messages_available?.

About Messages

The Dataflow Messages API is used for monitoring the progress of Dataflow jobs.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional. Defaults to :v1beta3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.messages_available?

def self.messages_available?(version: :v1beta3, transport: :grpc) -> boolean

Determines whether the Messages service is supported by the current client. If true, you can retrieve a client object by calling Dataflow.messages. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Messages service, or if the versioned client gem needs an update to support the Messages service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional. Defaults to :v1beta3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.metrics

def self.metrics(version: :v1beta3, transport: :grpc, &block) -> ::Object

Create a new client object for Metrics.

By default, this returns an instance of Google::Cloud::Dataflow::V1beta3::Metrics::Client for a gRPC client for version V1beta3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Metrics service. You can determine whether the method will succeed by calling Dataflow.metrics_available?.

About Metrics

The Dataflow Metrics API lets you monitor the progress of Dataflow jobs.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional. Defaults to :v1beta3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.metrics_available?

def self.metrics_available?(version: :v1beta3, transport: :grpc) -> boolean

Determines whether the Metrics service is supported by the current client. If true, you can retrieve a client object by calling Dataflow.metrics. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Metrics service, or if the versioned client gem needs an update to support the Metrics service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional. Defaults to :v1beta3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.snapshots

def self.snapshots(version: :v1beta3, transport: :grpc, &block) -> ::Object

Create a new client object for Snapshots.

By default, this returns an instance of Google::Cloud::Dataflow::V1beta3::Snapshots::Client for a gRPC client for version V1beta3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Snapshots service. You can determine whether the method will succeed by calling Dataflow.snapshots_available?.

About Snapshots

Provides methods to manage snapshots of Google Cloud Dataflow jobs.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional. Defaults to :v1beta3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.snapshots_available?

def self.snapshots_available?(version: :v1beta3, transport: :grpc) -> boolean

Determines whether the Snapshots service is supported by the current client. If true, you can retrieve a client object by calling Dataflow.snapshots. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Snapshots service, or if the versioned client gem needs an update to support the Snapshots service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional. Defaults to :v1beta3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.templates_service

def self.templates_service(version: :v1beta3, transport: :grpc, &block) -> ::Object

Create a new client object for TemplatesService.

By default, this returns an instance of Google::Cloud::Dataflow::V1beta3::TemplatesService::Client for a gRPC client for version V1beta3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TemplatesService service. You can determine whether the method will succeed by calling Dataflow.templates_service_available?.

About TemplatesService

Provides a method to create Cloud Dataflow jobs from templates.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional. Defaults to :v1beta3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.templates_service_available?

def self.templates_service_available?(version: :v1beta3, transport: :grpc) -> boolean

Determines whether the TemplatesService service is supported by the current client. If true, you can retrieve a client object by calling Dataflow.templates_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TemplatesService service, or if the versioned client gem needs an update to support the TemplatesService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1beta3) — The API version to connect to. Optional. Defaults to :v1beta3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "0.6.0"