package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = {
  1. cacheHit : bool;
    (*

    Whether the query result was fetched from the query cache.

    *)
  2. errors : ErrorProto.t list;
    (*

    [Output-only] All errors and warnings encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.

    *)
  3. jobComplete : bool;
    (*

    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.

    *)
  4. jobReference : JobReference.t;
    (*

    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).

    *)
  5. kind : string;
    (*

    The resource type.

    *)
  6. pageToken : string;
    (*

    A token used for paging results.

    *)
  7. rows : TableRow.t list;
    (*

    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.

    *)
  8. schema : TableSchema.t;
    (*

    The schema of the results. Present only when the query completes successfully.

    *)
  9. totalBytesProcessed : int64;
    (*

    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.

    *)
  10. totalRows : 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.

    *)
}
val cacheHit : (t, bool) GapiLens.t
val errors : (t, ErrorProto.t list) GapiLens.t
val jobComplete : (t, bool) GapiLens.t
val jobReference : (t, JobReference.t) GapiLens.t
val kind : (t, string) GapiLens.t
val pageToken : (t, string) GapiLens.t
val rows : (t, TableRow.t list) GapiLens.t
val schema : (t, TableSchema.t) GapiLens.t
val totalBytesProcessed : (t, int64) GapiLens.t
val totalRows : (t, string) GapiLens.t
val empty : t
val render : t -> GapiJson.json_data_model list
val parse : t -> GapiJson.json_data_model -> t
val to_data_model : t -> GapiJson.json_data_model
val of_data_model : GapiJson.json_data_model -> t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct