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="datastream_v1alpha1.html">Datastream API</a> . <a href="datastream_v1alpha1.projects.html">projects</a> . <a href="datastream_v1alpha1.projects.locations.html">locations</a> . <a href="datastream_v1alpha1.projects.locations.streams.html">streams</a> . <a href="datastream_v1alpha1.projects.locations.streams.objects.html">objects</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="#get">get(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Use this method to get details about a stream object.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Use this method to list the objects of a specific stream.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<p class="toc_element"> 90 <code><a href="#startBackfillJob">startBackfillJob(object, x__xgafv=None)</a></code></p> 91<p class="firstline">Starts backfill job for the specified stream object.</p> 92<p class="toc_element"> 93 <code><a href="#stopBackfillJob">stopBackfillJob(object, x__xgafv=None)</a></code></p> 94<p class="firstline">Stops the backfill job for the specified stream object.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="get">get(name, x__xgafv=None)</code> 103 <pre>Use this method to get details about a stream object. 104 105Args: 106 name: string, Required. The name of the stream object resource to get. (required) 107 x__xgafv: string, V1 error format. 108 Allowed values 109 1 - v1 error format 110 2 - v2 error format 111 112Returns: 113 An object of the form: 114 115 { # A specific stream object (e.g a specific DB table). 116 "backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object. 117 "errors": [ # Output only. Errors which caused the backfill job to fail. 118 { # Represent a user-facing Error. 119 "details": { # Additional information about the error. 120 "a_key": "A String", 121 }, 122 "errorTime": "A String", # The time when the error occurred. 123 "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. 124 "message": "A String", # A message containing more information about the error that occurred. 125 "reason": "A String", # A title that explains the reason for the error. 126 }, 127 ], 128 "lastEndTime": "A String", # Output only. Backfill job's end time. 129 "lastStartTime": "A String", # Output only. Backfill job's start time. 130 "state": "A String", # Backfill job state. 131 "trigger": "A String", # Backfill job's triggering reason. 132 }, 133 "createTime": "A String", # Output only. The creation time of the object. 134 "displayName": "A String", # Required. Display name. 135 "errors": [ # Output only. Active errors on the object. 136 { # Represent a user-facing Error. 137 "details": { # Additional information about the error. 138 "a_key": "A String", 139 }, 140 "errorTime": "A String", # The time when the error occurred. 141 "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. 142 "message": "A String", # A message containing more information about the error that occurred. 143 "reason": "A String", # A title that explains the reason for the error. 144 }, 145 ], 146 "name": "A String", # Output only. The object's name. 147 "sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source. 148 "mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier. 149 "database": "A String", # The database name. 150 "table": "A String", # The table name. 151 }, 152 "oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier. 153 "schema": "A String", # The schema name. 154 "table": "A String", # The table name. 155 }, 156 }, 157 "updateTime": "A String", # Output only. The last update time of the object. 158}</pre> 159</div> 160 161<div class="method"> 162 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 163 <pre>Use this method to list the objects of a specific stream. 164 165Args: 166 parent: string, Required. The parent stream that owns the collection of objects. (required) 167 pageSize: integer, Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000. 168 pageToken: string, Page token received from a previous `ListStreamObjectsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStreamObjectsRequest` must match the call that provided the page token. 169 x__xgafv: string, V1 error format. 170 Allowed values 171 1 - v1 error format 172 2 - v2 error format 173 174Returns: 175 An object of the form: 176 177 { # Response containing the objects for a stream. 178 "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. 179 "streamObjects": [ # List of stream objects. 180 { # A specific stream object (e.g a specific DB table). 181 "backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object. 182 "errors": [ # Output only. Errors which caused the backfill job to fail. 183 { # Represent a user-facing Error. 184 "details": { # Additional information about the error. 185 "a_key": "A String", 186 }, 187 "errorTime": "A String", # The time when the error occurred. 188 "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. 189 "message": "A String", # A message containing more information about the error that occurred. 190 "reason": "A String", # A title that explains the reason for the error. 191 }, 192 ], 193 "lastEndTime": "A String", # Output only. Backfill job's end time. 194 "lastStartTime": "A String", # Output only. Backfill job's start time. 195 "state": "A String", # Backfill job state. 196 "trigger": "A String", # Backfill job's triggering reason. 197 }, 198 "createTime": "A String", # Output only. The creation time of the object. 199 "displayName": "A String", # Required. Display name. 200 "errors": [ # Output only. Active errors on the object. 201 { # Represent a user-facing Error. 202 "details": { # Additional information about the error. 203 "a_key": "A String", 204 }, 205 "errorTime": "A String", # The time when the error occurred. 206 "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. 207 "message": "A String", # A message containing more information about the error that occurred. 208 "reason": "A String", # A title that explains the reason for the error. 209 }, 210 ], 211 "name": "A String", # Output only. The object's name. 212 "sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source. 213 "mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier. 214 "database": "A String", # The database name. 215 "table": "A String", # The table name. 216 }, 217 "oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier. 218 "schema": "A String", # The schema name. 219 "table": "A String", # The table name. 220 }, 221 }, 222 "updateTime": "A String", # Output only. The last update time of the object. 223 }, 224 ], 225}</pre> 226</div> 227 228<div class="method"> 229 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 230 <pre>Retrieves the next page of results. 231 232Args: 233 previous_request: The request for the previous page. (required) 234 previous_response: The response from the request for the previous page. (required) 235 236Returns: 237 A request object that you can call 'execute()' on to request the next 238 page. Returns None if there are no more items in the collection. 239 </pre> 240</div> 241 242<div class="method"> 243 <code class="details" id="startBackfillJob">startBackfillJob(object, x__xgafv=None)</code> 244 <pre>Starts backfill job for the specified stream object. 245 246Args: 247 object: string, Required. The name of the stream object resource to start a backfill job for. (required) 248 x__xgafv: string, V1 error format. 249 Allowed values 250 1 - v1 error format 251 2 - v2 error format 252 253Returns: 254 An object of the form: 255 256 { # Response for manually initiating a backfill job for a specific stream object. 257 "object": { # A specific stream object (e.g a specific DB table). # The stream object resource a backfill job was started for. 258 "backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object. 259 "errors": [ # Output only. Errors which caused the backfill job to fail. 260 { # Represent a user-facing Error. 261 "details": { # Additional information about the error. 262 "a_key": "A String", 263 }, 264 "errorTime": "A String", # The time when the error occurred. 265 "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. 266 "message": "A String", # A message containing more information about the error that occurred. 267 "reason": "A String", # A title that explains the reason for the error. 268 }, 269 ], 270 "lastEndTime": "A String", # Output only. Backfill job's end time. 271 "lastStartTime": "A String", # Output only. Backfill job's start time. 272 "state": "A String", # Backfill job state. 273 "trigger": "A String", # Backfill job's triggering reason. 274 }, 275 "createTime": "A String", # Output only. The creation time of the object. 276 "displayName": "A String", # Required. Display name. 277 "errors": [ # Output only. Active errors on the object. 278 { # Represent a user-facing Error. 279 "details": { # Additional information about the error. 280 "a_key": "A String", 281 }, 282 "errorTime": "A String", # The time when the error occurred. 283 "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. 284 "message": "A String", # A message containing more information about the error that occurred. 285 "reason": "A String", # A title that explains the reason for the error. 286 }, 287 ], 288 "name": "A String", # Output only. The object's name. 289 "sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source. 290 "mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier. 291 "database": "A String", # The database name. 292 "table": "A String", # The table name. 293 }, 294 "oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier. 295 "schema": "A String", # The schema name. 296 "table": "A String", # The table name. 297 }, 298 }, 299 "updateTime": "A String", # Output only. The last update time of the object. 300 }, 301}</pre> 302</div> 303 304<div class="method"> 305 <code class="details" id="stopBackfillJob">stopBackfillJob(object, x__xgafv=None)</code> 306 <pre>Stops the backfill job for the specified stream object. 307 308Args: 309 object: string, Required. The name of the stream object resource to stop the backfill job for. (required) 310 x__xgafv: string, V1 error format. 311 Allowed values 312 1 - v1 error format 313 2 - v2 error format 314 315Returns: 316 An object of the form: 317 318 { # Response for manually stop a backfill job for a specific stream object. 319 "object": { # A specific stream object (e.g a specific DB table). # The stream object resource the backfill job was stopped for. 320 "backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object. 321 "errors": [ # Output only. Errors which caused the backfill job to fail. 322 { # Represent a user-facing Error. 323 "details": { # Additional information about the error. 324 "a_key": "A String", 325 }, 326 "errorTime": "A String", # The time when the error occurred. 327 "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. 328 "message": "A String", # A message containing more information about the error that occurred. 329 "reason": "A String", # A title that explains the reason for the error. 330 }, 331 ], 332 "lastEndTime": "A String", # Output only. Backfill job's end time. 333 "lastStartTime": "A String", # Output only. Backfill job's start time. 334 "state": "A String", # Backfill job state. 335 "trigger": "A String", # Backfill job's triggering reason. 336 }, 337 "createTime": "A String", # Output only. The creation time of the object. 338 "displayName": "A String", # Required. Display name. 339 "errors": [ # Output only. Active errors on the object. 340 { # Represent a user-facing Error. 341 "details": { # Additional information about the error. 342 "a_key": "A String", 343 }, 344 "errorTime": "A String", # The time when the error occurred. 345 "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. 346 "message": "A String", # A message containing more information about the error that occurred. 347 "reason": "A String", # A title that explains the reason for the error. 348 }, 349 ], 350 "name": "A String", # Output only. The object's name. 351 "sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source. 352 "mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier. 353 "database": "A String", # The database name. 354 "table": "A String", # The table name. 355 }, 356 "oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier. 357 "schema": "A String", # The schema name. 358 "table": "A String", # The table name. 359 }, 360 }, 361 "updateTime": "A String", # Output only. The last update time of the object. 362 }, 363}</pre> 364</div> 365 366</body></html>