Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html
blob: bcb2d8776f39d2fdb67a47c60ee847459ca5122b [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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 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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="bigquerydatatransfer_v1.projects.locations.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, pageToken=None, runAttempt=None, states=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 "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
139 "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
140 "name": "A String", # The resource name of the transfer run.
141 # Transfer run names have the form
142 # `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
143 # The name is ignored when creating a transfer run.
144 "schedule": "A String", # Output only. Describes the schedule of this transfer run if it was
145 # created as part of a regular schedule. For batch transfer runs that are
146 # scheduled manually, this is empty.
147 # NOTE: the system might choose to delay the schedule depending on the
148 # current load, so `schedule_time` doesn't always match this.
149 "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
150 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
151 "state": "A String", # Data transfer run state. Ignored for input requests.
152 "errorStatus": { # The `Status` type defines a logical error model that is suitable for # Status of the transfer run.
153 # different programming environments, including REST APIs and RPC APIs. It is
154 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
155 # three pieces of data: error code, error message, and error details.
156 #
157 # You can find out more about this error model and how to work with it in the
158 # [API Design Guide](https://cloud.google.com/apis/design/errors).
159 "message": "A String", # A developer-facing error message, which should be in English. Any
160 # user-facing error message should be localized and sent in the
161 # google.rpc.Status.details field, or localized by the client.
162 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
163 "details": [ # A list of messages that carry the error details. There is a common set of
164 # message types for APIs to use.
165 {
166 "a_key": "", # Properties of the object. Contains field @type with type URL.
167 },
168 ],
169 },
170 "params": { # Output only. Data transfer specific parameters.
171 "a_key": "", # Properties of the object.
172 },
173 "startTime": "A String", # Output only. Time when transfer run was started.
174 # Parameter ignored by server for input requests.
175 "dataSourceId": "A String", # Output only. Data source id.
176 "runTime": "A String", # For batch transfer runs, specifies the date and time that
177 # data should be ingested.
178 "endTime": "A String", # Output only. Time when transfer run ended.
179 # Parameter ignored by server for input requests.
180 }</pre>
181</div>
182
183<div class="method">
184 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, runAttempt=None, states=None, x__xgafv=None)</code>
185 <pre>Returns information about running and completed jobs.
186
187Args:
188 parent: string, Name of transfer configuration for which transfer runs should be retrieved.
189Format of transfer configuration resource name is:
190`projects/{project_id}/transferConfigs/{config_id}`. (required)
191 pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
192 pageToken: string, Pagination token, which can be used to request a specific page
193of `ListTransferRunsRequest` list results. For multiple-page
194results, `ListTransferRunsResponse` outputs
195a `next_page` token, which can be used as the
196`page_token` value to request the next page of list results.
197 runAttempt: string, Indicates how run attempts are to be pulled.
198 states: string, When specified, only transfer runs with requested states are returned. (repeated)
199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203
204Returns:
205 An object of the form:
206
207 { # The returned list of pipelines in the project.
208 "nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results,
209 # this token can be used as the
210 # `ListTransferRunsRequest.page_token`
211 # to request the next page of list results.
212 "transferRuns": [ # Output only. The stored pipeline transfer runs.
213 { # Represents a data transfer run.
214 "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
215 "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
216 "name": "A String", # The resource name of the transfer run.
217 # Transfer run names have the form
218 # `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
219 # The name is ignored when creating a transfer run.
220 "schedule": "A String", # Output only. Describes the schedule of this transfer run if it was
221 # created as part of a regular schedule. For batch transfer runs that are
222 # scheduled manually, this is empty.
223 # NOTE: the system might choose to delay the schedule depending on the
224 # current load, so `schedule_time` doesn't always match this.
225 "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
226 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
227 "state": "A String", # Data transfer run state. Ignored for input requests.
228 "errorStatus": { # The `Status` type defines a logical error model that is suitable for # Status of the transfer run.
229 # different programming environments, including REST APIs and RPC APIs. It is
230 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
231 # three pieces of data: error code, error message, and error details.
232 #
233 # You can find out more about this error model and how to work with it in the
234 # [API Design Guide](https://cloud.google.com/apis/design/errors).
235 "message": "A String", # A developer-facing error message, which should be in English. Any
236 # user-facing error message should be localized and sent in the
237 # google.rpc.Status.details field, or localized by the client.
238 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
239 "details": [ # A list of messages that carry the error details. There is a common set of
240 # message types for APIs to use.
241 {
242 "a_key": "", # Properties of the object. Contains field @type with type URL.
243 },
244 ],
245 },
246 "params": { # Output only. Data transfer specific parameters.
247 "a_key": "", # Properties of the object.
248 },
249 "startTime": "A String", # Output only. Time when transfer run was started.
250 # Parameter ignored by server for input requests.
251 "dataSourceId": "A String", # Output only. Data source id.
252 "runTime": "A String", # For batch transfer runs, specifies the date and time that
253 # data should be ingested.
254 "endTime": "A String", # Output only. Time when transfer run ended.
255 # Parameter ignored by server for input requests.
256 },
257 ],
258 }</pre>
259</div>
260
261<div class="method">
262 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
263 <pre>Retrieves the next page of results.
264
265Args:
266 previous_request: The request for the previous page. (required)
267 previous_response: The response from the request for the previous page. (required)
268
269Returns:
270 A request object that you can call 'execute()' on to request the next
271 page. Returns None if there are no more items in the collection.
272 </pre>
273</div>
274
275</body></html>