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 {

default?: any;

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;

};

required?: string[];

title?: string;

type?:

| "TYPE_UNSPECIFIED"

| "STRING"

| "NUMBER"

| "INTEGER"

| "BOOLEAN"

| "ARRAY"

| "OBJECT";

}

§Properties

default?: any

[src]

Optional. Default value of the data.

description?: string

[src]

Optional. The description of the data.

enum?: string[]

[src]

Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

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