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="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 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"> 92 <code><a href="#list">list(parent, pageSize=None, pageToken=None, runAttempt=None, states=None, x__xgafv=None)</a></code></p> 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"> 99 <code class="details" id="close">close()</code> 100 <pre>Close httplib2 connections.</pre> 101</div> 102 103<div class="method"> 104 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 105 <pre>Deletes the specified transfer run. 106 107Args: 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) 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 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 `{}`. 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: 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) 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. 136 "dataSourceId": "A String", # Output only. Data source id. 137 "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id. 138 "emailPreferences": { # 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. 139 "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures. 140 }, 141 "endTime": "A String", # Output only. Time when transfer run ended. Parameter ignored by server for input requests. 142 "errorStatus": { # 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. 143 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 144 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 145 { 146 "a_key": "", # Properties of the object. Contains field @type with type URL. 147 }, 148 ], 149 "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. 150 }, 151 "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. 152 "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}` 153 "params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq 154 "a_key": "", # Properties of the object. 155 }, 156 "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be ingested. 157 "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. 158 "scheduleTime": "A String", # Minimum time after which a transfer run can be started. 159 "startTime": "A String", # Output only. Time when transfer run was started. Parameter ignored by server for input requests. 160 "state": "A String", # Data transfer run state. Ignored for input requests. 161 "updateTime": "A String", # Output only. Last time the data transfer run state was updated. 162 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done. 163}</pre> 164</div> 165 166<div class="method"> 167 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, runAttempt=None, states=None, x__xgafv=None)</code> 168 <pre>Returns information about running and completed jobs. 169 170Args: 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) 172 pageSize: integer, Page size. The default page size is the maximum value of 1000 results. 173 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. 174 runAttempt: string, Indicates how run attempts are to be pulled. 175 Allowed values 176 RUN_ATTEMPT_UNSPECIFIED - All runs should be returned. 177 LATEST - Only latest run per day should be returned. 178 states: string, When specified, only transfer runs with requested states are returned. (repeated) 179 Allowed values 180 TRANSFER_STATE_UNSPECIFIED - State placeholder (0). 181 PENDING - Data transfer is scheduled and is waiting to be picked up by data transfer backend (2). 182 RUNNING - Data transfer is in progress (3). 183 SUCCEEDED - Data transfer completed successfully (4). 184 FAILED - Data transfer failed (5). 185 CANCELLED - Data transfer is cancelled (6). 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. 195 "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. 196 "transferRuns": [ # Output only. The stored pipeline transfer runs. 197 { # Represents a data transfer run. 198 "dataSourceId": "A String", # Output only. Data source id. 199 "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id. 200 "emailPreferences": { # 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. 201 "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures. 202 }, 203 "endTime": "A String", # Output only. Time when transfer run ended. Parameter ignored by server for input requests. 204 "errorStatus": { # 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. 205 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 206 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 207 { 208 "a_key": "", # Properties of the object. Contains field @type with type URL. 209 }, 210 ], 211 "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. 212 }, 213 "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. 214 "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}` 215 "params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq 216 "a_key": "", # Properties of the object. 217 }, 218 "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be ingested. 219 "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. 220 "scheduleTime": "A String", # Minimum time after which a transfer run can be started. 221 "startTime": "A String", # Output only. Time when transfer run was started. Parameter ignored by server for input requests. 222 "state": "A String", # Data transfer run state. Ignored for input requests. 223 "updateTime": "A String", # Output only. Last time the data transfer run state was updated. 224 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done. 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: 239 A request object that you can call 'execute()' on to request the next 240 page. Returns None if there are no more items in the collection. 241 </pre> 242</div> 243 244</body></html>