Get job metrics (async)

Demonstrates how to get a collection of metrics describing the detailed progress of a job.

Code sample

C#

To authenticate to Dataflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.

using Google.Cloud.Dataflow.V1Beta3;
using Google.Protobuf.WellKnownTypes;
using System.Threading.Tasks;

public sealed partial class GeneratedMetricsV1Beta3ClientSnippets
{
    /// <summary>Snippet for GetJobMetricsAsync</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public async Task GetJobMetricsRequestObjectAsync()
    {
        // Create client
        MetricsV1Beta3Client metricsV1Beta3Client = await MetricsV1Beta3Client.CreateAsync();
        // Initialize request argument(s)
        GetJobMetricsRequest request = new GetJobMetricsRequest
        {
            ProjectId = "",
            JobId = "",
            StartTime = new Timestamp(),
            Location = "",
        };
        // Make the request
        JobMetrics response = await metricsV1Beta3Client.GetJobMetricsAsync(request);
    }
}

Java

To authenticate to Dataflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.

import com.google.api.core.ApiFuture;
import com.google.dataflow.v1beta3.GetJobMetricsRequest;
import com.google.dataflow.v1beta3.JobMetrics;
import com.google.dataflow.v1beta3.MetricsV1Beta3Client;
import com.google.protobuf.Timestamp;

public class AsyncGetJobMetrics {

  public static void main(String[] args) throws Exception {
    asyncGetJobMetrics();
  }

  public static void asyncGetJobMetrics() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (MetricsV1Beta3Client metricsV1Beta3Client = MetricsV1Beta3Client.create()) {
      GetJobMetricsRequest request =
          GetJobMetricsRequest.newBuilder()
              .setProjectId("projectId-894832108")
              .setJobId("jobId101296568")
              .setStartTime(Timestamp.newBuilder().build())
              .setLocation("location1901043637")
              .build();
      ApiFuture<JobMetrics> future =
          metricsV1Beta3Client.getJobMetricsCallable().futureCall(request);
      // Do something.
      JobMetrics response = future.get();
    }
  }
}

Node.js

To authenticate to Dataflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  A project id.
 */
// const projectId = 'abc123'
/**
 *  The job to get metrics for.
 */
// const jobId = 'abc123'
/**
 *  Return only metric data that has changed since this time.
 *  Default is to return all information about all metrics for the job.
 */
// const startTime = {}
/**
 *  The regional endpoint 
 *  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
 *  contains the job specified by job_id.
 */
// const location = 'abc123'

// Imports the Dataflow library
const {MetricsV1Beta3Client} = require('@google-cloud/dataflow').v1beta3;

// Instantiates a client
const dataflowClient = new MetricsV1Beta3Client();

async function callGetJobMetrics() {
  // Construct request
  const request = {
  };

  // Run request
  const response = await dataflowClient.getJobMetrics(request);
  console.log(response);
}

callGetJobMetrics();

Python

To authenticate to Dataflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataflow_v1beta3


async def sample_get_job_metrics():
    # Create a client
    client = dataflow_v1beta3.MetricsV1Beta3AsyncClient()

    # Initialize request argument(s)
    request = dataflow_v1beta3.GetJobMetricsRequest(
    )

    # Make the request
    response = await client.get_job_metrics(request=request)

    # Handle the response
    print(response)

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser.