JsonSchema (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.JsonSchema

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class JsonSchema
extends GenericJson
```
Model definition for JsonSchema.
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`	`JsonSchema.Annotations` Additional information about this property.
`static class`	`JsonSchema.Variant` In a variant data type, the value of one property is used to determine how to interpret the entire entity.

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

JsonSchema()

Constructors
Constructor and Description
`JsonSchema()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JsonSchema`	`clone()`
`String`	`get$ref()` A reference to another schema.
`JsonSchema`	`getAdditionalProperties()` If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
`JsonSchema.Annotations`	`getAnnotations()` Additional information about this property.
`String`	`getDefault()` The default value of this property (if one exists).
`String`	`getDescription()` A description of this object.
`List<String>`	`getEnum()` Values this parameter may take (if it is an enum).
`List<String>`	`getEnumDescriptions()` The descriptions for the enums.
`String`	`getFormat()` An additional regular expression or key that helps constrain the value.
`String`	`getId()` Unique identifier for this schema.
`JsonSchema`	`getItems()` If this is a schema for an array, this property is the schema for each element in the array.
`String`	`getLocation()` Whether this parameter goes in the query or the path for REST requests.
`String`	`getMaximum()` The maximum value of this parameter.
`String`	`getMinimum()` The minimum value of this parameter.
`String`	`getPattern()` The regular expression this parameter must conform to.
`Map<String,JsonSchema>`	`getProperties()` If this is a schema for an object, list the schema for each property of this object.
`Boolean`	`getReadOnly()` The value is read-only, generated by the service.
`Boolean`	`getRepeated()` Whether this parameter may appear multiple times.
`Boolean`	`getRequired()` Whether the parameter is required.
`String`	`getType()` The value type for this schema.
`JsonSchema.Variant`	`getVariant()` In a variant data type, the value of one property is used to determine how to interpret the entire entity.
`JsonSchema`	`set(String fieldName, Object value)`
`JsonSchema`	`set$ref(String $ref)` A reference to another schema.
`JsonSchema`	`setAdditionalProperties(JsonSchema additionalProperties)` If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
`JsonSchema`	`setAnnotations(JsonSchema.Annotations annotations)` Additional information about this property.
`JsonSchema`	`setDefault(String default__)` The default value of this property (if one exists).
`JsonSchema`	`setDescription(String description)` A description of this object.
`JsonSchema`	`setEnum(List<String> enum__)` Values this parameter may take (if it is an enum).
`JsonSchema`	`setEnumDescriptions(List<String> enumDescriptions)` The descriptions for the enums.
`JsonSchema`	`setFormat(String format)` An additional regular expression or key that helps constrain the value.
`JsonSchema`	`setId(String id)` Unique identifier for this schema.
`JsonSchema`	`setItems(JsonSchema items)` If this is a schema for an array, this property is the schema for each element in the array.
`JsonSchema`	`setLocation(String location)` Whether this parameter goes in the query or the path for REST requests.
`JsonSchema`	`setMaximum(String maximum)` The maximum value of this parameter.
`JsonSchema`	`setMinimum(String minimum)` The minimum value of this parameter.
`JsonSchema`	`setPattern(String pattern)` The regular expression this parameter must conform to.
`JsonSchema`	`setProperties(Map<String,JsonSchema> properties)` If this is a schema for an object, list the schema for each property of this object.
`JsonSchema`	`setReadOnly(Boolean readOnly)` The value is read-only, generated by the service.
`JsonSchema`	`setRepeated(Boolean repeated)` Whether this parameter may appear multiple times.
`JsonSchema`	`setRequired(Boolean required)` Whether the parameter is required.
`JsonSchema`	`setType(String type)` The value type for this schema.
`JsonSchema`	`setVariant(JsonSchema.Variant variant)` In a variant data type, the value of one property is used to determine how to interpret the entire entity.

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
  - JsonSchema
```
public JsonSchema()
```
- Method Detail
  - get$ref
```
public String get$ref()
```
    A reference to another schema. The value of this property is the "id" of another schema.
    
    Returns:
    
    value or null for none
  - set$ref
```
public JsonSchema set$ref(String $ref)
```
    A reference to another schema. The value of this property is the "id" of another schema.
    
    Parameters:
    
    $ref - $ref or null for none
  - getAdditionalProperties
```
public JsonSchema getAdditionalProperties()
```
    If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
    
    Returns:
    
    value or null for none
  - setAdditionalProperties
```
public JsonSchema setAdditionalProperties(JsonSchema additionalProperties)
```
    If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
    
    Parameters:
    
    additionalProperties - additionalProperties or null for none
  - getAnnotations
```
public JsonSchema.Annotations getAnnotations()
```
    Additional information about this property.
    
    Returns:
    
    value or null for none
  - setAnnotations
```
public JsonSchema setAnnotations(JsonSchema.Annotations annotations)
```
    Additional information about this property.
    
    Parameters:
    
    annotations - annotations or null for none
  - getDefault
```
public String getDefault()
```
    The default value of this property (if one exists).
    
    Returns:
    
    value or null for none
  - setDefault
```
public JsonSchema setDefault(String default__)
```
    The default value of this property (if one exists).
    
    Parameters:
    
    default__ - default__ or null for none
  - getDescription
```
public String getDescription()
```
    A description of this object.
    
    Returns:
    
    value or null for none
  - setDescription
```
public JsonSchema setDescription(String description)
```
    A description of this object.
    
    Parameters:
    
    description - description or null for none
  - getEnum
```
public List<String> getEnum()
```
    Values this parameter may take (if it is an enum).
    
    Returns:
    
    value or null for none
  - setEnum
```
public JsonSchema setEnum(List<String> enum__)
```
    Values this parameter may take (if it is an enum).
    
    Parameters:
    
    enum__ - enum__ or null for none
  - getEnumDescriptions
```
public List<String> getEnumDescriptions()
```
    The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
    
    Returns:
    
    value or null for none
  - setEnumDescriptions
```
public JsonSchema setEnumDescriptions(List<String> enumDescriptions)
```
    The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
    
    Parameters:
    
    enumDescriptions - enumDescriptions or null for none
  - getFormat
```
public String getFormat()
```
    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
    
    Returns:
    
    value or null for none
  - setFormat
```
public JsonSchema setFormat(String format)
```
    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
    
    Parameters:
    
    format - format or null for none
  - getId
```
public String getId()
```
    Unique identifier for this schema.
    
    Returns:
    
    value or null for none
  - setId
```
public JsonSchema setId(String id)
```
    Unique identifier for this schema.
    
    Parameters:
    
    id - id or null for none
  - getItems
```
public JsonSchema getItems()
```
    If this is a schema for an array, this property is the schema for each element in the array.
    
    Returns:
    
    value or null for none
  - setItems
```
public JsonSchema setItems(JsonSchema items)
```
    If this is a schema for an array, this property is the schema for each element in the array.
    
    Parameters:
    
    items - items or null for none
  - getLocation
```
public String getLocation()
```
    Whether this parameter goes in the query or the path for REST requests.
    
    Returns:
    
    value or null for none
  - setLocation
```
public JsonSchema setLocation(String location)
```
    Whether this parameter goes in the query or the path for REST requests.
    
    Parameters:
    
    location - location or null for none
  - getMaximum
```
public String getMaximum()
```
    The maximum value of this parameter.
    
    Returns:
    
    value or null for none
  - setMaximum
```
public JsonSchema setMaximum(String maximum)
```
    The maximum value of this parameter.
    
    Parameters:
    
    maximum - maximum or null for none
  - getMinimum
```
public String getMinimum()
```
    The minimum value of this parameter.
    
    Returns:
    
    value or null for none
  - setMinimum
```
public JsonSchema setMinimum(String minimum)
```
    The minimum value of this parameter.
    
    Parameters:
    
    minimum - minimum or null for none
  - getPattern
```
public String getPattern()
```
    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
    
    Returns:
    
    value or null for none
  - setPattern
```
public JsonSchema setPattern(String pattern)
```
    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
    
    Parameters:
    
    pattern - pattern or null for none
  - getProperties
```
public Map<String,JsonSchema> getProperties()
```
    If this is a schema for an object, list the schema for each property of this object.
    
    Returns:
    
    value or null for none
  - setProperties
```
public JsonSchema setProperties(Map<String,JsonSchema> properties)
```
    If this is a schema for an object, list the schema for each property of this object.
    
    Parameters:
    
    properties - properties or null for none
  - getReadOnly
```
public Boolean getReadOnly()
```
    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.
    
    Returns:
    
    value or null for none
  - setReadOnly
```
public JsonSchema setReadOnly(Boolean readOnly)
```
    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.
    
    Parameters:
    
    readOnly - readOnly or null for none
  - getRepeated
```
public Boolean getRepeated()
```
    Whether this parameter may appear multiple times.
    
    Returns:
    
    value or null for none
  - setRepeated
```
public JsonSchema setRepeated(Boolean repeated)
```
    Whether this parameter may appear multiple times.
    
    Parameters:
    
    repeated - repeated or null for none
  - getRequired
```
public Boolean getRequired()
```
    Whether the parameter is required.
    
    Returns:
    
    value or null for none
  - setRequired
```
public JsonSchema setRequired(Boolean required)
```
    Whether the parameter is required.
    
    Parameters:
    
    required - required or null for none
  - getType
```
public String getType()
```
    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
    
    Returns:
    
    value or null for none
  - setType
```
public JsonSchema setType(String type)
```
    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
    
    Parameters:
    
    type - type or null for none
  - getVariant
```
public JsonSchema.Variant getVariant()
```
    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.
    
    Returns:
    
    value or null for none
  - setVariant
```
public JsonSchema setVariant(JsonSchema.Variant variant)
```
    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.
    
    Parameters:
    
    variant - variant or null for none
  - set
```
public JsonSchema set(String fieldName,
                      Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public JsonSchema clone()
```
    Overrides:
    
    clone in class GenericJson

Class JsonSchema

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

JsonSchema

Method Detail

get$ref

set$ref

getAdditionalProperties

setAdditionalProperties

getAnnotations

setAnnotations

getDefault

setDefault

getDescription

setDescription

getEnum

setEnum

getEnumDescriptions

setEnumDescriptions

getFormat

setFormat

getId

setId

getItems

setItems

getLocation

setLocation

getMaximum

setMaximum

getMinimum

setMinimum

getPattern

setPattern

getProperties

setProperties

getReadOnly

setReadOnly

getRepeated

setRepeated

getRequired

setRequired

getType

setType

getVariant

setVariant

set

clone