Google Cloud Dataflow V1beta3 Client - Class GetStageExecutionDetailsRequest (0.6.5)

Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class GetStageExecutionDetailsRequest.

Request to get information about a particular execution stage of a job.

Currently only tracked for Batch jobs.

Generated from protobuf message google.dataflow.v1beta3.GetStageExecutionDetailsRequest

Namespace

Google \ Cloud \ Dataflow \ V1beta3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ project_id string

A project id.

↳ job_id string

The job to get execution details for.

↳ location string

The regional endpoint that contains the job specified by job_id.

↳ stage_id string

The stage for which to fetch information.

↳ page_size int

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.

↳ page_token string

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.

↳ start_time Google\Protobuf\Timestamp

Lower time bound of work items to include, by start time.

↳ end_time Google\Protobuf\Timestamp

Upper time bound of work items to include, by start time.

getProjectId

A project id.

Returns
Type Description
string

setProjectId

A project id.

Parameter
Name Description
var string
Returns
Type Description
$this

getJobId

The job to get execution details for.

Returns
Type Description
string

setJobId

The job to get execution details for.

Parameter
Name Description
var string
Returns
Type Description
$this

getLocation

The regional endpoint that contains the job specified by job_id.

Returns
Type Description
string

setLocation

The regional endpoint that contains the job specified by job_id.

Parameter
Name Description
var string
Returns
Type Description
$this

getStageId

The stage for which to fetch information.

Returns
Type Description
string

setStageId

The stage for which to fetch information.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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.

Returns
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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.

Returns
Type Description
string

setPageToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getStartTime

Lower time bound of work items to include, by start time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Lower time bound of work items to include, by start time.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEndTime

Upper time bound of work items to include, by start time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Upper time bound of work items to include, by start time.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this