public final class RestDescription
extends com.google.api.client.json.GenericJson
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the API Discovery Service. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json
Modifier and Type | Class and Description |
---|---|
static class |
RestDescription.Auth
Authentication information.
|
static class |
RestDescription.Icons
Links to 16x16 and 32x32 icons representing the API.
|
com.google.api.client.util.GenericData.Flags
Constructor and Description |
---|
RestDescription() |
Modifier and Type | Method and Description |
---|---|
RestDescription |
clone() |
RestDescription.Auth |
getAuth()
Authentication information.
|
java.lang.String |
getBasePath()
[DEPRECATED] The base path for REST requests.
|
java.lang.String |
getBaseUrl()
[DEPRECATED] The base URL for REST requests.
|
java.lang.String |
getBatchPath()
The path for REST batch requests.
|
java.lang.String |
getCanonicalName()
Indicates how the API name should be capitalized and split into various parts.
|
java.lang.String |
getDescription()
The description of this API.
|
java.lang.String |
getDiscoveryVersion()
Indicate the version of the Discovery API used to generate this doc.
|
java.lang.String |
getDocumentationLink()
A link to human readable documentation for the API.
|
java.lang.String |
getEtag()
The ETag for this response.
|
java.lang.Boolean |
getExponentialBackoffDefault()
Enable exponential backoff for suitable methods in the generated clients.
|
java.util.List<java.lang.String> |
getFeatures()
A list of supported features for this API.
|
RestDescription.Icons |
getIcons()
Links to 16x16 and 32x32 icons representing the API.
|
java.lang.String |
getId()
The ID of this API.
|
java.lang.String |
getKind()
The kind for this response.
|
java.util.List<java.lang.String> |
getLabels()
Labels for the status of this API, such as labs or deprecated.
|
java.util.Map<java.lang.String,RestMethod> |
getMethods()
API-level methods for this API.
|
java.lang.String |
getName()
The name of this API.
|
java.lang.String |
getOwnerDomain()
The domain of the owner of this API.
|
java.lang.String |
getOwnerName()
The name of the owner of this API.
|
java.lang.String |
getPackagePath()
The package of the owner of this API.
|
java.util.Map<java.lang.String,JsonSchema> |
getParameters()
Common parameters that apply across all apis.
|
java.lang.String |
getProtocol()
The protocol described by this document.
|
java.util.Map<java.lang.String,RestResource> |
getResources()
The resources in this API.
|
java.lang.String |
getRevision()
The version of this API.
|
java.lang.String |
getRootUrl()
The root URL under which all API services live.
|
java.util.Map<java.lang.String,JsonSchema> |
getSchemas()
The schemas for this API.
|
java.lang.String |
getServicePath()
The base path for all REST requests.
|
java.lang.String |
getTitle()
The title of this API.
|
java.lang.String |
getVersion()
The version of this API.
|
java.lang.Boolean |
getVersionModule() |
RestDescription |
set(java.lang.String fieldName,
java.lang.Object value) |
RestDescription |
setAuth(RestDescription.Auth auth)
Authentication information.
|
RestDescription |
setBasePath(java.lang.String basePath)
[DEPRECATED] The base path for REST requests.
|
RestDescription |
setBaseUrl(java.lang.String baseUrl)
[DEPRECATED] The base URL for REST requests.
|
RestDescription |
setBatchPath(java.lang.String batchPath)
The path for REST batch requests.
|
RestDescription |
setCanonicalName(java.lang.String canonicalName)
Indicates how the API name should be capitalized and split into various parts.
|
RestDescription |
setDescription(java.lang.String description)
The description of this API.
|
RestDescription |
setDiscoveryVersion(java.lang.String discoveryVersion)
Indicate the version of the Discovery API used to generate this doc.
|
RestDescription |
setDocumentationLink(java.lang.String documentationLink)
A link to human readable documentation for the API.
|
RestDescription |
setEtag(java.lang.String etag)
The ETag for this response.
|
RestDescription |
setExponentialBackoffDefault(java.lang.Boolean exponentialBackoffDefault)
Enable exponential backoff for suitable methods in the generated clients.
|
RestDescription |
setFeatures(java.util.List<java.lang.String> features)
A list of supported features for this API.
|
RestDescription |
setIcons(RestDescription.Icons icons)
Links to 16x16 and 32x32 icons representing the API.
|
RestDescription |
setId(java.lang.String id)
The ID of this API.
|
RestDescription |
setKind(java.lang.String kind)
The kind for this response.
|
RestDescription |
setLabels(java.util.List<java.lang.String> labels)
Labels for the status of this API, such as labs or deprecated.
|
RestDescription |
setMethods(java.util.Map<java.lang.String,RestMethod> methods)
API-level methods for this API.
|
RestDescription |
setName(java.lang.String name)
The name of this API.
|
RestDescription |
setOwnerDomain(java.lang.String ownerDomain)
The domain of the owner of this API.
|
RestDescription |
setOwnerName(java.lang.String ownerName)
The name of the owner of this API.
|
RestDescription |
setPackagePath(java.lang.String packagePath)
The package of the owner of this API.
|
RestDescription |
setParameters(java.util.Map<java.lang.String,JsonSchema> parameters)
Common parameters that apply across all apis.
|
RestDescription |
setProtocol(java.lang.String protocol)
The protocol described by this document.
|
RestDescription |
setResources(java.util.Map<java.lang.String,RestResource> resources)
The resources in this API.
|
RestDescription |
setRevision(java.lang.String revision)
The version of this API.
|
RestDescription |
setRootUrl(java.lang.String rootUrl)
The root URL under which all API services live.
|
RestDescription |
setSchemas(java.util.Map<java.lang.String,JsonSchema> schemas)
The schemas for this API.
|
RestDescription |
setServicePath(java.lang.String servicePath)
The base path for all REST requests.
|
RestDescription |
setTitle(java.lang.String title)
The title of this API.
|
RestDescription |
setVersion(java.lang.String version)
The version of this API.
|
RestDescription |
setVersionModule(java.lang.Boolean versionModule) |
getFactory, setFactory, toPrettyString, toString
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values
public RestDescription.Auth getAuth()
null
for nonepublic RestDescription setAuth(RestDescription.Auth auth)
auth
- auth or null
for nonepublic java.lang.String getBasePath()
null
for nonepublic RestDescription setBasePath(java.lang.String basePath)
basePath
- basePath or null
for nonepublic java.lang.String getBaseUrl()
null
for nonepublic RestDescription setBaseUrl(java.lang.String baseUrl)
baseUrl
- baseUrl or null
for nonepublic java.lang.String getBatchPath()
null
for nonepublic RestDescription setBatchPath(java.lang.String batchPath)
batchPath
- batchPath or null
for nonepublic java.lang.String getCanonicalName()
null
for nonepublic RestDescription setCanonicalName(java.lang.String canonicalName)
canonicalName
- canonicalName or null
for nonepublic java.lang.String getDescription()
null
for nonepublic RestDescription setDescription(java.lang.String description)
description
- description or null
for nonepublic java.lang.String getDiscoveryVersion()
null
for nonepublic RestDescription setDiscoveryVersion(java.lang.String discoveryVersion)
discoveryVersion
- discoveryVersion or null
for nonepublic java.lang.String getDocumentationLink()
null
for nonepublic RestDescription setDocumentationLink(java.lang.String documentationLink)
documentationLink
- documentationLink or null
for nonepublic java.lang.String getEtag()
null
for nonepublic RestDescription setEtag(java.lang.String etag)
etag
- etag or null
for nonepublic java.lang.Boolean getExponentialBackoffDefault()
null
for nonepublic RestDescription setExponentialBackoffDefault(java.lang.Boolean exponentialBackoffDefault)
exponentialBackoffDefault
- exponentialBackoffDefault or null
for nonepublic java.util.List<java.lang.String> getFeatures()
null
for nonepublic RestDescription setFeatures(java.util.List<java.lang.String> features)
features
- features or null
for nonepublic RestDescription.Icons getIcons()
null
for nonepublic RestDescription setIcons(RestDescription.Icons icons)
icons
- icons or null
for nonepublic java.lang.String getId()
null
for nonepublic RestDescription setId(java.lang.String id)
id
- id or null
for nonepublic java.lang.String getKind()
null
for nonepublic RestDescription setKind(java.lang.String kind)
kind
- kind or null
for nonepublic java.util.List<java.lang.String> getLabels()
null
for nonepublic RestDescription setLabels(java.util.List<java.lang.String> labels)
labels
- labels or null
for nonepublic java.util.Map<java.lang.String,RestMethod> getMethods()
null
for nonepublic RestDescription setMethods(java.util.Map<java.lang.String,RestMethod> methods)
methods
- methods or null
for nonepublic java.lang.String getName()
null
for nonepublic RestDescription setName(java.lang.String name)
name
- name or null
for nonepublic java.lang.String getOwnerDomain()
null
for nonepublic RestDescription setOwnerDomain(java.lang.String ownerDomain)
ownerDomain
- ownerDomain or null
for nonepublic java.lang.String getOwnerName()
null
for nonepublic RestDescription setOwnerName(java.lang.String ownerName)
ownerName
- ownerName or null
for nonepublic java.lang.String getPackagePath()
null
for nonepublic RestDescription setPackagePath(java.lang.String packagePath)
packagePath
- packagePath or null
for nonepublic java.util.Map<java.lang.String,JsonSchema> getParameters()
null
for nonepublic RestDescription setParameters(java.util.Map<java.lang.String,JsonSchema> parameters)
parameters
- parameters or null
for nonepublic java.lang.String getProtocol()
null
for nonepublic RestDescription setProtocol(java.lang.String protocol)
protocol
- protocol or null
for nonepublic java.util.Map<java.lang.String,RestResource> getResources()
null
for nonepublic RestDescription setResources(java.util.Map<java.lang.String,RestResource> resources)
resources
- resources or null
for nonepublic java.lang.String getRevision()
null
for nonepublic RestDescription setRevision(java.lang.String revision)
revision
- revision or null
for nonepublic java.lang.String getRootUrl()
null
for nonepublic RestDescription setRootUrl(java.lang.String rootUrl)
rootUrl
- rootUrl or null
for nonepublic java.util.Map<java.lang.String,JsonSchema> getSchemas()
null
for nonepublic RestDescription setSchemas(java.util.Map<java.lang.String,JsonSchema> schemas)
schemas
- schemas or null
for nonepublic java.lang.String getServicePath()
null
for nonepublic RestDescription setServicePath(java.lang.String servicePath)
servicePath
- servicePath or null
for nonepublic java.lang.String getTitle()
null
for nonepublic RestDescription setTitle(java.lang.String title)
title
- title or null
for nonepublic java.lang.String getVersion()
null
for nonepublic RestDescription setVersion(java.lang.String version)
version
- version or null
for nonepublic java.lang.Boolean getVersionModule()
null
for nonepublic RestDescription setVersionModule(java.lang.Boolean versionModule)
versionModule
- versionModule or null
for nonepublic RestDescription set(java.lang.String fieldName, java.lang.Object value)
set
in class com.google.api.client.json.GenericJson
public RestDescription clone()
clone
in class com.google.api.client.json.GenericJson