Blame - docs/dyn/bigquery_v2.jobs.html - platform/external/python/google-api-python-client

blob: e252020f736d74a258b20b7112b60734355dc083 [file] [log] [blame]

Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[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="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.jobs.html">jobs</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#get">get(projectId, jobId)</a></code></p>
				79	<p class="firstline">Retrieves the specified job by ID.</p>
				80	<p class="toc_element">
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	81	<code><a href="#getQueryResults">getQueryResults(projectId, jobId, timeoutMs=None, pageToken=None, maxResults=None, startIndex=None)</a></code></p>
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	82	<p class="firstline">Retrieves the results of a query job.</p>
				83	<p class="toc_element">
				84	<code><a href="#insert">insert(projectId, body=None, media_body=None)</a></code></p>
				85	<p class="firstline">Starts a new asynchronous job.</p>
				86	<p class="toc_element">
				87	<code><a href="#list">list(projectId, projection=None, stateFilter=None, pageToken=None, allUsers=None, maxResults=None)</a></code></p>
				88	<p class="firstline">Lists all the Jobs in the specified project that were started by the user.</p>
				89	<p class="toc_element">
				90	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<p class="toc_element">
				93	<code><a href="#query">query(projectId, body)</a></code></p>
				94	<p class="firstline">Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.</p>
				95	<h3>Method Details</h3>
				96	<div class="method">
				97	<code class="details" id="get">get(projectId, jobId)</code>
				98	<pre>Retrieves the specified job by ID.
				99
				100	Args:
				101	projectId: string, Project ID of the requested job (required)
				102	jobId: string, Job ID of the requested job (required)
				103
				104	Returns:
				105	An object of the form:
				106
				107	{
				108	"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
				109	"state": "A String", # [Output-only] Running state of the job.
				110	"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
				111	{
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	112	"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
				113	"message": "A String", # A human-readable description of the error.
				114	"reason": "A String", # A short error code that summarizes the error.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	115	"location": "A String", # Specifies where the error occurred, if present.
				116	},
				117	],
				118	"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	119	"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
				120	"message": "A String", # A human-readable description of the error.
				121	"reason": "A String", # A short error code that summarizes the error.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	122	"location": "A String", # Specifies where the error occurred, if present.
				123	},
				124	},
				125	"kind": "bigquery#job", # [Output-only] The type of the resource.
				126	"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	127	"load": { # [Output-only] Statistics for a load job.
				128	"outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
				129	"inputFiles": "A String", # [Output-only] Number of source files in a load job.
				130	"inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a joad job.
				131	"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
				132	},
				133	"query": { # [Output-only] Statistics for a query job.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	134	"completionRatio": 3.14, # [Output-Only] Approximate fraction of data processed for this query. This will be 1.0 unless min_completion_ratio for the query was set to something other than 1.0.
				135	"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	136	"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
				137	},
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	138	"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	139	"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	140	"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.
				141	},
				142	"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
				143	"projectId": "A String", # [Required] Project ID being billed for the job.
				144	"jobId": "A String", # [Required] ID of the job.
				145	},
				146	"etag": "A String", # [Output-only] A hash of this resource.
				147	"configuration": { # [Required] Describes the job configuration.
				148	"load": { # [Pick one] Configures a load job.
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	149	"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
				150	"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
				151	"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
				152	"destinationTable": { # [Required] The destination table to load the data into.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	153	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				154	"tableId": "A String", # [Required] ID of the table.
				155	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				156	},
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	157	"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
				158	"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	159	"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	160	"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
				161	"sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	162	"A String",
				163	],
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	164	"quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
				165	"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
				166	"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
				167	"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
				168	"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
				169	"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	170	"fields": [ # Describes the fields in a table.
				171	{
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	172	"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	173	# Object with schema name: TableFieldSchema
				174	],
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	175	"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	176	"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
				177	"name": "A String", # [Required] The field name.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	178	},
				179	],
				180	},
				181	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	182	"dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	183	"link": { # [Pick one] Configures a link job.
				184	"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
				185	"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
				186	"destinationTable": { # [Required] The destination table of the link job.
				187	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				188	"tableId": "A String", # [Required] ID of the table.
				189	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				190	},
				191	"sourceUri": [ # [Required] URI of source table to link.
				192	"A String",
				193	],
				194	},
				195	"query": { # [Pick one] Configures a query job.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	196	"useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	197	"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
				198	"projectId": "A String", # [Optional] The ID of the container project.
				199	"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
				200	},
				201	"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
				202	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				203	"tableId": "A String", # [Required] ID of the table.
				204	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				205	},
Joe Gregorio	f4839b0	2012-09-06 13:47:24 -0400	[diff] [blame]	206	"priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	207	"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	208	"allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	209	"query": "A String", # [Required] BigQuery SQL query to execute.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	210	"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
				211	"minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
Joe Gregorio	52a5c53	2013-01-24 16:19:07 -0500	[diff] [blame]	212	"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	213	},
				214	"copy": { # [Pick one] Copies a table.
				215	"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
				216	"writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.
				217	"destinationTable": { # [Required] The destination table
				218	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				219	"tableId": "A String", # [Required] ID of the table.
				220	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				221	},
				222	"sourceTable": { # [Required] Source table to copy.
				223	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				224	"tableId": "A String", # [Required] ID of the table.
				225	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				226	},
				227	},
				228	"extract": { # [Pick one] Configures an extract job.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	229	"destinationFormat": "A String", # [Experimental] Optional and defaults to CSV. Format with which files should be exported. To export to CSV, specify "CSV". Tables with nested or repeated fields cannot be exported as CSV. To export to newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	230	"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	231	"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	232	"sourceTable": { # [Required] A reference to the table being exported.
				233	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				234	"tableId": "A String", # [Required] ID of the table.
				235	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				236	},
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	237	"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	238	},
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	239	},
				240	"id": "A String", # [Output-only] Opaque ID field of the job
				241	"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
				242	}</pre>
				243	</div>
				244
				245	<div class="method">
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	246	<code class="details" id="getQueryResults">getQueryResults(projectId, jobId, timeoutMs=None, pageToken=None, maxResults=None, startIndex=None)</code>
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	247	<pre>Retrieves the results of a query job.
				248
				249	Args:
				250	projectId: string, Project ID of the query job (required)
				251	jobId: string, Job ID of the query job (required)
				252	timeoutMs: integer, How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	253	pageToken: string, Page token, returned by a previous call, to request the next page of results
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	254	maxResults: integer, Maximum number of results to read
				255	startIndex: string, Zero-based index of the starting row
				256
				257	Returns:
				258	An object of the form:
				259
				260	{
				261	"kind": "bigquery#getQueryResultsResponse", # The resource type of the response.
				262	"rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	263	{ # Represents a single row in the result set, consisting of one or more fields.
				264	"f": [
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	265	{ # Represents a single cell in the result set. Users of the java client can detect whether their value result is null by calling 'com.google.api.client.util.Data.isNull(cell.getV())'.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	266	"v": "",
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	267	},
				268	],
				269	},
				270	],
				271	"jobReference": { # Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
				272	"projectId": "A String", # [Required] Project ID being billed for the job.
				273	"jobId": "A String", # [Required] ID of the job.
				274	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	275	"pageToken": "A String", # A token used for paging results.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	276	"jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
				277	"totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	278	"cacheHit": True or False, # Whether the query result was fetched from the query cache.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	279	"etag": "A String", # A hash of this response.
				280	"schema": { # The schema of the results. Present only when the query completes successfully.
				281	"fields": [ # Describes the fields in a table.
				282	{
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	283	"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	284	# Object with schema name: TableFieldSchema
				285	],
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	286	"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	287	"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
				288	"name": "A String", # [Required] The field name.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	289	},
				290	],
				291	},
				292	}</pre>
				293	</div>
				294
				295	<div class="method">
				296	<code class="details" id="insert">insert(projectId, body=None, media_body=None)</code>
				297	<pre>Starts a new asynchronous job.
				298
				299	Args:
				300	projectId: string, Project ID of the project that will be billed for the job (required)
				301	body: object, The request body.
				302	The object takes the form of:
				303
				304	{
				305	"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
				306	"state": "A String", # [Output-only] Running state of the job.
				307	"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
				308	{
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	309	"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
				310	"message": "A String", # A human-readable description of the error.
				311	"reason": "A String", # A short error code that summarizes the error.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	312	"location": "A String", # Specifies where the error occurred, if present.
				313	},
				314	],
				315	"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	316	"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
				317	"message": "A String", # A human-readable description of the error.
				318	"reason": "A String", # A short error code that summarizes the error.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	319	"location": "A String", # Specifies where the error occurred, if present.
				320	},
				321	},
				322	"kind": "bigquery#job", # [Output-only] The type of the resource.
				323	"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	324	"load": { # [Output-only] Statistics for a load job.
				325	"outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
				326	"inputFiles": "A String", # [Output-only] Number of source files in a load job.
				327	"inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a joad job.
				328	"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
				329	},
				330	"query": { # [Output-only] Statistics for a query job.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	331	"completionRatio": 3.14, # [Output-Only] Approximate fraction of data processed for this query. This will be 1.0 unless min_completion_ratio for the query was set to something other than 1.0.
				332	"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	333	"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
				334	},
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	335	"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	336	"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	337	"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.
				338	},
				339	"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
				340	"projectId": "A String", # [Required] Project ID being billed for the job.
				341	"jobId": "A String", # [Required] ID of the job.
				342	},
				343	"etag": "A String", # [Output-only] A hash of this resource.
				344	"configuration": { # [Required] Describes the job configuration.
				345	"load": { # [Pick one] Configures a load job.
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	346	"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
				347	"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
				348	"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
				349	"destinationTable": { # [Required] The destination table to load the data into.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	350	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				351	"tableId": "A String", # [Required] ID of the table.
				352	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				353	},
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	354	"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
				355	"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	356	"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	357	"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
				358	"sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	359	"A String",
				360	],
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	361	"quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
				362	"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
				363	"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
				364	"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
				365	"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
				366	"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	367	"fields": [ # Describes the fields in a table.
				368	{
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	369	"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	370	# Object with schema name: TableFieldSchema
				371	],
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	372	"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	373	"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
				374	"name": "A String", # [Required] The field name.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	375	},
				376	],
				377	},
				378	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	379	"dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	380	"link": { # [Pick one] Configures a link job.
				381	"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
				382	"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
				383	"destinationTable": { # [Required] The destination table of the link job.
				384	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				385	"tableId": "A String", # [Required] ID of the table.
				386	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				387	},
				388	"sourceUri": [ # [Required] URI of source table to link.
				389	"A String",
				390	],
				391	},
				392	"query": { # [Pick one] Configures a query job.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	393	"useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	394	"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
				395	"projectId": "A String", # [Optional] The ID of the container project.
				396	"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
				397	},
				398	"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
				399	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				400	"tableId": "A String", # [Required] ID of the table.
				401	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				402	},
Joe Gregorio	f4839b0	2012-09-06 13:47:24 -0400	[diff] [blame]	403	"priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	404	"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	405	"allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	406	"query": "A String", # [Required] BigQuery SQL query to execute.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	407	"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
				408	"minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
Joe Gregorio	52a5c53	2013-01-24 16:19:07 -0500	[diff] [blame]	409	"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	410	},
				411	"copy": { # [Pick one] Copies a table.
				412	"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
				413	"writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.
				414	"destinationTable": { # [Required] The destination table
				415	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				416	"tableId": "A String", # [Required] ID of the table.
				417	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				418	},
				419	"sourceTable": { # [Required] Source table to copy.
				420	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				421	"tableId": "A String", # [Required] ID of the table.
				422	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				423	},
				424	},
				425	"extract": { # [Pick one] Configures an extract job.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	426	"destinationFormat": "A String", # [Experimental] Optional and defaults to CSV. Format with which files should be exported. To export to CSV, specify "CSV". Tables with nested or repeated fields cannot be exported as CSV. To export to newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	427	"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	428	"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	429	"sourceTable": { # [Required] A reference to the table being exported.
				430	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				431	"tableId": "A String", # [Required] ID of the table.
				432	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				433	},
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	434	"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	435	},
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	436	},
				437	"id": "A String", # [Output-only] Opaque ID field of the job
				438	"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
				439	}
				440
				441	media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
				442
				443	Returns:
				444	An object of the form:
				445
				446	{
				447	"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
				448	"state": "A String", # [Output-only] Running state of the job.
				449	"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
				450	{
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	451	"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
				452	"message": "A String", # A human-readable description of the error.
				453	"reason": "A String", # A short error code that summarizes the error.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	454	"location": "A String", # Specifies where the error occurred, if present.
				455	},
				456	],
				457	"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	458	"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
				459	"message": "A String", # A human-readable description of the error.
				460	"reason": "A String", # A short error code that summarizes the error.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	461	"location": "A String", # Specifies where the error occurred, if present.
				462	},
				463	},
				464	"kind": "bigquery#job", # [Output-only] The type of the resource.
				465	"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	466	"load": { # [Output-only] Statistics for a load job.
				467	"outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
				468	"inputFiles": "A String", # [Output-only] Number of source files in a load job.
				469	"inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a joad job.
				470	"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
				471	},
				472	"query": { # [Output-only] Statistics for a query job.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	473	"completionRatio": 3.14, # [Output-Only] Approximate fraction of data processed for this query. This will be 1.0 unless min_completion_ratio for the query was set to something other than 1.0.
				474	"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	475	"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
				476	},
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	477	"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	478	"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	479	"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.
				480	},
				481	"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
				482	"projectId": "A String", # [Required] Project ID being billed for the job.
				483	"jobId": "A String", # [Required] ID of the job.
				484	},
				485	"etag": "A String", # [Output-only] A hash of this resource.
				486	"configuration": { # [Required] Describes the job configuration.
				487	"load": { # [Pick one] Configures a load job.
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	488	"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
				489	"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
				490	"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
				491	"destinationTable": { # [Required] The destination table to load the data into.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	492	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				493	"tableId": "A String", # [Required] ID of the table.
				494	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				495	},
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	496	"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
				497	"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	498	"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	499	"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
				500	"sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	501	"A String",
				502	],
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	503	"quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
				504	"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
				505	"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
				506	"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
				507	"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
				508	"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	509	"fields": [ # Describes the fields in a table.
				510	{
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	511	"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	512	# Object with schema name: TableFieldSchema
				513	],
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	514	"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	515	"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
				516	"name": "A String", # [Required] The field name.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	517	},
				518	],
				519	},
				520	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	521	"dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	522	"link": { # [Pick one] Configures a link job.
				523	"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
				524	"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
				525	"destinationTable": { # [Required] The destination table of the link job.
				526	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				527	"tableId": "A String", # [Required] ID of the table.
				528	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				529	},
				530	"sourceUri": [ # [Required] URI of source table to link.
				531	"A String",
				532	],
				533	},
				534	"query": { # [Pick one] Configures a query job.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	535	"useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	536	"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
				537	"projectId": "A String", # [Optional] The ID of the container project.
				538	"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
				539	},
				540	"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
				541	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				542	"tableId": "A String", # [Required] ID of the table.
				543	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				544	},
Joe Gregorio	f4839b0	2012-09-06 13:47:24 -0400	[diff] [blame]	545	"priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	546	"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	547	"allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	548	"query": "A String", # [Required] BigQuery SQL query to execute.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	549	"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
				550	"minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
Joe Gregorio	52a5c53	2013-01-24 16:19:07 -0500	[diff] [blame]	551	"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	552	},
				553	"copy": { # [Pick one] Copies a table.
				554	"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
				555	"writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.
				556	"destinationTable": { # [Required] The destination table
				557	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				558	"tableId": "A String", # [Required] ID of the table.
				559	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				560	},
				561	"sourceTable": { # [Required] Source table to copy.
				562	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				563	"tableId": "A String", # [Required] ID of the table.
				564	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				565	},
				566	},
				567	"extract": { # [Pick one] Configures an extract job.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	568	"destinationFormat": "A String", # [Experimental] Optional and defaults to CSV. Format with which files should be exported. To export to CSV, specify "CSV". Tables with nested or repeated fields cannot be exported as CSV. To export to newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	569	"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	570	"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	571	"sourceTable": { # [Required] A reference to the table being exported.
				572	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				573	"tableId": "A String", # [Required] ID of the table.
				574	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				575	},
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	576	"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	577	},
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	578	},
				579	"id": "A String", # [Output-only] Opaque ID field of the job
				580	"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
				581	}</pre>
				582	</div>
				583
				584	<div class="method">
				585	<code class="details" id="list">list(projectId, projection=None, stateFilter=None, pageToken=None, allUsers=None, maxResults=None)</code>
				586	<pre>Lists all the Jobs in the specified project that were started by the user.
				587
				588	Args:
				589	projectId: string, Project ID of the jobs to list (required)
				590	projection: string, Restrict information returned to a set of selected fields
				591	Allowed values
				592	full - Includes all job data
				593	minimal - Does not include the job configuration
				594	stateFilter: string, Filter for job state (repeated)
				595	Allowed values
				596	done - Finished jobs
				597	pending - Pending jobs
				598	running - Running jobs
				599	pageToken: string, Page token, returned by a previous call, to request the next page of results
				600	allUsers: boolean, Whether to display jobs owned by all users in the project. Default false
				601	maxResults: integer, Maximum number of results to return
				602
				603	Returns:
				604	An object of the form:
				605
				606	{
				607	"nextPageToken": "A String", # A token to request the next page of results.
				608	"totalItems": 42, # Total number of jobs in this collection.
				609	"kind": "bigquery#jobList", # The resource type of the response.
				610	"etag": "A String", # A hash of this page of results.
				611	"jobs": [ # List of jobs that were requested.
				612	{
				613	"status": { # [Full-projection-only] Describes the state of the job.
				614	"state": "A String", # [Output-only] Running state of the job.
				615	"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
				616	{
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	617	"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
				618	"message": "A String", # A human-readable description of the error.
				619	"reason": "A String", # A short error code that summarizes the error.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	620	"location": "A String", # Specifies where the error occurred, if present.
				621	},
				622	],
				623	"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	624	"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
				625	"message": "A String", # A human-readable description of the error.
				626	"reason": "A String", # A short error code that summarizes the error.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	627	"location": "A String", # Specifies where the error occurred, if present.
				628	},
				629	},
				630	"kind": "bigquery#job", # The resource type.
				631	"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	632	"load": { # [Output-only] Statistics for a load job.
				633	"outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
				634	"inputFiles": "A String", # [Output-only] Number of source files in a load job.
				635	"inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a joad job.
				636	"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
				637	},
				638	"query": { # [Output-only] Statistics for a query job.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	639	"completionRatio": 3.14, # [Output-Only] Approximate fraction of data processed for this query. This will be 1.0 unless min_completion_ratio for the query was set to something other than 1.0.
				640	"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	641	"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
				642	},
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	643	"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	644	"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	645	"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.
				646	},
				647	"jobReference": { # Job reference uniquely identifying the job.
				648	"projectId": "A String", # [Required] Project ID being billed for the job.
				649	"jobId": "A String", # [Required] ID of the job.
				650	},
				651	"state": "A String", # Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.
				652	"configuration": { # [Full-projection-only] Specifies the job configuration.
				653	"load": { # [Pick one] Configures a load job.
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	654	"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
				655	"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
				656	"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
				657	"destinationTable": { # [Required] The destination table to load the data into.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	658	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				659	"tableId": "A String", # [Required] ID of the table.
				660	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				661	},
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	662	"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
				663	"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	664	"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	665	"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
				666	"sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	667	"A String",
				668	],
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	669	"quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
				670	"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
				671	"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
				672	"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
				673	"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
				674	"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	675	"fields": [ # Describes the fields in a table.
				676	{
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	677	"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	678	# Object with schema name: TableFieldSchema
				679	],
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	680	"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	681	"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
				682	"name": "A String", # [Required] The field name.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	683	},
				684	],
				685	},
				686	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	687	"dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	688	"link": { # [Pick one] Configures a link job.
				689	"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
				690	"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
				691	"destinationTable": { # [Required] The destination table of the link job.
				692	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				693	"tableId": "A String", # [Required] ID of the table.
				694	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				695	},
				696	"sourceUri": [ # [Required] URI of source table to link.
				697	"A String",
				698	],
				699	},
				700	"query": { # [Pick one] Configures a query job.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	701	"useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	702	"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
				703	"projectId": "A String", # [Optional] The ID of the container project.
				704	"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
				705	},
				706	"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
				707	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				708	"tableId": "A String", # [Required] ID of the table.
				709	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				710	},
Joe Gregorio	f4839b0	2012-09-06 13:47:24 -0400	[diff] [blame]	711	"priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	712	"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	713	"allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	714	"query": "A String", # [Required] BigQuery SQL query to execute.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	715	"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
				716	"minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
Joe Gregorio	52a5c53	2013-01-24 16:19:07 -0500	[diff] [blame]	717	"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	718	},
				719	"copy": { # [Pick one] Copies a table.
				720	"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
				721	"writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.
				722	"destinationTable": { # [Required] The destination table
				723	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				724	"tableId": "A String", # [Required] ID of the table.
				725	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				726	},
				727	"sourceTable": { # [Required] Source table to copy.
				728	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				729	"tableId": "A String", # [Required] ID of the table.
				730	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				731	},
				732	},
				733	"extract": { # [Pick one] Configures an extract job.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	734	"destinationFormat": "A String", # [Experimental] Optional and defaults to CSV. Format with which files should be exported. To export to CSV, specify "CSV". Tables with nested or repeated fields cannot be exported as CSV. To export to newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	735	"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	736	"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	737	"sourceTable": { # [Required] A reference to the table being exported.
				738	"projectId": "A String", # [Required] ID of the project billed for storage of the table.
				739	"tableId": "A String", # [Required] ID of the table.
				740	"datasetId": "A String", # [Required] ID of the dataset containing the table.
				741	},
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	742	"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	743	},
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	744	},
				745	"id": "A String", # Unique opaque ID of the job.
				746	"errorResult": { # A result object that will be present only if the job has failed.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	747	"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
				748	"message": "A String", # A human-readable description of the error.
				749	"reason": "A String", # A short error code that summarizes the error.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	750	"location": "A String", # Specifies where the error occurred, if present.
				751	},
				752	},
				753	],
				754	}</pre>
				755	</div>
				756
				757	<div class="method">
				758	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				759	<pre>Retrieves the next page of results.
				760
				761	Args:
				762	previous_request: The request for the previous page. (required)
				763	previous_response: The response from the request for the previous page. (required)
				764
				765	Returns:
				766	A request object that you can call 'execute()' on to request the next
				767	page. Returns None if there are no more items in the collection.
Joe Gregorio	52a5c53	2013-01-24 16:19:07 -0500	[diff] [blame]	768	</pre>
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	769	</div>
				770
				771	<div class="method">
				772	<code class="details" id="query">query(projectId, body)</code>
				773	<pre>Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.
				774
				775	Args:
				776	projectId: string, Project ID of the project billed for the query (required)
				777	body: object, The request body. (required)
				778	The object takes the form of:
				779
				780	{
				781	"timeoutMs": 42, # [Optional] How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	782	"kind": "bigquery#queryRequest", # The resource type of the request.
Joe Gregorio	1b425aa	2012-08-24 12:04:34 -0400	[diff] [blame]	783	"dryRun": True or False, # [Optional] If set, don't actually run the query. A valid query will return an empty response, while an invalid query will return the same error it would if it wasn't a dry run.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	784	"useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	785	"defaultDataset": { # [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be fully-qualified in the format projectId:datasetId.tableid.
				786	"projectId": "A String", # [Optional] The ID of the container project.
				787	"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
				788	},
Joe Gregorio	1b425aa	2012-08-24 12:04:34 -0400	[diff] [blame]	789	"maxResults": 42, # [Optional] The maximum number of results to return per page of results. If the response list exceeds the maximum response size for a single response, you will have to page through the results. Default is to return the maximum response size.
				790	"query": "A String", # [Required] A query string, following the BigQuery query syntax of the query to execute. Table names should be qualified by dataset name in the format projectId:datasetId.tableId unless you specify the defaultDataset value. If the table is in the same project as the job, you can omit the project ID. Example: SELECT f1 FROM myProjectId:myDatasetId.myTableId.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	791	"minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
Joe Gregorio	52a5c53	2013-01-24 16:19:07 -0500	[diff] [blame]	792	"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	793	}
				794
				795
				796	Returns:
				797	An object of the form:
				798
				799	{
				800	"kind": "bigquery#queryResponse", # The resource type.
				801	"rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	802	{ # Represents a single row in the result set, consisting of one or more fields.
				803	"f": [
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	804	{ # Represents a single cell in the result set. Users of the java client can detect whether their value result is null by calling 'com.google.api.client.util.Data.isNull(cell.getV())'.
Joe Gregorio	7578da5	2012-11-01 14:20:00 -0400	[diff] [blame]	805	"v": "",
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	806	},
				807	],
				808	},
				809	],
				810	"jobReference": { # Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
				811	"projectId": "A String", # [Required] Project ID being billed for the job.
				812	"jobId": "A String", # [Required] ID of the job.
				813	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	814	"pageToken": "A String", # A token used for paging results.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	815	"jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
				816	"totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	817	"totalBytesProcessed": "A String", # The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.
				818	"cacheHit": True or False, # Whether the query result was fetched from the query cache.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	819	"schema": { # The schema of the results. Present only when the query completes successfully.
				820	"fields": [ # Describes the fields in a table.
				821	{
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	822	"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	823	# Object with schema name: TableFieldSchema
				824	],
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	825	"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
Joe Gregorio	41be8e8	2013-03-07 10:31:47 -0500	[diff] [blame]	826	"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
				827	"name": "A String", # [Required] The field name.
Joe Gregorio	075572b	2012-07-09 16:53:09 -0400	[diff] [blame]	828	},
				829	],
				830	},
				831	}</pre>
				832	</div>
				833
				834	</body></html>