package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
val delete : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?deleteContents:bool -> projectId:string -> datasetId:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter deleteContents

    If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False

  • parameter projectId

    Project ID of the dataset being deleted

  • parameter datasetId

    Dataset ID of dataset being deleted

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

Returns the dataset specified by datasetID.

  • 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 dataset

  • parameter datasetId

    Dataset ID of the requested dataset

Creates a new empty dataset.

  • 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 new dataset

val list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?all:bool -> ?maxResults:int -> ?pageToken:string -> projectId:string -> GapiConversation.Session.t -> GapiBigqueryV2Model.DatasetList.t * GapiConversation.Session.t

Lists all datasets in the specified project to which you have been granted the READER dataset role.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter all

    Whether to list all datasets, including hidden ones

  • parameter maxResults

    The maximum number of results to return

  • parameter pageToken

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

  • parameter projectId

    Project ID of the datasets to be listed

val patch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> projectId:string -> datasetId:string -> GapiBigqueryV2Model.Dataset.t -> GapiConversation.Session.t -> GapiBigqueryV2Model.Dataset.t * GapiConversation.Session.t

Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics.

  • 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 dataset being updated

  • parameter datasetId

    Dataset ID of the dataset being updated

val update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> projectId:string -> datasetId:string -> GapiBigqueryV2Model.Dataset.t -> GapiConversation.Session.t -> GapiBigqueryV2Model.Dataset.t * GapiConversation.Session.t

Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.

  • 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 dataset being updated

  • parameter datasetId

    Dataset ID of the dataset being updated