package gapi-ocaml

You can search for identifiers within the package.

in-package search v0.2.0

gapi-ocaml

Legend:
Library
Module
Module type
Parameter
Class
Class type

module StateFilter : sig ... end

module Projection : sig ... end

val cancel : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  projectId:string ->
  jobId:string ->
  GapiConversation.Session.t ->
  GapiBigqueryV2Model.JobCancelResponse.t * GapiConversation.Session.t

Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/bigquery/v2/").

parameter std_params
Optional standard parameters.

parameter projectId
Project ID of the job to cancel

parameter jobId
Job ID of the job to cancel

val get : 
  ?base_url:string ->
  ?etag:string ->
  ?std_params:GapiService.StandardParameters.t ->
  projectId:string ->
  jobId:string ->
  GapiConversation.Session.t ->
  GapiBigqueryV2Model.Job.t * GapiConversation.Session.t

Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/bigquery/v2/").

parameter etag
Optional ETag.

parameter std_params
Optional standard parameters.

parameter projectId
Project ID of the requested job

parameter jobId
Job ID of the requested job

val getQueryResults : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?maxResults:int ->
  ?pageToken:string ->
  ?startIndex:string ->
  ?timeoutMs:int ->
  projectId:string ->
  jobId:string ->
  GapiConversation.Session.t ->
  GapiBigqueryV2Model.GetQueryResultsResponse.t * GapiConversation.Session.t

Retrieves the results of a query job.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/bigquery/v2/").

parameter std_params
Optional standard parameters.

parameter maxResults
Maximum number of results to read

parameter pageToken
Page token, returned by a previous call, to request the next page of results

parameter startIndex
Zero-based index of the starting row

parameter timeoutMs
How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false

parameter projectId
Project ID of the query job

parameter jobId
Job ID of the query job

val insert : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?media_source:GapiMediaResource.t ->
  projectId:string ->
  GapiBigqueryV2Model.Job.t ->
  GapiConversation.Session.t ->
  GapiBigqueryV2Model.Job.t * GapiConversation.Session.t

Starts a new asynchronous job. Requires the Can View project role.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/bigquery/v2/").

parameter std_params
Optional standard parameters.

parameter projectId
Project ID of the project that will be billed for the job

val list : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?allUsers:bool ->
  ?maxResults:int ->
  ?pageToken:string ->
  ?projection:Projection.t ->
  ?stateFilter:StateFilter.t list ->
  projectId:string ->
  GapiConversation.Session.t ->
  GapiBigqueryV2Model.JobList.t * GapiConversation.Session.t

Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/bigquery/v2/").

parameter std_params
Optional standard parameters.

parameter allUsers
Whether to display jobs owned by all users in the project. Default false

parameter maxResults
Maximum number of results to return

parameter pageToken
Page token, returned by a previous call, to request the next page of results

parameter projection
Restrict information returned to a set of selected fields

parameter stateFilter
Filter for job state

parameter projectId
Project ID of the jobs to list

val query : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  projectId:string ->
  GapiBigqueryV2Model.QueryRequest.t ->
  GapiConversation.Session.t ->
  GapiBigqueryV2Model.QueryResponse.t * GapiConversation.Session.t

Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/bigquery/v2/").

parameter std_params
Optional standard parameters.

parameter projectId
Project ID of the project billed for the query