- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Schema.
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.
Generated from protobuf message google.cloud.aiplatform.v1.Schema
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ type
int
Optional. The type of the data.
↳ format
string
Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
↳ title
string
Optional. The title of the Schema.
↳ description
string
Optional. The description of the data.
↳ nullable
bool
Optional. Indicates if the value may be null.
↳ default
↳ items
Google\Cloud\AIPlatform\V1\Schema
Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
↳ min_items
int|string
Optional. Minimum number of the elements for Type.ARRAY.
↳ max_items
int|string
Optional. Maximum number of the elements for Type.ARRAY.
↳ enum
array
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"]}
↳ properties
array| Google\Protobuf\Internal\MapField
Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
↳ property_ordering
array
Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
↳ required
array
Optional. Required properties of Type.OBJECT.
↳ min_properties
int|string
Optional. Minimum number of the properties for Type.OBJECT.
↳ max_properties
int|string
Optional. Maximum number of the properties for Type.OBJECT.
↳ minimum
float
Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
↳ maximum
float
Optional. Maximum value of the Type.INTEGER and Type.NUMBER
↳ min_length
int|string
Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
↳ max_length
int|string
Optional. Maximum length of the Type.STRING
↳ pattern
string
Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
↳ example
Google\Protobuf\Value
Optional. Example of the object. Will only populated when the object is the root.
↳ any_of
array< Google\Cloud\AIPlatform\V1\Schema
>
Optional. The value should be validated against any (one or more) of the subschemas in the list.
getType
Optional. The type of the data.
int
setType
Optional. The type of the data.
var
int
$this
getFormat
Optional. The format of the data.
Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
string
setFormat
Optional. The format of the data.
Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
var
string
$this
getTitle
Optional. The title of the Schema.
string
setTitle
Optional. The title of the Schema.
var
string
$this
getDescription
Optional. The description of the data.
string
setDescription
Optional. The description of the data.
var
string
$this
getNullable
Optional. Indicates if the value may be null.
bool
setNullable
Optional. Indicates if the value may be null.
var
bool
$this
getDefault
Optional. Default value of the data.
hasDefault
clearDefault
setDefault
Optional. Default value of the data.
$this
getItems
Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
hasItems
clearItems
setItems
Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
$this
getMinItems
Optional. Minimum number of the elements for Type.ARRAY.
int|string
setMinItems
Optional. Minimum number of the elements for Type.ARRAY.
var
int|string
$this
getMaxItems
Optional. Maximum number of the elements for Type.ARRAY.
int|string
setMaxItems
Optional. Maximum number of the elements for Type.ARRAY.
var
int|string
$this
getEnum
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"]}
setEnum
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"]}
var
string[]
$this
getProperties
Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
setProperties
Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
$this
getPropertyOrdering
Optional. The order of the properties.
Not a standard field in open api spec. Only used to support the order of the properties.
setPropertyOrdering
Optional. The order of the properties.
Not a standard field in open api spec. Only used to support the order of the properties.
var
string[]
$this
getRequired
Optional. Required properties of Type.OBJECT.
setRequired
Optional. Required properties of Type.OBJECT.
var
string[]
$this
getMinProperties
Optional. Minimum number of the properties for Type.OBJECT.
int|string
setMinProperties
Optional. Minimum number of the properties for Type.OBJECT.
var
int|string
$this
getMaxProperties
Optional. Maximum number of the properties for Type.OBJECT.
int|string
setMaxProperties
Optional. Maximum number of the properties for Type.OBJECT.
var
int|string
$this
getMinimum
Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
float
setMinimum
Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
var
float
$this
getMaximum
Optional. Maximum value of the Type.INTEGER and Type.NUMBER
float
setMaximum
Optional. Maximum value of the Type.INTEGER and Type.NUMBER
var
float
$this
getMinLength
Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
int|string
setMinLength
Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
var
int|string
$this
getMaxLength
Optional. Maximum length of the Type.STRING
int|string
setMaxLength
Optional. Maximum length of the Type.STRING
var
int|string
$this
getPattern
Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
string
setPattern
Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
var
string
$this
getExample
Optional. Example of the object. Will only populated when the object is the root.
hasExample
clearExample
setExample
Optional. Example of the object. Will only populated when the object is the root.
$this
getAnyOf
Optional. The value should be validated against any (one or more) of the subschemas in the list.
setAnyOf
Optional. The value should be validated against any (one or more) of the subschemas in the list.
$this
