Dataflow v1beta3 API - Class MetricsV1Beta3Client (2.0.0-beta06)

public abstract class MetricsV1Beta3Client

Reference documentation and code samples for the Dataflow v1beta3 API class MetricsV1Beta3Client.

MetricsV1Beta3 client wrapper, for convenient use.

Inheritance

object > MetricsV1Beta3Client

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

MetricsV1Beta3ClientImpl

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Remarks

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

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the MetricsV1Beta3 service, which is a host of "dataflow.googleapis.com" and a port of 443.

Property Value
Type	Description
`string`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default MetricsV1Beta3 scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default MetricsV1Beta3 scopes are:

GrpcClient

public virtual MetricsV1Beta3.MetricsV1Beta3Client GrpcClient { get; }

The underlying gRPC MetricsV1Beta3 client

Property Value
Type	Description
`MetricsV1Beta3MetricsV1Beta3Client`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

Methods

Create()

public static MetricsV1Beta3Client Create()

Synchronously creates a MetricsV1Beta3Client using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MetricsV1Beta3ClientBuilder.

Returns
Type	Description
`MetricsV1Beta3Client`	The created MetricsV1Beta3Client.

CreateAsync(CancellationToken)

public static Task<MetricsV1Beta3Client> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a MetricsV1Beta3Client using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MetricsV1Beta3ClientBuilder.

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`TaskMetricsV1Beta3Client`	The task representing the created MetricsV1Beta3Client.

GetJobExecutionDetails(GetJobExecutionDetailsRequest, CallSettings)

public virtual PagedEnumerable<JobExecutionDetails, StageSummary> GetJobExecutionDetails(GetJobExecutionDetailsRequest request, CallSettings callSettings = null)

Request detailed information about the execution status of the job.

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

Parameters
Name	Description
`request`	`GetJobExecutionDetailsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableJobExecutionDetailsStageSummary`	A pageable sequence of StageSummary resources.

Example

// 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;

GetJobExecutionDetailsAsync(GetJobExecutionDetailsRequest, CallSettings)

public virtual PagedAsyncEnumerable<JobExecutionDetails, StageSummary> GetJobExecutionDetailsAsync(GetJobExecutionDetailsRequest request, CallSettings callSettings = null)

Request detailed information about the execution status of the job.

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

Parameters
Name	Description
`request`	`GetJobExecutionDetailsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableJobExecutionDetailsStageSummary`	A pageable asynchronous sequence of StageSummary resources.

Example

// Create client
MetricsV1Beta3Client metricsV1Beta3Client = await MetricsV1Beta3Client.CreateAsync();
// Initialize request argument(s)
GetJobExecutionDetailsRequest request = new GetJobExecutionDetailsRequest
{
    ProjectId = "",
    JobId = "",
    Location = "",
};
// Make the request
PagedAsyncEnumerable<JobExecutionDetails, StageSummary> response = metricsV1Beta3Client.GetJobExecutionDetailsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((StageSummary 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((JobExecutionDetails page) =>
{
    // 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 = 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 (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;

GetJobMetrics(GetJobMetricsRequest, CallSettings)

public virtual JobMetrics GetJobMetrics(GetJobMetricsRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
`request`	`GetJobMetricsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`JobMetrics`	The RPC response.

Example

// Create client
MetricsV1Beta3Client metricsV1Beta3Client = MetricsV1Beta3Client.Create();
// Initialize request argument(s)
GetJobMetricsRequest request = new GetJobMetricsRequest
{
    ProjectId = "",
    JobId = "",
    StartTime = new Timestamp(),
    Location = "",
};
// Make the request
JobMetrics response = metricsV1Beta3Client.GetJobMetrics(request);

GetJobMetricsAsync(GetJobMetricsRequest, CallSettings)

public virtual Task<JobMetrics> GetJobMetricsAsync(GetJobMetricsRequest request, CallSettings callSettings = null)

Request the job status.

Parameters
Name	Description
`request`	`GetJobMetricsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskJobMetrics`	A Task containing the RPC response.

Example

// 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);

GetJobMetricsAsync(GetJobMetricsRequest, CancellationToken)

public virtual Task<JobMetrics> GetJobMetricsAsync(GetJobMetricsRequest request, CancellationToken cancellationToken)

Request the job status.

Parameters
Name	Description
`request`	`GetJobMetricsRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskJobMetrics`	A Task containing the RPC response.

Example

// 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);

GetStageExecutionDetails(GetStageExecutionDetailsRequest, CallSettings)

public virtual PagedEnumerable<StageExecutionDetails, WorkerDetails> GetStageExecutionDetails(GetStageExecutionDetailsRequest request, CallSettings callSettings = null)

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

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

Parameters
Name	Description
`request`	`GetStageExecutionDetailsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableStageExecutionDetailsWorkerDetails`	A pageable sequence of WorkerDetails resources.

Example

// Create client
MetricsV1Beta3Client metricsV1Beta3Client = MetricsV1Beta3Client.Create();
// Initialize request argument(s)
GetStageExecutionDetailsRequest request = new GetStageExecutionDetailsRequest
{
    ProjectId = "",
    JobId = "",
    Location = "",
    StageId = "",
    StartTime = new Timestamp(),
    EndTime = new Timestamp(),
};
// Make the request
PagedEnumerable<StageExecutionDetails, WorkerDetails> response = metricsV1Beta3Client.GetStageExecutionDetails(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (WorkerDetails 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 (StageExecutionDetails page in response.AsRawResponses())
{
    // 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 = response.ReadPage(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;

GetStageExecutionDetailsAsync(GetStageExecutionDetailsRequest, CallSettings)

public virtual PagedAsyncEnumerable<StageExecutionDetails, WorkerDetails> GetStageExecutionDetailsAsync(GetStageExecutionDetailsRequest request, CallSettings callSettings = null)

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

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

Parameters
Name	Description
`request`	`GetStageExecutionDetailsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableStageExecutionDetailsWorkerDetails`	A pageable asynchronous sequence of WorkerDetails resources.

Example

// 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;

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
`Task`	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.