google_api_discovery v0.6.0 API Reference
Modules
API calls for all endpoints tagged Apis
.
Handle Tesla connections for GoogleApi.Discovery.V1.
Attributes
discoveryVersion
(type:String.t
, default:v1
) - Indicate the version of the Discovery API used to generate this doc.items
(type:list(GoogleApi.Discovery.V1.Model.DirectoryListItems.t)
, default:nil
) - The individual directory entries. One entry per api/version pair.kind
(type:String.t
, default:discovery#directoryList
) - The kind for this response.
Attributes
description
(type:String.t
, default:nil
) - The description of this API.discoveryLink
(type:String.t
, default:nil
) - A link to the discovery document.discoveryRestUrl
(type:String.t
, default:nil
) - The URL for the discovery REST document.documentationLink
(type:String.t
, default:nil
) - A link to human readable documentation for the API.icons
(type:GoogleApi.Discovery.V1.Model.DirectoryListItemsIcons.t
, default:nil
) - Links to 16x16 and 32x32 icons representing the API.id
(type:String.t
, default:nil
) - The id of this API.kind
(type:String.t
, default:discovery#directoryItem
) - The kind for this response.labels
(type:list(String.t)
, default:nil
) - Labels for the status of this API, such as labs or deprecated.name
(type:String.t
, default:nil
) - The name of the API.preferred
(type:boolean()
, default:nil
) - True if this version is the preferred version to use.title
(type:String.t
, default:nil
) - The title of this API.version
(type:String.t
, default:nil
) - The version of the API.
Links to 16x16 and 32x32 icons representing the API.
Attributes
$ref
(type:String.t
, default:nil
) - A reference to another schema. The value of this property is the "id" of another schema.additionalProperties
(type:GoogleApi.Discovery.V1.Model.JsonSchema.t
, default:nil
) - If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.annotations
(type:GoogleApi.Discovery.V1.Model.JsonSchemaAnnotations.t
, default:nil
) - Additional information about this property.default
(type:String.t
, default:nil
) - The default value of this property (if one exists).description
(type:String.t
, default:nil
) - A description of this object.enum
(type:list(String.t)
, default:nil
) - Values this parameter may take (if it is an enum).enumDescriptions
(type:list(String.t)
, default:nil
) - The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.format
(type:String.t
, default:nil
) - 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.23id
(type:String.t
, default:nil
) - Unique identifier for this schema.items
(type:GoogleApi.Discovery.V1.Model.JsonSchema.t
, default:nil
) - If this is a schema for an array, this property is the schema for each element in the array.location
(type:String.t
, default:nil
) - Whether this parameter goes in the query or the path for REST requests.maximum
(type:String.t
, default:nil
) - The maximum value of this parameter.minimum
(type:String.t
, default:nil
) - The minimum value of this parameter.pattern
(type:String.t
, default:nil
) - 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.htmlproperties
(type:%{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}
, default:nil
) - If this is a schema for an object, list the schema for each property of this object.readOnly
(type:boolean()
, default:nil
) - 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.repeated
(type:boolean()
, default:nil
) - Whether this parameter may appear multiple times.required
(type:boolean()
, default:nil
) - Whether the parameter is required.type
(type:String.t
, default:nil
) - 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.1variant
(type:GoogleApi.Discovery.V1.Model.JsonSchemaVariant.t
, default:nil
) - 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.
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
auth
(type:GoogleApi.Discovery.V1.Model.RestDescriptionAuth.t
, default:nil
) - Authentication information.basePath
(type:String.t
, default:nil
) - [DEPRECATED] The base path for REST requests.baseUrl
(type:String.t
, default:nil
) - [DEPRECATED] The base URL for REST requests.batchPath
(type:String.t
, default:nil
) - The path for REST batch requests.canonicalName
(type:String.t
, default:nil
) - Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.description
(type:String.t
, default:nil
) - The description of this API.discoveryVersion
(type:String.t
, default:v1
) - Indicate the version of the Discovery API used to generate this doc.documentationLink
(type:String.t
, default:nil
) - A link to human readable documentation for the API.etag
(type:String.t
, default:nil
) - The ETag for this response.exponentialBackoffDefault
(type:boolean()
, default:nil
) - Enable exponential backoff for suitable methods in the generated clients.features
(type:list(String.t)
, default:nil
) - A list of supported features for this API.icons
(type:GoogleApi.Discovery.V1.Model.RestDescriptionIcons.t
, default:nil
) - Links to 16x16 and 32x32 icons representing the API.id
(type:String.t
, default:nil
) - The ID of this API.kind
(type:String.t
, default:discovery#restDescription
) - The kind for this response.labels
(type:list(String.t)
, default:nil
) - Labels for the status of this API, such as labs or deprecated.methods
(type:%{optional(String.t) => GoogleApi.Discovery.V1.Model.RestMethod.t}
, default:nil
) - API-level methods for this API.name
(type:String.t
, default:nil
) - The name of this API.ownerDomain
(type:String.t
, default:nil
) - 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.ownerName
(type:String.t
, default:nil
) - The name of the owner of this API. See ownerDomain.packagePath
(type:String.t
, default:nil
) - The package of the owner of this API. See ownerDomain.parameters
(type:%{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}
, default:nil
) - Common parameters that apply across all apis.protocol
(type:String.t
, default:rest
) - The protocol described by this document.resources
(type:%{optional(String.t) => GoogleApi.Discovery.V1.Model.RestResource.t}
, default:nil
) - The resources in this API.revision
(type:String.t
, default:nil
) - The version of this API.rootUrl
(type:String.t
, default:nil
) - The root URL under which all API services live.schemas
(type:%{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}
, default:nil
) - The schemas for this API.servicePath
(type:String.t
, default:nil
) - The base path for all REST requests.title
(type:String.t
, default:nil
) - The title of this API.version
(type:String.t
, default:nil
) - The version of this API.version_module
(type:boolean()
, default:nil
) -
Authentication information.
OAuth 2.0 authentication information.
Links to 16x16 and 32x32 icons representing the API.
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.
Media upload parameters.
Supported upload protocols.
Supports the Resumable Media Upload protocol.
Supports uploading as a single HTTP request.
The schema for the request.
The schema for the response.