RestDescription (API Discovery Service v1-rev20200806-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.discovery.model.RestDescription

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class RestDescription
extends GenericJson
```
Model definition for RestDescription.
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

Author:

Google, Inc.

Nested Class Summary

Nested Classes
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.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

RestDescription()

Constructors
Constructor and Description
`RestDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RestDescription`	`clone()`
`RestDescription.Auth`	`getAuth()` Authentication information.
`String`	`getBasePath()` [DEPRECATED] The base path for REST requests.
`String`	`getBaseUrl()` [DEPRECATED] The base URL for REST requests.
`String`	`getBatchPath()` The path for REST batch requests.
`String`	`getCanonicalName()` Indicates how the API name should be capitalized and split into various parts.
`String`	`getDescription()` The description of this API.
`String`	`getDiscoveryVersion()` Indicate the version of the Discovery API used to generate this doc.
`String`	`getDocumentationLink()` A link to human readable documentation for the API.
`String`	`getEtag()` The ETag for this response.
`Boolean`	`getExponentialBackoffDefault()` Enable exponential backoff for suitable methods in the generated clients.
`List<String>`	`getFeatures()` A list of supported features for this API.
`RestDescription.Icons`	`getIcons()` Links to 16x16 and 32x32 icons representing the API.
`String`	`getId()` The ID of this API.
`String`	`getKind()` The kind for this response.
`List<String>`	`getLabels()` Labels for the status of this API, such as labs or deprecated.
`Map<String,RestMethod>`	`getMethods()` API-level methods for this API.
`String`	`getName()` The name of this API.
`String`	`getOwnerDomain()` The domain of the owner of this API.
`String`	`getOwnerName()` The name of the owner of this API.
`String`	`getPackagePath()` The package of the owner of this API.
`Map<String,JsonSchema>`	`getParameters()` Common parameters that apply across all apis.
`String`	`getProtocol()` The protocol described by this document.
`Map<String,RestResource>`	`getResources()` The resources in this API.
`String`	`getRevision()` The version of this API.
`String`	`getRootUrl()` The root URL under which all API services live.
`Map<String,JsonSchema>`	`getSchemas()` The schemas for this API.
`String`	`getServicePath()` The base path for all REST requests.
`String`	`getTitle()` The title of this API.
`String`	`getVersion()` The version of this API.
`Boolean`	`getVersionModule()`
`RestDescription`	`set(String fieldName, Object value)`
`RestDescription`	`setAuth(RestDescription.Auth auth)` Authentication information.
`RestDescription`	`setBasePath(String basePath)` [DEPRECATED] The base path for REST requests.
`RestDescription`	`setBaseUrl(String baseUrl)` [DEPRECATED] The base URL for REST requests.
`RestDescription`	`setBatchPath(String batchPath)` The path for REST batch requests.
`RestDescription`	`setCanonicalName(String canonicalName)` Indicates how the API name should be capitalized and split into various parts.
`RestDescription`	`setDescription(String description)` The description of this API.
`RestDescription`	`setDiscoveryVersion(String discoveryVersion)` Indicate the version of the Discovery API used to generate this doc.
`RestDescription`	`setDocumentationLink(String documentationLink)` A link to human readable documentation for the API.
`RestDescription`	`setEtag(String etag)` The ETag for this response.
`RestDescription`	`setExponentialBackoffDefault(Boolean exponentialBackoffDefault)` Enable exponential backoff for suitable methods in the generated clients.
`RestDescription`	`setFeatures(List<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(String id)` The ID of this API.
`RestDescription`	`setKind(String kind)` The kind for this response.
`RestDescription`	`setLabels(List<String> labels)` Labels for the status of this API, such as labs or deprecated.
`RestDescription`	`setMethods(Map<String,RestMethod> methods)` API-level methods for this API.
`RestDescription`	`setName(String name)` The name of this API.
`RestDescription`	`setOwnerDomain(String ownerDomain)` The domain of the owner of this API.
`RestDescription`	`setOwnerName(String ownerName)` The name of the owner of this API.
`RestDescription`	`setPackagePath(String packagePath)` The package of the owner of this API.
`RestDescription`	`setParameters(Map<String,JsonSchema> parameters)` Common parameters that apply across all apis.
`RestDescription`	`setProtocol(String protocol)` The protocol described by this document.
`RestDescription`	`setResources(Map<String,RestResource> resources)` The resources in this API.
`RestDescription`	`setRevision(String revision)` The version of this API.
`RestDescription`	`setRootUrl(String rootUrl)` The root URL under which all API services live.
`RestDescription`	`setSchemas(Map<String,JsonSchema> schemas)` The schemas for this API.
`RestDescription`	`setServicePath(String servicePath)` The base path for all REST requests.
`RestDescription`	`setTitle(String title)` The title of this API.
`RestDescription`	`setVersion(String version)` The version of this API.
`RestDescription`	`setVersionModule(Boolean versionModule)`

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - RestDescription
```
public RestDescription()
```
- Method Detail
  - getAuth
```
public RestDescription.Auth getAuth()
```
    Authentication information.
    
    Returns:
    
    value or null for none
  - setAuth
```
public RestDescription setAuth(RestDescription.Auth auth)
```
    Authentication information.
    
    Parameters:
    
    auth - auth or null for none
  - getBasePath
```
public String getBasePath()
```
    [DEPRECATED] The base path for REST requests.
    
    Returns:
    
    value or null for none
  - setBasePath
```
public RestDescription setBasePath(String basePath)
```
    [DEPRECATED] The base path for REST requests.
    
    Parameters:
    
    basePath - basePath or null for none
  - getBaseUrl
```
public String getBaseUrl()
```
    [DEPRECATED] The base URL for REST requests.
    
    Returns:
    
    value or null for none
  - setBaseUrl
```
public RestDescription setBaseUrl(String baseUrl)
```
    [DEPRECATED] The base URL for REST requests.
    
    Parameters:
    
    baseUrl - baseUrl or null for none
  - getBatchPath
```
public String getBatchPath()
```
    The path for REST batch requests.
    
    Returns:
    
    value or null for none
  - setBatchPath
```
public RestDescription setBatchPath(String batchPath)
```
    The path for REST batch requests.
    
    Parameters:
    
    batchPath - batchPath or null for none
  - getCanonicalName
```
public String getCanonicalName()
```
    Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.
    
    Returns:
    
    value or null for none
  - setCanonicalName
```
public RestDescription setCanonicalName(String canonicalName)
```
    Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.
    
    Parameters:
    
    canonicalName - canonicalName or null for none
  - getDescription
```
public String getDescription()
```
    The description of this API.
    
    Returns:
    
    value or null for none
  - setDescription
```
public RestDescription setDescription(String description)
```
    The description of this API.
    
    Parameters:
    
    description - description or null for none
  - getDiscoveryVersion
```
public String getDiscoveryVersion()
```
    Indicate the version of the Discovery API used to generate this doc.
    
    Returns:
    
    value or null for none
  - setDiscoveryVersion
```
public RestDescription setDiscoveryVersion(String discoveryVersion)
```
    Indicate the version of the Discovery API used to generate this doc.
    
    Parameters:
    
    discoveryVersion - discoveryVersion or null for none
  - getDocumentationLink
```
public String getDocumentationLink()
```
    A link to human readable documentation for the API.
    
    Returns:
    
    value or null for none
  - setDocumentationLink
```
public RestDescription setDocumentationLink(String documentationLink)
```
    A link to human readable documentation for the API.
    
    Parameters:
    
    documentationLink - documentationLink or null for none
  - getEtag
```
public String getEtag()
```
    The ETag for this response.
    
    Returns:
    
    value or null for none
  - setEtag
```
public RestDescription setEtag(String etag)
```
    The ETag for this response.
    
    Parameters:
    
    etag - etag or null for none
  - getExponentialBackoffDefault
```
public Boolean getExponentialBackoffDefault()
```
    Enable exponential backoff for suitable methods in the generated clients.
    
    Returns:
    
    value or null for none
  - setExponentialBackoffDefault
```
public RestDescription setExponentialBackoffDefault(Boolean exponentialBackoffDefault)
```
    Enable exponential backoff for suitable methods in the generated clients.
    
    Parameters:
    
    exponentialBackoffDefault - exponentialBackoffDefault or null for none
  - getFeatures
```
public List<String> getFeatures()
```
    A list of supported features for this API.
    
    Returns:
    
    value or null for none
  - setFeatures
```
public RestDescription setFeatures(List<String> features)
```
    A list of supported features for this API.
    
    Parameters:
    
    features - features or null for none
  - getIcons
```
public RestDescription.Icons getIcons()
```
    Links to 16x16 and 32x32 icons representing the API.
    
    Returns:
    
    value or null for none
  - setIcons
```
public RestDescription setIcons(RestDescription.Icons icons)
```
    Links to 16x16 and 32x32 icons representing the API.
    
    Parameters:
    
    icons - icons or null for none
  - getId
```
public String getId()
```
    The ID of this API.
    
    Returns:
    
    value or null for none
  - setId
```
public RestDescription setId(String id)
```
    The ID of this API.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public String getKind()
```
    The kind for this response.
    
    Returns:
    
    value or null for none
  - setKind
```
public RestDescription setKind(String kind)
```
    The kind for this response.
    
    Parameters:
    
    kind - kind or null for none
  - getLabels
```
public List<String> getLabels()
```
    Labels for the status of this API, such as labs or deprecated.
    
    Returns:
    
    value or null for none
  - setLabels
```
public RestDescription setLabels(List<String> labels)
```
    Labels for the status of this API, such as labs or deprecated.
    
    Parameters:
    
    labels - labels or null for none
  - getMethods
```
public Map<String,RestMethod> getMethods()
```
    API-level methods for this API.
    
    Returns:
    
    value or null for none
  - setMethods
```
public RestDescription setMethods(Map<String,RestMethod> methods)
```
    API-level methods for this API.
    
    Parameters:
    
    methods - methods or null for none
  - getName
```
public String getName()
```
    The name of this API.
    
    Returns:
    
    value or null for none
  - setName
```
public RestDescription setName(String name)
```
    The name of this API.
    
    Parameters:
    
    name - name or null for none
  - getOwnerDomain
```
public String getOwnerDomain()
```
    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.
    
    Returns:
    
    value or null for none
  - setOwnerDomain
```
public RestDescription setOwnerDomain(String ownerDomain)
```
    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.
    
    Parameters:
    
    ownerDomain - ownerDomain or null for none
  - getOwnerName
```
public String getOwnerName()
```
    The name of the owner of this API. See ownerDomain.
    
    Returns:
    
    value or null for none
  - setOwnerName
```
public RestDescription setOwnerName(String ownerName)
```
    The name of the owner of this API. See ownerDomain.
    
    Parameters:
    
    ownerName - ownerName or null for none
  - getPackagePath
```
public String getPackagePath()
```
    The package of the owner of this API. See ownerDomain.
    
    Returns:
    
    value or null for none
  - setPackagePath
```
public RestDescription setPackagePath(String packagePath)
```
    The package of the owner of this API. See ownerDomain.
    
    Parameters:
    
    packagePath - packagePath or null for none
  - getParameters
```
public Map<String,JsonSchema> getParameters()
```
    Common parameters that apply across all apis.
    
    Returns:
    
    value or null for none
  - setParameters
```
public RestDescription setParameters(Map<String,JsonSchema> parameters)
```
    Common parameters that apply across all apis.
    
    Parameters:
    
    parameters - parameters or null for none
  - getProtocol
```
public String getProtocol()
```
    The protocol described by this document.
    
    Returns:
    
    value or null for none
  - setProtocol
```
public RestDescription setProtocol(String protocol)
```
    The protocol described by this document.
    
    Parameters:
    
    protocol - protocol or null for none
  - getResources
```
public Map<String,RestResource> getResources()
```
    The resources in this API.
    
    Returns:
    
    value or null for none
  - setResources
```
public RestDescription setResources(Map<String,RestResource> resources)
```
    The resources in this API.
    
    Parameters:
    
    resources - resources or null for none
  - getRevision
```
public String getRevision()
```
    The version of this API.
    
    Returns:
    
    value or null for none
  - setRevision
```
public RestDescription setRevision(String revision)
```
    The version of this API.
    
    Parameters:
    
    revision - revision or null for none
  - getRootUrl
```
public String getRootUrl()
```
    The root URL under which all API services live.
    
    Returns:
    
    value or null for none
  - setRootUrl
```
public RestDescription setRootUrl(String rootUrl)
```
    The root URL under which all API services live.
    
    Parameters:
    
    rootUrl - rootUrl or null for none
  - getSchemas
```
public Map<String,JsonSchema> getSchemas()
```
    The schemas for this API.
    
    Returns:
    
    value or null for none
  - setSchemas
```
public RestDescription setSchemas(Map<String,JsonSchema> schemas)
```
    The schemas for this API.
    
    Parameters:
    
    schemas - schemas or null for none
  - getServicePath
```
public String getServicePath()
```
    The base path for all REST requests.
    
    Returns:
    
    value or null for none
  - setServicePath
```
public RestDescription setServicePath(String servicePath)
```
    The base path for all REST requests.
    
    Parameters:
    
    servicePath - servicePath or null for none
  - getTitle
```
public String getTitle()
```
    The title of this API.
    
    Returns:
    
    value or null for none
  - setTitle
```
public RestDescription setTitle(String title)
```
    The title of this API.
    
    Parameters:
    
    title - title or null for none
  - getVersion
```
public String getVersion()
```
    The version of this API.
    
    Returns:
    
    value or null for none
  - setVersion
```
public RestDescription setVersion(String version)
```
    The version of this API.
    
    Parameters:
    
    version - version or null for none
  - getVersionModule
```
public Boolean getVersionModule()
```
    Returns:
    
    value or null for none
  - setVersionModule
```
public RestDescription setVersionModule(Boolean versionModule)
```
    Parameters:
    
    versionModule - versionModule or null for none
  - set
```
public RestDescription set(String fieldName,
                           Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public RestDescription clone()
```
    Overrides:
    
    clone in class GenericJson

Class RestDescription

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

RestDescription

Method Detail

getAuth

setAuth

getBasePath

setBasePath

getBaseUrl

setBaseUrl

getBatchPath

setBatchPath

getCanonicalName

setCanonicalName

getDescription

setDescription

getDiscoveryVersion

setDiscoveryVersion

getDocumentationLink

setDocumentationLink

getEtag

setEtag

getExponentialBackoffDefault

setExponentialBackoffDefault

getFeatures

setFeatures

getIcons

setIcons

getId

setId

getKind

setKind

getLabels

setLabels

getMethods

setMethods

getName

setName

getOwnerDomain

setOwnerDomain

getOwnerName

setOwnerName

getPackagePath

setPackagePath

getParameters

setParameters

getProtocol

setProtocol

getResources

setResources

getRevision

setRevision

getRootUrl

setRootUrl

getSchemas

setSchemas

getServicePath

setServicePath

getTitle

setTitle

getVersion

setVersion

getVersionModule

setVersionModule

set

clone