Get stage execution details (async)

Demonstrates how to get information about the workers and work items within a stage.

Code sample

C#JavaNode.jsPython

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

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

public sealed partial class GeneratedMetricsV1Beta3ClientSnippets
{
    /// <summary>Snippet for GetStageExecutionDetailsAsync</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 GetStageExecutionDetailsRequestObjectAsync()
    {
        // Create client
        MetricsV1Beta3Client metricsV1Beta3Client = await MetricsV1Beta3Client.CreateAsync();
        // Initialize request argument(s)
        GetStageExecutionDetailsRequest request = new GetStageExecutionDetailsRequest
        {
            ProjectId = "",
            JobId = "",
            Location = "",
            StageId = "",
            StartTime = new Timestamp(),
            EndTime = new Timestamp(),
        };
        // Make the request
        PagedAsyncEnumerable<StageExecutionDetails, WorkerDetails> response = metricsV1Beta3Client.GetStageExecutionDetailsAsync(request);

        // Iterate over all response items, lazily performing RPCs as required
        await response.ForEachAsync((WorkerDetails item) =>
        {
            // Do something with each item
            Console.WriteLine(item);
        });

        // Or iterate over pages (of server-defined size), performing one RPC per page
        await response.AsRawResponses().ForEachAsync((StageExecutionDetails page) =>
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (WorkerDetails 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<WorkerDetails> singlePage = await response.ReadPageAsync(pageSize);
        // Do something with the page of items
        Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
        foreach (WorkerDetails 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;
    }
}

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.GetStageExecutionDetailsRequest;
import com.google.dataflow.v1beta3.MetricsV1Beta3Client;
import com.google.dataflow.v1beta3.WorkerDetails;
import com.google.protobuf.Timestamp;

public class AsyncGetStageExecutionDetails {

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

  public static void asyncGetStageExecutionDetails() 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()) {
      GetStageExecutionDetailsRequest request =
          GetStageExecutionDetailsRequest.newBuilder()
              .setProjectId("projectId-894832108")
              .setJobId("jobId101296568")
              .setLocation("location1901043637")
              .setStageId("stageId-1897528135")
              .setPageSize(883849137)
              .setPageToken("pageToken873572522")
              .setStartTime(Timestamp.newBuilder().build())
              .setEndTime(Timestamp.newBuilder().build())
              .build();
      ApiFuture<WorkerDetails> future =
          metricsV1Beta3Client.getStageExecutionDetailsPagedCallable().futureCall(request);
      // Do something.
      for (WorkerDetails element : future.get().iterateAll()) {
        // doThingsWith(element);
      }
    }
  }
}

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 execution details for.
 */
// const jobId = 'abc123'
/**
 *  The regional endpoint 
 *  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
 *  contains the job specified by job_id.
 */
// const location = 'abc123'
/**
 *  The stage for which to fetch information.
 */
// const stageId = 'abc123'
/**
 *  If specified, determines the maximum number of work items to
 *  return.  If unspecified, the service may choose an appropriate
 *  default, or may return an arbitrarily large number of results.
 */
// const pageSize = 1234
/**
 *  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.
 */
// const pageToken = 'abc123'
/**
 *  Lower time bound of work items to include, by start time.
 */
// const startTime = {}
/**
 *  Upper time bound of work items to include, by start time.
 */
// const endTime = {}

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

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

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

  // Run request
  const iterable = dataflowClient.getStageExecutionDetailsAsync(request);
  for await (const response of iterable) {
      console.log(response);
  }
}

callGetStageExecutionDetails();

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_stage_execution_details():
    # Create a client
    client = dataflow_v1beta3.MetricsV1Beta3AsyncClient()

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

    # Make the request
    page_result = client.get_stage_execution_details(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

What's next

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