Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / dataflow_v1b3.projects.jobs.messages.html
blob: 91730cc9f1edb0aa018eb0b5a9fd189cfe1013dc [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]75<h1><a href="dataflow_v1b3.html">Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.jobs.html">jobs</a> . <a href="dataflow_v1b3.projects.jobs.messages.html">messages</a></h1>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]78 <code><a href="#list">list(projectId, jobId, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, location=None, minimumImportance=None, endTime=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]85 <code class="details" id="list">list(projectId, jobId, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, location=None, minimumImportance=None, endTime=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]86 <pre>Request the job status.
87
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]88To request the status of a job, we recommend using
89`projects.locations.jobs.messages.list` with a [regional endpoint]
90(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using
91`projects.jobs.messages.list` is not recommended, as you can only request
92the status of jobs that are running in `us-central1`.
93
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]94Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]95 projectId: string, A project id. (required)
96 jobId: string, The job to get messages about. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]97 startTime: string, If specified, return only messages with timestamps >= start_time.
98The default is the job creation time (i.e. beginning of messages).
99 pageSize: integer, If specified, determines the maximum number of messages to
100return. If unspecified, the service may choose an appropriate
101default, or may return an arbitrarily large number of results.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]102 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106 pageToken: string, If supplied, this should be the value of next_page_token returned
107by an earlier call. This will cause the next page of results to
108be returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]109 location: string, The [regional endpoint]
110(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
111contains the job specified by job_id.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]112 minimumImportance: string, Filter to only get messages with importance >= level
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]113 endTime: string, Return only messages with timestamps < end_time. The default is now
114(i.e. return up to the latest messages available).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]115
116Returns:
117 An object of the form:
118
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]119 { # Response to a request to list job messages.
120 "nextPageToken": "A String", # The token to obtain the next page of results if there are more.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]121 "autoscalingEvents": [ # Autoscaling events in ascending timestamp order.
122 { # A structured message reporting an autoscaling decision made by the Dataflow
123 # service.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]124 "description": { # A rich message format, including a human readable string, a key for # A message describing why the system decided to adjust the current
125 # number of workers, why it failed, or why the system decided to
126 # not make any changes to the number of workers.
127 # identifying the message, and structured data associated with the message for
128 # programmatic consumption.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]129 "messageKey": "A String", # Identifier for this message type. Used by external systems to
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]130 # internationalize or personalize message.
131 "messageText": "A String", # Human-readable version of message.
132 "parameters": [ # The structured data associated with this message.
133 { # Structured data associated with this message.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]134 "key": "A String", # Key or name for this parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]135 "value": "", # Value for this parameter.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]136 },
137 ],
138 },
139 "targetNumWorkers": "A String", # The target number of workers the worker pool wants to resize to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]140 "eventType": "A String", # The type of autoscaling event to report.
141 "workerPool": "A String", # A short and friendly name for the worker pool this event refers to,
142 # populated from the value of PoolStageRelation::user_pool_name.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]143 "time": "A String", # The time this event was emitted to indicate a new target or current
144 # num_workers value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]145 "currentNumWorkers": "A String", # The current number of workers the job has.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]146 },
147 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]148 "jobMessages": [ # Messages in ascending timestamp order.
149 { # A particular message pertaining to a Dataflow job.
150 "messageImportance": "A String", # Importance level of the message.
151 "messageText": "A String", # The text of the message.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]152 "id": "A String", # Deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]153 "time": "A String", # The timestamp of the message.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]154 },
155 ],
156 }</pre>
157</div>
158
159<div class="method">
160 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
161 <pre>Retrieves the next page of results.
162
163Args:
164 previous_request: The request for the previous page. (required)
165 previous_response: The response from the request for the previous page. (required)
166
167Returns:
168 A request object that you can call 'execute()' on to request the next
169 page. Returns None if there are no more items in the collection.
170 </pre>
171</div>
172
173</body></html>