Class GoogleCloudAiplatformV1Schema

Defines the schema of input and output data. This is a subset of the OpenAPI 3.0 Schema Object.

Inheritance

object

GoogleCloudAiplatformV1Schema

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.Aiplatform.v1.Data

Assembly: Google.Apis.Aiplatform.v1.dll

Syntax

public class GoogleCloudAiplatformV1Schema : IDirectResponseSchema

Properties

AdditionalProperties

Optional. If type is OBJECT, specifies how to handle properties not defined in properties. If it is a boolean false, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.

Declaration

[JsonProperty("additionalProperties")]
public virtual object AdditionalProperties { get; set; }

Property Value

Type	Description
object

AnyOf

Optional. The instance must be valid against any (one or more) of the subschemas listed in any_of.

Declaration

[JsonProperty("anyOf")]
public virtual IList<GoogleCloudAiplatformV1Schema> AnyOf { get; set; }

Property Value

Type	Description
IList<GoogleCloudAiplatformV1Schema>

Default__

Optional. Default value to use if the field is not specified.

Declaration

[JsonProperty("default")]
public virtual object Default__ { get; set; }

Property Value

Type	Description
object

Defs

Optional. defs provides a map of schema definitions that can be reused by ref elsewhere in the schema. Only allowed at root level of the schema.

Declaration

[JsonProperty("defs")]
public virtual IDictionary<string, GoogleCloudAiplatformV1Schema> Defs { get; set; }

Property Value

Type	Description
IDictionary<string, GoogleCloudAiplatformV1Schema>

Description

Optional. Description of the 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

Enum__

Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set format to enum and provide the list of possible values in enum. For example: 1. To define directions: {type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]} 2. To define apartment numbers: {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 an instance of this schema.

Declaration

[JsonProperty("example")]
public virtual object Example { get; set; }

Property Value

Type	Description
object

Format

Optional. The format of the data. For NUMBER type, format can be float or double. For INTEGER type, format can be int32 or int64. For STRING type, format can be email, byte, date, date-time, password, and other formats to further refine the data type.

Declaration

[JsonProperty("format")]
public virtual string Format { get; set; }

Property Value

Type	Description
string

Items

Optional. If type is ARRAY, items specifies the schema of elements in the array.

Declaration

[JsonProperty("items")]
public virtual GoogleCloudAiplatformV1Schema Items { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1Schema

MaxItems

Optional. If type is ARRAY, max_items specifies the maximum number of items in an array.

Declaration

[JsonProperty("maxItems")]
public virtual long? MaxItems { get; set; }

Property Value

Type	Description
long?

MaxLength

Optional. If type is STRING, max_length specifies the maximum length of the string.

Declaration

[JsonProperty("maxLength")]
public virtual long? MaxLength { get; set; }

Property Value

Type	Description
long?

MaxProperties

Optional. If type is OBJECT, max_properties specifies the maximum number of properties that can be provided.

Declaration

[JsonProperty("maxProperties")]
public virtual long? MaxProperties { get; set; }

Property Value

Type	Description
long?

Maximum

Optional. If type is INTEGER or NUMBER, maximum specifies the maximum allowed value.

Declaration

[JsonProperty("maximum")]
public virtual double? Maximum { get; set; }

Property Value

Type	Description
double?

MinItems

Optional. If type is ARRAY, min_items specifies the minimum number of items in an array.

Declaration

[JsonProperty("minItems")]
public virtual long? MinItems { get; set; }

Property Value

Type	Description
long?

MinLength

Optional. If type is STRING, min_length specifies the minimum length of the string.

Declaration

[JsonProperty("minLength")]
public virtual long? MinLength { get; set; }

Property Value

Type	Description
long?

MinProperties

Optional. If type is OBJECT, min_properties specifies the minimum number of properties that can be provided.

Declaration

[JsonProperty("minProperties")]
public virtual long? MinProperties { get; set; }

Property Value

Type	Description
long?

Minimum

Optional. If type is INTEGER or NUMBER, minimum specifies the minimum allowed value.

Declaration

[JsonProperty("minimum")]
public virtual double? Minimum { get; set; }

Property Value

Type	Description
double?

Nullable

Optional. Indicates if the value of this field can be null.

Declaration

[JsonProperty("nullable")]
public virtual bool? Nullable { get; set; }

Property Value

Type	Description
bool?

Pattern

Optional. If type is STRING, pattern specifies a regular expression that the string must match.

Declaration

[JsonProperty("pattern")]
public virtual string Pattern { get; set; }

Property Value

Type	Description
string

Properties

Optional. If type is OBJECT, properties is a map of property names to schema definitions for each property of the object.

Declaration

[JsonProperty("properties")]
public virtual IDictionary<string, GoogleCloudAiplatformV1Schema> Properties { get; set; }

Property Value

Type	Description
IDictionary<string, GoogleCloudAiplatformV1Schema>

PropertyOrdering

Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.

Declaration

[JsonProperty("propertyOrdering")]
public virtual IList<string> PropertyOrdering { get; set; }

Property Value

Type	Description
IList<string>

Ref__

Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in 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. If type is OBJECT, required lists the names of properties that must be present.

Declaration

[JsonProperty("required")]
public virtual IList<string> Required { get; set; }

Property Value

Type	Description
IList<string>

Title

Optional. Title for the schema.

Declaration

[JsonProperty("title")]
public virtual string Title { get; set; }

Property Value

Type	Description
string

Type

Optional. Data type of the schema field.

Declaration

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

Property Value

Type	Description
string

Implements

IDirectResponseSchema