Google Cloud Dataflow V1beta3 Client - Class GetStageExecutionDetailsRequest (0.5.1)

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
NameDescription
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
TypeDescription
string

setProjectId

A project id.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getJobId

The job to get execution details for.

Returns
TypeDescription
string

setJobId

The job to get execution details for.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLocation

The regional endpoint that contains the job specified by job_id.

Returns
TypeDescription
string

setLocation

The regional endpoint that contains the job specified by job_id.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStageId

The stage for which to fetch information.

Returns
TypeDescription
string

setStageId

The stage for which to fetch information.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getStartTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this