Blame - docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html - platform/external/python/google-api-python-client

blob: 5c9865cffd7a67fec93f1909e2e8bd96ee996b30 [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html">runs()</a></code>
				79	</p>
				80	<p class="firstline">Returns the runs Resource.</p>
				81
				82	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-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">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	86	<code><a href="#create">create(parent, body=None, serviceAccountName=None, authorizationCode=None, versionInfo=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	87	<p class="firstline">Creates a new data transfer configuration.</p>
				88	<p class="toc_element">
				89	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	90	<p class="firstline">Deletes a data transfer configuration, including any associated transfer runs and logs.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="toc_element">
				92	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				93	<p class="firstline">Returns information about a data transfer config.</p>
				94	<p class="toc_element">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	95	<code><a href="#list">list(parent, dataSourceIds=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	96	<p class="firstline">Returns information about all data transfers in the project.</p>
				97	<p class="toc_element">
				98	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				99	<p class="firstline">Retrieves the next page of results.</p>
				100	<p class="toc_element">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	101	<code><a href="#patch">patch(name, body=None, versionInfo=None, updateMask=None, serviceAccountName=None, authorizationCode=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	102	<p class="firstline">Updates a data transfer configuration. All fields must be set, even if they are not updated.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	104	<code><a href="#scheduleRuns">scheduleRuns(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	105	<p class="firstline">Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	106	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	107	<code><a href="#startManualRuns">startManualRuns(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	108	<p class="firstline">Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	109	<h3>Method Details</h3>
				110	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	111	<code class="details" id="close">close()</code>
				112	<pre>Close httplib2 connections.</pre>
				113	</div>
				114
				115	<div class="method">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	116	<code class="details" id="create">create(parent, body=None, serviceAccountName=None, authorizationCode=None, versionInfo=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	117	<pre>Creates a new data transfer configuration.
				118
				119	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	120	parent: string, Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	121	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	122	The object takes the form of:
				123
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	124	{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	125	"displayName": "A String", # User specified display name for the data transfer.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	126	"params": { # Data transfer specific parameters.
				127	"a_key": "", # Properties of the object.
				128	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	129	"nextRunTime": "A String", # Output only. Next time when data transfer will run.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	130	"emailPreferences": { # Represents preferences for sending email notifications for transfer run events. # Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
				131	"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
				132	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	133	"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
				134	"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
				135	"schedule": "A String", # Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
				136	"state": "A String", # Output only. State of the most recently updated transfer run.
				137	"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
				138	"disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer.
				139	"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	140	"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	141	"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
				142	"endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	143	"startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	144	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	145	"notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	146	"dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	147	"name": "A String", # The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
				148	"destinationDatasetId": "A String", # The BigQuery target dataset id.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	149	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	150
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	151	serviceAccountName: string, Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	152	authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	153	versionInfo: string, Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	154	x__xgafv: string, V1 error format.
				155	Allowed values
				156	1 - v1 error format
				157	2 - v2 error format
				158
				159	Returns:
				160	An object of the form:
				161
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	162	{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	163	"displayName": "A String", # User specified display name for the data transfer.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	164	"params": { # Data transfer specific parameters.
				165	"a_key": "", # Properties of the object.
				166	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	167	"nextRunTime": "A String", # Output only. Next time when data transfer will run.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	168	"emailPreferences": { # Represents preferences for sending email notifications for transfer run events. # Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
				169	"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
				170	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	171	"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
				172	"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
				173	"schedule": "A String", # Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
				174	"state": "A String", # Output only. State of the most recently updated transfer run.
				175	"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
				176	"disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer.
				177	"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	178	"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	179	"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
				180	"endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	181	"startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	182	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	183	"notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	184	"dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	185	"name": "A String", # The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
				186	"destinationDatasetId": "A String", # The BigQuery target dataset id.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	187	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	188	</div>
				189
				190	<div class="method">
				191	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	192	<pre>Deletes a data transfer configuration, including any associated transfer runs and logs.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	193
				194	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	195	name: string, Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	196	x__xgafv: string, V1 error format.
				197	Allowed values
				198	1 - v1 error format
				199	2 - v2 error format
				200
				201	Returns:
				202	An object of the form:
				203
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	204	{ # 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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	205	}</pre>
				206	</div>
				207
				208	<div class="method">
				209	<code class="details" id="get">get(name, x__xgafv=None)</code>
				210	<pre>Returns information about a data transfer config.
				211
				212	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	213	name: string, Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	214	x__xgafv: string, V1 error format.
				215	Allowed values
				216	1 - v1 error format
				217	2 - v2 error format
				218
				219	Returns:
				220	An object of the form:
				221
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	222	{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	223	"displayName": "A String", # User specified display name for the data transfer.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	224	"params": { # Data transfer specific parameters.
				225	"a_key": "", # Properties of the object.
				226	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	227	"nextRunTime": "A String", # Output only. Next time when data transfer will run.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	228	"emailPreferences": { # Represents preferences for sending email notifications for transfer run events. # Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
				229	"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
				230	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	231	"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
				232	"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
				233	"schedule": "A String", # Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
				234	"state": "A String", # Output only. State of the most recently updated transfer run.
				235	"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
				236	"disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer.
				237	"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	238	"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	239	"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
				240	"endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	241	"startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	242	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	243	"notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	244	"dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	245	"name": "A String", # The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
				246	"destinationDatasetId": "A String", # The BigQuery target dataset id.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	247	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	248	</div>
				249
				250	<div class="method">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	251	<code class="details" id="list">list(parent, dataSourceIds=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	252	<pre>Returns information about all data transfers in the project.
				253
				254	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	255	parent: string, Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	256	dataSourceIds: string, When specified, only configurations of requested data sources are returned. (repeated)
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	257	pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	258	pageToken: string, Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	259	x__xgafv: string, V1 error format.
				260	Allowed values
				261	1 - v1 error format
				262	2 - v2 error format
				263
				264	Returns:
				265	An object of the form:
				266
				267	{ # The returned list of pipelines in the project.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	268	"nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	269	"transferConfigs": [ # Output only. The stored pipeline transfer configurations.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	270	{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	271	"displayName": "A String", # User specified display name for the data transfer.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	272	"params": { # Data transfer specific parameters.
				273	"a_key": "", # Properties of the object.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	274	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	275	"nextRunTime": "A String", # Output only. Next time when data transfer will run.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	276	"emailPreferences": { # Represents preferences for sending email notifications for transfer run events. # Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
				277	"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
				278	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	279	"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
				280	"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
				281	"schedule": "A String", # Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
				282	"state": "A String", # Output only. State of the most recently updated transfer run.
				283	"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
				284	"disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer.
				285	"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	286	"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	287	"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
				288	"endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	289	"startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	290	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	291	"notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	292	"dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	293	"name": "A String", # The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
				294	"destinationDatasetId": "A String", # The BigQuery target dataset id.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	295	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	296	],
				297	}</pre>
				298	</div>
				299
				300	<div class="method">
				301	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				302	<pre>Retrieves the next page of results.
				303
				304	Args:
				305	previous_request: The request for the previous page. (required)
				306	previous_response: The response from the request for the previous page. (required)
				307
				308	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	309	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	310	page. Returns None if there are no more items in the collection.
				311	</pre>
				312	</div>
				313
				314	<div class="method">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	315	<code class="details" id="patch">patch(name, body=None, versionInfo=None, updateMask=None, serviceAccountName=None, authorizationCode=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	316	<pre>Updates a data transfer configuration. All fields must be set, even if they are not updated.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	317
				318	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	319	name: string, The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	320	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	321	The object takes the form of:
				322
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	323	{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	324	"displayName": "A String", # User specified display name for the data transfer.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	325	"params": { # Data transfer specific parameters.
				326	"a_key": "", # Properties of the object.
				327	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	328	"nextRunTime": "A String", # Output only. Next time when data transfer will run.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	329	"emailPreferences": { # Represents preferences for sending email notifications for transfer run events. # Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
				330	"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
				331	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	332	"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
				333	"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
				334	"schedule": "A String", # Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
				335	"state": "A String", # Output only. State of the most recently updated transfer run.
				336	"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
				337	"disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer.
				338	"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	339	"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	340	"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
				341	"endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	342	"startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	343	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	344	"notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	345	"dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	346	"name": "A String", # The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
				347	"destinationDatasetId": "A String", # The BigQuery target dataset id.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	348	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	349
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	350	versionInfo: string, Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	351	updateMask: string, Required. Required list of fields to be updated in this request.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	352	serviceAccountName: string, Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	353	authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	354	x__xgafv: string, V1 error format.
				355	Allowed values
				356	1 - v1 error format
				357	2 - v2 error format
				358
				359	Returns:
				360	An object of the form:
				361
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	362	{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	363	"displayName": "A String", # User specified display name for the data transfer.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	364	"params": { # Data transfer specific parameters.
				365	"a_key": "", # Properties of the object.
				366	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	367	"nextRunTime": "A String", # Output only. Next time when data transfer will run.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	368	"emailPreferences": { # Represents preferences for sending email notifications for transfer run events. # Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
				369	"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
				370	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	371	"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
				372	"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
				373	"schedule": "A String", # Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
				374	"state": "A String", # Output only. State of the most recently updated transfer run.
				375	"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
				376	"disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer.
				377	"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	378	"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	379	"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
				380	"endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	381	"startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	382	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	383	"notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	384	"dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	385	"name": "A String", # The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
				386	"destinationDatasetId": "A String", # The BigQuery target dataset id.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	387	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	388	</div>
				389
				390	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	391	<code class="details" id="scheduleRuns">scheduleRuns(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	392	<pre>Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	393
				394	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	395	parent: string, Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	396	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	397	The object takes the form of:
				398
				399	{ # A request to schedule transfer runs for a time range.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	400	"startTime": "A String", # Required. Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	401	"endTime": "A String", # Required. End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	402	}
				403
				404	x__xgafv: string, V1 error format.
				405	Allowed values
				406	1 - v1 error format
				407	2 - v2 error format
				408
				409	Returns:
				410	An object of the form:
				411
				412	{ # A response to schedule transfer runs for a time range.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	413	"runs": [ # The transfer runs that were scheduled.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	414	{ # Represents a data transfer run.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	415	"updateTime": "A String", # Output only. Last time the data transfer run state was updated.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	416	"params": { # Output only. Data transfer specific parameters.
				417	"a_key": "", # Properties of the object.
				418	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	419	"dataSourceId": "A String", # Output only. Data source id.
				420	"startTime": "A String", # Output only. Time when transfer run was started. Parameter ignored by server for input requests.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	421	"runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be ingested.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	422	"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.
				423	"scheduleTime": "A String", # Minimum time after which a transfer run can be started.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	424	"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.
				425	"endTime": "A String", # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
				426	"destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	427	"state": "A String", # Data transfer run state. Ignored for input requests.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	428	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	429	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	430	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	431	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	432	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	433	},
				434	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	435	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	436	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	437	"notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes
				438	"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.
				439	"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
				440	},
				441	"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	442	},
				443	],
				444	}</pre>
				445	</div>
				446
				447	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	448	<code class="details" id="startManualRuns">startManualRuns(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	449	<pre>Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	450
				451	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	452	parent: string, Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	453	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	454	The object takes the form of:
				455
				456	{ # A request to start manual transfer runs.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	457	"requestedTimeRange": { # A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive). # Time range for the transfer runs that should be started.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	458	"endTime": "A String", # End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	459	"startTime": "A String", # Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	460	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	461	"requestedRunTime": "A String", # Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	462	}
				463
				464	x__xgafv: string, V1 error format.
				465	Allowed values
				466	1 - v1 error format
				467	2 - v2 error format
				468
				469	Returns:
				470	An object of the form:
				471
				472	{ # A response to start manual transfer runs.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	473	"runs": [ # The transfer runs that were created.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	474	{ # Represents a data transfer run.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	475	"updateTime": "A String", # Output only. Last time the data transfer run state was updated.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	476	"params": { # Output only. Data transfer specific parameters.
				477	"a_key": "", # Properties of the object.
				478	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	479	"dataSourceId": "A String", # Output only. Data source id.
				480	"startTime": "A String", # Output only. Time when transfer run was started. Parameter ignored by server for input requests.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	481	"runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be ingested.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	482	"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.
				483	"scheduleTime": "A String", # Minimum time after which a transfer run can be started.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	484	"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.
				485	"endTime": "A String", # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
				486	"destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	487	"state": "A String", # Data transfer run state. Ignored for input requests.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	488	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	489	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	490	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	491	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	492	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	493	},
				494	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	495	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	496	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	497	"notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes
				498	"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.
				499	"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
				500	},
				501	"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	502	},
				503	],
				504	}</pre>
				505	</div>
				506
				507	</body></html>