Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class MetricsV1Beta3Client.
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:
$metricsV1Beta3Client = new MetricsV1Beta3Client();
try {
// Iterate over pages of elements
$pagedResponse = $metricsV1Beta3Client->getJobExecutionDetails();
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $metricsV1Beta3Client->getJobExecutionDetails();
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$metricsV1Beta3Client->close();
}
Namespace
Google \ Cloud \ Dataflow \ V1beta3Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
getJobExecutionDetails
Request detailed information about the execution status of the job.
EXPERIMENTAL. This API is subject to change or removal without notice.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ projectId |
string
A project id. |
↳ jobId |
string
The job to get execution details for. |
↳ location |
string
The regional endpoint that contains the job specified by job_id. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataflow\V1beta3\Client\MetricsV1Beta3Client;
use Google\Cloud\Dataflow\V1beta3\GetJobExecutionDetailsRequest;
use Google\Cloud\Dataflow\V1beta3\StageSummary;
/**
* This sample 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,
* please see the apiEndpoint client configuration option for more details.
*/
function get_job_execution_details_sample(): void
{
// Create a client.
$metricsV1Beta3Client = new MetricsV1Beta3Client();
// Prepare the request message.
$request = new GetJobExecutionDetailsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $metricsV1Beta3Client->getJobExecutionDetails($request);
/** @var StageSummary $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
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
.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ projectId |
string
A project id. |
↳ jobId |
string
The job to get metrics for. |
↳ startTime |
Timestamp
Return only metric data that has changed since this time. Default is to return all information about all metrics for the job. |
↳ location |
string
The regional endpoint that contains the job specified by job_id. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataflow\V1beta3\JobMetrics |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataflow\V1beta3\Client\MetricsV1Beta3Client;
use Google\Cloud\Dataflow\V1beta3\GetJobMetricsRequest;
use Google\Cloud\Dataflow\V1beta3\JobMetrics;
/**
* This sample 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,
* please see the apiEndpoint client configuration option for more details.
*/
function get_job_metrics_sample(): void
{
// Create a client.
$metricsV1Beta3Client = new MetricsV1Beta3Client();
// Prepare the request message.
$request = new GetJobMetricsRequest();
// Call the API and handle any network failures.
try {
/** @var JobMetrics $response */
$response = $metricsV1Beta3Client->getJobMetrics($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
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.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ projectId |
string
A project id. |
↳ jobId |
string
The job to get execution details for. |
↳ location |
string
The regional endpoint that contains the job specified by job_id. |
↳ stageId |
string
The stage for which to fetch information. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ startTime |
Timestamp
Lower time bound of work items to include, by start time. |
↳ endTime |
Timestamp
Upper time bound of work items to include, by start time. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataflow\V1beta3\Client\MetricsV1Beta3Client;
use Google\Cloud\Dataflow\V1beta3\GetStageExecutionDetailsRequest;
use Google\Cloud\Dataflow\V1beta3\WorkerDetails;
/**
* This sample 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,
* please see the apiEndpoint client configuration option for more details.
*/
function get_stage_execution_details_sample(): void
{
// Create a client.
$metricsV1Beta3Client = new MetricsV1Beta3Client();
// Prepare the request message.
$request = new GetStageExecutionDetailsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $metricsV1Beta3Client->getStageExecutionDetails($request);
/** @var WorkerDetails $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
Constants
SERVICE_NAME
Value: 'google.dataflow.v1beta3.MetricsV1Beta3'
The name of the service.
SERVICE_ADDRESS
Value: 'dataflow.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.