1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="bigquerydatatransfer_v1.html">BigQuery Data Transfer 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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="bigquerydatatransfer_v1.projects.transferConfigs.runs.transferLogs.html">transferLogs()</a></code>
</p>
<p class="firstline">Returns the transferLogs Resource.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified transfer run.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns information about the particular transfer run.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, runAttempt=None, states=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns information about running and completed jobs.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes the specified transfer run.
Args:
name: string, The field will contain name of the resource requested, for example:
`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Returns information about the particular transfer run.
Args:
name: string, The field will contain name of the resource requested, for example:
`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a data transfer run.
"updateTime": "A String", # Output only. Last time the data transfer run state was updated.
"destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
"name": "A String", # The resource name of the transfer run.
# Transfer run names have the form
# `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
# The name is ignored when creating a transfer run.
"schedule": "A String", # Output only. Describes the schedule of this transfer run if it was
# created as part of a regular schedule. For batch transfer runs that are
# scheduled manually, this is empty.
# NOTE: the system might choose to delay the schedule depending on the
# current load, so `schedule_time` doesn't always match this.
"scheduleTime": "A String", # Minimum time after which a transfer run can be started.
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
"state": "A String", # Data transfer run state. Ignored for input requests.
"errorStatus": { # The `Status` type defines a logical error model that is suitable for # Status of the transfer run.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"params": { # Output only. Data transfer specific parameters.
"a_key": "", # Properties of the object.
},
"startTime": "A String", # Output only. Time when transfer run was started.
# Parameter ignored by server for input requests.
"dataSourceId": "A String", # Output only. Data source id.
"runTime": "A String", # For batch transfer runs, specifies the date and time that
# data should be ingested.
"endTime": "A String", # Output only. Time when transfer run ended.
# Parameter ignored by server for input requests.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, runAttempt=None, states=None, x__xgafv=None)</code>
<pre>Returns information about running and completed jobs.
Args:
parent: string, Name of transfer configuration for which transfer runs should be retrieved.
Format of transfer configuration resource name is:
`projects/{project_id}/transferConfigs/{config_id}`. (required)
pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
pageToken: string, Pagination token, which can be used to request a specific page
of `ListTransferRunsRequest` list results. For multiple-page
results, `ListTransferRunsResponse` outputs
a `next_page` token, which can be used as the
`page_token` value to request the next page of list results.
runAttempt: string, Indicates how run attempts are to be pulled.
states: string, When specified, only transfer runs with requested states are returned. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The returned list of pipelines in the project.
"nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results,
# this token can be used as the
# `ListTransferRunsRequest.page_token`
# to request the next page of list results.
"transferRuns": [ # Output only. The stored pipeline transfer runs.
{ # Represents a data transfer run.
"updateTime": "A String", # Output only. Last time the data transfer run state was updated.
"destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
"name": "A String", # The resource name of the transfer run.
# Transfer run names have the form
# `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
# The name is ignored when creating a transfer run.
"schedule": "A String", # Output only. Describes the schedule of this transfer run if it was
# created as part of a regular schedule. For batch transfer runs that are
# scheduled manually, this is empty.
# NOTE: the system might choose to delay the schedule depending on the
# current load, so `schedule_time` doesn't always match this.
"scheduleTime": "A String", # Minimum time after which a transfer run can be started.
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
"state": "A String", # Data transfer run state. Ignored for input requests.
"errorStatus": { # The `Status` type defines a logical error model that is suitable for # Status of the transfer run.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"params": { # Output only. Data transfer specific parameters.
"a_key": "", # Properties of the object.
},
"startTime": "A String", # Output only. Time when transfer run was started.
# Parameter ignored by server for input requests.
"dataSourceId": "A String", # Output only. Data source id.
"runTime": "A String", # For batch transfer runs, specifies the date and time that
# data should be ingested.
"endTime": "A String", # Output only. Time when transfer run ended.
# Parameter ignored by server for input requests.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
