Class MetricsV1Beta3Client (0.55.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: The Dataflow Metrics API lets you monitor the progress of Dataflow jobs.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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();
   JobMetrics response = metricsV1Beta3Client.getJobMetrics(request);
 }

Note: close() needs to be called on the MetricsV1Beta3Client object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

GetJobMetrics

Request the job status.

To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a regional endpoint. Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getJobMetrics(GetJobMetricsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getJobMetricsCallable()

GetJobExecutionDetails

Request detailed information about the execution status of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getJobExecutionDetails(GetJobExecutionDetailsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getJobExecutionDetailsPagedCallable()

  • getJobExecutionDetailsCallable()

GetStageExecutionDetails

Request detailed information about the execution status of a stage of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getStageExecutionDetails(GetStageExecutionDetailsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getStageExecutionDetailsPagedCallable()

  • getStageExecutionDetailsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of MetricsV1Beta3Settings to create(). For example:

To customize credentials:


 // 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
 MetricsV1Beta3Settings metricsV1Beta3Settings =
     MetricsV1Beta3Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MetricsV1Beta3Client metricsV1Beta3Client = MetricsV1Beta3Client.create(metricsV1Beta3Settings);

To customize the endpoint:


 // 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
 MetricsV1Beta3Settings metricsV1Beta3Settings =
     MetricsV1Beta3Settings.newBuilder().setEndpoint(myEndpoint).build();
 MetricsV1Beta3Client metricsV1Beta3Client = MetricsV1Beta3Client.create(metricsV1Beta3Settings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 MetricsV1Beta3Settings metricsV1Beta3Settings =
     MetricsV1Beta3Settings.newHttpJsonBuilder().build();
 MetricsV1Beta3Client metricsV1Beta3Client = MetricsV1Beta3Client.create(metricsV1Beta3Settings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > MetricsV1Beta3Client

Static Methods

create()

public static final MetricsV1Beta3Client create()

Constructs an instance of MetricsV1Beta3Client with default settings.

Returns
Type Description
MetricsV1Beta3Client
Exceptions
Type Description
IOException

create(MetricsV1Beta3Settings settings)

public static final MetricsV1Beta3Client create(MetricsV1Beta3Settings settings)

Constructs an instance of MetricsV1Beta3Client, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings MetricsV1Beta3Settings
Returns
Type Description
MetricsV1Beta3Client
Exceptions
Type Description
IOException

create(MetricsV1Beta3Stub stub)

public static final MetricsV1Beta3Client create(MetricsV1Beta3Stub stub)

Constructs an instance of MetricsV1Beta3Client, using the given stub for making calls. This is for advanced usage - prefer using create(MetricsV1Beta3Settings).

Parameter
Name Description
stub MetricsV1Beta3Stub
Returns
Type Description
MetricsV1Beta3Client

Constructors

MetricsV1Beta3Client(MetricsV1Beta3Settings settings)

protected MetricsV1Beta3Client(MetricsV1Beta3Settings settings)

Constructs an instance of MetricsV1Beta3Client, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings MetricsV1Beta3Settings

MetricsV1Beta3Client(MetricsV1Beta3Stub stub)

protected MetricsV1Beta3Client(MetricsV1Beta3Stub stub)
Parameter
Name Description
stub MetricsV1Beta3Stub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

getJobExecutionDetails(GetJobExecutionDetailsRequest request)

public final MetricsV1Beta3Client.GetJobExecutionDetailsPagedResponse getJobExecutionDetails(GetJobExecutionDetailsRequest request)

Request detailed information about the execution status of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Sample code:


 // 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);
   }
 }
Parameter
Name Description
request GetJobExecutionDetailsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
MetricsV1Beta3Client.GetJobExecutionDetailsPagedResponse

getJobExecutionDetailsCallable()

public final UnaryCallable<GetJobExecutionDetailsRequest,JobExecutionDetails> getJobExecutionDetailsCallable()

Request detailed information about the execution status of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Sample code:


 // 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();
   while (true) {
     JobExecutionDetails response =
         metricsV1Beta3Client.getJobExecutionDetailsCallable().call(request);
     for (StageSummary element : response.getStagesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<GetJobExecutionDetailsRequest,JobExecutionDetails>

getJobExecutionDetailsPagedCallable()

public final UnaryCallable<GetJobExecutionDetailsRequest,MetricsV1Beta3Client.GetJobExecutionDetailsPagedResponse> getJobExecutionDetailsPagedCallable()

Request detailed information about the execution status of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Sample code:


 // 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();
   ApiFuture<StageSummary> future =
       metricsV1Beta3Client.getJobExecutionDetailsPagedCallable().futureCall(request);
   // Do something.
   for (StageSummary element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<GetJobExecutionDetailsRequest,GetJobExecutionDetailsPagedResponse>

getJobMetrics(GetJobMetricsRequest request)

public final JobMetrics getJobMetrics(GetJobMetricsRequest request)

Request the job status.

To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a regional endpoint. Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1.

Sample code:


 // 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();
   JobMetrics response = metricsV1Beta3Client.getJobMetrics(request);
 }
Parameter
Name Description
request GetJobMetricsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
JobMetrics

getJobMetricsCallable()

public final UnaryCallable<GetJobMetricsRequest,JobMetrics> getJobMetricsCallable()

Request the job status.

To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a regional endpoint. Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1.

Sample code:


 // 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();
 }
Returns
Type Description
UnaryCallable<GetJobMetricsRequest,JobMetrics>

getSettings()

public final MetricsV1Beta3Settings getSettings()
Returns
Type Description
MetricsV1Beta3Settings

getStageExecutionDetails(GetStageExecutionDetailsRequest request)

public final MetricsV1Beta3Client.GetStageExecutionDetailsPagedResponse getStageExecutionDetails(GetStageExecutionDetailsRequest request)

Request detailed information about the execution status of a stage of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Sample code:


 // 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();
   for (WorkerDetails element :
       metricsV1Beta3Client.getStageExecutionDetails(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request GetStageExecutionDetailsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
MetricsV1Beta3Client.GetStageExecutionDetailsPagedResponse

getStageExecutionDetailsCallable()

public final UnaryCallable<GetStageExecutionDetailsRequest,StageExecutionDetails> getStageExecutionDetailsCallable()

Request detailed information about the execution status of a stage of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Sample code:


 // 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();
   while (true) {
     StageExecutionDetails response =
         metricsV1Beta3Client.getStageExecutionDetailsCallable().call(request);
     for (WorkerDetails element : response.getWorkersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<GetStageExecutionDetailsRequest,StageExecutionDetails>

getStageExecutionDetailsPagedCallable()

public final UnaryCallable<GetStageExecutionDetailsRequest,MetricsV1Beta3Client.GetStageExecutionDetailsPagedResponse> getStageExecutionDetailsPagedCallable()

Request detailed information about the execution status of a stage of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Sample code:


 // 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);
   }
 }
Returns
Type Description
UnaryCallable<GetStageExecutionDetailsRequest,GetStageExecutionDetailsPagedResponse>

getStub()

public MetricsV1Beta3Stub getStub()
Returns
Type Description
MetricsV1Beta3Stub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()