Default request referring to version v1 of the APIs Discovery Service. This contains the host and root path used as a starting point for constructing service requests.

Represents the entirety of the methods and resources available for the APIs Discovery Service service.

The schema for the response.

See: restMethodResponse smart constructor.

Creates a value of RestMethodResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmrRef

Schema ID for the response schema.

Common parameters that apply across all apis.

See: restDescriptionParameters smart constructor.

Creates a value of RestDescriptionParameters with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdpAddtional

Description of a single parameter.

Creates a value of RestMethod with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmSupportsMediaDownload
• rmParameterOrder
• rmMediaUpload
• rmHTTPMethod
• rmPath
• rmResponse
• rmSupportsMediaUpload
• rmScopes
• rmSupportsSubscription
• rmParameters
• rmId
• rmEtagRequired
• rmUseMediaDownloadService
• rmDescription
• rmRequest

Whether this method supports media downloads.

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.

Media upload parameters.

HTTP method used by this method.

The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.

The schema for the response.

Whether this method supports media uploads.

OAuth 2.0 scopes applicable to this method.

Whether this method supports subscriptions.

Details for all parameters in this method.

A unique ID for this method. This property can be used to match methods between different versions of Discovery.

Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.

Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.

Description of this method.

The schema for the request.

Creates a value of RestResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rrResources
• rrMethods

Sub-resources on this resource.

Methods on this resource.

Available OAuth 2.0 scopes.

See: restDescriptionAuthOAuth2Scopes smart constructor.

Creates a value of RestDescriptionAuthOAuth2Scopes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdaoasAddtional

The scope value.

API-level methods for this API.

See: restDescriptionMethods smart constructor.

Creates a value of RestDescriptionMethods with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdmAddtional

An individual method description.

Creates a value of DirectoryListItemsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dliiDiscoveryLink
• dliiPreferred
• dliiKind
• dliiIcons
• dliiName
• dliiVersion
• dliiDocumentationLink
• dliiId
• dliiLabels
• dliiTitle
• dliiDescription
• dliiDiscoveryRestURL

A link to the discovery document.

True if this version is the preferred version to use.

The kind for this response.

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

The name of the API.

The version of the API.

A link to human readable documentation for the API.

The id of this API.

Labels for the status of this API, such as labs or deprecated.

The title of this API.

The description of this API.

The URL for the discovery REST document.

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

See: directoryListItemsItemIcons smart constructor.

Creates a value of DirectoryListItemsItemIcons with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dliiiX16
• dliiiX32

The URL of the 16x16 icon.

The URL of the 32x32 icon.

Sub-resources on this resource.

See: restResourceResources smart constructor.

Creates a value of RestResourceResources with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rrrAddtional

Description for any sub-resources on this resource.

OAuth 2.0 authentication information.

See: restDescriptionAuthOAuth2 smart constructor.

Creates a value of RestDescriptionAuthOAuth2 with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdaoaScopes

Available OAuth 2.0 scopes.

The scope value.

See: restDescriptionAuthOAuth2ScopesAdditional smart constructor.

Creates a value of RestDescriptionAuthOAuth2ScopesAdditional with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdaoasaDescription

Description of scope.

Supports uploading as a single HTTP request.

See: restMethodMediaUploadProtocolsSimple smart constructor.

Creates a value of RestMethodMediaUploadProtocolsSimple with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmmupsPath
• rmmupsMultiPart

The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.

True if this endpoint supports upload multipart media.

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

See: restDescriptionIcons smart constructor.

Creates a value of RestDescriptionIcons with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdiX16
• rdiX32

The URL of the 16x16 icon.

The URL of the 32x32 icon.

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.

See: jsonSchemaVariant smart constructor.

Creates a value of JSONSchemaVariant with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jsvDiscriminant
• jsvMap

The name of the type discriminant property.

The map of discriminant value to schema to use for parsing..

Methods on this resource.

See: restResourceMethods smart constructor.

Creates a value of RestResourceMethods with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rrmAddtional

Description for any methods on this resource.

Authentication information.

See: restDescriptionAuth smart constructor.

Creates a value of RestDescriptionAuth with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdaOAuth2

OAuth 2.0 authentication information.

Creates a value of RestDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdEtag
• rdSchemas
• rdServicePath
• rdBasePath
• rdKind
• rdExponentialBackoffDefault
• rdAuth
• rdIcons
• rdBaseURL
• rdProtocol
• rdOwnerName
• rdResources
• rdOwnerDomain
• rdBatchPath
• rdMethods
• rdName
• rdPackagePath
• rdFeatures
• rdVersion
• rdParameters
• rdDocumentationLink
• rdRootURL
• rdId
• rdCanonicalName
• rdLabels
• rdDiscoveryVersion
• rdTitle
• rdRevision
• rdDescription

The ETag for this response.

The schemas for this API.

The base path for all REST requests.

DEPRECATED

The base path for REST requests.

The kind for this response.

Enable exponential backoff for suitable methods in the generated clients.

Authentication information.

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

DEPRECATED

The base URL for REST requests.

The protocol described by this document.

The name of the owner of this API. See ownerDomain.

The resources in this API.

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.

The path for REST batch requests.

API-level methods for this API.

The name of this API.

The package of the owner of this API. See ownerDomain.

A list of supported features for this API.

The version of this API.

Common parameters that apply across all apis.

A link to human readable documentation for the API.

The root URL under which all API services live.

The ID of this API.

Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.

Labels for the status of this API, such as labs or deprecated.

Indicate the version of the Discovery API used to generate this doc.

The title of this API.

The version of this API.

The description of this API.

Creates a value of JSONSchema with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jsAnnotations
• jsVariant
• jsLocation
• jsRef
• jsPattern
• jsMaximum
• jsDefault
• jsFormat
• jsItems
• jsMinimum
• jsRequired
• jsId
• jsAdditionalProperties
• jsType
• jsEnum
• jsRepeated
• jsReadOnly
• jsEnumDescriptions
• jsDescription
• jsProperties

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.

Whether this parameter goes in the query or the path for REST requests.

A reference to another schema. The value of this property is the "id" of another schema.

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

The maximum value of this parameter.

The default value of this property (if one exists).

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

If this is a schema for an array, this property is the schema for each element in the array.

The minimum value of this parameter.

Whether the parameter is required.

Unique identifier for this schema.

If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.

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

Values this parameter may take (if it is an enum).

Whether this parameter may appear multiple times.

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.

The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.

A description of this object.

If this is a schema for an object, list the schema for each property of this object.

The schemas for this API.

See: restDescriptionSchemas smart constructor.

Creates a value of RestDescriptionSchemas with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdsAddtional

An individual schema description.

Creates a value of JSONSchemaVariantMapItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jsvmiRef
• jsvmiTypeValue

The resources in this API.

See: restDescriptionResources smart constructor.

Creates a value of RestDescriptionResources with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdrAddtional

An individual resource description. Contains methods and sub-resources related to this resource.

Supported upload protocols.

See: restMethodMediaUploadProtocols smart constructor.

Creates a value of RestMethodMediaUploadProtocols with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmmupSimple
• rmmupResumable

Supports uploading as a single HTTP request.

Supports the Resumable Media Upload protocol.

Additional information about this property.

See: jsonSchemaAnnotations smart constructor.

Creates a value of JSONSchemaAnnotations with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jsaRequired

A list of methods for which this property is required on requests.

Details for all parameters in this method.

See: restMethodParameters smart constructor.

Creates a value of RestMethodParameters with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmpAddtional

Details for a single parameter in this method.

Media upload parameters.

See: restMethodMediaUpload smart constructor.

Creates a value of RestMethodMediaUpload with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmmuProtocols
• rmmuAccept
• rmmuMaxSize

Supported upload protocols.

MIME Media Ranges for acceptable media uploads to this method.

Maximum size of a media upload, such as "1MB", "2GB" or "3TB".

If this is a schema for an object, list the schema for each property of this object.

See: jsonSchemaProperties smart constructor.

Creates a value of JSONSchemaProperties with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jspAddtional

A single property of this object. The value is itself a JSON Schema object describing this property.

Supports the Resumable Media Upload protocol.

See: restMethodMediaUploadProtocolsResumable smart constructor.

Creates a value of RestMethodMediaUploadProtocolsResumable with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmmuprPath
• rmmuprMultiPart

The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.

True if this endpoint supports uploading multipart media.

Creates a value of DirectoryList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dlKind
• dlItems
• dlDiscoveryVersion

The kind for this response.

The individual directory entries. One entry per api/version pair.

Indicate the version of the Discovery API used to generate this doc.

The schema for the request.

See: restMethodRequest smart constructor.

Creates a value of RestMethodRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rRef
• rParameterName

Schema ID for the request schema.

parameter name.