Show / Hide Table of Contents

Class Schema

Represents a select subset of an OpenAPI 3.0 schema object.

Inheritance
object
Schema
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.CustomerEngagementSuite.v1.Data
Assembly: Google.Apis.CustomerEngagementSuite.v1.dll
Syntax
public class Schema : IDirectResponseSchema

Properties

AdditionalProperties

Optional. Can either be a boolean or an object, controls the presence of additional properties.

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

AnyOf

Optional. The value should be validated against any (one or more) of the subschemas in the list.

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

Default__

Optional. Default value of the data.

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

Defs

Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

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

Description

Optional. The description of the data.

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

Enum__

Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}

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

Items

Optional. Schema of the elements of Type.ARRAY.

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

MaxItems

Optional. Maximum number of the elements for Type.ARRAY.

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

Maximum

Optional. Maximum value for Type.INTEGER and Type.NUMBER.

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

MinItems

Optional. Minimum number of the elements for Type.ARRAY.

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

Minimum

Optional. Minimum value for Type.INTEGER and Type.NUMBER.

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

Nullable

Optional. Indicates if the value may be null.

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

PrefixItems

Optional. Schemas of initial elements of Type.ARRAY.

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

Properties

Optional. Properties of Type.OBJECT.

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

Ref__

Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.

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

Required

Optional. Required properties of Type.OBJECT.

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

Title

Optional. The title of the schema.

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

Type

Required. The type of the data.

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

UniqueItems

Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.

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

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX