Google Cloud Dataflow V1beta3 Client - Class ListJobMessagesRequest (0.3.10)

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

Request to list job messages.

Up to max_results messages will be returned in the time range specified starting with the oldest messages first. If no time range is specified the results with start with the oldest message.

Generated from protobuf message google.dataflow.v1beta3.ListJobMessagesRequest

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 messages about.

↳ minimum_importance int

Filter to only get messages with importance >= level

↳ page_size int

If specified, determines the maximum number of messages 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

If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).

↳ end_time Google\Protobuf\Timestamp

Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).

↳ location string

The regional endpoint that contains the job specified by job_id.

getProjectId

A project id.

Returns
TypeDescription
string

setProjectId

A project id.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getJobId

The job to get messages about.

Returns
TypeDescription
string

setJobId

The job to get messages about.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMinimumImportance

Filter to only get messages with importance >= level

Returns
TypeDescription
int

setMinimumImportance

Filter to only get messages with importance >= level

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageSize

If specified, determines the maximum number of messages 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 messages 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

If specified, return only messages with timestamps >= start_time.

The default is the job creation time (i.e. beginning of messages).

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

If specified, return only messages with timestamps >= start_time.

The default is the job creation time (i.e. beginning of messages).

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

getEndTime

Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).

Parameter
NameDescription
var Google\Protobuf\Timestamp
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