docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html - platform/external/python/google-api-python-client - Git at Google

 <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 Service 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, runAttempt=None, statuses=None, pageToken=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.
     "status": "A String", # Data transfer run status. Ignored for input requests.
         # @OutputOnly
     "updateTime": "A String", # Last time the data transfer run status was updated.
         # @OutputOnly
     "destinationDatasetId": "A String", # The BigQuery target dataset id.
     "name": "A String", # The resource name of the transfer run.
         # Transfer run names have the form
         # `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`.
         # The name is ignored when creating a transfer run.
     "schedule": "A String", # Describes the schedule of this transfer run if it was created as part of
         # a regular schedule. For batch transfer runs that are directly created,
         # this is empty.
         # NOTE: the system might choose to delay the schedule depending on the
         # current load, so `schedule_time` doesn't always matches this.
         # @OutputOnly
     "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
     "userId": "A String", # The user id for this transfer run.
         # @OutputOnly
     "dataSourceId": "A String", # Data source id.
         # @OutputOnly
     "startTime": "A String", # Time when transfer run was started. Parameter ignored by server for input
         # requests.
         # @OutputOnly
     "params": { # Data transfer specific parameters.
       "a_key": "", # Properties of the object.
     },
     "runTime": "A String", # For batch transfer runs, specifies the date and time that
         # data should be ingested.
     "endTime": "A String", # Time when transfer run ended. Parameter ignored by server for input
         # requests.
         # @OutputOnly
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(parent, pageSize=None, runAttempt=None, statuses=None, pageToken=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.
   runAttempt: string, Indicates how run attempts are to be pulled.
   statuses: string, When specified, only transfer runs with requested statuses are returned. (repeated)
   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.
   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", # 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.
         # @OutputOnly
     "transferRuns": [ # The stored pipeline transfer runs.
         # @OutputOnly
       { # Represents a data transfer run.
         "status": "A String", # Data transfer run status. Ignored for input requests.
             # @OutputOnly
         "updateTime": "A String", # Last time the data transfer run status was updated.
             # @OutputOnly
         "destinationDatasetId": "A String", # The BigQuery target dataset id.
         "name": "A String", # The resource name of the transfer run.
             # Transfer run names have the form
             # `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`.
             # The name is ignored when creating a transfer run.
         "schedule": "A String", # Describes the schedule of this transfer run if it was created as part of
             # a regular schedule. For batch transfer runs that are directly created,
             # this is empty.
             # NOTE: the system might choose to delay the schedule depending on the
             # current load, so `schedule_time` doesn't always matches this.
             # @OutputOnly
         "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
         "userId": "A String", # The user id for this transfer run.
             # @OutputOnly
         "dataSourceId": "A String", # Data source id.
             # @OutputOnly
         "startTime": "A String", # Time when transfer run was started. Parameter ignored by server for input
             # requests.
             # @OutputOnly
         "params": { # Data transfer specific parameters.
           "a_key": "", # Properties of the object.
         },
         "runTime": "A String", # For batch transfer runs, specifies the date and time that
             # data should be ingested.
         "endTime": "A String", # Time when transfer run ended. Parameter ignored by server for input
             # requests.
             # @OutputOnly
       },
     ],
   }</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>
	<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 Service 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, runAttempt=None, statuses=None, pageToken=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.
	"status": "A String", # Data transfer run status. Ignored for input requests.
	# @OutputOnly
	"updateTime": "A String", # Last time the data transfer run status was updated.
	# @OutputOnly
	"destinationDatasetId": "A String", # The BigQuery target dataset id.
	"name": "A String", # The resource name of the transfer run.
	# Transfer run names have the form
	# `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`.
	# The name is ignored when creating a transfer run.
	"schedule": "A String", # Describes the schedule of this transfer run if it was created as part of
	# a regular schedule. For batch transfer runs that are directly created,
	# this is empty.
	# NOTE: the system might choose to delay the schedule depending on the
	# current load, so `schedule_time` doesn't always matches this.
	# @OutputOnly
	"scheduleTime": "A String", # Minimum time after which a transfer run can be started.
	"userId": "A String", # The user id for this transfer run.
	# @OutputOnly
	"dataSourceId": "A String", # Data source id.
	# @OutputOnly
	"startTime": "A String", # Time when transfer run was started. Parameter ignored by server for input
	# requests.
	# @OutputOnly
	"params": { # Data transfer specific parameters.
	"a_key": "", # Properties of the object.
	},
	"runTime": "A String", # For batch transfer runs, specifies the date and time that
	# data should be ingested.
	"endTime": "A String", # Time when transfer run ended. Parameter ignored by server for input
	# requests.
	# @OutputOnly
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(parent, pageSize=None, runAttempt=None, statuses=None, pageToken=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.
	runAttempt: string, Indicates how run attempts are to be pulled.
	statuses: string, When specified, only transfer runs with requested statuses are returned. (repeated)
	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.
	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", # 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.
	# @OutputOnly
	"transferRuns": [ # The stored pipeline transfer runs.
	# @OutputOnly
	{ # Represents a data transfer run.
	"status": "A String", # Data transfer run status. Ignored for input requests.
	# @OutputOnly
	"updateTime": "A String", # Last time the data transfer run status was updated.
	# @OutputOnly
	"destinationDatasetId": "A String", # The BigQuery target dataset id.
	"name": "A String", # The resource name of the transfer run.
	# Transfer run names have the form
	# `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`.
	# The name is ignored when creating a transfer run.
	"schedule": "A String", # Describes the schedule of this transfer run if it was created as part of
	# a regular schedule. For batch transfer runs that are directly created,
	# this is empty.
	# NOTE: the system might choose to delay the schedule depending on the
	# current load, so `schedule_time` doesn't always matches this.
	# @OutputOnly
	"scheduleTime": "A String", # Minimum time after which a transfer run can be started.
	"userId": "A String", # The user id for this transfer run.
	# @OutputOnly
	"dataSourceId": "A String", # Data source id.
	# @OutputOnly
	"startTime": "A String", # Time when transfer run was started. Parameter ignored by server for input
	# requests.
	# @OutputOnly
	"params": { # Data transfer specific parameters.
	"a_key": "", # Properties of the object.
	},
	"runTime": "A String", # For batch transfer runs, specifies the date and time that
	# data should be ingested.
	"endTime": "A String", # Time when transfer run ended. Parameter ignored by server for input
	# requests.
	# @OutputOnly
	},
	],
	}</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>