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

Attributes

  • parameters (%{optional(String.t) => JsonSchema}): Details for all parameters in this method. Defaults to: null.
  • description (String.t): Description of this method. Defaults to: null.
  • 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: null.
  • httpMethod (String.t): HTTP method used by this method. Defaults to: null.
  • id (String.t): A unique ID for this method. This property can be used to match methods between different versions of Discovery. Defaults to: null.
  • mediaUpload (RestMethodMediaUpload): Defaults to: null.
  • parameterOrder ([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: null.
  • 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: null.
  • request (RestMethodRequest): Defaults to: null.
  • response (RestMethodResponse): Defaults to: null.
  • scopes ([String.t]): OAuth 2.0 scopes applicable to this method. Defaults to: null.
  • supportsMediaDownload (boolean()): Whether this method supports media downloads. Defaults to: null.
  • supportsMediaUpload (boolean()): Whether this method supports media uploads. Defaults to: null.
  • supportsSubscription (boolean()): Whether this method supports subscriptions. Defaults to: null.
  • 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: null.

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: any(),
  etagRequired: any(),
  httpMethod: any(),
  id: any(),
  mediaUpload: GoogleApi.Discovery.V1.Model.RestMethodMediaUpload.t(),
  parameterOrder: [any()],
  parameters: map(),
  path: any(),
  request: GoogleApi.Discovery.V1.Model.RestMethodRequest.t(),
  response: GoogleApi.Discovery.V1.Model.RestMethodResponse.t(),
  scopes: [any()],
  supportsMediaDownload: any(),
  supportsMediaUpload: any(),
  supportsSubscription: any(),
  useMediaDownloadService: any()
}

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.