View Source GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Schema (google_api_ai_platform v0.2.0)
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.
Attributes
-
description
(type:String.t
, default:nil
) - Optional. The description of the data. -
enum
(type:list(String.t)
, default:nil
) - 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
(type:any()
, default:nil
) - Optional. Example of the object. Will only populated when the object is the root. -
format
(type:String.t
, default:nil
) - Optional. The format of the data. Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64 -
items
(type:GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Schema.t
, default:nil
) - Optional. Schema of the elements of Type.ARRAY. -
nullable
(type:boolean()
, default:nil
) - Optional. Indicates if the value may be null. -
properties
(type:%{optional(String.t) => GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Schema.t}
, default:nil
) - Optional. Properties of Type.OBJECT. -
required
(type:list(String.t)
, default:nil
) - Optional. Required properties of Type.OBJECT. -
type
(type:String.t
, default:nil
) - Optional. The type of the data.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Schema{ description: String.t() | nil, enum: [String.t()] | nil, example: any() | nil, format: String.t() | nil, items: t() | nil, nullable: boolean() | nil, properties: %{optional(String.t()) => t()} | nil, required: [String.t()] | nil, type: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.