Get job metrics (Ruby)
Stay organized with collections
Save and categorize content based on your preferences.
Demonstrates how to get a collection of metrics describing the progress of a job.
Code sample
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],[],[[["\u003cp\u003eThis code snippet demonstrates how to retrieve a collection of metrics that describe the progress of a Dataflow job.\u003c/p\u003e\n"],["\u003cp\u003eThe example uses the \u003ccode\u003eget_job_metrics\u003c/code\u003e method from the \u003ccode\u003eGoogle::Cloud::Dataflow::V1beta3::Metrics::Client\u003c/code\u003e to fetch the metrics.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication to Dataflow requires setting up Application Default Credentials, as detailed in the linked documentation.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eget_job_metrics\u003c/code\u003e method returns an object of type \u003ccode\u003eGoogle::Cloud::Dataflow::V1beta3::JobMetrics\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Get job metrics (Ruby)\n\nDemonstrates how to get a collection of metrics describing the progress of a job.\n\nCode sample\n-----------\n\n### Ruby\n\n\nTo authenticate to Dataflow, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n require \"google/cloud/dataflow/v1beta3\"\n\n ##\n # Snippet for the get_job_metrics call in the Metrics service\n #\n # This snippet has been automatically generated and should be regarded as a code\n # template only. It will require modifications to work:\n # - It may require correct/in-range values for request initialization.\n # - It may require specifying regional endpoints when creating the service\n # client as shown in https://cloud.google.com/ruby/docs/reference.\n #\n # This is an auto-generated example demonstrating basic usage of\n # Google::Cloud::Dataflow::V1beta3::Metrics::Client#get_job_metrics.\n #\n def get_job_metrics\n # Create a client object. The client can be reused for multiple calls.\n client = Google::Cloud::Dataflow::V1beta3::Metrics::Client.new\n\n # Create a request. To set request fields, pass in keyword arguments.\n request = Google::Cloud::Dataflow::V1beta3::GetJobMetricsRequest.new\n\n # Call the get_job_metrics method.\n result = client.get_job_metrics request\n\n # The returned object is of type Google::Cloud::Dataflow::V1beta3::JobMetrics.\n p result\n end\n\nWhat's next\n-----------\n\n\nTo search and filter code samples for other Google Cloud products, see the\n[Google Cloud sample browser](/docs/samples?product=dataflow)."]]