Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html
blob: c8e65e8f5341f7b39f63f1d1d5474520cddc64bb [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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]100 name: string, Required. The field will contain name of the resource requested, for example:
101`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
102`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
107
108Returns:
109 An object of the form:
110
111 { # A generic empty message that you can re-use to avoid defining duplicated
112 # empty messages in your APIs. A typical example is to use it as the request
113 # or the response type of an API method. For instance:
114 #
115 # service Foo {
116 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
117 # }
118 #
119 # The JSON representation for `Empty` is empty JSON object `{}`.
120 }</pre>
121</div>
122
123<div class="method">
124 <code class="details" id="get">get(name, x__xgafv=None)</code>
125 <pre>Returns information about the particular transfer run.
126
127Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]128 name: string, Required. The field will contain name of the resource requested, for example:
129`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
130`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
135
136Returns:
137 An object of the form:
138
139 { # Represents a data transfer run.
140 "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
141 "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
142 "name": "A String", # The resource name of the transfer run.
143 # Transfer run names have the form
144 # `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
145 # The name is ignored when creating a transfer run.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]146 "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this
147 # transfer run finishes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 "schedule": "A String", # Output only. Describes the schedule of this transfer run if it was
149 # created as part of a regular schedule. For batch transfer runs that are
150 # scheduled manually, this is empty.
151 # NOTE: the system might choose to delay the schedule depending on the
152 # current load, so `schedule_time` doesn't always match this.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]153 "startTime": "A String", # Output only. Time when transfer run was started.
154 # Parameter ignored by server for input requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]156 "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 "state": "A String", # Data transfer run state. Ignored for input requests.
158 "errorStatus": { # The `Status` type defines a logical error model that is suitable for # Status of the transfer run.
159 # different programming environments, including REST APIs and RPC APIs. It is
160 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
161 # three pieces of data: error code, error message, and error details.
162 #
163 # You can find out more about this error model and how to work with it in the
164 # [API Design Guide](https://cloud.google.com/apis/design/errors).
165 "message": "A String", # A developer-facing error message, which should be in English. Any
166 # user-facing error message should be localized and sent in the
167 # google.rpc.Status.details field, or localized by the client.
168 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
169 "details": [ # A list of messages that carry the error details. There is a common set of
170 # message types for APIs to use.
171 {
172 "a_key": "", # Properties of the object. Contains field @type with type URL.
173 },
174 ],
175 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]176 "dataSourceId": "A String", # Output only. Data source id.
177 "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Output only. Email notifications will be sent according to these
178 # preferences to the email address of the user who owns the transfer config
179 # this run was derived from.
180 # events.
181 "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
182 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 "params": { # Output only. Data transfer specific parameters.
184 "a_key": "", # Properties of the object.
185 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]186 "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be
187 # ingested.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 "endTime": "A String", # Output only. Time when transfer run ended.
189 # Parameter ignored by server for input requests.
190 }</pre>
191</div>
192
193<div class="method">
194 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, runAttempt=None, states=None, x__xgafv=None)</code>
195 <pre>Returns information about running and completed jobs.
196
197Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]198 parent: string, Required. Name of transfer configuration for which transfer runs should be retrieved.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]199Format of transfer configuration resource name is:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]200`projects/{project_id}/transferConfigs/{config_id}` or
201`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202 pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
203 pageToken: string, Pagination token, which can be used to request a specific page
204of `ListTransferRunsRequest` list results. For multiple-page
205results, `ListTransferRunsResponse` outputs
206a `next_page` token, which can be used as the
207`page_token` value to request the next page of list results.
208 runAttempt: string, Indicates how run attempts are to be pulled.
209 states: string, When specified, only transfer runs with requested states are returned. (repeated)
210 x__xgafv: string, V1 error format.
211 Allowed values
212 1 - v1 error format
213 2 - v2 error format
214
215Returns:
216 An object of the form:
217
218 { # The returned list of pipelines in the project.
219 "nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results,
220 # this token can be used as the
221 # `ListTransferRunsRequest.page_token`
222 # to request the next page of list results.
223 "transferRuns": [ # Output only. The stored pipeline transfer runs.
224 { # Represents a data transfer run.
225 "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
226 "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
227 "name": "A String", # The resource name of the transfer run.
228 # Transfer run names have the form
229 # `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
230 # The name is ignored when creating a transfer run.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]231 "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this
232 # transfer run finishes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]233 "schedule": "A String", # Output only. Describes the schedule of this transfer run if it was
234 # created as part of a regular schedule. For batch transfer runs that are
235 # scheduled manually, this is empty.
236 # NOTE: the system might choose to delay the schedule depending on the
237 # current load, so `schedule_time` doesn't always match this.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]238 "startTime": "A String", # Output only. Time when transfer run was started.
239 # Parameter ignored by server for input requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]241 "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]242 "state": "A String", # Data transfer run state. Ignored for input requests.
243 "errorStatus": { # The `Status` type defines a logical error model that is suitable for # Status of the transfer run.
244 # different programming environments, including REST APIs and RPC APIs. It is
245 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
246 # three pieces of data: error code, error message, and error details.
247 #
248 # You can find out more about this error model and how to work with it in the
249 # [API Design Guide](https://cloud.google.com/apis/design/errors).
250 "message": "A String", # A developer-facing error message, which should be in English. Any
251 # user-facing error message should be localized and sent in the
252 # google.rpc.Status.details field, or localized by the client.
253 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
254 "details": [ # A list of messages that carry the error details. There is a common set of
255 # message types for APIs to use.
256 {
257 "a_key": "", # Properties of the object. Contains field @type with type URL.
258 },
259 ],
260 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]261 "dataSourceId": "A String", # Output only. Data source id.
262 "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Output only. Email notifications will be sent according to these
263 # preferences to the email address of the user who owns the transfer config
264 # this run was derived from.
265 # events.
266 "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
267 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]268 "params": { # Output only. Data transfer specific parameters.
269 "a_key": "", # Properties of the object.
270 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]271 "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be
272 # ingested.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]273 "endTime": "A String", # Output only. Time when transfer run ended.
274 # Parameter ignored by server for input requests.
275 },
276 ],
277 }</pre>
278</div>
279
280<div class="method">
281 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
282 <pre>Retrieves the next page of results.
283
284Args:
285 previous_request: The request for the previous page. (required)
286 previous_response: The response from the request for the previous page. (required)
287
288Returns:
289 A request object that you can call 'execute()' on to request the next
290 page. Returns None if there are no more items in the collection.
291 </pre>
292</div>
293
294</body></html>