Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html
blob: 787cceb126c521177e7d1be83d5c52daf82cb7c9 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes the specified transfer run.</p>
88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Returns information about the particular transfer run.</p>
91<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]92 <code><a href="#list">list(parent, states=None, runAttempt=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93<p class="firstline">Returns information about running and completed jobs.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
97<h3>Method Details</h3>
98<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]99 <code class="details" id="close">close()</code>
100 <pre>Close httplib2 connections.</pre>
101</div>
102
103<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
105 <pre>Deletes the specified transfer run.
106
107Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]108 name: string, Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113
114Returns:
115 An object of the form:
116
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]117 { # 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 `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 }</pre>
119</div>
120
121<div class="method">
122 <code class="details" id="get">get(name, x__xgafv=None)</code>
123 <pre>Returns information about the particular transfer run.
124
125Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126 name: string, Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132Returns:
133 An object of the form:
134
135 { # Represents a data transfer run.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]136 &quot;notificationPubsubTopic&quot;: &quot;A String&quot;, # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]137 &quot;state&quot;: &quot;A String&quot;, # Data transfer run state. Ignored for input requests.
138 &quot;scheduleTime&quot;: &quot;A String&quot;, # Minimum time after which a transfer run can be started.
139 &quot;runTime&quot;: &quot;A String&quot;, # For batch transfer runs, specifies the date and time of the data should be ingested.
140 &quot;name&quot;: &quot;A String&quot;, # 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.
141 &quot;userId&quot;: &quot;A String&quot;, # Deprecated. Unique ID of the user on whose behalf transfer is done.
142 &quot;schedule&quot;: &quot;A String&quot;, # 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&#x27;t always match this.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]143 &quot;emailPreferences&quot;: { # Represents preferences for sending email notifications for transfer run events. # Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
144 &quot;enableFailureEmail&quot;: True or False, # If true, email notifications will be sent on transfer run failures.
145 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]146 &quot;dataSourceId&quot;: &quot;A String&quot;, # Output only. Data source id.
147 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time when transfer run was started. Parameter ignored by server for input requests.
148 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
149 &quot;params&quot;: { # Output only. Data transfer specific parameters.
150 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
151 },
152 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the data transfer run state was updated.
153 &quot;destinationDatasetId&quot;: &quot;A String&quot;, # Output only. The BigQuery target dataset id.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]154 &quot;errorStatus&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # Status of the transfer run.
155 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]157 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 },
159 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]160 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]161 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 }</pre>
164</div>
165
166<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]167 <code class="details" id="list">list(parent, states=None, runAttempt=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168 <pre>Returns information about running and completed jobs.
169
170Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]171 parent: string, Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 states: string, When specified, only transfer runs with requested states are returned. (repeated)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]173 Allowed values
174 TRANSFER_STATE_UNSPECIFIED - State placeholder.
175 PENDING - Data transfer is scheduled and is waiting to be picked up by data transfer backend.
176 RUNNING - Data transfer is in progress.
177 SUCCEEDED - Data transfer completed successfully.
178 FAILED - Data transfer failed.
179 CANCELLED - Data transfer is cancelled.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]180 runAttempt: string, Indicates how run attempts are to be pulled.
181 Allowed values
182 RUN_ATTEMPT_UNSPECIFIED - All runs should be returned.
183 LATEST - Only latest run per day should be returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]185 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]186 x__xgafv: string, V1 error format.
187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
190
191Returns:
192 An object of the form:
193
194 { # The returned list of pipelines in the project.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]195 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]196 &quot;transferRuns&quot;: [ # Output only. The stored pipeline transfer runs.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]197 { # Represents a data transfer run.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]198 &quot;notificationPubsubTopic&quot;: &quot;A String&quot;, # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]199 &quot;state&quot;: &quot;A String&quot;, # Data transfer run state. Ignored for input requests.
200 &quot;scheduleTime&quot;: &quot;A String&quot;, # Minimum time after which a transfer run can be started.
201 &quot;runTime&quot;: &quot;A String&quot;, # For batch transfer runs, specifies the date and time of the data should be ingested.
202 &quot;name&quot;: &quot;A String&quot;, # 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.
203 &quot;userId&quot;: &quot;A String&quot;, # Deprecated. Unique ID of the user on whose behalf transfer is done.
204 &quot;schedule&quot;: &quot;A String&quot;, # 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&#x27;t always match this.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]205 &quot;emailPreferences&quot;: { # Represents preferences for sending email notifications for transfer run events. # Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
206 &quot;enableFailureEmail&quot;: True or False, # If true, email notifications will be sent on transfer run failures.
207 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]208 &quot;dataSourceId&quot;: &quot;A String&quot;, # Output only. Data source id.
209 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time when transfer run was started. Parameter ignored by server for input requests.
210 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
211 &quot;params&quot;: { # Output only. Data transfer specific parameters.
212 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
213 },
214 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the data transfer run state was updated.
215 &quot;destinationDatasetId&quot;: &quot;A String&quot;, # Output only. The BigQuery target dataset id.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]216 &quot;errorStatus&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # Status of the transfer run.
217 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]218 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]219 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220 },
221 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]222 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]223 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]225 },
226 ],
227 }</pre>
228</div>
229
230<div class="method">
231 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
232 <pre>Retrieves the next page of results.
233
234Args:
235 previous_request: The request for the previous page. (required)
236 previous_response: The response from the request for the previous page. (required)
237
238Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]239 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 page. Returns None if there are no more items in the collection.
241 </pre>
242</div>
243
244</body></html>