google_api_discovery v0.3.0 API Reference

Modules

API calls for all endpoints tagged Apis.

Handle Tesla connections for GoogleApi.Discovery.V1.

Attributes

  • discoveryVersion (String.t): Indicate the version of the Discovery API used to generate this doc. Defaults to v1.
  • items (list(GoogleApi.Discovery.V1.Model.DirectoryListItems.t)): The individual directory entries. One entry per api/version pair. Defaults to nil.
  • kind (String.t): The kind for this response. Defaults to discovery#directoryList.

Attributes

  • description (String.t): The description of this API. Defaults to nil.
  • discoveryLink (String.t): A link to the discovery document. Defaults to nil.
  • discoveryRestUrl (String.t): The URL for the discovery REST document. Defaults to nil.
  • documentationLink (String.t): A link to human readable documentation for the API. Defaults to nil.
  • icons (GoogleApi.Discovery.V1.Model.DirectoryListItemsIcons.t): Links to 16x16 and 32x32 icons representing the API. Defaults to nil.
  • id (String.t): The id of this API. Defaults to nil.
  • kind (String.t): The kind for this response. Defaults to discovery#directoryItem.
  • labels (list(String.t)): Labels for the status of this API, such as labs or deprecated. Defaults to nil.
  • name (String.t): The name of the API. Defaults to nil.
  • preferred (boolean()): True if this version is the preferred version to use. Defaults to nil.
  • title (String.t): The title of this API. Defaults to nil.
  • version (String.t): The version of the API. Defaults to nil.

Links to 16x16 and 32x32 icons representing the API.

Attributes

  • $ref (String.t): A reference to another schema. The value of this property is the "id" of another schema. Defaults to nil.
  • additionalProperties (GoogleApi.Discovery.V1.Model.JsonSchema.t): If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object. Defaults to nil.
  • annotations (GoogleApi.Discovery.V1.Model.JsonSchemaAnnotations.t): Additional information about this property. Defaults to nil.
  • default (String.t): The default value of this property (if one exists). Defaults to nil.
  • description (String.t): A description of this object. Defaults to nil.
  • enum (list(String.t)): Values this parameter may take (if it is an enum). Defaults to nil.
  • enumDescriptions (list(String.t)): The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. Defaults to nil.
  • format (String.t): An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 Defaults to nil.
  • id (String.t): Unique identifier for this schema. Defaults to nil.
  • items (GoogleApi.Discovery.V1.Model.JsonSchema.t): If this is a schema for an array, this property is the schema for each element in the array. Defaults to nil.
  • location (String.t): Whether this parameter goes in the query or the path for REST requests. Defaults to nil.
  • maximum (String.t): The maximum value of this parameter. Defaults to nil.
  • minimum (String.t): The minimum value of this parameter. Defaults to nil.
  • pattern (String.t): The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html Defaults to nil.
  • properties (%{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}): If this is a schema for an object, list the schema for each property of this object. Defaults to nil.
  • readOnly (boolean()): The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service. Defaults to nil.
  • repeated (boolean()): Whether this parameter may appear multiple times. Defaults to nil.
  • required (boolean()): Whether the parameter is required. Defaults to nil.
  • type (String.t): The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 Defaults to nil.
  • variant (GoogleApi.Discovery.V1.Model.JsonSchemaVariant.t): In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names. Defaults to nil.

Additional information about this property.

In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.

Attributes

  • $ref (String.t): Defaults to nil.
  • type_value (String.t): Defaults to nil.

Attributes

  • auth (GoogleApi.Discovery.V1.Model.RestDescriptionAuth.t): Authentication information. Defaults to nil.
  • basePath (String.t): [DEPRECATED] The base path for REST requests. Defaults to nil.
  • baseUrl (String.t): [DEPRECATED] The base URL for REST requests. Defaults to nil.
  • batchPath (String.t): The path for REST batch requests. Defaults to nil.
  • canonicalName (String.t): Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names. Defaults to nil.
  • description (String.t): The description of this API. Defaults to nil.
  • discoveryVersion (String.t): Indicate the version of the Discovery API used to generate this doc. Defaults to v1.
  • documentationLink (String.t): A link to human readable documentation for the API. Defaults to nil.
  • etag (String.t): The ETag for this response. Defaults to nil.
  • exponentialBackoffDefault (boolean()): Enable exponential backoff for suitable methods in the generated clients. Defaults to nil.
  • features (list(String.t)): A list of supported features for this API. Defaults to nil.
  • icons (GoogleApi.Discovery.V1.Model.RestDescriptionIcons.t): Links to 16x16 and 32x32 icons representing the API. Defaults to nil.
  • id (String.t): The ID of this API. Defaults to nil.
  • kind (String.t): The kind for this response. Defaults to discovery#restDescription.
  • labels (list(String.t)): Labels for the status of this API, such as labs or deprecated. Defaults to nil.
  • methods (%{optional(String.t) => GoogleApi.Discovery.V1.Model.RestMethod.t}): API-level methods for this API. Defaults to nil.
  • name (String.t): The name of this API. Defaults to nil.
  • ownerDomain (String.t): The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name. Defaults to nil.
  • ownerName (String.t): The name of the owner of this API. See ownerDomain. Defaults to nil.
  • packagePath (String.t): The package of the owner of this API. See ownerDomain. Defaults to nil.
  • parameters (%{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}): Common parameters that apply across all apis. Defaults to nil.
  • protocol (String.t): The protocol described by this document. Defaults to rest.
  • resources (%{optional(String.t) => GoogleApi.Discovery.V1.Model.RestResource.t}): The resources in this API. Defaults to nil.
  • revision (String.t): The version of this API. Defaults to nil.
  • rootUrl (String.t): The root URL under which all API services live. Defaults to nil.
  • schemas (%{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}): The schemas for this API. Defaults to nil.
  • servicePath (String.t): The base path for all REST requests. Defaults to nil.
  • title (String.t): The title of this API. Defaults to nil.
  • version (String.t): The version of this API. Defaults to nil.
  • version_module (boolean()): Defaults to nil.

OAuth 2.0 authentication information.

Links to 16x16 and 32x32 icons representing the API.

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.

Supports the Resumable Media Upload protocol.

Supports uploading as a single HTTP request.

Attributes

  • methods (%{optional(String.t) => GoogleApi.Discovery.V1.Model.RestMethod.t}): Methods on this resource. Defaults to nil.
  • resources (%{optional(String.t) => GoogleApi.Discovery.V1.Model.RestResource.t}): Sub-resources on this resource. Defaults to nil.