Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / dataflow_v1b3.projects.jobs.messages.html
blob: 37016e420db909928e0b70339827f4a9e092f35f [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]81 <code><a href="#list">list(projectId, jobId, location=None, pageSize=None, pageToken=None, startTime=None, endTime=None, minimumImportance=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.messages.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.messages.list` is not recommended, as you can only request the status of jobs that are running in `us-central1`.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]91
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]92<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]93 <code class="details" id="list">list(projectId, jobId, location=None, pageSize=None, pageToken=None, startTime=None, endTime=None, minimumImportance=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <pre>Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.messages.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.messages.list` is not recommended, as you can only request the status of jobs that are running in `us-central1`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]96Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]97 projectId: string, A project id. (required)
98 jobId: string, The job to get messages about. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]99 location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.
100 pageSize: integer, 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.
101 pageToken: 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]102 startTime: string, If specified, return only messages with timestamps &gt;= start_time. The default is the job creation time (i.e. beginning of messages).
103 endTime: string, Return only messages with timestamps &lt; end_time. The default is now (i.e. return up to the latest messages available).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]104 minimumImportance: string, Filter to only get messages with importance &gt;= level
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]105 Allowed values
106 JOB_MESSAGE_IMPORTANCE_UNKNOWN - The message importance isn&#x27;t specified, or is unknown.
107 JOB_MESSAGE_DEBUG - The message is at the &#x27;debug&#x27; level: typically only useful for software engineers working on the code the job is running. Typically, Dataflow pipeline runners do not display log messages at this level by default.
108 JOB_MESSAGE_DETAILED - The message is at the &#x27;detailed&#x27; level: somewhat verbose, but potentially useful to users. Typically, Dataflow pipeline runners do not display log messages at this level by default. These messages are displayed by default in the Dataflow monitoring UI.
109 JOB_MESSAGE_BASIC - The message is at the &#x27;basic&#x27; level: useful for keeping track of the execution of a Dataflow pipeline. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.
110 JOB_MESSAGE_WARNING - The message is at the &#x27;warning&#x27; level: indicating a condition pertaining to a job which may require human intervention. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.
111 JOB_MESSAGE_ERROR - The message is at the &#x27;error&#x27; level: indicating a condition preventing a job from succeeding. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]112 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]116
117Returns:
118 An object of the form:
119
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]120 { # Response to a request to list job messages.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]121 &quot;jobMessages&quot;: [ # Messages in ascending timestamp order.
122 { # A particular message pertaining to a Dataflow job.
123 &quot;id&quot;: &quot;A String&quot;, # Deprecated.
124 &quot;messageText&quot;: &quot;A String&quot;, # The text of the message.
125 &quot;time&quot;: &quot;A String&quot;, # The timestamp of the message.
126 &quot;messageImportance&quot;: &quot;A String&quot;, # Importance level of the message.
127 },
128 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]129 &quot;autoscalingEvents&quot;: [ # Autoscaling events in ascending timestamp order.
130 { # A structured message reporting an autoscaling decision made by the Dataflow service.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]131 &quot;workerPool&quot;: &quot;A String&quot;, # A short and friendly name for the worker pool this event refers to, populated from the value of PoolStageRelation::user_pool_name.
132 &quot;eventType&quot;: &quot;A String&quot;, # The type of autoscaling event to report.
133 &quot;time&quot;: &quot;A String&quot;, # The time this event was emitted to indicate a new target or current num_workers value.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]134 &quot;currentNumWorkers&quot;: &quot;A String&quot;, # The current number of workers the job has.
135 &quot;description&quot;: { # A rich message format, including a human readable string, a key for identifying the message, and structured data associated with the message for programmatic consumption. # A message describing why the system decided to adjust the current number of workers, why it failed, or why the system decided to not make any changes to the number of workers.
136 &quot;messageText&quot;: &quot;A String&quot;, # Human-readable version of message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]137 &quot;parameters&quot;: [ # The structured data associated with this message.
138 { # Structured data associated with this message.
139 &quot;value&quot;: &quot;&quot;, # Value for this parameter.
140 &quot;key&quot;: &quot;A String&quot;, # Key or name for this parameter.
141 },
142 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]143 &quot;messageKey&quot;: &quot;A String&quot;, # Identifier for this message type. Used by external systems to internationalize or personalize message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]144 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]145 &quot;targetNumWorkers&quot;: &quot;A String&quot;, # The target number of workers the worker pool wants to resize to use.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]146 },
147 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]148 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token to obtain the next page of results if there are more.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
154 <pre>Retrieves the next page of results.
155
156Args:
157 previous_request: The request for the previous page. (required)
158 previous_response: The response from the request for the previous page. (required)
159
160Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 A request object that you can call &#x27;execute()&#x27; on to request the next
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]162 page. Returns None if there are no more items in the collection.
163 </pre>
164</div>
165
166</body></html>