Dataflow V1beta3 API - Class Google::Cloud::Dataflow::V1beta3::Messages::Rest::Client (v0.7.0)

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

REST client for the Messages service.

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

Inherits

  • Object

Methods

.configure

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

Configure the Messages 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 Messages clients
::Google::Cloud::Dataflow::V1beta3::Messages::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the Messages 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 Messages REST client object.

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

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

#list_job_messages

def list_job_messages(request, options = nil) -> ::Google::Cloud::Dataflow::V1beta3::ListJobMessagesResponse
def list_job_messages(project_id: nil, job_id: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, end_time: nil, location: nil) -> ::Google::Cloud::Dataflow::V1beta3::ListJobMessagesResponse

Request the job status.

To request the status of a job, we recommend using projects.locations.jobs.messages.list with a regional endpoint. Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1.

Overloads 
def list_job_messages(request, options = nil) -> ::Google::Cloud::Dataflow::V1beta3::ListJobMessagesResponse
Pass arguments to list_job_messages via a request object, either of type ListJobMessagesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataflow::V1beta3::ListJobMessagesRequest, ::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 list_job_messages(project_id: nil, job_id: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, end_time: nil, location: nil) -> ::Google::Cloud::Dataflow::V1beta3::ListJobMessagesResponse
Pass arguments to list_job_messages 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) — A project id.
  • job_id (::String) — The job to get messages about.
  • minimum_importance (::Google::Cloud::Dataflow::V1beta3::JobMessageImportance) — Filter to only get messages with importance >= level
  • page_size (::Integer) — If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.
  • page_token (::String) — If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.
  • start_time (::Google::Protobuf::Timestamp, ::Hash) — If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).
  • end_time (::Google::Protobuf::Timestamp, ::Hash) — Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).
  • location (::String) — The regional endpoint that contains the job specified by job_id.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Messages::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataflow::V1beta3::JobMessage.
  p item
end