Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove nextQuery docs & annotate arrays correctly #1559

Merged
merged 1 commit into from
Sep 6, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions packages/bigquery/src/dataset.js
Original file line number Diff line number Diff line change
Expand Up @@ -272,8 +272,6 @@ Dataset.prototype.delete = function(options, callback) {
* @param {?error} callback.err - An error returned while making this request
* @param {module:bigquery/table[]} callback.tables - The list of tables from
* your Dataset.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down
15 changes: 0 additions & 15 deletions packages/bigquery/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,6 @@ BigQuery.prototype.dataset = function(id) {
* @param {?error} callback.err - An error returned while making this request
* @param {module:bigquery/dataset[]} callback.datasets - The list of datasets
* in your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -259,8 +257,6 @@ BigQuery.prototype.getDatasets = function(query, callback) {
* @param {?error} callback.err - An error returned while making this request
* @param {module:bigquery/job[]} callback.jobs - The list of jobs in your
* project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -359,16 +355,7 @@ BigQuery.prototype.job = function(id) {
/**
* Run a query scoped to your project.
*
* If you provide a callback, this method returns the results from your query to
* it. When querying large sets of data, it is possible your results won't be
* returned all at once. In those cases, you will receive a third argument to
* your callback that can be passed back to this method to return more results.
*
* See the examples below for such a workflow.
*
* This method also runs as a readable stream if you do not provide a callback.
* In cases where more results exist, this will automatically run the subsequent
* queries for you, pushing each row to the stream.
*
* @resource [Jobs: query API Documentation]{@link https://cloud.google.com/bigquery/docs/reference/v2/jobs/query}
*
Expand All @@ -388,8 +375,6 @@ BigQuery.prototype.job = function(id) {
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request
* @param {array} callback.rows - The list of results from your query.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down
2 changes: 0 additions & 2 deletions packages/bigquery/src/table.js
Original file line number Diff line number Diff line change
Expand Up @@ -577,8 +577,6 @@ Table.prototype.export = function(destination, options, callback) {
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request
* @param {array} callback.rows - The table data from specified set of rows.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down
2 changes: 0 additions & 2 deletions packages/bigtable/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -435,8 +435,6 @@ Bigtable.prototype.createInstance = function(name, options, callback) {
* @param {?error} callback.error - An error returned while making this request.
* @param {module:bigtable/instance[]} callback.instances - List of all
* instances.
* @param {object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down
4 changes: 0 additions & 4 deletions packages/bigtable/src/instance.js
Original file line number Diff line number Diff line change
Expand Up @@ -451,8 +451,6 @@ Instance.prototype.cluster = function(name) {
* @param {?error} callback.error - An error returned while making this request.
* @param {module:bigtable/cluster[]} callback.clusters - List of all
* Clusters.
* @param {object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -554,8 +552,6 @@ Instance.prototype.getClusters = function(query, callback) {
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:bigtable/table[]} callback.tables - List of all Tables.
* @param {object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down
64 changes: 17 additions & 47 deletions packages/compute/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -579,10 +579,8 @@ Compute.prototype.firewall = function(name) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/address} callback.addresses - Address objects from
* @param {module:compute/address[]} callback.addresses - Address objects from
* your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -698,8 +696,6 @@ Compute.prototype.getAddresses = function(options, callback) {
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/autoscaler[]} callback.autoscalers - Autoscaler
* objects from your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -815,9 +811,8 @@ Compute.prototype.getAutoscalers = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/disk} callback.disks - Disk objects from your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {module:compute/disk[]} callback.disks - Disk objects from your
* project.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -932,8 +927,6 @@ Compute.prototype.getDisks = function(options, callback) {
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/instance-group[]} callback.instanceGroups -
* InstanceGroup objects from your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -1045,10 +1038,8 @@ Compute.prototype.getInstanceGroups = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/firewall} callback.firewalls - Firewall objects from
* @param {module:compute/firewall[]} callback.firewalls - Firewall objects from
* your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -1154,10 +1145,8 @@ Compute.prototype.getFirewalls = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/health-check} callback.healthChecks - HealthCheck
* @param {module:compute/health-check[]} callback.healthChecks - HealthCheck
* objects from your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -1269,8 +1258,6 @@ Compute.prototype.getHealthChecks = function(options, callback) {
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/machine-type[]} callback.machineTypes - MachineType
* objects from your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -1382,10 +1369,8 @@ Compute.prototype.getMachineTypes = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/network} callback.networks - Network objects from your
* project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {module:compute/network[]} callback.networks - Network objects from
* your project.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -1488,10 +1473,8 @@ Compute.prototype.getNetworks = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/operation} callback.operations - Operation objects
* @param {module:compute/operation[]} callback.operations - Operation objects
* from your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -1594,10 +1577,8 @@ Compute.prototype.getOperations = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/region} callback.regions - Region objects that are
* @param {module:compute/region[]} callback.regions - Region objects that are
* available to your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -1697,9 +1678,8 @@ Compute.prototype.getRegions = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/rule} callback.rules - Rule objects from this region.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {module:compute/rule[]} callback.rules - Rule objects from your
* project.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -1804,8 +1784,6 @@ Compute.prototype.getRules = function(options, callback) {
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/service[]} callback.services - Service objects from
* your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -1908,10 +1886,8 @@ Compute.prototype.getServices = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/snapshot} callback.snapshots - Snapshot objects from
* @param {module:compute/snapshot[]} callback.snapshots - Snapshot objects from
* your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -2014,10 +1990,8 @@ Compute.prototype.getSnapshots = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/subnetwork} callback.subnetworks - Subnetwork objects
* from your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {module:compute/subnetwork[]} callback.subnetworks - Subnetwork
* objects from your project.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -2129,9 +2103,7 @@ Compute.prototype.getSubnetworks = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/vm} callback.vms - VM objects from your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {module:compute/vm[]} callback.vms - VM objects from your project.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -2243,10 +2215,8 @@ Compute.prototype.getVMs = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/zone} callback.zones - Zone objects that are available
* to your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {module:compute/zone[]} callback.zones - Zone objects that are
* available to your project.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down
2 changes: 0 additions & 2 deletions packages/compute/src/instance-group.js
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,6 @@ InstanceGroup.prototype.delete = function(callback) {
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/vm[]} callback.vms - VM objects from this isntance
* group.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down
10 changes: 3 additions & 7 deletions packages/compute/src/network.js
Original file line number Diff line number Diff line change
Expand Up @@ -275,10 +275,8 @@ Network.prototype.createSubnetwork = function(name, config, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/subnetwork} callback.subnetworks - Subnetwork objects
* from this network.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {module:compute/subnetwork[]} callback.subnetworks - Subnetwork
* objects from this network.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -405,10 +403,8 @@ Network.prototype.firewall = function(name) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/firewall} callback.firewalls - Firewall objects from
* @param {module:compute/firewall[]} callback.firewalls - Firewall objects from
* this network.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down
15 changes: 4 additions & 11 deletions packages/compute/src/region.js
Original file line number Diff line number Diff line change
Expand Up @@ -356,10 +356,8 @@ Region.prototype.createRule = function(name, config, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/address} callback.addresses - Address objects from
* @param {module:compute/address[]} callback.addresses - Address objects from
* this region.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -462,10 +460,8 @@ Region.prototype.getAddresses = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/operation} callback.operations - Operation objects
* @param {module:compute/operation[]} callback.operations - Operation objects
* from this region.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -567,9 +563,8 @@ Region.prototype.getOperations = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/rule} callback.rules - Rule objects from this region.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {module:compute/rule[]} callback.rules - Rule objects from this
* region.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down Expand Up @@ -674,8 +669,6 @@ Region.prototype.getRules = function(options, callback) {
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/subnetwork[]} callback.subnetworks - Subnetwork
* objects from this region.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
*
* @example
Expand Down
Loading