Receber detalhes da execução do job

Demonstra como solicitar informações detalhadas sobre o status da execução do job.

Exemplo de código

C#

Para autenticar no Dataflow, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

using Google.Api.Gax;
using Google.Cloud.Dataflow.V1Beta3;
using System;

public sealed partial class GeneratedMetricsV1Beta3ClientSnippets
{
    /// <summary>Snippet for GetJobExecutionDetails</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 void GetJobExecutionDetailsRequestObject()
    {
        // Create client
        MetricsV1Beta3Client metricsV1Beta3Client = MetricsV1Beta3Client.Create();
        // Initialize request argument(s)
        GetJobExecutionDetailsRequest request = new GetJobExecutionDetailsRequest
        {
            ProjectId = "",
            JobId = "",
            Location = "",
        };
        // Make the request
        PagedEnumerable<JobExecutionDetails, StageSummary> response = metricsV1Beta3Client.GetJobExecutionDetails(request);

        // Iterate over all response items, lazily performing RPCs as required
        foreach (StageSummary item in response)
        {
            // Do something with each item
            Console.WriteLine(item);
        }

        // Or iterate over pages (of server-defined size), performing one RPC per page
        foreach (JobExecutionDetails page in response.AsRawResponses())
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (StageSummary item in page)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
        }

        // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
        int pageSize = 10;
        Page<StageSummary> singlePage = response.ReadPage(pageSize);
        // Do something with the page of items
        Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
        foreach (StageSummary item in singlePage)
        {
            // Do something with each item
            Console.WriteLine(item);
        }
        // Store the pageToken, for when the next page is required.
        string nextPageToken = singlePage.NextPageToken;
    }
}

Go

Para autenticar no Dataflow, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.


//go:build examples

package main

import (
	"context"

	dataflow "cloud.google.com/go/dataflow/apiv1beta3"
	dataflowpb "cloud.google.com/go/dataflow/apiv1beta3/dataflowpb"
	"google.golang.org/api/iterator"
)

func main() {
	ctx := context.Background()
	// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataflow.NewMetricsV1Beta3Client(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataflowpb.GetJobExecutionDetailsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataflow/apiv1beta3/dataflowpb#GetJobExecutionDetailsRequest.
	}
	it := c.GetJobExecutionDetails(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*dataflowpb.JobExecutionDetails)
	}
}

Java

Para autenticar no Dataflow, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

import com.google.dataflow.v1beta3.GetJobExecutionDetailsRequest;
import com.google.dataflow.v1beta3.MetricsV1Beta3Client;
import com.google.dataflow.v1beta3.StageSummary;

public class SyncGetJobExecutionDetails {

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

  public static void syncGetJobExecutionDetails() 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()) {
      GetJobExecutionDetailsRequest request =
          GetJobExecutionDetailsRequest.newBuilder()
              .setProjectId("projectId-894832108")
              .setJobId("jobId101296568")
              .setLocation("location1901043637")
              .setPageSize(883849137)
              .setPageToken("pageToken873572522")
              .build();
      for (StageSummary element :
          metricsV1Beta3Client.getJobExecutionDetails(request).iterateAll()) {
        // doThingsWith(element);
      }
    }
  }
}

Node.js

Para autenticar no Dataflow, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

'use strict';

const {MetricsV1Beta3Client} = require('@google-cloud/dataflow');
const {status} = require('@grpc/grpc-js');

const client = new MetricsV1Beta3Client();

/**
 * Use the getJobExecutionDetails method
 *
 * @param {string} projectId - The Google Cloud project ID containing the Dataflow job.
 * @param {string} locationId - The regional endpoint/location of the Dataflow job (e.g., 'us-central1').
 * @param {string} jobId - The server-generated ID of the Dataflow job.
 */
async function getJobExecutionDetails(projectId, locationId, jobId) {
  try {
    const request = {
      projectId,
      location: locationId,
      jobId,
    };

    const [response] = await client.getJobExecutionDetails(request);
    console.log(`Execution details retrieved for job: ${jobId}`);

    if (response.stages) {
      for (const stage of response.stages) {
        console.log(`Stage ID: ${stage.stageId}, State: ${stage.state}`);
      }
    }

    return response;
  } catch (err) {
    if (err.code === status.NOT_FOUND) {
      console.error(`Dataflow job execution details not found: ${err.message}`);
    } else if (err.code === status.INVALID_ARGUMENT) {
      console.error(`Invalid argument provided: ${err.message}`);
    } else {
      console.error(`Error retrieving job execution details: ${err.message}`);
    }
    throw err;
  }
}

module.exports = { getJobExecutionDetails };

Python

Para autenticar no Dataflow, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

import google.api_core.exceptions
from google.cloud import dataflow_v1beta3


def get_job_execution_details(
    project_id: str, location_id: str, job_id: str
) -> None:
    """Retrieves execution details for a Cloud Dataflow job.

    Args:
        project_id: The ID of the Google Cloud project that contains the Dataflow job.
        location_id: The regional endpoint where the Dataflow job is running (for example, 'us-central1').
        job_id: The server-generated ID of the Dataflow job to retrieve execution details for.
    """
    client = dataflow_v1beta3.MetricsV1Beta3Client()

    try:
        request = dataflow_v1beta3.GetJobExecutionDetailsRequest(
            project_id=project_id,
            location=location_id,
            job_id=job_id,
        )
        response = client.get_job_execution_details(request=request)

        print(f"Retrieved execution details for job: {job_id}")
        has_stages = False
        for stage in response:
            has_stages = True
            print(f"Stage ID: {stage.stage_id}")
            print(f"Stage State: {stage.state.name}")

        if not has_stages:
            print("No stages found for this job.")
    except google.api_core.exceptions.GoogleAPICallError as error:
        print(f"Failed to retrieve job execution details: {error}")

A seguir

Para pesquisar e filtrar exemplos de código de outros Google Cloud produtos, consulte a Google Cloud pesquisa de exemplos de código.