com.google.api.server.spi.discovery

Interface DiscoveryProvider

All Known Implementing Classes:

CachingDiscoveryProvider, LocalDiscoveryProvider, ProxyingDiscoveryProvider

public interface DiscoveryProvider

An interface for generating discovery documents from API configurations.

Method Summary

Modifier and Type	Method and Description
com.google.api.services.discovery.model.DirectoryList	getDirectory(java.lang.String root) Gets a list of REST discovery documents hosted by the current server.
com.google.api.services.discovery.model.RestDescription	getRestDocument(java.lang.String root, java.lang.String name, java.lang.String version) Gets a REST discovery document for an API.
com.google.api.services.discovery.model.RpcDescription	getRpcDocument(java.lang.String root, java.lang.String name, java.lang.String version) Gets an RPC discovery document for an API.

Method Detail

getRestDocument

com.google.api.services.discovery.model.RestDescription getRestDocument(java.lang.String root,
                                                                        java.lang.String name,
                                                                        java.lang.String version)
                                                                 throws NotFoundException,
                                                                        InternalServerErrorException

Gets a REST discovery document for an API.

Throws:

NotFoundException - if the API doesn't exist

InternalServerErrorException - an error takes place when getting the document

getRpcDocument

com.google.api.services.discovery.model.RpcDescription getRpcDocument(java.lang.String root,
                                                                      java.lang.String name,
                                                                      java.lang.String version)
                                                               throws NotFoundException,
                                                                      InternalServerErrorException

Gets an RPC discovery document for an API.

Throws:

NotFoundException - if the API doesn't exist

InternalServerErrorException - an error takes place when getting the document

getDirectory

com.google.api.services.discovery.model.DirectoryList getDirectory(java.lang.String root)
                                                            throws InternalServerErrorException

Gets a list of REST discovery documents hosted by the current server. This method will never return RPC discovery documents, as everything that uses online discovery uses the REST discovery doc (API explorer, Python and JavaScript client, etc).

Throws:

InternalServerErrorException