Class GoogleCloudAiplatformV1Schema
Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed.
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1.Data
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class GoogleCloudAiplatformV1Schema : IDirectResponseSchema
Properties
AnyOf
Optional. The value should be validated against any (one or more) of the subschemas in the list.
Declaration
[JsonProperty("anyOf")]
public virtual IList<GoogleCloudAiplatformV1Schema> AnyOf { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleCloudAiplatformV1Schema> |
Default__
Optional. Default value of the data.
Declaration
[JsonProperty("default")]
public virtual object Default__ { get; set; }
Property Value
Type | Description |
---|---|
object |
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> |
Example
Optional. Example of the object. Will only populated when the object is the root.
Declaration
[JsonProperty("example")]
public virtual object Example { get; set; }
Property Value
Type | Description |
---|---|
object |
Format
Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
Declaration
[JsonProperty("format")]
public virtual string Format { get; set; }
Property Value
Type | Description |
---|---|
string |
Items
Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
Declaration
[JsonProperty("items")]
public virtual GoogleCloudAiplatformV1Schema Items { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1Schema |
MaxItems
Optional. Maximum number of the elements for Type.ARRAY.
Declaration
[JsonProperty("maxItems")]
public virtual long? MaxItems { get; set; }
Property Value
Type | Description |
---|---|
long? |
MaxLength
Optional. Maximum length of the Type.STRING
Declaration
[JsonProperty("maxLength")]
public virtual long? MaxLength { get; set; }
Property Value
Type | Description |
---|---|
long? |
MaxProperties
Optional. Maximum number of the properties for Type.OBJECT.
Declaration
[JsonProperty("maxProperties")]
public virtual long? MaxProperties { get; set; }
Property Value
Type | Description |
---|---|
long? |
Maximum
Optional. Maximum value of the 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? |
MinLength
Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
Declaration
[JsonProperty("minLength")]
public virtual long? MinLength { get; set; }
Property Value
Type | Description |
---|---|
long? |
MinProperties
Optional. Minimum number of the properties for Type.OBJECT.
Declaration
[JsonProperty("minProperties")]
public virtual long? MinProperties { get; set; }
Property Value
Type | Description |
---|---|
long? |
Minimum
Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the 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? |
Pattern
Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
Declaration
[JsonProperty("pattern")]
public virtual string Pattern { get; set; }
Property Value
Type | Description |
---|---|
string |
Properties
Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
Declaration
[JsonProperty("properties")]
public virtual IDictionary<string, GoogleCloudAiplatformV1Schema> Properties { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, GoogleCloudAiplatformV1Schema> |
PropertyOrdering
Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
Declaration
[JsonProperty("propertyOrdering")]
public virtual IList<string> PropertyOrdering { get; set; }
Property Value
Type | Description |
---|---|
IList<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
Optional. The type of the data.
Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type | Description |
---|---|
string |