Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ba8c235185d73c50911d3e1ef511904b474fee2 / . / docs / dyn / bigquerydatatransfer_v1.projects.transferConfigs.runs.html
blob: 8c7412f784a70a63e56cec0b7d51c5bba8d600e3 [file] [log] [blame]
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[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
75<h1><a href="bigquerydatatransfer_v1.html">BigQuery Data Transfer Service API</a> . <a href="bigquerydatatransfer_v1.projects.html">projects</a> . <a href="bigquerydatatransfer_v1.projects.transferConfigs.html">transferConfigs</a> . <a href="bigquerydatatransfer_v1.projects.transferConfigs.runs.html">runs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="bigquerydatatransfer_v1.projects.transferConfigs.runs.transferLogs.html">transferLogs()</a></code>
79</p>
80<p class="firstline">Returns the transferLogs Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
84<p class="firstline">Deletes the specified transfer run.</p>
85<p class="toc_element">
86 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Returns information about the particular transfer run.</p>
88<p class="toc_element">
89 <code><a href="#list">list(parent, pageSize=None, runAttempt=None, statuses=None, pageToken=None, x__xgafv=None)</a></code></p>
90<p class="firstline">Returns information about running and completed jobs.</p>
91<p class="toc_element">
92 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
93<p class="firstline">Retrieves the next page of results.</p>
94<h3>Method Details</h3>
95<div class="method">
96 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
97 <pre>Deletes the specified transfer run.
98
99Args:
100 name: string, The field will contain name of the resource requested, for example:
101`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107Returns:
108 An object of the form:
109
110 { # A generic empty message that you can re-use to avoid defining duplicated
111 # empty messages in your APIs. A typical example is to use it as the request
112 # or the response type of an API method. For instance:
113 #
114 # service Foo {
115 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
116 # }
117 #
118 # The JSON representation for `Empty` is empty JSON object `{}`.
119 }</pre>
120</div>
121
122<div class="method">
123 <code class="details" id="get">get(name, x__xgafv=None)</code>
124 <pre>Returns information about the particular transfer run.
125
126Args:
127 name: string, The field will contain name of the resource requested, for example:
128`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
129 x__xgafv: string, V1 error format.
130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
133
134Returns:
135 An object of the form:
136
137 { # Represents a data transfer run.
138 "status": "A String", # Data transfer run status. Ignored for input requests.
139 # @OutputOnly
140 "updateTime": "A String", # Last time the data transfer run status was updated.
141 # @OutputOnly
142 "destinationDatasetId": "A String", # The BigQuery target dataset id.
143 "name": "A String", # The resource name of the transfer run.
144 # Transfer run names have the form
145 # `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`.
146 # The name is ignored when creating a transfer run.
147 "schedule": "A String", # Describes the schedule of this transfer run if it was created as part of
148 # a regular schedule. For batch transfer runs that are directly created,
149 # this is empty.
150 # NOTE: the system might choose to delay the schedule depending on the
151 # current load, so `schedule_time` doesn't always matches this.
152 # @OutputOnly
153 "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
154 "userId": "A String", # The user id for this transfer run.
155 # @OutputOnly
156 "dataSourceId": "A String", # Data source id.
157 # @OutputOnly
158 "startTime": "A String", # Time when transfer run was started. Parameter ignored by server for input
159 # requests.
160 # @OutputOnly
161 "params": { # Data transfer specific parameters.
162 "a_key": "", # Properties of the object.
163 },
164 "runTime": "A String", # For batch transfer runs, specifies the date and time that
165 # data should be ingested.
166 "endTime": "A String", # Time when transfer run ended. Parameter ignored by server for input
167 # requests.
168 # @OutputOnly
169 }</pre>
170</div>
171
172<div class="method">
173 <code class="details" id="list">list(parent, pageSize=None, runAttempt=None, statuses=None, pageToken=None, x__xgafv=None)</code>
174 <pre>Returns information about running and completed jobs.
175
176Args:
177 parent: string, Name of transfer configuration for which transfer runs should be retrieved.
178Format of transfer configuration resource name is:
179`projects/{project_id}/transferConfigs/{config_id}`. (required)
180 pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
181 runAttempt: string, Indicates how run attempts are to be pulled.
182 statuses: string, When specified, only transfer runs with requested statuses are returned. (repeated)
183 pageToken: string, Pagination token, which can be used to request a specific page
184of `ListTransferRunsRequest` list results. For multiple-page
185results, `ListTransferRunsResponse` outputs
186a `next_page` token, which can be used as the
187`page_token` value to request the next page of list results.
188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
192
193Returns:
194 An object of the form:
195
196 { # The returned list of pipelines in the project.
197 "nextPageToken": "A String", # The next-pagination token. For multiple-page list results,
198 # this token can be used as the
199 # `ListTransferRunsRequest.page_token`
200 # to request the next page of list results.
201 # @OutputOnly
202 "transferRuns": [ # The stored pipeline transfer runs.
203 # @OutputOnly
204 { # Represents a data transfer run.
205 "status": "A String", # Data transfer run status. Ignored for input requests.
206 # @OutputOnly
207 "updateTime": "A String", # Last time the data transfer run status was updated.
208 # @OutputOnly
209 "destinationDatasetId": "A String", # The BigQuery target dataset id.
210 "name": "A String", # The resource name of the transfer run.
211 # Transfer run names have the form
212 # `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`.
213 # The name is ignored when creating a transfer run.
214 "schedule": "A String", # Describes the schedule of this transfer run if it was created as part of
215 # a regular schedule. For batch transfer runs that are directly created,
216 # this is empty.
217 # NOTE: the system might choose to delay the schedule depending on the
218 # current load, so `schedule_time` doesn't always matches this.
219 # @OutputOnly
220 "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
221 "userId": "A String", # The user id for this transfer run.
222 # @OutputOnly
223 "dataSourceId": "A String", # Data source id.
224 # @OutputOnly
225 "startTime": "A String", # Time when transfer run was started. Parameter ignored by server for input
226 # requests.
227 # @OutputOnly
228 "params": { # Data transfer specific parameters.
229 "a_key": "", # Properties of the object.
230 },
231 "runTime": "A String", # For batch transfer runs, specifies the date and time that
232 # data should be ingested.
233 "endTime": "A String", # Time when transfer run ended. Parameter ignored by server for input
234 # requests.
235 # @OutputOnly
236 },
237 ],
238 }</pre>
239</div>
240
241<div class="method">
242 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
243 <pre>Retrieves the next page of results.
244
245Args:
246 previous_request: The request for the previous page. (required)
247 previous_response: The response from the request for the previous page. (required)
248
249Returns:
250 A request object that you can call 'execute()' on to request the next
251 page. Returns None if there are no more items in the collection.
252 </pre>
253</div>
254
255</body></html>