package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module GapiDiscoveryV1Model.RestMethodSource

Sourcemodule MediaUpload : sig ... end
Sourcemodule Response : sig ... end
Sourcemodule Request : sig ... end
Sourcetype t = {
  1. useMediaDownloadService : bool;
    (*

    Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.

    *)
  2. id : string;
    (*

    A unique ID for this method. This property can be used to match methods between different versions of Discovery.

    *)
  3. parameterOrder : string list;
    (*

    Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first.

    *)
  4. etagRequired : bool;
    (*

    Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.

    *)
  5. httpMethod : string;
    (*

    HTTP method used by this method.

    *)
  6. flatPath : string;
    (*

    The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property.

    *)
  7. supportsMediaDownload : bool;
    (*

    Whether this method supports media downloads.

    *)
  8. scopes : string list;
    (*

    OAuth 2.0 scopes applicable to this method.

    *)
  9. request : Request.t;
    (*

    The schema for the request.

    *)
  10. description : string;
    (*

    Description of this method.

    *)
  11. deprecated : bool;
    (*

    Whether this method is deprecated.

    *)
  12. response : Response.t;
    (*

    The schema for the response.

    *)
  13. apiVersion : string;
    (*

    The API Version of this method, as passed in via the `X-Goog-Api-Version` header or `$apiVersion` query parameter.

    *)
  14. supportsMediaUpload : bool;
    (*

    Whether this method supports media uploads.

    *)
  15. path : string;
    (*

    The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.

    *)
  16. supportsSubscription : bool;
    (*

    Whether this method supports subscriptions.

    *)
  17. mediaUpload : MediaUpload.t;
    (*

    Media upload parameters.

    *)
  18. parameters : (string * JsonSchema.t) list;
    (*

    Details for all parameters in this method.

    *)
}
Sourceval useMediaDownloadService : (t, bool) GapiLens.t
Sourceval id : (t, string) GapiLens.t
Sourceval parameterOrder : (t, string list) GapiLens.t
Sourceval etagRequired : (t, bool) GapiLens.t
Sourceval httpMethod : (t, string) GapiLens.t
Sourceval flatPath : (t, string) GapiLens.t
Sourceval supportsMediaDownload : (t, bool) GapiLens.t
Sourceval scopes : (t, string list) GapiLens.t
Sourceval request : (t, Request.t) GapiLens.t
Sourceval description : (t, string) GapiLens.t
Sourceval deprecated : (t, bool) GapiLens.t
Sourceval response : (t, Response.t) GapiLens.t
Sourceval apiVersion : (t, string) GapiLens.t
Sourceval supportsMediaUpload : (t, bool) GapiLens.t
Sourceval path : (t, string) GapiLens.t
Sourceval supportsSubscription : (t, bool) GapiLens.t
Sourceval mediaUpload : (t, MediaUpload.t) GapiLens.t
Sourceval parameters : (t, (string * JsonSchema.t) list) GapiLens.t
Sourceval empty : t
Sourceval render : t -> GapiJson.json_data_model list
Sourceval to_data_model : t -> GapiJson.json_data_model
Sourceval of_data_model : GapiJson.json_data_model -> t
OCaml

Innovation. Community. Security.