google_api_discovery v0.10.0 GoogleApi.Discovery.V1.Model.RestMethod View Source

Attributes

  • description (type: String.t, default: nil) - Description of this method.
  • etagRequired (type: boolean(), default: nil) - Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.
  • httpMethod (type: String.t, default: nil) - HTTP method used by this method.
  • id (type: String.t, default: nil) - A unique ID for this method. This property can be used to match methods between different versions of Discovery.
  • mediaUpload (type: GoogleApi.Discovery.V1.Model.RestMethodMediaUpload.t, default: nil) - Media upload parameters.
  • parameterOrder (type: list(String.t), default: nil) - 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.
  • parameters (type: %{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}, default: nil) - Details for all parameters in this method.
  • path (type: String.t, default: nil) - The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
  • request (type: GoogleApi.Discovery.V1.Model.RestMethodRequest.t, default: nil) - The schema for the request.
  • response (type: GoogleApi.Discovery.V1.Model.RestMethodResponse.t, default: nil) - The schema for the response.
  • scopes (type: list(String.t), default: nil) - OAuth 2.0 scopes applicable to this method.
  • supportsMediaDownload (type: boolean(), default: nil) - Whether this method supports media downloads.
  • supportsMediaUpload (type: boolean(), default: nil) - Whether this method supports media uploads.
  • supportsSubscription (type: boolean(), default: nil) - Whether this method supports subscriptions.
  • useMediaDownloadService (type: boolean(), default: nil) - Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Discovery.V1.Model.RestMethod{
  description: String.t(),
  etagRequired: boolean(),
  httpMethod: String.t(),
  id: String.t(),
  mediaUpload: GoogleApi.Discovery.V1.Model.RestMethodMediaUpload.t(),
  parameterOrder: [String.t()],
  parameters: %{
    optional(String.t()) => GoogleApi.Discovery.V1.Model.JsonSchema.t()
  },
  path: String.t(),
  request: GoogleApi.Discovery.V1.Model.RestMethodRequest.t(),
  response: GoogleApi.Discovery.V1.Model.RestMethodResponse.t(),
  scopes: [String.t()],
  supportsMediaDownload: boolean(),
  supportsMediaUpload: boolean(),
  supportsSubscription: boolean(),
  useMediaDownloadService: boolean()
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.