Show / Hide Table of Contents

Class JsonSchema

JsonSchema representation of schema metadata

Inheritance
object
JsonSchema
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Connectors.v1.Data
Assembly: Google.Apis.Connectors.v1.dll
Syntax
public class JsonSchema : IDirectResponseSchema

Properties

AdditionalDetails

Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema

Declaration
[JsonProperty("additionalDetails")]
public virtual IDictionary<string, object> AdditionalDetails { get; set; }
Property Value
Type Description
IDictionary<string, object>

AdditionalItems

Schema for additional items.

Declaration
[JsonProperty("additionalItems")]
public virtual JsonSchema AdditionalItems { get; set; }
Property Value
Type Description
JsonSchema

AdditionalProperties

Schema for additional properties.

Declaration
[JsonProperty("additionalProperties")]
public virtual JsonSchema AdditionalProperties { get; set; }
Property Value
Type Description
JsonSchema

AllOf

Schema that must be valid against all of the sub-schemas.

Declaration
[JsonProperty("allOf")]
public virtual IList<JsonSchema> AllOf { get; set; }
Property Value
Type Description
IList<JsonSchema>

AnyOf

Schema that must be valid against at least one of the sub-schemas.

Declaration
[JsonProperty("anyOf")]
public virtual IList<JsonSchema> AnyOf { get; set; }
Property Value
Type Description
IList<JsonSchema>

Comment

A comment on the schema.

Declaration
[JsonProperty("$comment")]
public virtual string Comment { get; set; }
Property Value
Type Description
string

Const__

Const value that the data must match.

Declaration
[JsonProperty("const")]
public virtual object Const__ { get; set; }
Property Value
Type Description
object

Contains

Schema that applies to at least one item in an array.

Declaration
[JsonProperty("contains")]
public virtual JsonSchema Contains { get; set; }
Property Value
Type Description
JsonSchema

ContentEncoding

Encoding of the content.

Declaration
[JsonProperty("contentEncoding")]
public virtual string ContentEncoding { get; set; }
Property Value
Type Description
string

ContentMediaType

Media type of the content.

Declaration
[JsonProperty("contentMediaType")]
public virtual string ContentMediaType { get; set; }
Property Value
Type Description
string

Default__

The default value of the field or object described by this schema.

Declaration
[JsonProperty("default")]
public virtual object Default__ { get; set; }
Property Value
Type Description
object

Definitions

Definitions for the schema.

Declaration
[JsonProperty("definitions")]
public virtual IDictionary<string, JsonSchema> Definitions { get; set; }
Property Value
Type Description
IDictionary<string, JsonSchema>

Defs

Definitions for the schema.

Declaration
[JsonProperty("$defs")]
public virtual IDictionary<string, JsonSchema> Defs { get; set; }
Property Value
Type Description
IDictionary<string, JsonSchema>

Dependencies

Dependencies for the schema.

Declaration
[JsonProperty("dependencies")]
public virtual IDictionary<string, object> Dependencies { get; set; }
Property Value
Type Description
IDictionary<string, object>

Description

A description of this schema.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Else__

Schema that must be valid if the "if" schema is invalid.

Declaration
[JsonProperty("else")]
public virtual JsonSchema Else__ { get; set; }
Property Value
Type Description
JsonSchema

Enum__

Possible values for an enumeration. This works in conjunction with type to represent types with a fixed set of legal values

Declaration
[JsonProperty("enum")]
public virtual IList<object> Enum__ { get; set; }
Property Value
Type Description
IList<object>

Examples

Examples of the value.

Declaration
[JsonProperty("examples")]
public virtual IList<object> Examples { get; set; }
Property Value
Type Description
IList<object>

ExclusiveMaximum

Whether the maximum number value is exclusive.

Declaration
[JsonProperty("exclusiveMaximum")]
public virtual object ExclusiveMaximum { get; set; }
Property Value
Type Description
object

ExclusiveMinimum

Whether the minimum number value is exclusive.

Declaration
[JsonProperty("exclusiveMinimum")]
public virtual object ExclusiveMinimum { get; set; }
Property Value
Type Description
object

Format

Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format

Declaration
[JsonProperty("format")]
public virtual string Format { get; set; }
Property Value
Type Description
string

Id

The URI defining the core schema meta-schema.

Declaration
[JsonProperty("$id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

If__

Schema that must be valid if the "if" schema is valid.

Declaration
[JsonProperty("if")]
public virtual JsonSchema If__ { get; set; }
Property Value
Type Description
JsonSchema

Items

Schema that applies to array values, applicable only if this is of type array.

Declaration
[JsonProperty("items")]
public virtual JsonSchema Items { get; set; }
Property Value
Type Description
JsonSchema

JdbcType

JDBC datatype of the field.

Declaration
[JsonProperty("jdbcType")]
public virtual string JdbcType { get; set; }
Property Value
Type Description
string

MaxItems

Maximum number of items in the array field.

Declaration
[JsonProperty("maxItems")]
public virtual int? MaxItems { get; set; }
Property Value
Type Description
int?

MaxLength

Maximum length of the string field.

Declaration
[JsonProperty("maxLength")]
public virtual int? MaxLength { get; set; }
Property Value
Type Description
int?

MaxProperties

Maximum number of properties.

Declaration
[JsonProperty("maxProperties")]
public virtual int? MaxProperties { get; set; }
Property Value
Type Description
int?

Maximum

Maximum value of the number field.

Declaration
[JsonProperty("maximum")]
public virtual object Maximum { get; set; }
Property Value
Type Description
object

MinItems

Minimum number of items in the array field.

Declaration
[JsonProperty("minItems")]
public virtual int? MinItems { get; set; }
Property Value
Type Description
int?

MinLength

Minimum length of the string field.

Declaration
[JsonProperty("minLength")]
public virtual int? MinLength { get; set; }
Property Value
Type Description
int?

MinProperties

Minimum number of properties.

Declaration
[JsonProperty("minProperties")]
public virtual int? MinProperties { get; set; }
Property Value
Type Description
int?

Minimum

Minimum value of the number field.

Declaration
[JsonProperty("minimum")]
public virtual object Minimum { get; set; }
Property Value
Type Description
object

MultipleOf

Number must be a multiple of this value.

Declaration
[JsonProperty("multipleOf")]
public virtual double? MultipleOf { get; set; }
Property Value
Type Description
double?

Not

Schema that must not be valid.

Declaration
[JsonProperty("not")]
public virtual JsonSchema Not { get; set; }
Property Value
Type Description
JsonSchema

OneOf

Schema that must be valid against at least one of the sub-schemas.

Declaration
[JsonProperty("oneOf")]
public virtual IList<JsonSchema> OneOf { get; set; }
Property Value
Type Description
IList<JsonSchema>

Pattern

Regex pattern of the string field. This is a string value that describes the regular expression that the string value should match.

Declaration
[JsonProperty("pattern")]
public virtual string Pattern { get; set; }
Property Value
Type Description
string

PatternProperties

Pattern properties for the schema.

Declaration
[JsonProperty("patternProperties")]
public virtual IDictionary<string, JsonSchema> PatternProperties { get; set; }
Property Value
Type Description
IDictionary<string, JsonSchema>

Properties

The child schemas, applicable only if this is of type object. The key is the name of the property and the value is the json schema that describes that property

Declaration
[JsonProperty("properties")]
public virtual IDictionary<string, JsonSchema> Properties { get; set; }
Property Value
Type Description
IDictionary<string, JsonSchema>

PropertyNames

Schema for property names.

Declaration
[JsonProperty("propertyNames")]
public virtual JsonSchema PropertyNames { get; set; }
Property Value
Type Description
JsonSchema

ReadOnly__

Whether the value is read-only.

Declaration
[JsonProperty("readOnly")]
public virtual bool? ReadOnly__ { get; set; }
Property Value
Type Description
bool?

Ref__

A reference to another schema.

Declaration
[JsonProperty("$ref")]
public virtual string Ref__ { get; set; }
Property Value
Type Description
string

Required

Whether this property is required.

Declaration
[JsonProperty("required")]
public virtual IList<string> Required { get; set; }
Property Value
Type Description
IList<string>

Schema

The URI defining the schema.

Declaration
[JsonProperty("$schema")]
public virtual string Schema { get; set; }
Property Value
Type Description
string

Then

Schema that must be valid if the "if" schema is valid.

Declaration
[JsonProperty("then")]
public virtual JsonSchema Then { get; set; }
Property Value
Type Description
JsonSchema

Title

A title of the schema.

Declaration
[JsonProperty("title")]
public virtual string Title { get; set; }
Property Value
Type Description
string

Type

JSON Schema Validation: A Vocabulary for Structural Validation of JSON

Declaration
[JsonProperty("type")]
public virtual IList<string> Type { get; set; }
Property Value
Type Description
IList<string>

UniqueItems

Whether the items in the array field are unique.

Declaration
[JsonProperty("uniqueItems")]
public virtual bool? UniqueItems { get; set; }
Property Value
Type Description
bool?

WriteOnly

Whether the value is write-only.

Declaration
[JsonProperty("writeOnly")]
public virtual bool? WriteOnly { get; set; }
Property Value
Type Description
bool?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX