OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(json): updated API descriptions

Browse Source
This commit is contained in:
Sebastian Thiel
2016-01-30 14:05:22 +01:00
parent a2c6b58d5b
commit 8f01e8e918
145 changed files with 50073 additions and 3975 deletions
Download Patch File Download Diff File Expand all files Collapse all files

180
etc/api/bigquery/v2/bigquery-api.json
View File

@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
"etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/k_BSN0ZnNv70IWVfokIVycD-7po\"",
"etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/KhBY9BAZ9f1xpe68E42latOsq24\"",
"discoveryVersion": "v1",
"id": "bigquery:v2",
"name": "bigquery",
"version": "v2",
"revision": "20151009",
"revision": "20160127",
"title": "BigQuery API",
"description": "A data platform for customers to create, manage, share and query data.",
"ownerDomain": "google.com",
@@ -307,13 +307,102 @@
}
}
},
"ExplainQueryStage": {
"id": "ExplainQueryStage",
"type": "object",
"properties": {
"computeRatioAvg": {
"type": "number",
"description": "Relative amount of time the average shard spent on CPU-bound tasks.",
"format": "double"
},
"computeRatioMax": {
"type": "number",
"description": "Relative amount of time the slowest shard spent on CPU-bound tasks.",
"format": "double"
},
"id": {
"type": "string",
"description": "Unique ID for stage within plan.",
"format": "int64"
},
"name": {
"type": "string",
"description": "Human-readable name for stage."
},
"readRatioAvg": {
"type": "number",
"description": "Relative amount of time the average shard spent reading input.",
"format": "double"
},
"readRatioMax": {
"type": "number",
"description": "Relative amount of time the slowest shard spent reading input.",
"format": "double"
},
"recordsRead": {
"type": "string",
"description": "Number of records read into the stage.",
"format": "int64"
},
"recordsWritten": {
"type": "string",
"description": "Number of records written by the stage.",
"format": "int64"
},
"steps": {
"type": "array",
"description": "List of operations within the stage in dependency order (approximately chronological).",
"items": {
"$ref": "ExplainQueryStep"
}
},
"waitRatioAvg": {
"type": "number",
"description": "Relative amount of time the average shard spent waiting to be scheduled.",
"format": "double"
},
"waitRatioMax": {
"type": "number",
"description": "Relative amount of time the slowest shard spent waiting to be scheduled.",
"format": "double"
},
"writeRatioAvg": {
"type": "number",
"description": "Relative amount of time the average shard spent on writing output.",
"format": "double"
},
"writeRatioMax": {
"type": "number",
"description": "Relative amount of time the slowest shard spent on writing output.",
"format": "double"
}
}
},
"ExplainQueryStep": {
"id": "ExplainQueryStep",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Machine-readable operation type."
},
"substeps": {
"type": "array",
"description": "Human-readable stage descriptions.",
"items": {
"type": "string"
}
}
}
},
"ExternalDataConfiguration": {
"id": "ExternalDataConfiguration",
"type": "object",
"properties": {
"compression": {
"type": "string",
"description": "[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE."
"description": "[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Datastore backups."
},
"csvOptions": {
"$ref": "CsvOptions",
@@ -321,24 +410,24 @@
},
"ignoreUnknownValues": {
"type": "boolean",
"description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names"
"description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Datastore backups: This setting is ignored."
},
"maxBadRecords": {
"type": "integer",
"description": "[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.",
"description": "[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Datastore backups.",
"format": "int32"
},
"schema": {
"$ref": "TableSchema",
"description": "[Required] The schema for the data."
"description": "[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups."
},
"sourceFormat": {
"type": "string",
"description": "[Required] The data format. For CSV files, specify \"CSV\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\"."
"description": "[Required] The data format. For CSV files, specify \"CSV\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Google Cloud Datastore backups, specify \"DATASTORE_BACKUP\"."
},
"sourceUris": {
"type": "array",
"description": "[Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs.",
"description": "[Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.",
"items": {
"type": "string"
}
@@ -478,10 +567,6 @@
"$ref": "JobConfigurationExtract",
"description": "[Pick one] Configures an extract job."
},
"link": {
"$ref": "JobConfigurationLink",
"description": "[Pick one] Configures a link job."
},
"load": {
"$ref": "JobConfigurationLoad",
"description": "[Pick one] Configures a load job."
@@ -530,31 +615,6 @@
}
}
},
"JobConfigurationLink": {
"id": "JobConfigurationLink",
"type": "object",
"properties": {
"createDisposition": {
"type": "string",
"description": "[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."
},
"destinationTable": {
"$ref": "TableReference",
"description": "[Required] The destination table of the link job."
},
"sourceUri": {
"type": "array",
"description": "[Required] URI of source table to link.",
"items": {
"type": "string"
}
},
"writeDisposition": {
"type": "string",
"description": "[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion."
}
}
},
"JobConfigurationLoad": {
"id": "JobConfigurationLoad",
"type": "object",
@@ -581,7 +641,7 @@
},
"fieldDelimiter": {
"type": "string",
"description": "[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 (',')."
"description": "[Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. 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 (',')."
},
"ignoreUnknownValues": {
"type": "boolean",
@@ -607,7 +667,7 @@
},
"schema": {
"$ref": "TableSchema",
"description": "[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."
"description": "[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore."
},
"schemaInline": {
"type": "string",
@@ -664,6 +724,12 @@
"description": "[Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.",
"default": "true"
},
"maximumBillingTier": {
"type": "integer",
"description": "[Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.",
"default": "1",
"format": "int32"
},
"preserveNulls": {
"type": "boolean",
"description": "[Deprecated] This property is deprecated."
@@ -678,7 +744,7 @@
},
"tableDefinitions": {
"type": "object",
"description": "[Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.",
"description": "[Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.",
"additionalProperties": {
"$ref": "ExternalDataConfiguration"
}
@@ -870,6 +936,13 @@
"type": "boolean",
"description": "[Output-only] Whether the query result was fetched from the query cache."
},
"queryPlan": {
"type": "array",
"description": "[Output-only, Experimental] Describes execution plan for the query as a list of stages.",
"items": {
"$ref": "ExplainQueryStage"
}
},
"totalBytesBilled": {
"type": "string",
"description": "[Output-only] Total bytes billed for the job.",
@@ -1167,7 +1240,7 @@
},
"externalDataConfiguration": {
"$ref": "ExternalDataConfiguration",
"description": "[Experimental] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table."
"description": "[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table."
},
"friendlyName": {
"type": "string",
@@ -1219,7 +1292,7 @@
},
"type": {
"type": "string",
"description": "[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. The default value is TABLE."
"description": "[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE."
},
"view": {
"$ref": "ViewDefinition",
@@ -1269,6 +1342,10 @@
"skipInvalidRows": {
"type": "boolean",
"description": "[Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist."
},
"templateSuffix": {
"type": "string",
"description": "[Optional] If specified, treats the destination table as a base template, and inserts the rows into an instance table named \"{destination}{templateSuffix}\". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables."
}
}
},
@@ -1498,6 +1575,13 @@
"query": {
"type": "string",
"description": "[Required] A query that BigQuery executes when the view is referenced."
},
"userDefinedFunctionResources": {
"type": "array",
"description": "[Experimental] Describes user-defined function resources used in the query.",
"items": {
"$ref": "UserDefinedFunctionResource"
}
}
}
}
@@ -1718,13 +1802,13 @@
"parameters": {
"jobId": {
"type": "string",
"description": "Job ID of the job to cancel",
"description": "[Required] Job ID of the job to cancel",
"required": true,
"location": "path"
},
"projectId": {
"type": "string",
"description": "Project ID of the job to cancel",
"description": "[Required] Project ID of the job to cancel",
"required": true,
"location": "path"
}
@@ -1749,13 +1833,13 @@
"parameters": {
"jobId": {
"type": "string",
"description": "Job ID of the requested job",
"description": "[Required] Job ID of the requested job",
"required": true,
"location": "path"
},
"projectId": {
"type": "string",
"description": "Project ID of the requested job",
"description": "[Required] Project ID of the requested job",
"required": true,
"location": "path"
}
@@ -1781,7 +1865,7 @@
"parameters": {
"jobId": {
"type": "string",
"description": "Job ID of the query job",
"description": "[Required] Job ID of the query job",
"required": true,
"location": "path"
},
@@ -1798,7 +1882,7 @@
},
"projectId": {
"type": "string",
"description": "Project ID of the query job",
"description": "[Required] Project ID of the query job",
"required": true,
"location": "path"
},