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

Attributes

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

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
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

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.