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.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ description |
string
Optional. The description of the data. |
↳ nullable |
bool
Optional. Indicates if the value may be null. |
↳ items |
Google\Cloud\AIPlatform\V1\Schema
Optional. Schema of the elements of 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. Properties of Type.OBJECT. |
↳ required |
array
Optional. Required properties of Type.OBJECT. |
↳ example |
Google\Protobuf\Value
Optional. Example of the object. Will only populated when the object is the root. |
getType
Optional. The type of the data.
| Returns | |
|---|---|
| Type | Description |
int | |
setType
Optional. The type of the data.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFormat
Optional. The format of the data.
Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64
| Returns | |
|---|---|
| Type | Description |
string | |
setFormat
Optional. The format of the data.
Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. The description of the data.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. The description of the data.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNullable
Optional. Indicates if the value may be null.
| Returns | |
|---|---|
| Type | Description |
bool | |
setNullable
Optional. Indicates if the value may be null.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getItems
Optional. Schema of the elements of Type.ARRAY.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\Schema|null | |
hasItems
clearItems
setItems
Optional. Schema of the elements of Type.ARRAY.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\Schema
|
| Returns | |
|---|---|
| Type | Description |
$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"]}
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
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"]}
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProperties
Optional. Properties of Type.OBJECT.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setProperties
Optional. Properties of Type.OBJECT.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequired
Optional. Required properties of Type.OBJECT.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setRequired
Optional. Required properties of Type.OBJECT.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExample
Optional. Example of the object. Will only populated when the object is the root.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Value|null | |
hasExample
clearExample
setExample
Optional. Example of the object. Will only populated when the object is the root.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |