class Google::Cloud::Dataflow::V1beta3::Messages::Client
Client
for the Messages
service.
The Dataflow
Messages
API is used for monitoring the progress of Dataflow
jobs.
Attributes
@private
Public Class Methods
Configure the Messages
Client
class.
See {::Google::Cloud::Dataflow::V1beta3::Messages::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all Messages clients ::Google::Cloud::Dataflow::V1beta3::Messages::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/messages/client.rb, line 55 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
Create a new Messages
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Dataflow::V1beta3::Messages::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Dataflow::V1beta3::Messages::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the Messages
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/dataflow/v1beta3/messages/client.rb, line 110 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/messages_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 @messages_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Dataflow::V1beta3::MessagesV1Beta3::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
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 {::Google::Cloud::Dataflow::V1beta3::Messages::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/messages/client.rb, line 89 def configure yield @config if block_given? @config end
Request the job status.
To request the status of a job, we recommend using `projects.locations.jobs.messages.list` with a [regional endpoint] (cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.messages.list` is not recommended, as you can only request the status of jobs that are running in `us-central1`.
@overload list_job_messages
(request, options = nil)
Pass arguments to `list_job_messages` via a request object, either of type {::Google::Cloud::Dataflow::V1beta3::ListJobMessagesRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload 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)
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). @param project_id [::String] A project id. @param job_id [::String] The job to get messages about. @param minimum_importance [::Google::Cloud::Dataflow::V1beta3::JobMessageImportance] Filter to only get messages with importance >= level @param 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. @param 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. @param 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). @param 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). @param location [::String] The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataflow::V1beta3::JobMessage>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Dataflow::V1beta3::JobMessage>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataflow/v1beta3/messages/client.rb, line 205 def list_job_messages request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::ListJobMessagesRequest # 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.list_job_messages.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.list_job_messages.timeout, metadata: metadata, retry_policy: @config.rpcs.list_job_messages.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @messages_stub.call_rpc :list_job_messages, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @messages_stub, :list_job_messages, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end