Package-level declarations

Data classes used to represent Google API discovery documents.

The main top-level class is RestDescription, used to represent a Google API discovery document.

See the using Google Discovery API docs for more information on how to use these classes.

Types

Link copied to clipboard
data class DirectoryItem(val kind: String, val id: String, val name: String, val version: String, val title: String, val description: String, val discoveryRestUrl: String, val discoveryLink: String? = null, val icons: SchemaIcons, val documentationLink: String? = null, val labels: List<String> = listOf(), val preferred: Boolean)

Data class to represent an individual directory item.

Link copied to clipboard
data class DirectoryList(val kind: String = "discovery#directoryList", val discoveryVersion: String, val items: List<DirectoryItem>)

JSON as returned by the Google API discovery.apis.list method.

Link copied to clipboard
Link copied to clipboard
data class RestDescription(val kind: String = "discovery#restDescription", val etag: String? = null, val discoveryVersion: String? = null, val id: String? = null, val name: String? = null, val canonicalName: String? = null, val version: String? = null, val revision: String? = null, val title: String? = null, val description: String? = null, val ownerDomain: String? = null, val ownerName: String? = null, val icons: SchemaIcons? = null, val documentationLink: String? = null, val labels: List<String>? = emptyList(), val protocol: String? = null, val baseUrl: String? = null, val basePath: String? = null, val rootUrl: String? = null, val servicePath: String? = null, val batchPath: String? = null, val packagePath: String? = null, val parameters: RestParameters? = null, val auth: SchemaAuth? = null, val features: List<String>? = emptyList(), val schemas: RestItems? = null, val methods: RestMethods? = null, val resources: RestResources? = null, val versionModule: Boolean? = null, val exponentialBackoffDefault: Boolean? = null)

Data class representing a resource from Google's Discovery API.

Link copied to clipboard
Link copied to clipboard
data class RestMethod(val id: String? = null, val path: String? = null, val flatPath: String? = null, val httpMethod: HttpMethod? = null, val description: String? = null, val etagRequired: Boolean? = null, val parameters: RestParameters? = emptyMap(), val parameterOrder: List<String>? = emptyList(), val request: RestMethod.Request? = null, val response: RestMethod.Response? = null, val scopes: List<String>? = emptyList(), val supportsMediaDownload: Boolean? = null, val useMediaDownloadService: Boolean? = null, val supportsMediaUpload: Boolean? = null, val mediaUpload: RestMethod.MediaUpload? = null, val supportsSubscription: Boolean? = null)

Data class to represent an individual method for RestDescription.methods.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class RestResource(val methods: RestMethods? = null, val resources: RestResources? = null)

Data class to represent metadata for an individual schema resource.

Link copied to clipboard
Link copied to clipboard
data class SchemaAuth(val oauth2: SchemaAuth.OAuth2? = null)

Data class to represent RestDescription.auth.

Link copied to clipboard
data class SchemaIcons(val x16: String? = null, val x32: String? = null)

Data class used to represent the RestDescription.icons data structure.

Link copied to clipboard