1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="dataflow_v1b3.projects.locations.jobs.html">jobs()</a></code> 79 </p> 80 <p class="firstline">Returns the jobs Resource.</p> 81 82 <p class="toc_element"> 83 <code><a href="dataflow_v1b3.projects.locations.templates.html">templates()</a></code> 84 </p> 85 <p class="firstline">Returns the templates Resource.</p> 86 87 <p class="toc_element"> 88 <code><a href="#workerMessages">workerMessages(projectId, location, body, x__xgafv=None)</a></code></p> 89 <p class="firstline">Send a worker_message to the service.</p> 90 <h3>Method Details</h3> 91 <div class="method"> 92 <code class="details" id="workerMessages">workerMessages(projectId, location, body, x__xgafv=None)</code> 93 <pre>Send a worker_message to the service. 94 95 Args: 96 projectId: string, The project to send the WorkerMessages to. (required) 97 location: string, The location which contains the job (required) 98 body: object, The request body. (required) 99 The object takes the form of: 100 101 { # A request for sending worker messages to the service. 102 "workerMessages": [ # The WorkerMessages to send. 103 { # WorkerMessage provides information to the backend about a worker. 104 "workerHealthReport": { # WorkerHealthReport contains information about the health of a worker. # The health of a worker. 105 # 106 # The VM should be identified by the labels attached to the WorkerMessage that 107 # this health ping belongs to. 108 "vmStartupTime": "A String", # The time the VM was booted. 109 "reportInterval": "A String", # The interval at which the worker is sending health reports. 110 # The default value of 0 should be interpreted as the field is not being 111 # explicitly set by the worker. 112 "pods": [ # The pods running on the worker. See: 113 # http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod 114 # 115 # This field is used by the worker to send the status of the indvidual 116 # containers running on each worker. 117 { 118 "a_key": "", # Properties of the object. 119 }, 120 ], 121 "vmIsHealthy": True or False, # Whether the VM is healthy. 122 }, 123 "labels": { # Labels are used to group WorkerMessages. 124 # For example, a worker_message about a particular container 125 # might have the labels: 126 # { "JOB_ID": "2015-04-22", 127 # "WORKER_ID": "wordcount-vm-2015" 128 # "CONTAINER_TYPE": "worker", 129 # "CONTAINER_ID": "ac1234def"} 130 # Label tags typically correspond to Label enum values. However, for ease 131 # of development other strings can be used as tags. LABEL_UNSPECIFIED should 132 # not be used here. 133 "a_key": "A String", 134 }, 135 "workerMetrics": { # Worker metrics exported from workers. This contains resource utilization # Resource metrics reported by workers. 136 # metrics accumulated from a variety of sources. For more information, see 137 # go/df-resource-signals. 138 "cpuTime": [ # CPU utilization samples. 139 { # Modeled after information exposed by /proc/stat. 140 "totalMs": "A String", # Total active CPU time across all cores (ie., non-idle) in milliseconds 141 # since start-up. 142 "rate": 3.14, # Average CPU utilization rate (% non-idle cpu / second) since previous 143 # sample. 144 "timestamp": "A String", # Timestamp of the measurement. 145 }, 146 ], 147 }, 148 "workerMessageCode": { # A message code is used to report status and error messages to the service. # A worker message code. 149 # The message codes are intended to be machine readable. The service will 150 # take care of translating these into user understandable messages if 151 # necessary. 152 # 153 # Example use cases: 154 # 1. Worker processes reporting successful startup. 155 # 2. Worker processes reporting specific errors (e.g. package staging 156 # failure). 157 "code": "A String", # The code is a string intended for consumption by a machine that identifies 158 # the type of message being sent. 159 # Examples: 160 # 1. "HARNESS_STARTED" might be used to indicate the worker harness has 161 # started. 162 # 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading 163 # a GCS file as part of the boot process of one of the worker containers. 164 # 165 # This is a string and not an enum to make it easy to add new codes without 166 # waiting for an API change. 167 "parameters": { # Parameters contains specific information about the code. 168 # 169 # This is a struct to allow parameters of different types. 170 # 171 # Examples: 172 # 1. For a "HARNESS_STARTED" message parameters might provide the name 173 # of the worker and additional data like timing information. 174 # 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing 175 # the GCS objects being downloaded and fields containing errors. 176 # 177 # In general complex data structures should be avoided. If a worker 178 # needs to send a specific and complicated data structure then please 179 # consider defining a new proto and adding it to the data oneof in 180 # WorkerMessageResponse. 181 # 182 # Conventions: 183 # Parameters should only be used for information that isn't typically passed 184 # as a label. 185 # hostname and other worker identifiers should almost always be passed 186 # as labels since they will be included on most messages. 187 "a_key": "", # Properties of the object. 188 }, 189 }, 190 "time": "A String", # The timestamp of the worker_message. 191 }, 192 ], 193 "location": "A String", # The location which contains the job 194 } 195 196 x__xgafv: string, V1 error format. 197 Allowed values 198 1 - v1 error format 199 2 - v2 error format 200 201 Returns: 202 An object of the form: 203 204 { # The response to the worker messages. 205 "workerMessageResponses": [ # The servers response to the worker messages. 206 { # A worker_message response allows the server to pass information to the 207 # sender. 208 "workerHealthReportResponse": { # WorkerHealthReportResponse contains information returned to the worker # The service's response to a worker's health report. 209 # in response to a health ping. 210 "reportInterval": "A String", # A positive value indicates the worker should change its reporting interval 211 # to the specified value. 212 # 213 # The default value of zero means no change in report rate is requested by 214 # the server. 215 }, 216 "workerMetricsResponse": { # Service-side response to WorkerMessage reporting resource utilization. # Service's response to reporting worker metrics (currently empty). 217 }, 218 }, 219 ], 220 }</pre> 221 </div> 222 223 </body></html>
