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 | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string | |
setProjectId
A project id.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getJobId
The job to get messages about.
| Returns | |
|---|---|
| Type | Description |
string | |
setJobId
The job to get messages about.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMinimumImportance
Filter to only get messages with importance >= level
| Returns | |
|---|---|
| Type | Description |
int | |
setMinimumImportance
Filter to only get messages with importance >= level
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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
If specified, return only messages with timestamps >= start_time.
The default is the job creation time (i.e. beginning of messages).
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| 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 | |