GoogleCloudAiplatformV1Schema

import type { GoogleCloudAiplatformV1Schema } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";

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.

interface GoogleCloudAiplatformV1Schema {

additionalProperties?: any;

anyOf?: GoogleCloudAiplatformV1Schema[];

default?: any;

defs?: {

[key: string]: GoogleCloudAiplatformV1Schema;

};

description?: string;

enum?: string[];

example?: any;

format?: string;

items?: GoogleCloudAiplatformV1Schema;

maximum?: number;

maxItems?: bigint;

maxLength?: bigint;

maxProperties?: bigint;

minimum?: number;

minItems?: bigint;

minLength?: bigint;

minProperties?: bigint;

nullable?: boolean;

pattern?: string;

properties?: {

[key: string]: GoogleCloudAiplatformV1Schema;

};

propertyOrdering?: string[];

ref?: string;

required?: string[];

title?: string;

type?:

| "TYPE_UNSPECIFIED"

| "STRING"

| "NUMBER"

| "INTEGER"

| "BOOLEAN"

| "ARRAY"

| "OBJECT"

| "NULL";

}

§Properties

additionalProperties?: any

[src]

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

anyOf?: GoogleCloudAiplatformV1Schema[]

[src]

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

default?: any

[src]

Optional. Default value of the data.

defs?: {

[key: string]: GoogleCloudAiplatformV1Schema;

}

[src]

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

description?: string

[src]

Optional. The description of the data.

enum?: string[]

[src]

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"]}

example?: any

[src]

Optional. Example of the object. Will only populated when the object is the root.

format?: string

[src]

Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc

items?: GoogleCloudAiplatformV1Schema

[src]

Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.

maximum?: number

[src]

Optional. Maximum value of the Type.INTEGER and Type.NUMBER

maxItems?: bigint

[src]

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

maxLength?: bigint

[src]

Optional. Maximum length of the Type.STRING

maxProperties?: bigint

[src]

Optional. Maximum number of the properties for Type.OBJECT.

minimum?: number

[src]

Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER

minItems?: bigint

[src]

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

minLength?: bigint

[src]

Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING

minProperties?: bigint

[src]

Optional. Minimum number of the properties for Type.OBJECT.

nullable?: boolean

[src]

Optional. Indicates if the value may be null.

pattern?: string

[src]

Optional. Pattern of the Type.STRING to restrict a string to a regular expression.

properties?: {

[key: string]: GoogleCloudAiplatformV1Schema;

}

[src]

Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.

propertyOrdering?: string[]

[src]

Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.

ref?: string

[src]

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

required?: string[]

[src]

Optional. Required properties of Type.OBJECT.

title?: string

[src]

Optional. The title of the Schema.

[src]

Optional. The type of the data.