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">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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#list">list(projectId, location, jobId, endTime=None, minimumImportance=None, pageSize=None, pageToken=None, startTime=None, x__xgafv=None)</a></code></p> 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> 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"> 88 <code class="details" id="close">close()</code> 89 <pre>Close httplib2 connections.</pre> 90</div> 91 92<div class="method"> 93 <code class="details" id="list">list(projectId, location, jobId, endTime=None, minimumImportance=None, pageSize=None, pageToken=None, startTime=None, x__xgafv=None)</code> 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`. 95 96Args: 97 projectId: string, A project id. (required) 98 location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. (required) 99 jobId: string, The job to get messages about. (required) 100 endTime: string, Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available). 101 minimumImportance: string, Filter to only get messages with importance >= level 102 Allowed values 103 JOB_MESSAGE_IMPORTANCE_UNKNOWN - The message importance isn't specified, or is unknown. 104 JOB_MESSAGE_DEBUG - The message is at the 'debug' 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. 105 JOB_MESSAGE_DETAILED - The message is at the 'detailed' 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. 106 JOB_MESSAGE_BASIC - The message is at the 'basic' 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. 107 JOB_MESSAGE_WARNING - The message is at the 'warning' 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. 108 JOB_MESSAGE_ERROR - The message is at the 'error' 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. 109 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. 110 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. 111 startTime: string, If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages). 112 x__xgafv: string, V1 error format. 113 Allowed values 114 1 - v1 error format 115 2 - v2 error format 116 117Returns: 118 An object of the form: 119 120 { # Response to a request to list job messages. 121 "autoscalingEvents": [ # Autoscaling events in ascending timestamp order. 122 { # A structured message reporting an autoscaling decision made by the Dataflow service. 123 "currentNumWorkers": "A String", # The current number of workers the job has. 124 "description": { # 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. 125 "messageKey": "A String", # Identifier for this message type. Used by external systems to internationalize or personalize message. 126 "messageText": "A String", # Human-readable version of message. 127 "parameters": [ # The structured data associated with this message. 128 { # Structured data associated with this message. 129 "key": "A String", # Key or name for this parameter. 130 "value": "", # Value for this parameter. 131 }, 132 ], 133 }, 134 "eventType": "A String", # The type of autoscaling event to report. 135 "targetNumWorkers": "A String", # The target number of workers the worker pool wants to resize to use. 136 "time": "A String", # The time this event was emitted to indicate a new target or current num_workers value. 137 "workerPool": "A String", # A short and friendly name for the worker pool this event refers to. 138 }, 139 ], 140 "jobMessages": [ # Messages in ascending timestamp order. 141 { # A particular message pertaining to a Dataflow job. 142 "id": "A String", # Deprecated. 143 "messageImportance": "A String", # Importance level of the message. 144 "messageText": "A String", # The text of the message. 145 "time": "A String", # The timestamp of the message. 146 }, 147 ], 148 "nextPageToken": "A String", # The token to obtain the next page of results if there are more. 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: 161 A request object that you can call 'execute()' on to request the next 162 page. Returns None if there are no more items in the collection. 163 </pre> 164</div> 165 166</body></html>