• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dataflow_v1b3.html">Google Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.locations.html">locations</a> . <a href="dataflow_v1b3.projects.locations.jobs.html">jobs</a> . <a href="dataflow_v1b3.projects.locations.jobs.messages.html">messages</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(projectId, location, jobId, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, minimumImportance=None, endTime=None)</a></code></p>
79<p class="firstline">Request the job status.</p>
80<p class="toc_element">
81  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="list">list(projectId, location, jobId, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, minimumImportance=None, endTime=None)</code>
86  <pre>Request the job status.
87
88Args:
89  projectId: string, A project id. (required)
90  location: string, The location which contains the job specified by job_id. (required)
91  jobId: string, The job to get messages about. (required)
92  startTime: string, If specified, return only messages with timestamps >= start_time.
93The default is the job creation time (i.e. beginning of messages).
94  pageSize: integer, If specified, determines the maximum number of messages to
95return.  If unspecified, the service may choose an appropriate
96default, or may return an arbitrarily large number of results.
97  x__xgafv: string, V1 error format.
98    Allowed values
99      1 - v1 error format
100      2 - v2 error format
101  pageToken: string, If supplied, this should be the value of next_page_token returned
102by an earlier call. This will cause the next page of results to
103be returned.
104  minimumImportance: string, Filter to only get messages with importance >= level
105  endTime: string, Return only messages with timestamps < end_time. The default is now
106(i.e. return up to the latest messages available).
107
108Returns:
109  An object of the form:
110
111    { # Response to a request to list job messages.
112    "nextPageToken": "A String", # The token to obtain the next page of results if there are more.
113    "autoscalingEvents": [ # Autoscaling events in ascending timestamp order.
114      { # A structured message reporting an autoscaling decision made by the Dataflow
115          # service.
116        "eventType": "A String", # The type of autoscaling event to report.
117        "currentNumWorkers": "A String", # The current number of workers the job has.
118        "description": { # A rich message format, including a human readable string, a key for # A message describing why the system decided to adjust the current
119            # number of workers, why it failed, or why the system decided to
120            # not make any changes to the number of workers.
121            # identifying the message, and structured data associated with the message for
122            # programmatic consumption.
123          "messageKey": "A String", # Idenfier for this message type.  Used by external systems to
124              # internationalize or personalize message.
125          "messageText": "A String", # Human-readable version of message.
126          "parameters": [ # The structured data associated with this message.
127            { # Structured data associated with this message.
128              "value": "", # Value for this parameter.
129              "key": "A String", # Key or name for this parameter.
130            },
131          ],
132        },
133        "targetNumWorkers": "A String", # The target number of workers the worker pool wants to resize to use.
134        "time": "A String", # The time this event was emitted to indicate a new target or current
135            # num_workers value.
136      },
137    ],
138    "jobMessages": [ # Messages in ascending timestamp order.
139      { # A particular message pertaining to a Dataflow job.
140        "messageImportance": "A String", # Importance level of the message.
141        "messageText": "A String", # The text of the message.
142        "id": "A String", # Deprecated.
143        "time": "A String", # The timestamp of the message.
144      },
145    ],
146  }</pre>
147</div>
148
149<div class="method">
150    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
151  <pre>Retrieves the next page of results.
152
153Args:
154  previous_request: The request for the previous page. (required)
155  previous_response: The response from the request for the previous page. (required)
156
157Returns:
158  A request object that you can call 'execute()' on to request the next
159  page. Returns None if there are no more items in the collection.
160    </pre>
161</div>
162
163</body></html>