blob: 71dc9245da136c87ef3753d64cc8c1a3c3d78985 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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="bigquerydatatransfer_v1.html">BigQuery Data Transfer API</a> . <a href="bigquerydatatransfer_v1.projects.html">projects</a> . <a href="bigquerydatatransfer_v1.projects.locations.html">locations</a> . <a href="bigquerydatatransfer_v1.projects.locations.transferConfigs.html">transferConfigs</a> . <a href="bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html">runs</a> . <a href="bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.transferLogs.html">transferLogs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#list">list(parent, pageToken=None, messageTypes=None, x__xgafv=None, pageSize=None)</a></code></p>
79<p class="firstline">Returns user facing log messages for the data transfer run.</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">
85 <code class="details" id="list">list(parent, pageToken=None, messageTypes=None, x__xgafv=None, pageSize=None)</code>
86 <pre>Returns user facing log messages for the data transfer run.
87
88Args:
Dan O'Mearadd494642020-05-01 07:42:23 -070089 parent: string, Required. Transfer run name in the form:
90`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
91`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092 pageToken: string, Pagination token, which can be used to request a specific page
93of `ListTransferLogsRequest` list results. For multiple-page
94results, `ListTransferLogsResponse` outputs
95a `next_page` token, which can be used as the
96`page_token` value to request the next page of list results.
97 messageTypes: string, Message types to return. If not populated - INFO, WARNING and ERROR
98messages are returned. (repeated)
99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
103 pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
104
105Returns:
106 An object of the form:
107
108 { # The returned list transfer run messages.
109 "nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results,
110 # this token can be used as the
111 # `GetTransferRunLogRequest.page_token`
112 # to request the next page of list results.
113 "transferMessages": [ # Output only. The stored pipeline transfer messages.
114 { # Represents a user facing message for a particular data transfer run.
115 "messageTime": "A String", # Time when message was logged.
116 "messageText": "A String", # Message text.
117 "severity": "A String", # Message severity.
118 },
119 ],
120 }</pre>
121</div>
122
123<div class="method">
124 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
125 <pre>Retrieves the next page of results.
126
127Args:
128 previous_request: The request for the previous page. (required)
129 previous_response: The response from the request for the previous page. (required)
130
131Returns:
132 A request object that you can call 'execute()' on to request the next
133 page. Returns None if there are no more items in the collection.
134 </pre>
135</div>
136
137</body></html>